afw.objects.AnalysisConfig#

class afw.objects.AnalysisConfig(name: str)[source]#

Bases: ABC

An object representing a full analysis

__init__(name: str)[source]#

Parameters:: name (str) – The name of the analysis. This should be a valid folder name

Methods

`__init__`(name)
`augment_events`(events)	Augment a set of events for use in plotting.
`define_objects`(events)	Define objects, such as leptons.
`get_dataset`(xcache_host)	Gets the fully-formatted dataset for the current analysis
`get_things_to_plot`()	Create a list of things to plot
`minify`(events)	Minify a set of events to be saved locally, for use in skimming
`preselect_events`(events)	Run preselection of events
`select_events`(events)	Run selection of events

abstractmethod augment_events(events: Array) → dict[Array][source]#

Augment a set of events for use in plotting. This should be used to eliminate dual-computation of properties for separate plots

Parameters:: events (ak.Array) – An awkward array of events post event selection
Returns:: A set of keyword arguments that will get passed to the ThingToPlot.fill_histogram method
Return type:: dict[ak.Array]

abstractmethod define_objects(events: Array) → Array[source]#

Define objects, such as leptons. This method operates in-place

Parameters:: events (ak.Array) – An awkward array of events, as read from root files
Returns:: The new events
Return type:: ak.Array

abstractmethod get_dataset(xcache_host: str) → dict[source]#

Gets the fully-formatted dataset for the current analysis

Parameters:: xcache_host (str) – The address of the local xcache redirector, if present
Returns:: A fully rendered dataset with a list of files and metadata
Return type:: dict

abstractmethod get_things_to_plot() → list[ThingToPlot][source]#

Create a list of things to plot

abstractmethod minify(events: Array) → Array[source]#

Minify a set of events to be saved locally, for use in skimming

Parameters:: events (ak.Array) – An awkward array of events, as read from root files
Returns:: The new events
Return type:: ak.Array

abstractmethod preselect_events(events: Array) → Array[source]#

Run preselection of events

Parameters:: events (ak.Array) – An awkward array of events post object definition
Returns:: An awkward array of events which pass preselection
Return type:: events (ak.Array)

abstractmethod select_events(events: Array) → list[bool][source]#

Run selection of events

Parameters:: events (ak.Array) – An awkward array of events post object definition and preselection
Returns:: A mask on events representing whether the event passes preselection
Return type:: mask