API Reference Guide

• pocket_coffea
  • pocket_coffea package
    • Subpackages
      • pocket_coffea.lib package
        • 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
          • count_objects_eq()
          • count_objects_gt()
          • count_objects_lt()
          • eq_nObj()
          • eq_nObj_minPt()
          • get_HLTsel()
          • get_JetVetoMap()
          • get_JetVetoMap_Mask()
          • get_nBtag()
          • get_nBtagEq()
          • get_nBtagMin()
          • get_nElectron()
          • get_nMuon()
          • get_nObj_eq()
          • get_nObj_less()
          • get_nObj_min()
          • less_nObj()
          • min_nObj()
          • min_nObj_minPt()
          • nBtagEq()
          • nBtagMin()
          • nElectron()
          • nMuon()
          • passthrough_f()
        • pocket_coffea.lib.deltaR_matching module
          • deltaR_matching_nonunique()
          • 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()
          • get_hist_axis_from_config()
          • mask_and_broadcast_weight()
          • weights_cache()
        • pocket_coffea.lib.jets module
          • CvsLsorted()
          • add_jec_variables()
          • btagging()
          • get_dijet()
          • jet_correction()
          • jet_correction_correctionlib()
          • jet_selection()
          • load_jet_factory()
          • met_correction()
        • pocket_coffea.lib.leptons module
          • get_charged_leptons()
          • get_diboson()
          • get_dilepton()
          • lepton_selection()
        • pocket_coffea.lib.objects module
        • pocket_coffea.lib.parton_provenance module
          • get_partons_provenance_tt5F()
          • get_partons_provenance_ttHbb()
          • get_partons_provenance_ttbb4F()
        • pocket_coffea.lib.reconstruction module
        • pocket_coffea.lib.scale_factors module
          • get_ele_sf()
          • get_mu_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_pileup_reweight()
        • pocket_coffea.lib.triggers module
          • get_trigger_mask()
        • pocket_coffea.lib.weights_manager module
          • WeightCustom
            • WeightCustom.function
            • WeightCustom.name
            • WeightCustom.serialize()
          • WeightsManager
            • WeightsManager.add_weight()
            • WeightsManager.available_variations()
            • WeightsManager.available_weights()
            • WeightsManager.get_weight()
        • 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()
          • jet_hists()
          • lepton_hists()
          • met_hists()
          • muon_hists()
          • parton_hists()
          • sv_hists()
        • pocket_coffea.parameters.jec_config module
        • pocket_coffea.parameters.lumi module
          • femtobarn()
        • Module contents
      • pocket_coffea.utils package
        • Submodules
        • pocket_coffea.utils.build_jets_calibrator module
          • build()
        • pocket_coffea.utils.configurator module
          • Configurator
            • Configurator.filter_dataset()
            • 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.save_config()
          • 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_sf module
          • plot_variation_correctionlib()
        • pocket_coffea.utils.plot_utils module
          • PlotManager
            • PlotManager.make_dirs()
            • PlotManager.plot_datamc()
            • PlotManager.plot_datamc_all()
          • Shape
            • Shape.categorical_axes_data
            • Shape.categorical_axes_mc
            • Shape.define_figure()
            • Shape.dense_axes
            • Shape.dense_dim
            • Shape.exclude_samples()
            • Shape.format_figure()
            • Shape.get_axis_items()
            • Shape.get_datamc_ratio()
            • Shape.group_samples()
            • Shape.load_attributes()
            • Shape.plot_data()
            • Shape.plot_datamc()
            • Shape.plot_datamc_all()
            • Shape.plot_datamc_ratio()
            • Shape.plot_mc()
            • Shape.plot_systematic_uncertainty()
            • 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.down
            • SystUnc.nsyst
            • SystUnc.plot()
            • SystUnc.ratio_down
            • SystUnc.ratio_up
            • SystUnc.up
        • pocket_coffea.utils.rucio module
          • get_dataset_files()
          • get_dataset_files_from_dbs()
          • get_rucio_client()
          • get_xrootd_sites_map()
        • pocket_coffea.utils.run module
        • pocket_coffea.utils.skim module
          • copy_file()
          • is_rootcompat()
          • uproot_writeable()
        • pocket_coffea.utils.utils module
          • add_to_path()
          • dump_ak_array()
          • 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.available_weights()
            • 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.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.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