API Reference

• columnflow.calibration
  • Calibrator
    • Calibrator.exposed
    • Calibrator.calibrator()
    • Calibrator.cache_instances
  • calibrator()
  • util
    • ak_random()
    • sum_transverse()
    • propagate_met()
  • cms
    • Summary
• columnflow.categorization
  • Categorizer
    • Categorizer.exposed
    • Categorizer.categorizer()
    • Categorizer.cache_instances
  • categorizer()
• columnflow.histogramming
  • HistProducer
    • HistProducer.create_hist_func
    • HistProducer.fill_hist_func
    • HistProducer.post_process_hist_func
    • HistProducer.post_process_merged_hist_func
    • HistProducer.skip_compatibility_check
    • HistProducer.exposed
    • HistProducer.hist_producer()
    • HistProducer.create_hist()
    • HistProducer.fill_hist()
    • HistProducer.post_process_hist()
    • HistProducer.post_process_merged_hist()
    • HistProducer.create_hist_func
    • HistProducer.fill_hist_func
    • HistProducer.post_process_hist_func
    • HistProducer.post_process_merged_hist_func
    • HistProducer.run_create_hist()
    • HistProducer.cache_instances
    • HistProducer.run_fill_hist()
    • HistProducer.run_post_process_hist()
    • HistProducer.run_post_process_merged_hist()
  • hist_producer()
  • default
    • cf_default
    • all_weights
• columnflow.inference
  • ParameterType
    • ParameterType.is_rate
    • ParameterType.is_shape
  • ParameterTransformation
    • ParameterTransformation.from_shape
    • ParameterTransformation.from_rate
  • ParameterTransformations
    • ParameterTransformations.any_from_shape
    • ParameterTransformations.any_from_rate
  • FlowStrategy
  • InferenceModel
    • InferenceModel.name
    • InferenceModel.config_insts
    • InferenceModel.model
    • InferenceModel.YamlDumper
    • InferenceModel.inference_model()
    • InferenceModel.used_datasets()
    • InferenceModel.model_spec()
    • InferenceModel.category_spec()
    • InferenceModel.process_spec()
    • InferenceModel.parameter_spec()
    • InferenceModel.parameter_group_spec()
    • InferenceModel.category_config_spec()
    • InferenceModel.process_config_spec()
    • InferenceModel.parameter_config_spec()
    • InferenceModel.require_shapes_for_parameter()
    • InferenceModel.to_yaml()
    • InferenceModel.pprint()
    • InferenceModel.get_categories()
    • InferenceModel.get_category()
    • InferenceModel.has_category()
    • InferenceModel.add_category()
    • InferenceModel.remove_category()
    • InferenceModel.get_processes()
    • InferenceModel.get_process()
    • InferenceModel.has_process()
    • InferenceModel.add_process()
    • InferenceModel.remove_process()
    • InferenceModel.get_parameters()
    • InferenceModel.get_parameter()
    • InferenceModel.has_parameter()
    • InferenceModel.add_parameter()
    • InferenceModel.remove_parameter()
    • InferenceModel.get_parameter_groups()
    • InferenceModel.get_parameter_group()
    • InferenceModel.has_parameter_group()
    • InferenceModel.add_parameter_group()
    • InferenceModel.remove_parameter_group()
    • InferenceModel.add_parameter_to_group()
    • InferenceModel.remove_parameter_from_groups()
    • InferenceModel.get_categories_with_process()
    • InferenceModel.get_processes_with_parameter()
    • InferenceModel.get_categories_with_parameter()
    • InferenceModel.get_groups_with_parameter()
    • InferenceModel.cleanup()
    • InferenceModel.remove_empty_categories()
    • InferenceModel.remove_dangling_parameters_from_groups()
    • InferenceModel.remove_empty_parameter_groups()
    • InferenceModel.iter_processes()
    • InferenceModel.iter_parameters()
    • InferenceModel.scale_process()
  • inference_model()
• columnflow.ml
  • MLModel
    • MLModel.single_config
    • MLModel.folds
    • MLModel.store_name
    • MLModel.analysis_inst
    • MLModel.parameters
    • MLModel.used_datasets
    • MLModel.used_columns
    • MLModel.produced_columns
    • MLModel.single_config
    • MLModel.folds
    • MLModel.store_name
    • MLModel.preparation_producer_in_ml_evaluation
    • MLModel.init_attributes
    • MLModel.config_inst
    • MLModel.parameters_repr
    • MLModel.parameter_pairs()
    • MLModel.accepts_scheduler_messages
    • MLModel.get_scheduler_messages()
    • MLModel.used_columns
    • MLModel.produced_columns
    • MLModel.used_datasets
    • MLModel.setup()
    • MLModel.requires()
    • MLModel.training_configs()
    • MLModel.training_calibrators()
    • MLModel.training_selector()
    • MLModel.training_producers()
    • MLModel.evaluation_producers()
    • MLModel.preparation_producer()
    • MLModel.sandbox()
    • MLModel.datasets()
    • MLModel.uses()
    • MLModel.produces()
    • MLModel.output()
    • MLModel.open_model()
    • MLModel.train()
    • MLModel.evaluate()
