API Reference Guide

• pocket_coffea
  • pocket_coffea package
    • Subpackages
      • pocket_coffea.executors package
        • Submodules
        • pocket_coffea.executors.executors_DESY_NAF module
        • 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_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.get_worker_env()
            • DaskExecutorFactory.setup()
          • ExecutorFactoryCondorCERN
            • ExecutorFactoryCondorCERN.get()
            • ExecutorFactoryCondorCERN.prepare_jobs()
            • ExecutorFactoryCondorCERN.recreate_jobs()
            • ExecutorFactoryCondorCERN.submit_jobs()
          • get_executor_factory()
        • 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()
        • Module contents
      • pocket_coffea.lib package
        • Subpackages
          • pocket_coffea.lib.weights package
            • Subpackages
              • pocket_coffea.lib.weights.common package
                • Submodules
                • pocket_coffea.lib.weights.common.common module
                  • SF_btag
                    • SF_btag.compute()
                    • SF_btag.has_variations
                    • SF_btag.name
                  • SF_btag_calib
                    • SF_btag_calib.compute()
                    • SF_btag_calib.has_variations
                    • SF_btag_calib.name
                  • SF_ctag
                    • SF_ctag.compute()
                    • SF_ctag.has_variations
                    • SF_ctag.name
                  • SF_ctag_calib
                    • SF_ctag_calib.compute()
                    • SF_ctag_calib.has_variations
                    • SF_ctag_calib.name
                  • SF_jet_puId
                    • SF_jet_puId.compute()
                    • SF_jet_puId.has_variations
                    • SF_jet_puId.name
                • pocket_coffea.lib.weights.common.weights_run2_UL module
                  • SF_ele_trigger
                    • SF_ele_trigger.compute()
                    • SF_ele_trigger.has_variations
                    • SF_ele_trigger.name
                  • get_ele_trigger_sf()
                  • sf_ele_trigger()
                  • sf_qcd_factor_scale()
                  • sf_qcd_renorm_scale()
                • pocket_coffea.lib.weights.common.weights_run3 module
                • Module contents
            • Submodules
            • pocket_coffea.lib.weights.test_weights_mechanism module
            • pocket_coffea.lib.weights.weights module
              • WeightData
                • WeightData.down
                • WeightData.name
                • WeightData.nominal
                • WeightData.up
              • WeightDataMultiVariation
                • WeightDataMultiVariation.down
                • WeightDataMultiVariation.name
                • WeightDataMultiVariation.nominal
                • WeightDataMultiVariation.up
                • WeightDataMultiVariation.variations
              • WeightLambda
                • WeightLambda.compute()
              • WeightWrapper
                • WeightWrapper.compute()
                • WeightWrapper.has_variations
                • WeightWrapper.isMC_only
                • WeightWrapper.name
                • WeightWrapper.serialize()
                • WeightWrapper.variations
              • WeightWrapperMeta
                • WeightWrapperMeta.get_weight_class_from_name()
                • WeightWrapperMeta.weight_classes
                • WeightWrapperMeta.wrap_func()
            • pocket_coffea.lib.weights.weights_manager module
              • WeightsManager
                • WeightsManager.add_weight()
                • WeightsManager.compute()
                • WeightsManager.get_available_modifiers_bycategory()
                • WeightsManager.get_available_modifiers_byweight()
                • WeightsManager.get_weight()
            • 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_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.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.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
          • CvsLsorted()
          • ProbBsorted()
          • add_jec_variables()
          • btagging()
          • get_dijet()
          • jet_correction()
          • jet_correction_correctionlib()
          • jet_selection()
          • load_jet_factory()
          • met_correction()
          • met_xy_correction()
        • pocket_coffea.lib.leptons module
          • get_charged_leptons()
          • get_diboson()
          • get_dilepton()
          • get_ele_scaled()
          • get_ele_smeared()
          • lepton_selection()
          • soft_lepton_selection()
        • 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.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_reco()
          • sf_ele_trigger()
          • sf_jet_puId()
          • sf_mu()
          • 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()
        • 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.jec_config module
        • 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
              • DataDiscoveryCLI
                • DataDiscoveryCLI.as_dict
                • DataDiscoveryCLI.do_allowlist_sites()
                • DataDiscoveryCLI.do_blocklist_sites()
                • DataDiscoveryCLI.do_clear()
                • DataDiscoveryCLI.do_list_replicas()
                • DataDiscoveryCLI.do_list_selected()
                • DataDiscoveryCLI.do_login()
                • DataDiscoveryCLI.do_query()
                • DataDiscoveryCLI.do_query_results()
                • DataDiscoveryCLI.do_regex_sites()
                • DataDiscoveryCLI.do_replicas()
                • DataDiscoveryCLI.do_save()
                • DataDiscoveryCLI.do_select()
                • DataDiscoveryCLI.do_sites_filters()
                • DataDiscoveryCLI.do_whoami()
                • DataDiscoveryCLI.extract_era_from_dataset_name()
                • DataDiscoveryCLI.extract_xsec_from_dataset_name()
                • DataDiscoveryCLI.extract_year_from_dataset_name()
                • DataDiscoveryCLI.generate_default_metadata()
                • DataDiscoveryCLI.is_mc_dataset()
                • DataDiscoveryCLI.load_dataset_definition()
                • DataDiscoveryCLI.start_cli()
              • get_indices_query()
              • print_dataset_query()
            • 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.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.config_template module
        • pocket_coffea.scripts.hadd_skimmed_files module
          • do_hadd()
        • pocket_coffea.scripts.make_config module
          • write_config()
        • pocket_coffea.scripts.merge_outputs module
          • merge_outputs()
        • pocket_coffea.scripts.split_output module
          • split_output()
        • pocket_coffea.scripts.print_parameters module
        • pocket_coffea.scripts.runner module
        • Module contents
      • pocket_coffea.utils package
        • 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.dataset module
          • Dataset
            • Dataset.check_samples()
            • Dataset.down_file
            • Dataset.download()
            • Dataset.get_samples()
            • Dataset.save()
          • Sample
            • Sample.check_files()
            • Sample.get_filelist()
            • Sample.get_parentlist()
            • Sample.get_sample_dict()
          • build_datasets()
          • do_dataset()
        • pocket_coffea.utils.load_output module
          • load_output()
        • pocket_coffea.utils.logging module
          • LogFormatter
            • LogFormatter.COLOR_CODES
            • LogFormatter.RESET_CODE
            • LogFormatter.format()
          • setup_logging()
        • 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
          • PlotManager
            • PlotManager.copy_index_file()
            • PlotManager.make_dirs()
            • PlotManager.plot_comparison()
            • PlotManager.plot_comparison_all()
            • PlotManager.plot_datamc()
            • PlotManager.plot_datamc_all()
            • PlotManager.plot_systematic_shifts()
            • PlotManager.plot_systematic_shifts_all()
          • Shape
            • Shape.blind_hist()
            • Shape.categorical_axes_data
            • Shape.categorical_axes_mc
            • Shape.define_figure()
            • Shape.dense_axes
            • Shape.dense_dim
            • Shape.filter_samples()
            • Shape.format_figure()
            • Shape.get_axis_items()
            • Shape.get_datamc_ratio()
            • Shape.get_ref_ratios()
            • Shape.group_samples()
            • Shape.load_attributes()
            • Shape.load_syst_manager()
            • Shape.plot_compare_ratios()
            • Shape.plot_comparison()
            • Shape.plot_comparison_all()
            • Shape.plot_data()
            • Shape.plot_datamc()
            • Shape.plot_datamc_all()
            • Shape.plot_datamc_ratio()
            • Shape.plot_mc()
            • Shape.plot_systematic_shifts()
            • Shape.plot_systematic_shifts_all()
            • Shape.plot_systematic_uncertainty()
            • Shape.replace_missing_variations()
            • Shape.rescale_samples()
            • Shape.samples
            • Shape.samples_data
            • Shape.samples_mc
            • Shape.stack_sum_data
            • Shape.stack_sum_mc_nominal
          • Style
            • Style.set_defaults()
            • Style.update()
          • SystManager
            • SystManager.get_syst()
            • SystManager.mcstat()
            • SystManager.total()
            • SystManager.update()
          • SystUnc
            • SystUnc.check_empty_variations()
            • SystUnc.define_figure()
            • SystUnc.down
            • SystUnc.format_figure()
            • SystUnc.nsyst
            • SystUnc.plot()
            • SystUnc.ratio_down
            • SystUnc.ratio_up
            • SystUnc.up
            • SystUnc.yaxis_ratio_limit
        • 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
        • pocket_coffea.utils.skim module
          • copy_file()
          • is_rootcompat()
          • save_skimed_dataset_definition()
          • uproot_writeable()
        • pocket_coffea.utils.utils module
          • adapt_chunksize()
          • add_to_path()
          • dump_ak_array()
          • load_config()
          • path_import()
        • Module contents
      • pocket_coffea.workflows package
        • Submodules
        • pocket_coffea.workflows.base module
          • BaseProcessorABC
            • BaseProcessorABC.apply_object_preselection()
            • BaseProcessorABC.apply_preselections()
            • BaseProcessorABC.available_variations()
            • 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_extra_shape_variations()
            • BaseProcessorABC.get_shape_variations()
            • BaseProcessorABC.load_metadata()
            • BaseProcessorABC.load_metadata_extra()
            • BaseProcessorABC.nevents
            • BaseProcessorABC.postprocess()
            • BaseProcessorABC.process()
            • 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
        • pocket_coffea.workflows.sf_lepton_variations module
        • pocket_coffea.workflows.tthbb_base_processor module
        • Module contents
    • Module contents