pocket_coffea package

Subpackages

• pocket_coffea.executors package
  • Submodules
  • pocket_coffea.executors.executors_CLAIX module
  • pocket_coffea.executors.executors_DESY_NAF module
    • ParslCondorExecutorFactory
      • ParslCondorExecutorFactory.close()
      • ParslCondorExecutorFactory.customized_args()
      • ParslCondorExecutorFactory.get()
      • ParslCondorExecutorFactory.get_worker_env()
      • ParslCondorExecutorFactory.setup()
    • get_executor_factory()
  • pocket_coffea.executors.executors_RWTH module
  • pocket_coffea.executors.executors_T3_CH_PSI module
    • DaskExecutorFactory
      • DaskExecutorFactory.close()
      • DaskExecutorFactory.customized_args()
      • DaskExecutorFactory.get()
      • DaskExecutorFactory.get_worker_env()
      • DaskExecutorFactory.setup()
    • get_executor_factory()
  • pocket_coffea.executors.executors_base module
    • ExecutorFactoryABC
      • ExecutorFactoryABC.close()
      • ExecutorFactoryABC.customized_args()
      • ExecutorFactoryABC.get()
      • ExecutorFactoryABC.set_env()
      • ExecutorFactoryABC.setup()
      • ExecutorFactoryABC.setup_proxyfile()
    • FuturesExecutorFactory
      • FuturesExecutorFactory.customized_args()
      • FuturesExecutorFactory.get()
    • IterativeExecutorFactory
      • IterativeExecutorFactory.get()
    • get_executor_factory()
  • pocket_coffea.executors.executors_brux module
  • pocket_coffea.executors.executors_casa module
    • DaskExecutorFactory
      • DaskExecutorFactory.close()
      • DaskExecutorFactory.customized_args()
      • DaskExecutorFactory.get()
      • DaskExecutorFactory.setup()
    • get_executor_factory()
  • pocket_coffea.executors.executors_cern_swan module
  • pocket_coffea.executors.executors_infn_af module
  • pocket_coffea.executors.executors_lxplus module
    • DaskExecutorFactory
      • DaskExecutorFactory.close()
      • DaskExecutorFactory.customized_args()
      • DaskExecutorFactory.get()
      • DaskExecutorFactory.setup()
    • ExecutorFactoryCondorCERN
      • ExecutorFactoryCondorCERN.get()
      • ExecutorFactoryCondorCERN.prepare_jobs()
      • ExecutorFactoryCondorCERN.recreate_jobs()
      • ExecutorFactoryCondorCERN.submit_jobs()
    • get_executor_factory()
    • get_worker_env()
    • set_queue()
    • update_queue()
  • pocket_coffea.executors.executors_manual_jobs module
    • ExecutorFactoryManualABC
      • ExecutorFactoryManualABC.close()
      • ExecutorFactoryManualABC.customized_args()
      • ExecutorFactoryManualABC.get()
      • ExecutorFactoryManualABC.prepare_jobs()
      • ExecutorFactoryManualABC.prepare_splitting()
      • ExecutorFactoryManualABC.recreate_jobs()
      • ExecutorFactoryManualABC.set_env()
      • ExecutorFactoryManualABC.setup()
      • ExecutorFactoryManualABC.setup_proxyfile()
      • ExecutorFactoryManualABC.submit()
      • ExecutorFactoryManualABC.submit_jobs()
    • ensure_job_sh_forwards_inner_yaml()
    • ensure_sub_transfers_inner_yaml()
    • write_inner_run_options()
  • pocket_coffea.executors.executors_oscar module
  • pocket_coffea.executors.executors_purdue_af module
    • DaskGatewayExecutorFactory
      • DaskGatewayExecutorFactory.close()
      • DaskGatewayExecutorFactory.customized_args()
      • DaskGatewayExecutorFactory.get()
      • DaskGatewayExecutorFactory.get_worker_env()
      • DaskGatewayExecutorFactory.setup()
      • DaskGatewayExecutorFactory.setup_proxyfile()
    • get_executor_factory()
  • pocket_coffea.executors.executors_rubin module
  • Module contents