• columnflow.plotting
  • plot_all
    • draw_stat_error_bands()
    • draw_syst_error_bands()
    • draw_stack()
    • draw_hist()
    • draw_profile()
    • draw_errorbars()
    • plot_all()
  • plot_functions_1d
    • plot_variable_stack()
    • plot_variable_variants()
    • plot_shifted_variable()
    • plot_cutflow()
    • plot_profile()
  • plot_functions_2d
    • plot_2d()
  • plot_util
    • get_cms_label()
    • get_attr_or_aux()
    • round_dynamic()
    • apply_settings()
    • hists_merge_cutflow_steps()
    • apply_process_settings()
    • apply_process_scaling()
    • apply_variable_settings()
    • use_flow_bins()
    • apply_density()
    • remove_residual_axis_single()
    • remove_residual_axis()
    • prepare_style_config()
    • prepare_stack_plot_config()
    • split_ax_kwargs()
    • apply_ax_kwargs()
    • get_position()
    • join_labels()
    • reduce_with()
    • broadcast_1d_to_nd()
    • broadcast_nminus1d_to_nd()
    • get_profile_width()
    • get_profile_variations()
    • blind_sensitive_bins()
    • rebin_equal_width()
    • apply_label_placeholders()
    • remove_label_placeholders()
    • calculate_stat_error()
• columnflow.production
  • Producer
    • Producer.exposed
    • Producer.producer()
    • Producer.cache_instances
  • producer()
  • categories
    • category_ids
  • normalization
    • get_inclusive_dataset()
    • get_stitching_datasets()
    • get_br_from_inclusive_dataset()
    • normalization_weights
    • stitched_normalization_weights
    • stitched_normalization_weights_brs_from_processes
  • processes
    • process_ids
  • util
    • attach_coffea_behavior
    • ak_extract_fields()
    • lv_xyzt()
    • lv_mass()
    • lv_energy()
    • lv_sum()
    • delta_r_match()
    • delta_r_match_multiple()
  • cms
    • btag
    • electron
    • gen_top_decay
    • mc_weight
    • muon
    • pdf
    • pileup
    • scale
    • seeds
• columnflow.reduction
  • Reducer
    • Reducer.exposed
    • Reducer.reducer()
    • Reducer.cache_instances
  • reducer()
  • default
    • cf_default_keep_columns
    • cf_default
• columnflow.selection
  • Selector
    • Selector.exposed
    • Selector.selector()
    • Selector.cache_instances
  • selector()
  • SelectionResult
    • SelectionResult.to_ak()
  • empty
    • empty
  • stats
    • increment_stats
    • increment_event_stats
  • cms
    • json_filter
    • met_filters
• columnflow.tasks
  • Introduction to Tasks
  • calibration
  • cutflow
  • external
    • GetDatasetLFNs
    • GetDatasetLFNsWrapper
    • ExternalFile
    • BundleExternalFiles
  • histograms
  • ml
  • plotting
  • production
  • reduction
  • selection
  • union
  • yields
  • cms
    • base
    • external
    • inference
  • framework
    • base
    • decorators
    • mixins
    • parameters
    • plotting
    • remote
