selection

Tasks related to selecting events and performing post-selection bookkeeping.

Classes:

SelectEvents(*args, **kwargs)
SelectEventsWrapper(*args, **kwargs)
MergeSelectionStats(*args, **kwargs)
MergeSelectionStatsWrapper(*args, **kwargs)
MergeSelectionMasks(*args, **kwargs)
MergeSelectionMasksWrapper(*args, **kwargs)

class SelectEvents(*args, **kwargs)

Bases: SelectorMixin, CalibratorsMixin, ChunkedIOMixin, DatasetTask, LocalWorkflow, RemoteWorkflow

Attributes:

sandbox
reqs
register_selector_shifts
missing_column_alias_strategy
check_finite_output
check_overlapping_inputs
exclude_index
exclude_params_branch
exclude_params_htcondor_workflow
exclude_params_index
exclude_params_remote_workflow
exclude_params_repr
exclude_params_repr_empty
exclude_params_req
exclude_params_req_get
exclude_params_req_set
exclude_params_sandbox
exclude_params_slurm_workflow
exclude_params_workflow

Methods:

workflow_requires()	Hook to add workflow requirements.
requires()	The Tasks that this Task depends on.
output()	The output that this Task produces.
run()	The task run method, to be overridden in a subclass.

sandbox = 'bash::$CF_BASE/sandboxes/venv_columnar.sh'

reqs = {'BuildBashSandbox': <class 'columnflow.tasks.framework.remote.BuildBashSandbox'>, 'BundleBashSandbox': <class 'columnflow.tasks.framework.remote.BundleBashSandbox'>, 'BundleCMSSWSandbox': <class 'columnflow.tasks.framework.remote.BundleCMSSWSandbox'>, 'BundleRepo': <class 'columnflow.tasks.framework.remote.BundleRepo'>, 'BundleSoftware': <class 'columnflow.tasks.framework.remote.BundleSoftware'>, 'CalibrateEvents': <class 'columnflow.tasks.calibration.CalibrateEvents'>, 'GetDatasetLFNs': <class 'columnflow.tasks.external.GetDatasetLFNs'>}

register_selector_shifts = True

missing_column_alias_strategy = 'original'

workflow_requires()

Hook to add workflow requirements. This method is expected to return a dictionary. When this method is called from a branch task, an exception is raised.

requires()

The Tasks that this Task depends on.

A Task will only run if all of the Tasks that it requires are completed. If your Task does not require any other Tasks, then you don’t need to override this method. Otherwise, a subclass can override this method to return a single Task, a list of Task instances, or a dict whose values are Task instances.

See Task.requires

output()

The output that this Task produces.

The output of the Task determines if the Task needs to be run–the task is considered finished iff the outputs all exist. Subclasses should override this method to return a single Target or a list of Target instances.

Implementation note

If running multiple workers, the output must be a resource that is accessible by all workers, such as a DFS or database. Otherwise, workers might compute the same output since they don’t see the work done by other workers.

See Task.output

run()

The task run method, to be overridden in a subclass.

See Task.run

check_finite_output = <luigi.parameter.BoolParameter object>

check_overlapping_inputs = <luigi.parameter.BoolParameter object>

exclude_index = False

exclude_params_branch = {'acceptance', 'branches', 'cancel_jobs', 'cleanup_jobs', 'htcondor_cpus', 'htcondor_flavor', 'htcondor_gpus', 'htcondor_logs', 'htcondor_memory', 'htcondor_pool', 'htcondor_scheduler', 'htcondor_share_software', 'ignore_submission', 'job_workers', 'max_runtime', 'no_poll', 'parallel_jobs', 'pilot', 'poll_fails', 'poll_interval', 'retries', 'shuffle_jobs', 'slurm_flavor', 'slurm_partition', 'submission_threads', 'tasks_per_job', 'tolerance', 'transfer_logs', 'walltime'}

exclude_params_htcondor_workflow = {}

exclude_params_index = {'effective_workflow', 'local_shift'}

exclude_params_remote_workflow = {'local_shift'}

exclude_params_repr = {'cancel_jobs', 'cleanup_jobs', 'workflow'}

exclude_params_repr_empty = {}

exclude_params_req = {'check_finite_output', 'check_overlapping_inputs', 'effective_workflow', 'local_shift'}

exclude_params_req_get = {}

exclude_params_req_set = {}

exclude_params_sandbox = {'local_shift', 'log_file', 'sandbox'}

exclude_params_slurm_workflow = {}

exclude_params_workflow = {'branch'}

class SelectEventsWrapper(*args, **kwargs)

Bases: AnalysisTask, WrapperTask

Attributes:

configs
datasets
exclude_index
exclude_params_index
exclude_params_repr
exclude_params_repr_empty
exclude_params_req
exclude_params_req_get
exclude_params_req_set
exclude_params_sandbox
shifts
skip_configs
skip_datasets
skip_shifts