• pocket_coffea.law_tasks package
  • Subpackages
    • pocket_coffea.law_tasks.configuration package
      • Submodules
      • pocket_coffea.law_tasks.configuration.general module
      • pocket_coffea.law_tasks.configuration.plotting module
      • Module contents
    • pocket_coffea.law_tasks.tasks package
      • Submodules
      • pocket_coffea.law_tasks.tasks.base module
      • pocket_coffea.law_tasks.tasks.datacard module
      • pocket_coffea.law_tasks.tasks.datasets module
      • pocket_coffea.law_tasks.tasks.plotting module
      • pocket_coffea.law_tasks.tasks.runner module
      • Module contents
  • Submodules
  • pocket_coffea.law_tasks.utils module
    • create_datasets_paths()
    • exclude_samples_from_plotting()
    • extract_executor_and_site()
    • filter_items_by_regex()
    • get_executor()
    • import_analysis_config()
    • load_analysis_config()
    • load_plotting_style()
    • load_run_options()
    • load_sample_names()
    • merge_datasets_definition()
    • modify_dataset_output_path()
    • process_datasets()
    • read_datasets_definition()
  • Module contents
• pocket_coffea.lib package
  • Subpackages
    • pocket_coffea.lib.calibrators package
      • Subpackages
      • Submodules
      • pocket_coffea.lib.calibrators.calibrator module
      • pocket_coffea.lib.calibrators.calibrators_manager module
      • Module contents
    • pocket_coffea.lib.weights package
      • Subpackages
      • Submodules
      • pocket_coffea.lib.weights.test_weights_mechanism module
      • pocket_coffea.lib.weights.weights module
      • pocket_coffea.lib.weights.weights_manager module
      • Module contents
  • Submodules
  • pocket_coffea.lib.categorization module
    • CartesianSelection
      • CartesianSelection.get_mask()
      • CartesianSelection.get_masks()
      • CartesianSelection.items()
      • CartesianSelection.keys()
      • CartesianSelection.prepare()
      • CartesianSelection.serialize()
      • CartesianSelection.template_mask
    • MaskStorage
      • MaskStorage.add()
      • MaskStorage.all()
      • MaskStorage.masks
      • MaskStorage.names
    • MultiCut
      • MultiCut.get_mask()
      • MultiCut.ncuts
      • MultiCut.prepare()
      • MultiCut.serialize()
    • StandardSelection
      • StandardSelection.get_mask()
      • StandardSelection.get_masks()
      • StandardSelection.items()
      • StandardSelection.keys()
      • StandardSelection.prepare()
      • StandardSelection.serialize()
      • StandardSelection.template_mask
  • pocket_coffea.lib.columns_manager module
    • ColOut
      • ColOut.collection
      • ColOut.columns
      • ColOut.fill_none
      • ColOut.fill_value
      • ColOut.flatten
      • ColOut.pos_end
      • ColOut.pos_start
      • ColOut.store_size
    • ColumnsManager
      • ColumnsManager.add_column()
      • ColumnsManager.fill_ak_arrays()
      • ColumnsManager.fill_columns_accumulators()
      • ColumnsManager.ncols
  • pocket_coffea.lib.cut_definition module
    • Cut
      • Cut.collection
      • Cut.function
      • Cut.get_mask()
      • Cut.id
      • Cut.name
      • Cut.params
      • Cut.serialize()
  • pocket_coffea.lib.cut_functions module
    • apply_event_flags()
    • apply_golden_json()
    • count_objects_eq()
    • count_objects_gt()
    • count_objects_lt()
    • eq_nObj()
    • eq_nObj_minPt()
    • get_HLTsel()
    • get_HLTsel_custom()
    • get_JetVetoMap()
    • get_JetVetoMap_Mask()
    • get_L1sel()
    • get_L1sel_custom()
    • get_nBtag()
    • get_nBtagEq()
    • get_nBtagMin()
    • get_nElectron()
    • get_nMuon()
    • get_nObj_eq()
    • get_nObj_less()
    • get_nObj_min()
    • get_nPVgood()
    • less_nObj()
    • min_nObj()
    • min_nObj_minPt()
    • nBtagEq()
    • nBtagMin()
    • nElectron()
    • nMuon()
    • passthrough_f()
  • pocket_coffea.lib.delayed_eval module
    • DelayedEvalBranchManager
      • DelayedEvalBranchManager.ensure_nominal_index()
      • DelayedEvalBranchManager.prepare_nominal_snapshot()
      • DelayedEvalBranchManager.register()
      • DelayedEvalBranchManager.union_final_categories_mask()
      • DelayedEvalBranchManager.update_for_current_variation()
  • pocket_coffea.lib.deltaR_matching module
    • deltaR_matching_nonunique()
    • delta_phi()
    • get_matching_objects_indices_padnone()
    • get_matching_pairs_indices()
    • metric_eta()
    • metric_phi()
    • metric_pt()
    • object_matching()
  • pocket_coffea.lib.gen_objects module
    • getGenJets()
    • getGenLeptons()
  • pocket_coffea.lib.hist_manager module
    • Axis
      • Axis.bins
      • Axis.coll
      • Axis.field
      • Axis.growth
      • Axis.label
      • Axis.lim
      • Axis.name
      • Axis.overflow
      • Axis.pos
      • Axis.start
      • Axis.stop
      • Axis.transform
      • Axis.type
      • Axis.underflow
    • HistConf
      • HistConf.autofill
      • HistConf.axes
      • HistConf.collapse_2D_masks
      • HistConf.collapse_2D_masks_mode
      • HistConf.exclude_categories
      • HistConf.exclude_samples
      • HistConf.hist_obj
      • HistConf.metadata_hist
      • HistConf.no_weights
      • HistConf.only_categories
      • HistConf.only_samples
      • HistConf.only_variations
      • HistConf.serialize()
      • HistConf.storage
      • HistConf.variations
    • HistManager
      • HistManager.fill_histograms()
      • HistManager.get_histogram()
      • HistManager.get_histograms()
      • HistManager.get_metadata_histograms()
      • HistManager.mask_and_broadcast_weight()
    • get_hist_axis_from_config()
    • weights_cache()
  • pocket_coffea.lib.jets module
    • CCsorted()
    • CvsLsorted()
    • ProbBsorted()
    • add_jec_variables()
    • add_jec_variables_subjet()
    • btagging()
    • compute_jetId()
    • get_dijet()
    • get_jer_correction_set()
    • get_jersmear()
    • get_rho()
    • jet_correction_corrlib()
    • jet_selection()
    • load_jet_factory()
    • met_correction()
    • met_correction_after_jec()
    • met_xy_correction()
    • msoftdrop_correction()
  • pocket_coffea.lib.leptons module
    • get_charged_leptons()
    • get_diboson()
    • get_dilepton()
    • get_ele_scaled()
    • get_ele_scaled_etdependent()
    • get_ele_smeared()
    • get_ele_smeared_etdependent()
    • lepton_selection()
    • lepton_selection_promptMVA()
    • soft_lepton_selection()
  • pocket_coffea.lib.muon_scale_and_resolution module
    • CrystallBall
      • CrystallBall.cdf()
      • CrystallBall.invcdf()
    • SeedSequence
      • SeedSequence.generate()
    • filter_boundaries()
    • get_k()
    • get_rndm()
    • get_std()
    • pt_resol()
    • pt_resol_var()
    • pt_scale()
    • pt_scale_var()
    • random()
  • pocket_coffea.lib.objects module
  • pocket_coffea.lib.parton_provenance module
    • analyze_W_flat()
    • analyze_parton_decays_flat_nomesons()
    • get_partons_provenance_tt5F()
    • get_partons_provenance_ttHbb()
    • get_partons_provenance_ttHbb_dileptonic()
    • get_partons_provenance_ttbb4F()
    • reverse_index_array()
  • pocket_coffea.lib.photon module
    • photon_selection()
  • pocket_coffea.lib.reconstruction module
  • pocket_coffea.lib.scale_factors module
    • get_ele_sf()
    • get_mu_sf()
    • get_pho_sf()
    • sf_L1prefiring()
    • sf_btag()
    • sf_btag_calib()
    • sf_ctag()
    • sf_ctag_calib()
    • sf_ele_id()
    • sf_ele_promptmva()
    • sf_ele_reco()
    • sf_ele_trigger()
    • sf_jet_puId()
    • sf_mu()
    • sf_mu_promptmva()
    • sf_partonshower_fsr()
    • sf_partonshower_isr()
    • sf_photon()
    • sf_pileup_reweight()
  • pocket_coffea.lib.triggers module
    • apply_trigger_mask()
    • get_trigger_mask_byprimarydataset()
  • Module contents