• columnflow.columnar_util
  • EMPTY_INT
  • EMPTY_FLOAT
  • mandatory_coffea_columns
  • default_coffea_collections
  • ItemEval
  • eval_item
  • Route
    • Route.fields
    • Route.column
    • Route.nano_column
    • Route.string_column
    • Route.string_nano_column
    • Route.DOT_SEP
    • Route.NANO_SEP
    • Route.slice_to_str()
    • Route.join()
    • Route.join_nano()
    • Route.split()
    • Route.split_nano()
    • Route.fields
    • Route.column
    • Route.nano_column
    • Route.string_column
    • Route.string_nano_column
    • Route.add()
    • Route.pop()
    • Route.reverse()
    • Route.copy()
    • Route.apply()
  • ColumnCollection
    • ColumnCollection.MANDATORY_COFFEA
    • ColumnCollection.ALL_FROM_CALIBRATOR
    • ColumnCollection.ALL_FROM_CALIBRATORS
    • ColumnCollection.ALL_FROM_SELECTOR
    • ColumnCollection.ALL_FROM_REDUCER
    • ColumnCollection.ALL_FROM_PRODUCER
    • ColumnCollection.ALL_FROM_PRODUCERS
    • ColumnCollection.ALL_FROM_ML_EVALUATION
  • get_ak_routes()
  • has_ak_column()
  • set_ak_column()
  • remove_ak_column()
  • add_ak_alias()
  • add_ak_aliases()
  • update_ak_array()
  • flatten_ak_array()
  • sort_ak_fields()
  • sorted_ak_to_parquet()
  • sorted_ak_to_root()
  • sorted_indices_from_mask()
  • mask_from_indices()
  • full_like()
  • fill_at()
  • attach_behavior()
  • attach_coffea_behavior()
  • layout_ak_array()
  • flat_np_view()
  • ak_copy()
  • RouteFilter
    • RouteFilter.keep
    • RouteFilter.remove
  • ArrayFunction
    • ArrayFunction.uses
    • ArrayFunction.produces
    • ArrayFunction.AUTO
    • ArrayFunction.USES
    • ArrayFunction.PRODUCES
    • ArrayFunction.check_used_columns
    • ArrayFunction.check_produced_columns
    • ArrayFunction.uses_instances
    • ArrayFunction.produces_instances
    • ArrayFunction.deps
    • ArrayFunction.deps_kwargs
    • ArrayFunction.call_func
    • ArrayFunction.uses
    • ArrayFunction.produces
    • ArrayFunction.IOFlag
    • ArrayFunction.IOFlagged
    • ArrayFunction.DeferredColumn
    • ArrayFunction.AUTO
    • ArrayFunction.USES
    • ArrayFunction.PRODUCES
    • ArrayFunction.call()
    • ArrayFunction.init()
    • ArrayFunction.pre_init()
    • ArrayFunction.skip()
    • ArrayFunction.check_used_columns
    • ArrayFunction.check_produced_columns
    • ArrayFunction.log_runtime
    • ArrayFunction.call_func
    • ArrayFunction.pre_init_func
    • ArrayFunction.init_func
    • ArrayFunction.skip_func
    • ArrayFunction.has_dep()
    • ArrayFunction.walk_deps()
    • ArrayFunction.deferred_init()
    • ArrayFunction.create_dependencies()
    • ArrayFunction.instantiate_dependency()
    • ArrayFunction.get_dependencies()
    • ArrayFunction.used_columns
    • ArrayFunction.produced_columns
  • deferred_column()
  • tagged_column()
  • optional_column()
  • skip_column()
  • TaskArrayFunctionMeta
  • TaskArrayFunction
    • TaskArrayFunction.shifts
    • TaskArrayFunction.shifts_instances
    • TaskArrayFunction.all_shifts
    • TaskArrayFunction.setup_func
    • TaskArrayFunction.teardown_func
    • TaskArrayFunction.sandbox
    • TaskArrayFunction.call_force
    • TaskArrayFunction.pick_cached_result
    • TaskArrayFunction.shifts
    • TaskArrayFunction.post_init()
    • TaskArrayFunction.requires()
    • TaskArrayFunction.setup()
    • TaskArrayFunction.teardown()
    • TaskArrayFunction.post_init_func
    • TaskArrayFunction.requires_func
    • TaskArrayFunction.setup_func
    • TaskArrayFunction.teardown_func
    • TaskArrayFunction.sandbox
    • TaskArrayFunction.call_force
    • TaskArrayFunction.max_chunk_size
    • TaskArrayFunction.pick_cached_result()
    • TaskArrayFunction.instantiate_dependency()
    • TaskArrayFunction.all_shifts
    • TaskArrayFunction.run_post_init()
    • TaskArrayFunction.run_requires()
    • TaskArrayFunction.run_setup()
    • TaskArrayFunction.run_teardown()
    • TaskArrayFunction.get_sandbox()
    • TaskArrayFunction.get_min_chunk_size()
    • TaskArrayFunction.cache_instances
  • NoThreadPool
    • NoThreadPool.SyncResult
    • NoThreadPool.close()
    • NoThreadPool.join()
    • NoThreadPool.terminate()
    • NoThreadPool.apply_async()
  • TaskQueue
    • TaskQueue.Task
    • TaskQueue.add()
    • TaskQueue.get_next()
  • DaskArrayReader
    • DaskArrayReader.MaterializationStrategy
    • DaskArrayReader.closed
    • DaskArrayReader.close()
    • DaskArrayReader.materialize()
  • ChunkedIOHandler
    • ChunkedIOHandler.SourceHandler
    • ChunkedIOHandler.ChunkPosition
    • ChunkedIOHandler.ReadResult
    • ChunkedIOHandler.default_chunk_size
    • ChunkedIOHandler.default_pool_size
    • ChunkedIOHandler.create_chunk_position()
    • ChunkedIOHandler.get_source_handler()
    • ChunkedIOHandler.open_uproot_root()
    • ChunkedIOHandler.close_uproot_root()
    • ChunkedIOHandler.read_uproot_root()
    • ChunkedIOHandler.open_coffea_root()
    • ChunkedIOHandler.close_coffea_root()
    • ChunkedIOHandler.read_coffea_root()
    • ChunkedIOHandler.open_coffea_parquet()
    • ChunkedIOHandler.close_coffea_parquet()
    • ChunkedIOHandler.read_coffea_parquet()
    • ChunkedIOHandler.open_awkward_parquet()
    • ChunkedIOHandler.close_awkward_parquet()
    • ChunkedIOHandler.read_awkward_parquet()
    • ChunkedIOHandler.n_chunks
    • ChunkedIOHandler.closed
    • ChunkedIOHandler.open()
    • ChunkedIOHandler.close()
    • ChunkedIOHandler.queue()