Methods:

requires()	Collect requirements defined by the underlying require_cls of the WrapperTask depending on optional additional parameters.
update_wrapper_params(params)

configs = <law.parameter.CSVParameter object>

datasets = <law.parameter.CSVParameter object>

exclude_index = False

exclude_params_index = {}

exclude_params_repr = {}

exclude_params_repr_empty = {}

exclude_params_req = {}

exclude_params_req_get = {}

exclude_params_req_set = {}

exclude_params_sandbox = {'log_file', 'sandbox'}

requires() → Requirements

Collect requirements defined by the underlying require_cls of the WrapperTask depending on optional additional parameters.

Return type:

Requirements

Returns:

Requirements for the WrapperTask instance.

shifts = <law.parameter.CSVParameter object>

skip_configs = <law.parameter.CSVParameter object>

skip_datasets = <law.parameter.CSVParameter object>

skip_shifts = <law.parameter.CSVParameter object>

update_wrapper_params(params)

class MergeSelectionStats(*args, **kwargs)

Bases: SelectorMixin, CalibratorsMixin, DatasetTask, ForestMerge

Attributes:

merge_factor
exclude_params_req_get
reqs
exclude_index
exclude_params_branch
exclude_params_forest_merge
exclude_params_index
exclude_params_remote_workflow
exclude_params_repr
exclude_params_repr_empty
exclude_params_req
exclude_params_req_set
exclude_params_sandbox
exclude_params_workflow

Methods:

create_branch_map()	Define the branch map for when this task is used as a workflow.
merge_workflow_requires()
merge_requires(start_branch, end_branch)
merge_output()
trace_merge_inputs(inputs)
run()	The task run method, to be overridden in a subclass.
merge(inputs, output)
merge_counts(dst, src)	Adds counts (integers or floats) in a src dictionary recursively into a dst dictionary.

merge_factor = 20

exclude_params_req_get = {'workflow'}

reqs = {'SelectEvents': <class 'columnflow.tasks.selection.SelectEvents'>}

create_branch_map()

Define the branch map for when this task is used as a workflow. By default, use the merging information provided by file_merging_factor to return a dictionary which maps branches to one or more input file indices. E.g. 1 -> [3, 4, 5] would mean that branch 1 is simultaneously handling input file indices 3, 4 and 5.

merge_workflow_requires()

merge_requires(start_branch, end_branch)

merge_output()

trace_merge_inputs(inputs)

run()

The task run method, to be overridden in a subclass.

See Task.run

merge(inputs, output)

classmethod merge_counts(dst, src)

Adds counts (integers or floats) in a src dictionary recursively into a dst dictionary. dst is updated in-place and also returned.

Return type:

dict

exclude_index = False

exclude_params_branch = {'acceptance', 'branches', 'pilot', 'tolerance'}

exclude_params_forest_merge = {'branch', 'branches', 'keep_nodes', 'tree_depth', 'tree_index'}

exclude_params_index = {'effective_workflow', 'local_shift'}

exclude_params_remote_workflow = {'local_shift'}

exclude_params_repr = {'workflow'}

exclude_params_repr_empty = {}

exclude_params_req = {'effective_workflow', 'local_shift'}

exclude_params_req_set = {}

exclude_params_sandbox = {'local_shift', 'log_file', 'sandbox'}

exclude_params_workflow = {'branch'}

class MergeSelectionStatsWrapper(*args, **kwargs)

Bases: AnalysisTask, WrapperTask

Attributes:

configs
datasets
exclude_index
exclude_params_index
exclude_params_repr
exclude_params_repr_empty
exclude_params_req
exclude_params_req_get
exclude_params_req_set
exclude_params_sandbox
shifts
skip_configs
skip_datasets
skip_shifts

Methods:

requires()	Collect requirements defined by the underlying require_cls of the WrapperTask depending on optional additional parameters.
update_wrapper_params(params)

configs = <law.parameter.CSVParameter object>

datasets = <law.parameter.CSVParameter object>

exclude_index = False

exclude_params_index = {}

exclude_params_repr = {}

exclude_params_repr_empty = {}

exclude_params_req = {}

exclude_params_req_get = {}

exclude_params_req_set = {}

exclude_params_sandbox = {'log_file', 'sandbox'}

requires() → Requirements

Collect requirements defined by the underlying require_cls of the WrapperTask depending on optional additional parameters.

Return type:

Requirements

Returns:

Requirements for the WrapperTask instance.

shifts = <law.parameter.CSVParameter object>

skip_configs = <law.parameter.CSVParameter object>

skip_datasets = <law.parameter.CSVParameter object>

skip_shifts = <law.parameter.CSVParameter object>

update_wrapper_params(params)

class MergeSelectionMasks(*args, **kwargs)

Bases: SelectorMixin, CalibratorsMixin, DatasetTask, ForestMerge, RemoteWorkflow