• pocket_coffea.parameters package
  • Subpackages
    • pocket_coffea.parameters.jec package
      • Module contents
  • Submodules
  • pocket_coffea.parameters.cuts module
  • pocket_coffea.parameters.dask_env module
    • setup_dask()
  • pocket_coffea.parameters.defaults module
    • compose_parameters_from_files()
    • dump_parameters()
    • get_default_parameters()
    • get_default_run_options()
    • get_defaults_and_compose()
    • merge_parameters()
    • merge_parameters_from_files()
    • merge_parameters_from_string()
    • register_configuration_dir()
    • setup_cvmfs_resolver()
  • pocket_coffea.parameters.histograms module
    • count_hist()
    • ele_hists()
    • fatjet_hists()
    • fatjet_taggers_hists()
    • genjet_hists()
    • jet_hists()
    • jet_taggers_hists()
    • lepton_hists()
    • met_hists()
    • muon_hists()
    • parton_hists()
    • processing_metadata_hists()
    • sv_hists()
  • pocket_coffea.parameters.lumi module
    • femtobarn()
  • Module contents
• pocket_coffea.scripts package
  • Subpackages
    • pocket_coffea.scripts.dataset package
      • Submodules
      • pocket_coffea.scripts.dataset.append_genweights module
      • pocket_coffea.scripts.dataset.append_parents module
      • pocket_coffea.scripts.dataset.build_datasets module
      • pocket_coffea.scripts.dataset.dataset_query module
      • pocket_coffea.scripts.dataset.download module
      • Module contents
    • pocket_coffea.scripts.plot package
      • Submodules
      • pocket_coffea.scripts.plot.make_plots module
      • pocket_coffea.scripts.plot.plot_cutflow module
      • pocket_coffea.scripts.plot.trigger_efficiency module
      • pocket_coffea.scripts.plot.trigger_scalefactor module
      • Module contents
  • Submodules
  • pocket_coffea.scripts.build_jec module
    • jet_factory_factory()
  • pocket_coffea.scripts.check_jobs module
    • bump_jobqueue()
    • check_jobs_logs()
    • create_layout()
    • find_other_file()
    • get_progress_table()
    • get_tables()
    • update_blacklist()
  • pocket_coffea.scripts.config_template module
  • pocket_coffea.scripts.hadd_skimmed_files module
    • do_hadd()
  • pocket_coffea.scripts.make_config module
    • write_config()
  • pocket_coffea.scripts.merge_columns module
    • find_leaf_dirs()
    • merge_leaf_dir()
    • worker()
  • pocket_coffea.scripts.merge_outputs module
    • append_configs()
    • merge_group_reduction()
    • merge_outputs()
    • process_failed()
  • pocket_coffea.scripts.pileup_corrlib module
  • pocket_coffea.scripts.print_parameters module
  • pocket_coffea.scripts.runner module
  • pocket_coffea.scripts.split_output module
    • split_output()
  • Module contents