• columnflow.config_util
  • get_events_from_categories()
  • get_category_name_columns()
  • get_root_processes_from_campaign()
  • get_datasets_from_process()
  • add_shift_aliases()
  • get_shift_from_configs()
  • get_shifts_from_sources()
  • group_shifts()
  • expand_shift_sources()
  • create_category_id()
  • add_category()
  • CategoryGroup
    • CategoryGroup.categories
    • CategoryGroup.is_complete
    • CategoryGroup.has_overlap
    • CategoryGroup.warn
    • CategoryGroup.is_partition
  • create_category_combinations()
  • verify_config_processes()
• columnflow.util
  • UNSET
  • primes
  • maybe_import()
  • import_plt()
  • import_ROOT()
  • import_file()
  • ipython_shell()
  • prettify()
  • get_docs_url()
  • get_github_url()
  • get_release_url()
  • get_code_url()
  • create_random_name()
  • expand_path()
  • real_path()
  • ensure_dir()
  • wget()
  • call_thread()
  • call_proc()
  • ensure_proxy()
  • dev_sandbox()
  • freeze()
  • memoize()
  • safe_div()
  • try_float()
  • try_complex()
  • try_int()
  • maybe_int()
  • is_pattern()
  • is_regex()
  • pattern_matcher()
  • dict_add_strict()
  • get_source_code()
  • DotDict
    • DotDict.__getattr__()
    • DotDict.__setattr__()
    • DotDict.copy()
    • DotDict.wrap()
    • DotDict.__annotations__
    • DotDict.__module__
  • MockModule
    • MockModule._name
    • MockModule.__init__()
    • MockModule.__getattr__()
    • MockModule.__repr__()
    • MockModule.__call__()
    • MockModule.__nonzero__()
    • MockModule.__bool__()
    • MockModule.__or__()
    • MockModule.__annotations__
    • MockModule.__dict__
    • MockModule.__module__
    • MockModule.__weakref__
  • FunctionArgs
    • FunctionArgs.__init__()
    • FunctionArgs.__call__()
    • FunctionArgs.__annotations__
    • FunctionArgs.__dict__
    • FunctionArgs.__module__
    • FunctionArgs.__weakref__
  • ClassPropertyDescriptor
    • ClassPropertyDescriptor.__init__()
    • ClassPropertyDescriptor.__get__()
    • ClassPropertyDescriptor.__set__()
    • ClassPropertyDescriptor.__annotations__
    • ClassPropertyDescriptor.__dict__
    • ClassPropertyDescriptor.__module__
    • ClassPropertyDescriptor.__weakref__
  • classproperty()
  • DerivableMeta
    • DerivableMeta.__new__()
    • DerivableMeta.has_cls()
    • DerivableMeta.get_cls()
    • DerivableMeta.derive()
    • DerivableMeta.derived_by()
    • DerivableMeta.__annotations__
    • DerivableMeta.__module__
  • Derivable
    • Derivable.cls_name
    • Derivable.cls_name
    • Derivable.__abstractmethods__
    • Derivable.__annotations__
    • Derivable.__dict__
    • Derivable.__module__
    • Derivable.__weakref__
  • KeyValueMessage
    • KeyValueMessage.message_cre
    • KeyValueMessage.from_message()
    • KeyValueMessage.__init__()
    • KeyValueMessage.__str__()
    • KeyValueMessage.__annotations__
    • KeyValueMessage.__module__
  • load_correction_set()
• columnflow.types
  • KeysView
  • ValuesView
  • ModuleType
  • GeneratorType
  • GenericAlias
  • TypeVar
  • TextIO
    • TextIO.buffer
    • TextIO.encoding
    • TextIO.errors
    • TextIO.line_buffering
    • TextIO.newlines
  • Annotated
  • AnnotatedType
  • T