Attributes:

sandbox
merge_factor
reqs
exclude_index
exclude_params_branch
exclude_params_forest_merge
exclude_params_htcondor_workflow
exclude_params_index
exclude_params_remote_workflow
exclude_params_repr
exclude_params_repr_empty
exclude_params_req
exclude_params_req_get
exclude_params_req_set
exclude_params_sandbox
exclude_params_slurm_workflow
exclude_params_workflow

Methods:

create_branch_map()	Define the branch map for when this task is used as a workflow.
merge_workflow_requires()
merge_requires(start_branch, end_branch)
trace_merge_workflow_inputs(inputs)
trace_merge_inputs(inputs)
merge_output()
merge(inputs, output)
zip_results_and_columns(inputs, tmp_dir)

sandbox = 'bash::$CF_BASE/sandboxes/venv_columnar.sh'

merge_factor = 8

reqs = {'BuildBashSandbox': <class 'columnflow.tasks.framework.remote.BuildBashSandbox'>, 'BundleBashSandbox': <class 'columnflow.tasks.framework.remote.BundleBashSandbox'>, 'BundleCMSSWSandbox': <class 'columnflow.tasks.framework.remote.BundleCMSSWSandbox'>, 'BundleRepo': <class 'columnflow.tasks.framework.remote.BundleRepo'>, 'BundleSoftware': <class 'columnflow.tasks.framework.remote.BundleSoftware'>, 'SelectEvents': <class 'columnflow.tasks.selection.SelectEvents'>}

create_branch_map()

Define the branch map for when this task is used as a workflow. By default, use the merging information provided by file_merging_factor to return a dictionary which maps branches to one or more input file indices. E.g. 1 -> [3, 4, 5] would mean that branch 1 is simultaneously handling input file indices 3, 4 and 5.

merge_workflow_requires()

merge_requires(start_branch, end_branch)

trace_merge_workflow_inputs(inputs)

trace_merge_inputs(inputs)

merge_output()

merge(inputs, output)

zip_results_and_columns(inputs, tmp_dir)

exclude_index = False

exclude_params_branch = {'acceptance', 'branches', 'cancel_jobs', 'cleanup_jobs', 'htcondor_cpus', 'htcondor_flavor', 'htcondor_gpus', 'htcondor_logs', 'htcondor_memory', 'htcondor_pool', 'htcondor_scheduler', 'htcondor_share_software', 'ignore_submission', 'job_workers', 'max_runtime', 'no_poll', 'parallel_jobs', 'pilot', 'poll_fails', 'poll_interval', 'retries', 'shuffle_jobs', 'slurm_flavor', 'slurm_partition', 'submission_threads', 'tasks_per_job', 'tolerance', 'transfer_logs', 'walltime'}

exclude_params_forest_merge = {'branch', 'branches', 'keep_nodes', 'tree_depth', 'tree_index'}

exclude_params_htcondor_workflow = {}

exclude_params_index = {'effective_workflow', 'local_shift'}

exclude_params_remote_workflow = {'local_shift'}

exclude_params_repr = {'cancel_jobs', 'cleanup_jobs', 'workflow'}

exclude_params_repr_empty = {}

exclude_params_req = {'effective_workflow', 'local_shift'}

exclude_params_req_get = {}

exclude_params_req_set = {}

exclude_params_sandbox = {'local_shift', 'log_file', 'sandbox'}

exclude_params_slurm_workflow = {}

exclude_params_workflow = {'branch'}

class MergeSelectionMasksWrapper(*args, **kwargs)

Bases: AnalysisTask, WrapperTask

Attributes:

configs
datasets
exclude_index
exclude_params_index
exclude_params_repr
exclude_params_repr_empty
exclude_params_req
exclude_params_req_get
exclude_params_req_set
exclude_params_sandbox
shifts
skip_configs
skip_datasets
skip_shifts

Methods:

requires()	Collect requirements defined by the underlying require_cls of the WrapperTask depending on optional additional parameters.
update_wrapper_params(params)

configs = <law.parameter.CSVParameter object>

datasets = <law.parameter.CSVParameter object>

exclude_index = False

exclude_params_index = {}

exclude_params_repr = {}

exclude_params_repr_empty = {}

exclude_params_req = {}

exclude_params_req_get = {}

exclude_params_req_set = {}

exclude_params_sandbox = {'log_file', 'sandbox'}

requires() → Requirements

Collect requirements defined by the underlying require_cls of the WrapperTask depending on optional additional parameters.

Return type:

Requirements

Returns:

Requirements for the WrapperTask instance.

shifts = <law.parameter.CSVParameter object>

skip_configs = <law.parameter.CSVParameter object>

skip_datasets = <law.parameter.CSVParameter object>

skip_shifts = <law.parameter.CSVParameter object>

update_wrapper_params(params)