Systematic

class coffea.nanoevents.methods.base.Systematic

Bases: object

A base mixin class to describe and build variations on a feature of an nanoevents object.

Attributes Summary

systematics

Return the list of all systematics attached to this object.

Methods Summary

add_kind(kind)	Register a type of systematic variation, it must fullfil the base class interface.
add_systematic(name, kind, what, ...)	name: str, name of the systematic variation / uncertainty source kind: str, the name of the kind of systematic variation what: Union[str, List[str], Tuple[str]], name what gets varied, this could be a list or tuple of column names varying_function: Union[function, bound method], a function that describes how 'what' is varied, it must close over all non-event-data arguments.
describe_variations()	returns a list of variation names
explodes_how()	This describes how a systematic uncertainty needs to be evaluated in the context of other systematic uncertainties.

Attributes Documentation

systematics

Return the list of all systematics attached to this object.

Methods Documentation

classmethod add_kind(kind: str)

Register a type of systematic variation, it must fullfil the base class interface.

add_systematic(name: str, kind: str, what: str | List[str] | Tuple[str], varying_function: Callable)

name: str, name of the systematic variation / uncertainty source kind: str, the name of the kind of systematic variation what: Union[str, List[str], Tuple[str]], name what gets varied,

this could be a list or tuple of column names

varying_function: Union[function, bound method], a function that describes how ‘what’ is varied, it must close over all non-event-data arguments.

abstract describe_variations()

returns a list of variation names

abstract explodes_how()

This describes how a systematic uncertainty needs to be evaluated in the context of other systematic uncertainties. i.e. Do you iterate over this keeping all others fixed or do you need to have correlations with other (subsets of) systematics.