• pocket_coffea.utils package
  • Subpackages
    • pocket_coffea.utils.stat package
      • Submodules
      • pocket_coffea.utils.stat.combine module
      • pocket_coffea.utils.stat.processes module
      • pocket_coffea.utils.stat.systematics module
      • Module contents
  • Submodules
  • pocket_coffea.utils.benchmarking module
    • print_processing_stats()
  • pocket_coffea.utils.build_jets_calibrator module
    • build()
  • pocket_coffea.utils.configurator module
    • Configurator
      • Configurator.clone()
      • Configurator.filter_dataset()
      • Configurator.load()
      • Configurator.load_columns_config()
      • Configurator.load_cuts_and_categories()
      • Configurator.load_datasets()
      • Configurator.load_subsamples()
      • Configurator.load_variations_config()
      • Configurator.load_weights_config()
      • Configurator.load_workflow()
      • Configurator.perform_checks()
      • Configurator.save_config()
      • Configurator.set_filesets_manually()
    • format()
  • pocket_coffea.utils.cutflow_utils module
  • pocket_coffea.utils.dataset module
    • Dataset
      • Dataset.check_samples()
      • Dataset.down_file
      • Dataset.download()
      • Dataset.get_samples()
      • Dataset.save()
    • Sample
      • Sample.check_files()
      • Sample.get_entries_uproot()
      • Sample.get_filelist()
      • Sample.get_parentlist()
      • Sample.get_sample_dict()
    • build_datasets()
    • do_dataset()
  • pocket_coffea.utils.export module
    • export_coffea_output_to_root()
    • save_histogram_to_root()
  • pocket_coffea.utils.filter_output module
    • compare_dict_types()
    • filter_dictionary()
    • filter_output_by_category()
    • filter_output_by_year()
  • pocket_coffea.utils.histogram module
    • rebin_hist()
  • pocket_coffea.utils.load_output module
    • load_output()
  • pocket_coffea.utils.logging module
    • LogFormatter
      • LogFormatter.COLOR_CODES
      • LogFormatter.RESET_CODE
      • LogFormatter.format()
    • setup_logging()
    • try_and_log_error()
  • pocket_coffea.utils.network module
    • check_port()
    • get_proxy_path()
  • pocket_coffea.utils.plot_efficiency module
    • EfficiencyMap
      • EfficiencyMap.compute_efficiency()
      • EfficiencyMap.define_1d_figures()
      • EfficiencyMap.define_datamc()
      • EfficiencyMap.define_systematics()
      • EfficiencyMap.define_variations()
      • EfficiencyMap.initialize_stack()
      • EfficiencyMap.plot1d()
      • EfficiencyMap.plot2d()
      • EfficiencyMap.save1d()
      • EfficiencyMap.save2d()
      • EfficiencyMap.save_corrections()
    • plot_efficiency_maps()
    • plot_efficiency_maps_splitHT()
    • plot_efficiency_maps_spliteras()
    • plot_ratio()
    • plot_residue()
    • plot_variation()
    • stack_sum()
    • uncertainty_efficiency()
    • uncertainty_sf()
  • pocket_coffea.utils.plot_functions module
    • plot_shapes_comparison()
  • pocket_coffea.utils.plot_sf module
    • plot_variation_correctionlib()
  • pocket_coffea.utils.plot_utils module
  • pocket_coffea.utils.rucio module
    • get_dataset_files_from_dbs()
    • get_dataset_files_replicas()
    • get_rucio_client()
    • get_xrootd_sites_map()
    • query_dataset()
  • pocket_coffea.utils.run module
    • get_runner()
  • pocket_coffea.utils.skim module
    • apply_skim_sumgenweights_override()
    • copy_file()
    • is_rootcompat()
    • save_skimed_dataset_definition()
    • uproot_writeable()
  • pocket_coffea.utils.time module
    • wait_until()
  • pocket_coffea.utils.utils module
    • adapt_chunksize()
    • add_to_path()
    • dump_ak_array()
    • get_nano_version()
    • get_random_seed()
    • load_config()
    • load_failed_jobs()
    • path_import()
    • replace_at_indices()
    • save_failed_jobs()
  • Module contents
