SummarizeTriggerVariables Class Reference

Inheritance diagram for SummarizeTriggerVariables:

Collaboration diagram for SummarizeTriggerVariables:

Public Member Functions
def	__init__ (self, root_file_name="save_vars.pkl", store_object_name="SoftwareTriggerVariables")
def	peel (self, variables)
def	barn (self)
def	refine (self, crops)
def	id (self)
def	initialize (self)
def	event (self)
def	terminate (self)
def	gather (self)
def	prepare (self)
def	pick (self, crop)

Static Public Member Functions
def	create_crop_part_collection ()
def	iter_store_obj (store_obj)

Public Attributes
	crops
	The gathered crops until now.
	foreach
	Name of the StoreArray or iterable StoreObjPtr that contains the objects to be harvested.
	output_file_name
	Name of the ROOT output file to be generated.
	title
	Name of this harvest. More...
	contact
	Contact email address to be displayed on the validation page.
	expert_level
	Integer expert level that controlls to detail of plots to be generated.
	refiners
	A list of additional refiner instances to be executed on top of the refiner methods that are members of this class.
	show_results
	Switch to show the result ROOT file in a TBrowser on terminate.
	stash
	stash of the harvested crops (start with those in the barn)
	raw_crops
	the dictionaries from peel as a numpy.array of doubles

Static Public Attributes
int	default_expert_level = 1
	The default value of expert_level if not specified explicitly by the caller.

Detailed Description

Read in the trigger variables stored in the data store and write them out into a ROOT file after all events have
passed.

Definition at line 93 of file variable_modules.py.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
			root_file_name = "save_vars.pkl",
			store_object_name = "SoftwareTriggerVariables"
	)

Create a new module to get the stored trigger variables from the data store and save them to a root file.
:param root_file_name: The file name where to store the variables.
:param store_object_name: The store object name where the trigger variables an be found in the data store.

Definition at line 99 of file variable_modules.py.

Member Function Documentation

barn()

def barn (   self )

inherited

Coroutine that receives the dictionaries of names and values from peel and store them into a pandas df.

Reimplemented from HarvestingModule.

Definition at line 28 of file variable_modules.py.

create_crop_part_collection()

def create_crop_part_collection ( )

staticinherited

Create the storing objects for the crop values

Currently a numpy.array of doubles is used to store all values in memory.

Definition at line 281 of file harvesting.py.

event()

def event (   self )

inherited

Event method of the module

* Does invoke the prepare method before the iteration starts.
* In each event fetch the StoreArray / iterable StoreObjPtr,
* Iterate through all instances
* Feed each instance to the pick method to deside it the instance is relevant
* Forward it to the peel method that should generated a dictionary of values
* Store each dictionary of values

Definition at line 241 of file harvesting.py.

gather()

def gather (   self )

inherited

Iterator that yield the instances form the StoreArray / iterable StoreObj.

Yields
------
Object instances from the StoreArray, iterable StoreObj or the StoreObj itself
in case it is not iterable.

Definition at line 334 of file harvesting.py.

id()

def id (   self )

inherited

Working around that name() is a method.

Exposing the name as a property using a different name

Definition at line 226 of file harvesting.py.

initialize()

def initialize (   self )

inherited

Initialisation method of the module.

Prepares the receiver stash of objects to be harvestered.

Definition at line 233 of file harvesting.py.

iter_store_obj()

def iter_store_obj (   store_obj )

staticinherited

Obtain a iterator from a StoreObj

Repeatly calls iter(store_obj) or store_obj.__iter__()
until the final iterator returns itself

Returns
-------
iterator of the StoreObj

Definition at line 452 of file harvesting.py.

peel()

def peel	(		self,
			variables
	)

For each collection of variables ( = event), get the list of all variables.
Write them back into the internal storage ( = pandas.DataFrame) of all events.

Reimplemented from HarvestingModule.

Definition at line 107 of file variable_modules.py.

pick()

def pick (   self,   crop  )

inherited

Indicate whether the instance should be forwarded to the peeling

Returns
-------
bool : Indicator if the instance is valueable in the current harverst.

Reimplemented in VxdCdcMergerHarvester, MCParticleHarvester, and VxdCdcMergerHarvesterMCSide.

Definition at line 398 of file harvesting.py.

prepare()

def prepare (   self )

inherited

Default implementation of prepare.

Can be overridden by subclasses.

Reimplemented in FitValidationModule, and SegmentFakeRatesModule.

Definition at line 373 of file harvesting.py.

refine()

def refine (   self,   crops  )

inherited

Receive the gathered crops and saves them into a ROOT file.

Reimplemented from HarvestingModule.

Definition at line 60 of file variable_modules.py.

terminate()

def terminate (   self )

inherited

Termination method of the module.

Finalize the collected crops.
Start the refinement.

Definition at line 265 of file harvesting.py.

Member Data Documentation

title

title

inherited

Name of this harvest.

Title particle of this harvest

Definition at line 210 of file harvesting.py.

---

The documentation for this class was generated from the following file:

• hlt/softwaretrigger/scripts/softwaretrigger/variable_modules.py