analyzer.core.analysis_modules¶

Attributes¶

`logger`
`MultiColumns`

Classes¶

`MetadataExpr`	Base class for simple predicates of metadata.
`IsYear`	Base class for simple predicates of metadata.
`IsSampleType`	Base class for simple predicates of metadata.
`IsRun`	Base class for simple predicates of metadata.
`MetadataAnd`	Base class for simple predicates of metadata.
`MetadataOr`	Base class for simple predicates of metadata.
`MetadataNot`	Base class for simple predicates of metadata.
`BaseAnalyzerModule`	Base class for a unit of analysis.
`AnalyzerModule`	Abstract base class for all analyzer modules.
`EventSourceModule`	Abstract base class for event source modules.
`PureResultModule`	Abstract base class for pure result modules.
`ModuleAddition`

Functions¶

`moduleExcludeFilter`(attribute, value)
`defaultCols`(columns)
`defaultParameterSpec`(params)
`register_module`(input_columns, output_columns[, ...])	Attempt to make decorator for constructing modules.
`configureConverter`(conv)

Module Contents¶

analyzer.core.analysis_modules.logger[source]¶

class analyzer.core.analysis_modules.MetadataExpr[source]¶

Bases: abc.ABC

Base class for simple predicates of metadata.

abstractmethod evaluate(metadata) → bool[source]¶

class analyzer.core.analysis_modules.IsYear[source]¶

Bases: MetadataExpr

Base class for simple predicates of metadata.

year: str[source]¶

evaluate(metadata)[source]¶

class analyzer.core.analysis_modules.IsSampleType[source]¶

Bases: MetadataExpr

Base class for simple predicates of metadata.

sample_type: analyzer.core.datasets.SampleType[source]¶

evaluate(metadata)[source]¶

class analyzer.core.analysis_modules.IsRun[source]¶

Bases: MetadataExpr

Base class for simple predicates of metadata.

run: int[source]¶

evaluate(metadata)[source]¶

class analyzer.core.analysis_modules.MetadataAnd[source]¶

Bases: MetadataExpr

Base class for simple predicates of metadata.

require_all: list[MetadataExpr][source]¶

evaluate(metadata)[source]¶

class analyzer.core.analysis_modules.MetadataOr[source]¶

Bases: MetadataExpr

Base class for simple predicates of metadata.

require_any: list[MetadataExpr][source]¶

evaluate(metadata)[source]¶

class analyzer.core.analysis_modules.MetadataNot[source]¶

Bases: MetadataExpr

Base class for simple predicates of metadata.

require_not: MetadataExpr[source]¶

evaluate(metadata)[source]¶

analyzer.core.analysis_modules.MultiColumns[source]¶

analyzer.core.analysis_modules.moduleExcludeFilter(attribute, value)[source]¶

class analyzer.core.analysis_modules.BaseAnalyzerModule[source]¶

Bases: abc.ABC

Base class for a unit of analysis. Provides a cache to avoid duplicate execution when running systematics.

MAX_CACHE_SIZE = 25[source]¶

should_run: MetadataExpr | None[source]¶

abstractmethod inputs(metadata) → analyzer.core.columns.ColumnCollection | list[analyzer.core.columns.Column] | Literal['EVENTS'][source]¶

getParameterSpec(metadata: dict) → analyzer.core.param_specs.ModuleParameterSpec[source]¶

filterParams(metadata, params)[source]¶

preloadForMeta(metadata: dict)[source]¶

getFromCache(key)[source]¶

neededResources(metadata) → list[str][source]¶

adlExport(metadata) → list[analyzer.core.adl.ADLBlock] | None[source]¶

classmethod name()[source]¶

clearCache()[source]¶

lint() → list[analyzer.core.linting.LintMessage][source]¶

selfkey()[source]¶

class analyzer.core.analysis_modules.AnalyzerModule[source]¶

Bases: BaseAnalyzerModule

Abstract base class for all analyzer modules. Subclasses must implement the inputs and run methods.

abstractmethod outputs(metadata) → analyzer.core.columns.ColumnCollection | list[analyzer.core.columns.Column] | Literal['EVENTS'][source]¶

abstractmethod run(columns, params: analyzer.core.param_specs.ModuleParameterValues) → tuple[analyzer.core.columns.TrackedColumns, list[analyzer.core.results.ResultBase | ModuleAddition]][source]¶

getKey(columns, params)[source]¶: Get a unique key associated with a given run. Acts a proxy for caching the output of the run method. Computed by hashing the self key, the parameters, and the key associated with the columns.

getKeyNoParams(columns)[source]¶: Why is ths even a different method.

__call__(columns, params)[source]¶

class analyzer.core.analysis_modules.EventSourceModule[source]¶

Bases: BaseAnalyzerModule

Abstract base class for event source modules. Subclasses must implement the outputs and run methods.

abstractmethod outputs(metadata) → analyzer.core.columns.ColumnCollection | list[analyzer.core.columns.Column][source]¶

abstractmethod run(params: analyzer.core.param_specs.ModuleParameterValues) → analyzer.core.columns.TrackedColumns[source]¶

getKey(params)[source]¶

__call__(params)[source]¶

class analyzer.core.analysis_modules.PureResultModule[source]¶

Bases: BaseAnalyzerModule

Abstract base class for pure result modules. Subclasses must implement the outputs and run methods.

abstractmethod outputs(metadata) → analyzer.core.columns.ColumnCollection | list[analyzer.core.columns.Column][source]¶

abstractmethod run(columns: MultiColumns, params: analyzer.core.param_specs.ModuleParameterValues) → list[analyzer.core.results.ResultBase][source]¶

getKey(columns: MultiColumns, params: analyzer.core.param_specs.ModuleParameterValues)[source]¶

__call__(columns: MultiColumns, params)[source]¶

analyzer.core.analysis_modules.defaultCols(columns)[source]¶

analyzer.core.analysis_modules.defaultParameterSpec(params)[source]¶

analyzer.core.analysis_modules.register_module(input_columns, output_columns, configuration=None, params=None)[source]¶: Attempt to make decorator for constructing modules. Has problems with pickle.

class analyzer.core.analysis_modules.ModuleAddition[source]¶

analyzer_module: AnalyzerModule | PureResultModule[source]¶

run_builder: analyzer.core.run_builders.RunBuilder | type | None[source]¶

this_module_parameters: dict | None = None[source]¶

analyzer.core.analysis_modules.configureConverter(conv)[source]¶