\(e\)¶

class ElectronCalibrator¶

This is the algorithm class used to calibrate electrons.

In a nutshell, this algorithm performs the following actions:

retrieves an xAOD::ElectronContainer from either TEvent or TStore

makes a shallow copy container and fills it with energy-and-direction calibrated electrons using the EgammaCalibrationAndSmearingTool in Tools Used

saves the shallow copy container to TStore from where it can be retrieved by algorithms downstream via name lookup

Inherits from xAH::Algorithm

Public Functions

ElectronCalibrator()¶

EL::StatusCode setupJob(EL::Job &job)¶

EL::StatusCode fileExecute()¶

EL::StatusCode histInitialize()¶

EL::StatusCode changeInput(bool firstFile)¶

EL::StatusCode initialize()¶

EL::StatusCode execute()¶

EL::StatusCode postExecute()¶

EL::StatusCode finalize()¶

EL::StatusCode histFinalize()¶

StatusCode algInitialize()¶: Run any initializations commmon to all xAH Algorithms (such as registerInstance). Call this inside histInitialize for best results.

StatusCode algFinalize()¶: Run any finalizations common to all xAH Algorithms (such as unregisterInstance). Call this inside histFinalize for best results.

StatusCode parseSystValVector()¶: Parse string of systematic sigma levels in m_systValVectorString into m_systValVector.

Public Members

std::string m_inContainerName = ""¶: The name of the input container for this algorithm to read from TEvent or TStore

std::string m_outContainerName = ""¶

The name of the nominal output container written by the algorithm to TStore

If the algorithm applies systematic variations, for each shallow copy saved to TStore, the systematic name will be appended to this.

bool m_sort = true¶: Sort the processed container elements by transverse momentum.

std::string m_inputAlgoSystNames = ""¶

The name of the vector containing the names of the systematically-varied containers from the upstream algorithm, which will be processed by this algorithm.

This vector is retrieved from the TStore. If left blank, it means there is no upstream algorithm which applies systematics. This is the case when processing straight from the original xAOD or DxAOD.

std::string m_outputAlgoSystNames = "ElectronCalibrator_Syst"¶

The name of the vector containing the names of the systematically-varied containers created by by this algorithm.

If m_systName is empty, the vector will contain only an empty string. When running on systematics, this is the string a downstream algorithm needs to process electrons.

bool m_writeSystToMetadata = false¶: Write systematics names to metadata.

std::string m_esModel = ""¶

std::string m_decorrelationModel = ""¶

bool m_setAFII = false¶: Force AFII flag in calibration, in case metadata is broken.

bool m_useDataDrivenLeakageCorr = false¶

std::string m_name = "UnnamedAlgorithm"¶

All algorithms initialized should have a unique name, to differentiate them at the TObject level.

Note, GetName() returns a char* while this returns a std::string.

bool m_debug = false¶: m_debug is being deprecated

bool m_verbose = false¶: m_verbose is being deprecated

MSG::Level m_msgLevel = MSG::INFO¶: debug level

std::string m_systName = ""¶: If running systematics, the name of the systematic

float m_systVal = 0.0¶

If running systematics, the value to set the systematic to

Note

This will set the systematic to the value \(\pm x\).

std::string m_systValVectorString = ""¶: If running systematics, you can run multiple points and store them in here. A comma separated list of working points should be given to m_systValVectorString, and then parsed by calling parseSystValVector.

std::vector<float> m_systValVector¶

std::string m_eventInfoContainerName = "EventInfo"¶: If the xAOD has a different EventInfo container name, set it here

int m_isMC = -1¶

This is an override at the algorithm level to force analyzing MC or not.

Value	Meaning
-1	Default, use eventInfo object to determine if data or mc
0	Treat the input as data
1	Treat the input as MC

Protected Functions

bool isMC()¶

Try to determine if we are running over data or MC. The xAH::Algorithm::m_isMC can be used

to fix the return value. Otherwise the EventInfo object is queried.

An exception is thrown if the type cannot be determined.

Return Value Meaning

0 Data

1 MC

void registerInstance()¶

Register the given instance under the moniker xAH::Algorithm::m_className

This will increase the reference count by 1.

int numInstances()¶

Return number of instances registered under the moniker xAH::Algorithm::m_className

This will return the reference count.

Warning

If for some reason the instance wasn’t registered, we spit out a warning.

void unregisterInstance()¶

Unregister the given instance under the moniker xAH::Algorithm::m_className

This will decrease the reference count by 1.

Warning

If for some reason the instance wasn’t registered, we spit out a warning.

template <typename T>

StatusCode checkToolStore(const std::string &tool_name)¶

Check whether the input CP tool already exists with this name in the asg::ToolStore

Depending on the outcome, the content of the map xAH::Algorithm::m_toolAlreadyUsed wll be set accordingly.

bool isToolAlreadyUsed(const std::string &tool_name)¶

Check whether the input CP tool has been already used by any xAH::Algorithm in the current job by scanning xAH::Algorithm::m_toolAlreadyUsed.

template <typename T>

void setToolName(asg::AnaToolHandle<T> &handle, std::string name = "") const¶

Note: This function does nothing in release 21.1! The native private tool mechanism is used instead.

Sets the name of a tool. If no name is needed, the tool will use the name of the algorithm plus a unique identifier (xAH::Algorithm::getAddress()) appended to ensure the tool is unique and effectively private.

The tool will not be guaranteed unique if two tools of the same type are created without a name passed in. But this is, at this point, up to the user and a more complex scenario than what this function tries to simplify on its own.

std::string getAddress() const¶: Return a std::string representation of this

Protected Attributes

std::string m_className = "Algorithm"¶

The moniker by which all instances are tracked in xAH::Algorithm::m_instanceRegistry

xAOD::TEvent *m_event = nullptr¶: The TEvent object

xAOD::TStore *m_store = nullptr¶: The TStore object

Private Members

int m_numEvent¶

int m_numObject¶

std::string m_outAuxContainerName¶

std::string m_outSCContainerName¶

std::string m_outSCAuxContainerName¶

std::vector<CP::SystematicSet> m_systList¶

CP::EgammaCalibrationAndSmearingTool *m_EgammaCalibrationAndSmearingTool = nullptr¶

CP::IsolationCorrectionTool *m_IsolationCorrectionTool = nullptr¶: apply leakage correction to calo based isolation variables for electrons