order.analysis

Definition of the central analysis class.

Class Analysis

class Analysis(*args, **kwargs)[source]

Bases: UniqueObject, AuxDataMixin, TagMixin

The analysis class which represents the central object of a physics analysis. Yet, it is quite lightweight as most information is contained in Config objects in the scope of a Campaign. In addition, it provides some convenience methods to directly access objects in deeper data structures.

Arguments

The configuration objects are initialized with configs. tags are forwarded to the TagMixin, aux to the AuxDataMixin, and name and id to the UniqueObject constructor.

Example

For usage examples, see the examples directory.

Members

configs
type: UniqueObjectIndex
read-only

The UniqueObjectIndex of child configs.

Methods:

get_channels(config)

Returns the UniqueObjectIndex of channels that belong to a config that was previously added.

get_categories(config)

Returns the UniqueObjectIndex of categories that belong to a config that was previously added.

get_datasets(config)

Returns the UniqueObjectIndex of datasets that belong to a config that was previously added.

get_processes(config)

Returns the UniqueObjectIndex of processes that belong to a config that was previously added.

get_variables(config)

Returns the UniqueObjectIndex of variables that belong to a config that was previously added.

get_shifts(config)

Returns the UniqueObjectIndex of shifts that belong to a config that was previously added.

add_config(*args, **kwargs)

Adds a child config to the configs index and returns it.

remove_config(*args, **kwargs)

Removes a child config from the configs index and returns the removed object.

clear_configs()

Removes all child configs from the configs index.

extend_configs(objs)

Adds multiple child configs to the configs index and returns the added objects in a list.

get_config(obj[, default])

Returns a child config given by obj, which might be a name, id, or an instance from the configs index.

has_config(obj)

Checks if the configs index contains an obj which might be a name, id, or an instance.

Attributes:

has_configs

Returns True when this config has child configs, False otherwise.

is_leaf_config

Returns True when this config has no child configs, False otherwise.

get_channels(config)[source]

Returns the UniqueObjectIndex of channels that belong to a config that was previously added. Shorthand for get_config(config).channels.

get_categories(config)[source]

Returns the UniqueObjectIndex of categories that belong to a config that was previously added. Shorthand for get_config(config).categories.

get_datasets(config)[source]

Returns the UniqueObjectIndex of datasets that belong to a config that was previously added. Shorthand for get_config(config).datasets.

get_processes(config)[source]

Returns the UniqueObjectIndex of processes that belong to a config that was previously added. Shorthand for get_config(config).processes.

get_variables(config)[source]

Returns the UniqueObjectIndex of variables that belong to a config that was previously added. Shorthand for get_config(config).variables.

get_shifts(config)[source]

Returns the UniqueObjectIndex of shifts that belong to a config that was previously added. Shorthand for get_config(config).shifts.

add_config(*args, **kwargs)[source]

Adds a child config to the configs index and returns it. See order.unique.UniqueObjectIndex.add() for more info. Also sets the analysis of the added config to this instance.

remove_config(*args, **kwargs)[source]

Removes a child config from the configs index and returns the removed object. See order.unique.UniqueObjectIndex.remove() for more info. Also resets the analysis of the removed config.

clear_configs()

Removes all child configs from the configs index.

extend_configs(objs)

Adds multiple child configs to the configs index and returns the added objects in a list.

get_config(obj, default=no_default)

Returns a child config given by obj, which might be a name, id, or an instance from the configs index. When no config is found, default is returned when set. Otherwise, an error is raised.

has_config(obj)

Checks if the configs index contains an obj which might be a name, id, or an instance.

property has_configs

Returns True when this config has child configs, False otherwise.

property is_leaf_config

Returns True when this config has no child configs, False otherwise.