• pocket_coffea.workflows package
  • Submodules
  • pocket_coffea.workflows.base module
    • BaseProcessorABC
      • BaseProcessorABC.apply_object_preselection()
      • BaseProcessorABC.apply_preselections()
      • BaseProcessorABC.compute_weights()
      • BaseProcessorABC.compute_weights_extra()
      • BaseProcessorABC.count_events()
      • BaseProcessorABC.count_objects()
      • BaseProcessorABC.define_categories()
      • BaseProcessorABC.define_column_accumulators()
      • BaseProcessorABC.define_column_accumulators_extra()
      • BaseProcessorABC.define_common_variables_after_presel()
      • BaseProcessorABC.define_common_variables_before_presel()
      • BaseProcessorABC.define_custom_axes_extra()
      • BaseProcessorABC.define_histograms()
      • BaseProcessorABC.define_histograms_extra()
      • BaseProcessorABC.define_weights()
      • BaseProcessorABC.export_skimmed_chunk()
      • BaseProcessorABC.fill_column_accumulators()
      • BaseProcessorABC.fill_column_accumulators_extra()
      • BaseProcessorABC.fill_histograms()
      • BaseProcessorABC.fill_histograms_extra()
      • BaseProcessorABC.get_preselection_mask()
      • BaseProcessorABC.initialize_calibrators()
      • BaseProcessorABC.load_metadata()
      • BaseProcessorABC.load_metadata_extra()
      • BaseProcessorABC.loop_over_variations()
      • BaseProcessorABC.nevents
      • BaseProcessorABC.postprocess()
      • BaseProcessorABC.process()
      • BaseProcessorABC.process_extra_after_calibrators()
      • BaseProcessorABC.process_extra_after_presel()
      • BaseProcessorABC.process_extra_after_skim()
      • BaseProcessorABC.process_extra_before_presel()
      • BaseProcessorABC.process_extra_before_skim()
      • BaseProcessorABC.rescale_sumgenweights()
      • BaseProcessorABC.save_processing_metadata()
      • BaseProcessorABC.skim_events()
  • pocket_coffea.workflows.genweights module
    • genWeightsProcessor
      • genWeightsProcessor.apply_object_preselection()
      • genWeightsProcessor.count_objects()
      • genWeightsProcessor.load_metadata()
      • genWeightsProcessor.process()
  • pocket_coffea.workflows.semileptonic_triggerSF module
    • semileptonicTriggerProcessor
      • semileptonicTriggerProcessor.define_custom_axes_extra()
  • pocket_coffea.workflows.sf_lepton_variations module
  • pocket_coffea.workflows.tthbb_base_processor module
    • ttHbbBaseProcessor
      • ttHbbBaseProcessor.apply_object_preselection()
      • ttHbbBaseProcessor.count_objects()
      • ttHbbBaseProcessor.define_common_variables_before_presel()
      • ttHbbBaseProcessor.fill_histograms_extra()
  • Module contents

Module contents

Copyright (c) 2024 Davide Valsecchi. All rights reserved.

PocketCoffea: Configurable analysis framework based on Coffea for CMS NanoAOD events analysis