Description of a calorimeter cluster. More...

#include <CaloCluster_v1.h>

Inheritance diagram for xAOD::CaloCluster_v1:

Collaboration diagram for xAOD::CaloCluster_v1:

Public Types
typedef float	flt_t

typedef CaloSampling::CaloSample	CaloSample

typedef uint8_t	ncells_t
	Type for number-of-cells-in-sampling counter. More...

typedef std::vector< uint16_t >	ncells_store_t
	Store type for number-of-cells-in-sampling counter. More...

using	TypelessConstAccessor = ConstAuxElement::TypelessConstAccessor

template<class T , class ALLOC = AuxAllocator_t<T>>
using	ConstAccessor = SG::ConstAccessor< T, ALLOC >

template<class T , class ALLOC = AuxAllocator_t<T>>
using	Accessor = SG::Accessor< T, ALLOC >

template<class T , class ALLOC = AuxAllocator_t<T>>
using	Decorator = SG::Decorator< T, ALLOC >

Public types
enum	ClusterSize { SW_55ele = 1, SW_35ele = 2, SW_37ele = 3, SW_55gam = 4, SW_35gam = 5, SW_37gam = 6, SW_55Econv = 7, SW_35Econv = 8, SW_37Econv = 9, SW_softe = 10, Topo_420 = 11, Topo_633 = 12, SW_7_11 = 13, SuperCluster =14, Tower_01_01 = 15, Tower_005_005 = 16, Tower_fixed_area = 17, CSize_Unknown = 99 }
	Enumeration to identify different cluster sizes. More...

enum	MomentType { FIRST_PHI = 101, FIRST_ETA = 102, SECOND_R = 201, SECOND_LAMBDA = 202, DELTA_PHI = 301, DELTA_THETA = 302, DELTA_ALPHA = 303, CENTER_X = 401, CENTER_Y = 402, CENTER_Z = 403, CENTER_MAG = 404, CENTER_LAMBDA = 501, LATERAL = 601, LONGITUDINAL = 602, ENG_FRAC_EM = 701, ENG_FRAC_MAX = 702, ENG_FRAC_CORE = 703, FIRST_ENG_DENS = 804, SECOND_ENG_DENS = 805, ISOLATION = 806, ENG_BAD_CELLS = 807, N_BAD_CELLS = 808, N_BAD_CELLS_CORR = 809, BAD_CELLS_CORR_E = 813, BADLARQ_FRAC = 821, ENG_POS = 822, SIGNIFICANCE = 823, CELL_SIGNIFICANCE = 824, CELL_SIG_SAMPLING = 825, AVG_LAR_Q = 826, AVG_TILE_Q = 827, ENG_BAD_HV_CELLS = 828, N_BAD_HV_CELLS = 829, PTD = 830, MASS = 831, EM_PROBABILITY = 900, HAD_WEIGHT = 901, OOC_WEIGHT = 902, DM_WEIGHT = 903, TILE_CONFIDENCE_LEVEL = 904, SECOND_TIME = 910, NCELL_SAMPLING = 920, VERTEX_FRACTION = 1000, NVERTEX_FRACTION = 1001, ETACALOFRAME = 1100, PHICALOFRAME = 1101, ETA1CALOFRAME = 1102, PHI1CALOFRAME = 1103, ETA2CALOFRAME = 1104, PHI2CALOFRAME = 1105, ENG_CALIB_TOT = 10001, ENG_CALIB_OUT_L = 10010, ENG_CALIB_OUT_M = 10011, ENG_CALIB_OUT_T = 10012, ENG_CALIB_DEAD_L = 10020, ENG_CALIB_DEAD_M = 10021, ENG_CALIB_DEAD_T = 10022, ENG_CALIB_EMB0 = 10030, ENG_CALIB_EME0 = 10031, ENG_CALIB_TILEG3 = 10032, ENG_CALIB_DEAD_TOT = 10040, ENG_CALIB_DEAD_EMB0 = 10041, ENG_CALIB_DEAD_TILE0 = 10042, ENG_CALIB_DEAD_TILEG3 = 10043, ENG_CALIB_DEAD_EME0 = 10044, ENG_CALIB_DEAD_HEC0 = 10045, ENG_CALIB_DEAD_FCAL = 10046, ENG_CALIB_DEAD_LEAKAGE = 10047, ENG_CALIB_DEAD_UNCLASS = 10048, ENG_CALIB_FRAC_EM = 10051, ENG_CALIB_FRAC_HAD = 10052, ENG_CALIB_FRAC_REST = 10053, ENERGY_DigiHSTruth = 40101, ETA_DigiHSTruth = 401024, PHI_DigiHSTruth = 401034, TIME_DigiHSTruth = 40104, ENERGY_CALIB_DigiHSTruth = 40105, ETA_CALIB_DigiHSTruth = 40106, PHI_CALIB_DigiHSTruth = 40107, TIME_CALIB_DigiHSTruth = 40108, FIRST_PHI_DigiHSTruth = 50101, FIRST_ETA_DigiHSTruth = 50102, SECOND_R_DigiHSTruth = 50201, SECOND_LAMBDA_DigiHSTruth = 50202, DELTA_PHI_DigiHSTruth = 50301, DELTA_THETA_DigiHSTruth = 50302, DELTA_ALPHA_DigiHSTruth = 50303, CENTER_X_DigiHSTruth = 50401, CENTER_Y_DigiHSTruth = 50402, CENTER_Z_DigiHSTruth = 50403, CENTER_MAG_DigiHSTruth = 50404, CENTER_LAMBDA_DigiHSTruth = 50501, LATERAL_DigiHSTruth = 50601, LONGITUDINAL_DigiHSTruth = 50602, ENG_FRAC_EM_DigiHSTruth = 50701, ENG_FRAC_MAX_DigiHSTruth = 50702, ENG_FRAC_CORE_DigiHSTruth = 75003, FIRST_ENG_DENS_DigiHSTruth = 50804, SECOND_ENG_DENS_DigiHSTruth = 50805, ISOLATION_DigiHSTruth = 50806, ENG_BAD_CELLS_DigiHSTruth = 50807, N_BAD_CELLS_DigiHSTruth = 50808, N_BAD_CELLS_CORR_DigiHSTruth = 50809, BAD_CELLS_CORR_E_DigiHSTruth = 50813, BADLARQ_FRAC_DigiHSTruth = 50821, ENG_POS_DigiHSTruth = 50822, SIGNIFICANCE_DigiHSTruth = 50823, CELL_SIGNIFICANCE_DigiHSTruth = 50824, CELL_SIG_SAMPLING_DigiHSTruth = 50825, AVG_LAR_Q_DigiHSTruth = 50826, AVG_TILE_Q_DigiHSTruth = 50827, ENG_BAD_HV_CELLS_DigiHSTruth = 50828, N_BAD_HV_CELLS_DigiHSTruth = 50829, EM_PROBABILITY_DigiHSTruth = 50900, HAD_WEIGHT_DigiHSTruth = 50901, OOC_WEIGHT_DigiHSTruth = 50902, DM_WEIGHT_DigiHSTruth = 50903 }
	Enums to identify different moments. More...

enum	State { UNKNOWN = -1, UNCALIBRATED = 0, CALIBRATED = 1, ALTCALIBRATED = 2, NSTATES = 3 }
	enum of possible signal states. More...

Public Member Functions
	CaloCluster_v1 ()
	Default constructor. More...

	CaloCluster_v1 (const CaloCluster_v1 &other)
	Copy constructor. More...

virtual	~CaloCluster_v1 ()
	Destructor. More...

CaloCluster_v1 &	operator= (const xAOD::CaloCluster_v1 &other)
	Assignment operator. More...

unsigned int	getClusterEtaSize () const
	Get eta size from cluster size. More...

unsigned int	getClusterPhiSize () const
	Get phi size from cluster size. More...

void	setBadChannelList (const CaloClusterBadChannelList &bcl)

const CaloClusterBadChannelList &	badChannelList () const

const CaloCluster_v1 *	getSisterCluster () const
	Get a pointer to a 'sister' cluster (eg the non-calibrated counterpart) More...

const ElementLink< xAOD::CaloClusterContainer_v1 > &	getSisterClusterLink () const
	Get a link to a 'sister' cluster (eg the non-calibrated counterpart) More...

bool	setSisterClusterLink (const ElementLink< CaloClusterContainer_v1 > &sister)
	Set a link to a 'sister' cluster (eg the non-calibrated counterpart) More...

void	toPersistent ()
	Function preparing the object to be persistified. More...

template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::reference_type	auxdata (const std::string &name)
	Fetch an aux data variable, as a non-const reference. More...

template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type	auxdata (const std::string &name) const
	Fetch an aux data variable, as a const reference. More...

template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED bool	isAvailableWritable (const std::string &name, const std::string &clsname="")
	Check if an aux variable is available for writing. More...

void	assign (const AuxElement &other, bool warnUnlocked=false)
	Assignment. More...

const SG::AuxVectorData *	container () const
	Return the container holding this element. More...

SG::AuxVectorData *	container ()
	Return the container holding this element. More...

template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type	auxdataConst (const std::string &name) const
	Fetch an aux data variable, as a const reference. More...

template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type	auxdataConst (const std::string &name, const std::string &clsname) const
	Fetch an aux data variable, as a const reference. More...

template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED bool	isAvailableWritableAsDecoration (const std::string &name, const std::string &clsname="") const
	Check if an aux variable is available for writing as a decoration. More...

template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Decorator< T, ALLOC >::reference_type	auxdecor (const std::string &name) const
	Fetch an aux decoration, as a non-const reference. More...

template<class T , class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Decorator< T, ALLOC >::reference_type	auxdecor (const std::string &name, const std::string &clsname) const
	Fetch an aux decoration, as a non-const reference. More...

void	makePrivateStore ()
	Create a new (empty) private store for this object. More...

template<class U1 >
void	makePrivateStore (const U1 &other, bool warnUnlocked=false)
	Create a new private store for this object and copy aux data. More...

template<class U1 >
void	makePrivateStore (const U1 *other, bool warnUnlocked=false)
	Create a new private store for this object and copy aux data. More...

void	releasePrivateStore ()
	Release and free any private store associated with this object. More...

void	setStore (const SG::IConstAuxStore *store)
	Set the store associated with this object. More...

void	setStore (SG::IAuxStore *store)
	Set the store associated with this object. More...

void	setStore (const DataLink< SG::IConstAuxStore > &store)
	Set the store associated with this object. More...

void	setConstStore (const SG::IConstAuxStore *store)
	Synonym for `setStore` with `IConstAuxStore`. More...

void	setNonConstStore (SG::IAuxStore *store)
	Synonym for `setStore` with `IAuxStore`. More...

bool	usingPrivateStore () const
	Test to see if this object is currently using a private store. More...

bool	usingStandaloneStore () const
	Test to see if this object is currently using a standalone store. More...

const SG::IConstAuxStore *	getConstStore () const
	Return the current store, as a const interface. More...

SG::IAuxStore *	getStore () const
	Return the current store, as a non-const interface. More...

void	clearCache ()
	Clear the cached aux data pointers. More...

const SG::auxid_set_t &	getAuxIDs () const
	Return a set of identifiers for existing data items for this object. More...

const SG::auxid_set_t &	getDecorIDs () const
	Return a set of identifiers for decorations for this object. More...

bool	hasStore () const
	Return true if this object has an associated store. More...

bool	hasNonConstStore () const
	Return true if this object has an associated non-const store. More...

bool	clearDecorations () const
	Clear all decorations. More...

bool	trackIndices () const
	Return true if index tracking is enabled for this object. More...

size_t	index () const
	Return the index of this element within its container. More...

size_t	index () const
	Return the index of this element within its container. More...

convinience functions
{ The transverse energy of the cluster (negative for neg-Energy clusters with zero mass)
double	et () const

Energy/Eta/Phi/number of cells per sampling
} Retrieve energy in a given sampling
float	eSample (const CaloSample sampling) const

float	etaSample (const CaloSample sampling) const
	Retrieve barycenter $\eta$ in a given sample. More...

float	phiSample (const CaloSample sampling) const
	Retrieve barycenter $\varphi$ in a given sample. More...

float	energy_max (const CaloSample sampling) const
	Retrieve maximum cell energy in given sampling. More...

float	etamax (const CaloSample sampling) const
	Retrieve $\eta$ of cell with maximum energy in given sampling. More...

float	phimax (const CaloSample sampling) const
	Retrieve $\varphi$ of cell with maximum energy in given sampling. More...

float	etasize (const CaloSample sampling) const
	Returns cluster size in $\eta$ for a given sampling. More...

float	phisize (const CaloSample sampling) const
	Returns cluster size in $\varphi$ for a given sampling. More...

int	numberCellsInSampling (const CaloSample samp, bool isInnerWheel=false) const
	Returns number of cells in given sampling. More...

void	setNumberCellsInSampling (CaloSampling::CaloSample samp, int ncells, bool isInnerWheel=false)
	Set the number of cells in a sampling layer. More...

int	numberCells () const
	Return total number of cells in cluster. More...

template<class CDATA >
bool	getNumberCellsInSampling (CDATA &cdata) const
	Get number of cells for all sampling layer. More...

float	energyBE (const unsigned layer) const
	Get the energy in one layer of the EM Calo. More...

float	etaBE (const unsigned layer) const
	Get the eta in one layer of the EM Calo. More...

float	phiBE (const unsigned layer) const
	Get the phi in one layer of the EM Calo. More...

bool	setEnergy (const CaloSample sampling, const float e)
	Set energy for a given sampling. Returns false if the sample isn't part of the cluster. More...

bool	setEta (const CaloSample sampling, const float eta)
	Set $\eta$ in a given sampling. Returns false if the sample isn't part of the cluster. More...

bool	setPhi (const CaloSample sampling, const float phi)
	Set $\varphi$ in a given sampling. Returns false if the sample isn't part of the cluster. More...

bool	setEmax (const CaloSample sampling, const float eMax)
	Set the Energy of the cell with the highest energy in a particular sampling. More...

bool	setEtamax (const CaloSample sampling, const float etaMax)
	Set the eta of the cell with the highest energy in a particular sampling. More...

bool	setPhimax (const CaloSample sampling, const float phiMax)
	Set the phi of the cell with the highest energy in a particular sampling. More...

bool	setEtasize (const CaloSample sampling, const float etaSize)
	Set the cluster size in $\varphi$ for a given sampling. More...

bool	setPhisize (const CaloSample sampling, const float phiSize)
	Set the cluster size in $\vareta$ for a given sampling. More...

Cluster moments
Set individual moment
void	insertMoment (MomentType type, double value)

bool	retrieveMoment (MomentType type, double &value) const
	Retrieve individual moment. More...

double	getMomentValue (MomentType type) const
	Retrieve individual moment - no check for existance! Returns -999 on error. More...

void	insertMoment (MomentType type, const ncells_store_t &values)
	Insert number of cells/sampling moment (non-scalar) More...

bool	retrieveMoment (MomentType type, ncells_store_t &values) const
	Retrieve non-scalar moments. More...

Special Cluster Variables
Set raw $\eta$ of cluster seed
void	setEta0 (flt_t)

flt_t	eta0 () const
	Returns raw $\eta$ of cluster seed. More...

void	setPhi0 (flt_t)
	Set raw $\phi$ of cluster seed. More...

flt_t	phi0 () const
	Returns raw $\phi$ of cluster seed. More...

void	setTime (flt_t)
	Set cluster time. More...

flt_t	time () const
	Access cluster time. More...

void	setSecondTime (flt_t stime)
	Set second moment of cell timing distribution. More...

flt_t	secondTime () const
	Access second moment of cell timing distribution. More...

unsigned	samplingPattern () const
	Access to sampling pattern (one bit per sampling) (Method may be removed later) More...

void	setSamplingPattern (const unsigned sp, const bool clearSamplingVars=false)
	Set sampling pattern (one bit per sampling. More...

void	clearSamplingData ()
	Clear the sampling data. More...

unsigned	nSamples () const

bool	hasSampling (const CaloSample s) const
	Checks if certain smapling contributes to cluster. More...

ClusterSize	clusterSize () const
	Get cluster size. More...

void	setClusterSize (const ClusterSize)
	Get cluster size. More...

bool	inBarrel () const
	Returns true if at least one clustered cell in the barrel. More...

bool	inEndcap () const
	Returns true if at least one clustered cell in the endcap. More...

4Momentum setter (signal-state dependent)
}@ Set Energy for the current signal state
void	setE (flt_t)

void	setEta (flt_t)
	Set Eta for the current signal state. More...

void	setPhi (flt_t)
	Set Phi for the current signal state. More...

void	setM (flt_t)
	Set Mass for the current signal state. More...

Static Public Attributes
static constexpr bool	supportsThinning = true
	Mark that this type supports thinning operations. More...

Protected Member Functions
bool	noPrivateData () const
	True if this element has no private data. More...

bool	havePrivateData () const
	True if this element currently has private data. More...

bool	hadPrivateData () const
	True if this element had private data before it was added to its current container. More...

Private Types
enum	PrivateStoreState : uint8_t { PrivateStoreState::NO_PRIVATE = 0, PrivateStoreState::HAVE_PRIVATE = 1, PrivateStoreState::HAD_PRIVATE = 2 }
	The current private data state. More...

Private Member Functions
unsigned	sampVarIdx (const CaloSample) const

float	getSamplVarFromAcc (const Accessor< std::vector< float > > &acc, const CaloSample sampling, const float errorvalue=CaloClusterDetails::defaultErrorValue) const

bool	setSamplVarFromAcc (const Accessor< std::vector< float > > &acc, const CaloSample sampling, const float value)

void	releasePrivateStoreForDtor ()
	Out-of-line portion of destructor. More...

void	setIndex (size_t index, SG::AuxVectorData *container)
	Set the index/container for this element. More...

bool	setIndexPrivate (size_t index, SG::AuxVectorData *container)
	Set the index/container for this element. More...

void	makePrivateStore1 (const void *other, bool warnUnlocked)
	Create a new private store for this object and copy aux data. More...

void	makePrivateStore1 (const AuxElement *other, bool warnUnlocked)
	Create a new private store for this object and copy aux data. More...

AuxElementStandaloneData *	setStore1 (const SG::IConstAuxStore *store)
	Set the store associated with this object. More...

void	clearAux ()
	Clear all aux data associated with this element. More...

void	copyAux (const ConstAuxElement &other, bool warnUnlocked=false)
	Copy aux data from another object. More...

void	setNoPrivateData ()
	Record that this element does not have private data. More...

void	setHavePrivateData ()
	Record that this element currently has private data. More...

void	setHadPrivateData ()
	Record that this element used to have private data. More...

Managing compound cell-in-sampling counting data
template<class UNSIGNED >
UNSIGNED	extractLowerCount (ncells_store_t::value_type cdata) const
	extract lower cell count from data More...

template<class UNSIGNED >
UNSIGNED	extractUpperCount (ncells_store_t::value_type cdata) const
	extract upper cell count from data More...

template<class UNSIGNED >
ncells_store_t::value_type	setLowerCount (ncells_store_t::value_type cdata, UNSIGNED clower)

template<class UNSIGNED >
ncells_store_t::value_type	setUpperCount (ncells_store_t::value_type cdata, UNSIGNED cupper)

template<class UNSIGNED >
UNSIGNED	lowerCellCountBound () const
	lower value boundary for cell count More...

template<class UNSIGNED >
UNSIGNED	upperCellCountBound () const
	upper boundary for cell count More...

template<class UNSIGNED , class CCTYPE >
CCTYPE	adjustToRange (UNSIGNED count) const
	< reduce value range to min and max counts More...

Private Attributes
unsigned	m_samplingPattern
	bit-pattern describing the calo samplings contributing to this cluster More...

State	m_signalState
	Current signal state. More...

std::unique_ptr< CaloClusterCellLink >	m_cellLinks
	Unique ptr to cell links. More...

CaloRecoStatus	m_recoStatus
	Reco status (transient only) More...

double	m_secondTime = { -1. }
	Second cell time moment (transient only) More...

const SG::AuxVectorData *	m_container
	The container of which this object is an element. More...

size_t	m_index
	The index of this element within its container. More...

PrivateStoreState	m_privateStoreState

Friends
class	::CaloClusterChangeSignalState

Functions implementing the xAOD::IParticle interface
typedef IParticle::FourMom_t	FourMom_t
	Definition of the 4-momentum type. More...

typedef ROOT::Math::LorentzVector< ROOT::Math::PtEtaPhiM4D< double > >	GenVecFourMom_t
	Base 4 Momentum type for calo. More...

virtual double	pt () const
	The transverse momentum ( $p_T$ ) of the particle (negative for negative-energy clusters) More...

virtual double	eta () const
	The pseudorapidity ( $\eta$ ) of the particle. More...

virtual double	phi () const
	The azimuthal angle ( $\phi$ ) of the particle. More...

virtual double	m () const
	The invariant mass of the particle. More...

virtual double	e () const
	The total energy of the particle. More...

virtual double	rapidity () const
	The true rapidity (y) of the particle. More...

GenVecFourMom_t	genvecP4 () const
	The full 4-momentum of the particle : GenVector type. More...

GenVecFourMom_t	genvecP4 (const State s) const
	The full 4-momentum of the particle : GenVector type. More...

virtual FourMom_t	p4 () const
	The full 4-momentum of the particle. More...

FourMom_t	p4 (const State s) const

virtual Type::ObjectType	type () const
	The type of the object as a simple enumeration. More...

4Momentum in different signal states
}@ Get Energy in signal state UNCALIBRATED
flt_t	rawE () const

void	setRawE (flt_t)
	Set Energy for signal state UNCALIBRATED. More...

flt_t	rawEta () const
	Get $\eta$ in signal state UNCALIBRATED. More...

void	setRawEta (flt_t)
	Set $\eta$ for signal state UNCALIBRATED. More...

flt_t	rawPhi () const
	Get $\phi$ in signal state UNCALIBRATED. More...

void	setRawPhi (flt_t)
	Set $\phi$ for signal state UNCALIBRATED. More...

flt_t	rawM () const
	Get mass in signal state UNCALIBRATED. More...

void	setRawM (flt_t)
	Set mass for singal state UNCALIBRATED. More...

flt_t	altE () const
	Get Energy in signal state ALTCALIBRATED. More...

void	setAltE (flt_t)
	Set Energy for signal state ALTCALIBRATED. More...

flt_t	altEta () const
	Get $\eta$ in signal state ALTCALIBRATED. More...

void	setAltEta (flt_t)
	Set $\eta$ for signal state ALTCALIBRATED. More...

flt_t	altPhi () const
	Get $\phi$ in signal state ALTCALIBRATED. More...

void	setAltPhi (flt_t)
	Set $\phi$ for signal state ALTCALIBRATED. More...

flt_t	altM () const
	Get mass in signal state ALTCALIBRATED. More...

void	setAltM (flt_t)
	Set mass for singal state ALTCALIBRATED. More...

flt_t	calE () const
	Geet Energy in signal state CALIBRATED. More...

void	setCalE (flt_t)
	Set Energy for signal state CALIBRATED. More...

flt_t	calEta () const
	Get $\eta$ in signal state CALIBRATED. More...

void	setCalEta (flt_t)
	Set $\eta$ for signal state CALIBRATED. More...

flt_t	calPhi () const
	Get $\phi$ in signal state CALIBRATED. More...

void	setCalPhi (flt_t)
	Set $\phi$ for signal state CALIBRATED. More...

flt_t	calM () const
	Get mass in signal state CALIBRATED. More...

void	setCalM (flt_t)
	Set mass for singal state CALIBRATED. More...

State	signalState () const
	Get the current signal state. More...

double	pt (const State s) const
	pt with a given signal state More...

double	e (const State s) const
	energy with a given signal state More...

double	eta (const State s) const
	eta with a given signal state More...

double	phi (const State s) const
	phi with a given signal state More...

double	m (const State s) const
	m with a given signal state More...

bool	setSignalState (const State s)
	Switch signal state. More...

Athena-only methods, used during building stage
Set up an ElementLink to a CaloClusterCellLink object Takes ownership of CCCL. Deprecated; use the unique_ptr version for new code.
typedef CaloClusterCellLink::const_iterator	const_cell_iterator
	Iterator of the underlying CaloClusterCellLink (explicitly const version) More...

typedef CaloClusterCellLink::iterator	cell_iterator
	Iterator of the underlying CaloClusterCellLink (non-const version) More...

typedef const_cell_iterator	const_iterator
	STL-compatible iterators. More...

typedef cell_iterator	iterator

void	addCellLink (CaloClusterCellLink *CCCL)

void	addCellLink (std::unique_ptr< CaloClusterCellLink > CCCL)
	Set up an ElementLink to a CaloClusterCellLink object. More...

bool	setLink (CaloClusterCellLinkContainer CCCL, IProxyDict sg=nullptr)
	Set up an ElementLink to a CaloClusterCellLink object. More...

bool	setLink (CaloClusterCellLinkContainer *CCCL, const EventContext &ctx)
	Push the CaloClusterCellLink object into the cell-link container and hand-over ownership to it. More...

const CaloClusterCellLink *	getCellLinks () const
	Get a pointer to the CaloClusterCellLink object (const version) More...

CaloClusterCellLink *	getOwnCellLinks ()
	Get a pointer to the owned CaloClusterCellLink object (non-const version) More...

bool	addCell (const unsigned index, const double weight)
	Method to add a cell to the cluster (Beware: Kinematics not updated!) More...

bool	removeCell (const CaloCell *ptr)
	Method to remove a cell to the cluster (slow!) (Beware: Kinematics not updated!) More...

size_t	size () const
	size method (forwarded from CaloClusterCellLink obj) More...

const_cell_iterator	cell_cbegin () const

const_cell_iterator	cell_cend () const

const_cell_iterator	cell_begin () const
	Iterator of the underlying CaloClusterCellLink (const version) More...

const_cell_iterator	cell_end () const

cell_iterator	cell_begin ()

cell_iterator	cell_end ()

const_iterator	begin () const

const_iterator	end () const

const_iterator	cbegin () const

const_iterator	cend () const

iterator	begin ()

iterator	end ()

void	reweightCell (cell_iterator it, const double weight)
	Method to reweight a cell in the cluster (Beware: Kinematics not updated!) More...

CaloRecoStatus &	recoStatus ()
	Accesssor to CaloRecoStatus (non-const) More...

const CaloRecoStatus &	recoStatus () const
	Accesssor to CaloRecoStatus (const) More...

Detailed Description

Description of a calorimeter cluster.

Author: Attila Krasznahorkay Attil.nosp@m.a.Kr.nosp@m.aszna.nosp@m.hork.nosp@m.ay@ce.nosp@m.rn.c.nosp@m.h; Walter Lampl Walte.nosp@m.r.La.nosp@m.mpl@c.nosp@m.ern..nosp@m.ch; Peter Loch Peter.nosp@m..Loc.nosp@m.h@cer.nosp@m.n.ch

Since: 23-March-2021: added methods to set and retrieve second moment of cell time distribution (persistified as a cluster moment)

Definition at line 62 of file CaloCluster_v1.h.

Member Typedef Documentation

◆ Accessor

template<class T , class ALLOC = AuxAllocator_t<T>>

using SG::AuxElement::Accessor = SG::Accessor<T, ALLOC>

inherited

Definition at line 572 of file AuxElement.h.

◆ CaloSample

typedef CaloSampling::CaloSample xAOD::CaloCluster_v1::CaloSample

Definition at line 69 of file CaloCluster_v1.h.

◆ cell_iterator

typedef CaloClusterCellLink::iterator xAOD::CaloCluster_v1::cell_iterator

Iterator of the underlying CaloClusterCellLink (non-const version)

Definition at line 819 of file CaloCluster_v1.h.

◆ const_cell_iterator

typedef CaloClusterCellLink::const_iterator xAOD::CaloCluster_v1::const_cell_iterator

Iterator of the underlying CaloClusterCellLink (explicitly const version)

Definition at line 796 of file CaloCluster_v1.h.

◆ const_iterator

typedef const_cell_iterator xAOD::CaloCluster_v1::const_iterator

STL-compatible iterators.

Definition at line 825 of file CaloCluster_v1.h.

◆ ConstAccessor

template<class T , class ALLOC = AuxAllocator_t<T>>

using SG::AuxElement::ConstAccessor = SG::ConstAccessor<T, ALLOC>

inherited

Definition at line 569 of file AuxElement.h.

◆ Decorator

template<class T , class ALLOC = AuxAllocator_t<T>>

using SG::AuxElement::Decorator = SG::Decorator<T, ALLOC>

inherited

Definition at line 575 of file AuxElement.h.

◆ flt_t

typedef float xAOD::CaloCluster_v1::flt_t

Definition at line 67 of file CaloCluster_v1.h.

◆ FourMom_t

typedef IParticle::FourMom_t xAOD::CaloCluster_v1::FourMom_t

Definition of the 4-momentum type.

Definition at line 346 of file CaloCluster_v1.h.

◆ GenVecFourMom_t

typedef ROOT::Math::LorentzVector<ROOT::Math::PtEtaPhiM4D<double> > xAOD::CaloCluster_v1::GenVecFourMom_t

Base 4 Momentum type for calo.

Definition at line 349 of file CaloCluster_v1.h.

◆ iterator

typedef cell_iterator xAOD::CaloCluster_v1::iterator

Definition at line 826 of file CaloCluster_v1.h.

◆ ncells_store_t

typedef std::vector<uint16_t> xAOD::CaloCluster_v1::ncells_store_t

Store type for number-of-cells-in-sampling counter.

Due to the severe change of granularity of EME2 from the inner to the outer wheel, clusters spanning the region around $|\eta| = 2.5$ provide the exclusive count of EME2 cells together with the count of cells in the inner wheel. The persistent store to hold both counts for one given index (given by CaloSampling::CaloSample) therefore holds two 8-bit words/sampling.

Definition at line 83 of file CaloCluster_v1.h.

◆ ncells_t

typedef uint8_t xAOD::CaloCluster_v1::ncells_t

Type for number-of-cells-in-sampling counter.

The total number of cells in a given cluster from any given sampling is limited to [0,255] and thus stored in an 8-bit word.

Definition at line 75 of file CaloCluster_v1.h.

◆ TypelessConstAccessor

using SG::AuxElement::TypelessConstAccessor = ConstAuxElement::TypelessConstAccessor

inherited

Definition at line 566 of file AuxElement.h.

Member Enumeration Documentation

◆ ClusterSize

enum xAOD::CaloCluster_v1::ClusterSize

Enumeration to identify different cluster sizes.

Enumerator
SW_55ele
SW_35ele
SW_37ele
SW_55gam
SW_35gam
SW_37gam
SW_55Econv
SW_35Econv
SW_37Econv
SW_softe
Topo_420
Topo_633
SW_7_11
SuperCluster
Tower_01_01
Tower_005_005
Tower_fixed_area
CSize_Unknown

Definition at line 89 of file CaloCluster_v1.h.

                        {
          // electrons
          SW_55ele   = 1,
          SW_35ele   = 2,
          SW_37ele   = 3,
          // photons
          SW_55gam   = 4,
          SW_35gam   = 5,
          SW_37gam   = 6,
          // early converted photons
          SW_55Econv = 7,
          SW_35Econv = 8,
          SW_37Econv = 9,
          // soft electrons
          SW_softe   = 10,
          // topological clusters
          Topo_420   = 11,
          Topo_633   = 12,
          // transient cluster for AODCellContainer
          SW_7_11    = 13,
          //New (2016) egamma cluster
          SuperCluster=14,
          //New (2020) cluster representation of towers
          Tower_01_01 = 15,
          Tower_005_005 = 16,
          Tower_fixed_area = 17,
          CSize_Unknown = 99
       };

◆ MomentType

enum xAOD::CaloCluster_v1::MomentType

Enums to identify different moments.

Each enum corresponds to a different characteristic moment of a CaloCluster. The enums are loosly grouped by their type - i.e. first moment over an angle, second moment, angular deviations etc.

Enumerator
FIRST_PHI	First Moment in $\phi$ .
FIRST_ETA	First Moment in $\eta$ .
SECOND_R	Second Moment in $r$ .
SECOND_LAMBDA	Second Moment in $\lambda$ .
DELTA_PHI	Angular shower axis deviation ( $\phi$ ) from IP-to-Center.
DELTA_THETA	Angular shower axis deviation ( $\theta$ ) from IP-to-Center.
DELTA_ALPHA	Angular shower axis deviation ( $\Delta\alpha$ ) from IP-to-Center.
CENTER_X	Cluster Centroid ( $x$ )
CENTER_Y	Cluster Centroid ( $y$ )
CENTER_Z	Cluster Centroid ( $z$ )
CENTER_MAG	Cluster Centroid ( $\sqrt(x^2+y^2+z^2)$ )
CENTER_LAMBDA	Shower depth at Cluster Centroid.
LATERAL	Normalized lateral moment.
LONGITUDINAL	Normalized longitudinal moment.
ENG_FRAC_EM	Energy fraction in EM calorimeters.
ENG_FRAC_MAX	Energy fraction of hottest cell.
ENG_FRAC_CORE	Energy fraction of the sum of the hottest cells in each sampling.
FIRST_ENG_DENS	First Moment in E/V.
SECOND_ENG_DENS	Second Moment in E/V.
ISOLATION	Energy weighted fraction of non-clustered perimeter cells.
ENG_BAD_CELLS	Total em-scale energy of bad cells in this cluster.
N_BAD_CELLS	number of bad cells
N_BAD_CELLS_CORR	Number of bad cells with energy density average correction applied.
BAD_CELLS_CORR_E	Energy of bad cells with energy density average correction applied.
BADLARQ_FRAC	Energy fraction of LAr cells with quality larger than a given cut.
ENG_POS	Total positive Energy of this cluster.
SIGNIFICANCE	Cluster significance.
CELL_SIGNIFICANCE	Cell significance = E/sig of the cell with the largest \|E\|/sig.
CELL_SIG_SAMPLING	CaloSample of the cell with the largest \|E\|/sig.
AVG_LAR_Q	Sum(E_cell_LAr^2 Q_cell_LAr)/Sum(E_cell_LAr^2)
AVG_TILE_Q	Sum(E_cell_Tile^2 Q_cell_Tile)/Sum(E_cell_Tile^2)
ENG_BAD_HV_CELLS	Total em-scale energy of cells with bad HV in this cluster.
N_BAD_HV_CELLS	number of cells with bad HV
PTD	relative spread of pT of constiuent cells = sqrt(n)*RMS/Mean
MASS	cell based mass i.e. the mass of the 4-vector sum of all massless positive energetic cells
EM_PROBABILITY	Classification probability to be em-like.
HAD_WEIGHT	Hadronic weight (E_w/E_em)
OOC_WEIGHT	Out-of-cluster weight (E_ooc/E_w)
DM_WEIGHT	Dead-material weight (E_dm/E_ooc)
TILE_CONFIDENCE_LEVEL	Confidence Level of a tile calorimeter cluster to be noise.
SECOND_TIME	Second moment of cell time distribution in cluster.
NCELL_SAMPLING	Number of cells in sampling layer.
VERTEX_FRACTION	Vertex fraction of this cluster wrt. primary vertex of the event. Calculated in CaloRec/CaloClusterVertexFractionMaker.cxx
NVERTEX_FRACTION	slightly updated vertex fraction more pile up independent (similar to nJVF)
ETACALOFRAME	Eta in the calo frame (for egamma)
PHICALOFRAME	Phi in the calo frame (for egamma)
ETA1CALOFRAME	Eta of sampling 1 in the calo frame (for egamma)
PHI1CALOFRAME	Phi of sampling 1 in the calo frame (for egamma)
ETA2CALOFRAME	Eta of sampling 2 in the calo frame (for egamma)
PHI2CALOFRAME	Phi of sampling 2 in the calo frame (for egamma)
ENG_CALIB_TOT	Calibration Hit energy inside the cluster.
ENG_CALIB_OUT_L	Attached Calibration Hit energy outside clusters but inside the calorimeter with loose matching (Angle < 1.0)
ENG_CALIB_OUT_M	Attached Calibration Hit energy outside clusters but inside the calorimeter with medium matching (Angle < 0.5).
ENG_CALIB_OUT_T	Attached Calibration Hit energy outside clusters but inside the calorimeter with tight matching (Angle < 0.3).
ENG_CALIB_DEAD_L	Attached Calibration Hit energy in dead material with loose matching (Angle < 1.0).
ENG_CALIB_DEAD_M	Attached Calibration Hit energy in dead material with medium matching (Angle < 0.5).
ENG_CALIB_DEAD_T	Attached Calibration Hit energy in dead material with tight matching (Angle < 0.3).
ENG_CALIB_EMB0	Calibration Hit energy inside the cluster barrel presampler.
ENG_CALIB_EME0	Calibration Hit energy inside the cluster endcap presampler.
ENG_CALIB_TILEG3	Calibration Hit energy inside the cluster scintillator.
ENG_CALIB_DEAD_TOT	Attached Calibration Hit energy in dead material.
ENG_CALIB_DEAD_EMB0	Attached Calibration Hit energy in dead material before EMB0, between EMB0 and EMB1.
ENG_CALIB_DEAD_TILE0	Attached Calibration Hit energy in dead material between EMB3 and TILE0.
ENG_CALIB_DEAD_TILEG3	Attached Calibration Hit energy in dead material before scintillator.
ENG_CALIB_DEAD_EME0	Attached Calibration Hit energy in dead material before EME0, between EME0 and EME1.
ENG_CALIB_DEAD_HEC0	Attached Calibration Hit energy in dead material between EME3 and HEC0.
ENG_CALIB_DEAD_FCAL	Attached Calibration Hit energy in dead material before FCAL, between FCAL and HEC.
ENG_CALIB_DEAD_LEAKAGE	Attached Calibration Hit energy in dead material behind calorimeters.
ENG_CALIB_DEAD_UNCLASS	Attached Calibration Hit energy in dead material in unclassified areas of the detector.
ENG_CALIB_FRAC_EM	Calibration Hit energy inside the cluster caused by e/gamma/pi0.
ENG_CALIB_FRAC_HAD	Calibration Hit energy inside the cluster caused by charged pi+ and pi-.
ENG_CALIB_FRAC_REST	Calibration Hit energy inside the cluster caused by other particles.
ENERGY_DigiHSTruth	First Moment in $\phi$ .
ETA_DigiHSTruth	Eta moment that I am trying to include.
PHI_DigiHSTruth	phi moment I would like to have
TIME_DigiHSTruth	First Moment in $\phi$ .
ENERGY_CALIB_DigiHSTruth	First Moment in $\phi$ .
ETA_CALIB_DigiHSTruth	First Moment in $\phi$ .
PHI_CALIB_DigiHSTruth	First Moment in $\phi$ .
TIME_CALIB_DigiHSTruth	First Moment in $\phi$ .
FIRST_PHI_DigiHSTruth	First Moment in $\phi$ .
FIRST_ETA_DigiHSTruth	First Moment in $\eta$ .
SECOND_R_DigiHSTruth	Second Moment in $r$ .
SECOND_LAMBDA_DigiHSTruth	Second Moment in $\lambda$ .
DELTA_PHI_DigiHSTruth
DELTA_THETA_DigiHSTruth
DELTA_ALPHA_DigiHSTruth
CENTER_X_DigiHSTruth	Cluster Centroid ( $x$ )
CENTER_Y_DigiHSTruth	Cluster Centroid ( $y$ )
CENTER_Z_DigiHSTruth	Cluster Centroid ( $z$ )
CENTER_MAG_DigiHSTruth
CENTER_LAMBDA_DigiHSTruth	Shower depth at Cluster Centroid.
LATERAL_DigiHSTruth	Normalized lateral moment.
LONGITUDINAL_DigiHSTruth	Normalized longitudinal moment.
ENG_FRAC_EM_DigiHSTruth	Energy fraction in EM calorimeters.
ENG_FRAC_MAX_DigiHSTruth	Energy fraction of hottest cell.
ENG_FRAC_CORE_DigiHSTruth
FIRST_ENG_DENS_DigiHSTruth	First Moment in E/V.
SECOND_ENG_DENS_DigiHSTruth	Second Moment in E/V.
ISOLATION_DigiHSTruth
ENG_BAD_CELLS_DigiHSTruth
N_BAD_CELLS_DigiHSTruth	number of bad cells
N_BAD_CELLS_CORR_DigiHSTruth
BAD_CELLS_CORR_E_DigiHSTruth
BADLARQ_FRAC_DigiHSTruth
ENG_POS_DigiHSTruth	Total positive Energy of this cluster.
SIGNIFICANCE_DigiHSTruth	Cluster significance.
CELL_SIGNIFICANCE_DigiHSTruth
CELL_SIG_SAMPLING_DigiHSTruth
AVG_LAR_Q_DigiHSTruth
AVG_TILE_Q_DigiHSTruth
ENG_BAD_HV_CELLS_DigiHSTruth
N_BAD_HV_CELLS_DigiHSTruth	number of cells with bad HV
EM_PROBABILITY_DigiHSTruth	Classification probability to be em-like.
HAD_WEIGHT_DigiHSTruth	Hadronic weight (E_w/E_em)
OOC_WEIGHT_DigiHSTruth	Out-of-cluster weight (E_ooc/E_w)
DM_WEIGHT_DigiHSTruth	Dead-material weight (E_dm/E_ooc)

Definition at line 123 of file CaloCluster_v1.h.

                       {
          FIRST_PHI         = 101, 
          FIRST_ETA         = 102, 
          SECOND_R          = 201, 
          SECOND_LAMBDA     = 202, 
          DELTA_PHI         = 301,
          DELTA_THETA       = 302,
          DELTA_ALPHA       = 303, 
          CENTER_X          = 401, 
          CENTER_Y          = 402, 
          CENTER_Z          = 403, 
          CENTER_MAG        = 404,
          CENTER_LAMBDA     = 501, 
          LATERAL           = 601, 
          LONGITUDINAL      = 602, 
          ENG_FRAC_EM       = 701, 
          ENG_FRAC_MAX      = 702, 
          ENG_FRAC_CORE     = 703,
          FIRST_ENG_DENS    = 804, 
          SECOND_ENG_DENS   = 805, 
          ISOLATION         = 806,
          ENG_BAD_CELLS     = 807,
          N_BAD_CELLS       = 808, 
          N_BAD_CELLS_CORR  = 809,
          BAD_CELLS_CORR_E  = 813,
          BADLARQ_FRAC      = 821,
          ENG_POS           = 822, 
          SIGNIFICANCE      = 823, 
          CELL_SIGNIFICANCE = 824,
          CELL_SIG_SAMPLING = 825,
          AVG_LAR_Q         = 826,
          AVG_TILE_Q        = 827,
          ENG_BAD_HV_CELLS  = 828,
          N_BAD_HV_CELLS    = 829, 
          PTD               = 830,
          MASS              = 831,
          EM_PROBABILITY    = 900, 
          HAD_WEIGHT        = 901, 
          OOC_WEIGHT        = 902, 
          DM_WEIGHT         = 903, 
          TILE_CONFIDENCE_LEVEL = 904,
      SECOND_TIME      = 910,
      NCELL_SAMPLING   = 920,
  
          VERTEX_FRACTION = 1000, 
          NVERTEX_FRACTION = 1001, 
          ETACALOFRAME  = 1100, 
          PHICALOFRAME  = 1101, 
          ETA1CALOFRAME = 1102, 
          PHI1CALOFRAME = 1103, 
          ETA2CALOFRAME = 1104, 
          PHI2CALOFRAME = 1105, 
  
          ENG_CALIB_TOT     = 10001,
          ENG_CALIB_OUT_L   = 10010, 
          ENG_CALIB_OUT_M   = 10011, 
          ENG_CALIB_OUT_T   = 10012, 
          ENG_CALIB_DEAD_L  = 10020, 
          ENG_CALIB_DEAD_M  = 10021, 
          ENG_CALIB_DEAD_T  = 10022,  
          ENG_CALIB_EMB0         = 10030,
          ENG_CALIB_EME0         = 10031,
          ENG_CALIB_TILEG3       = 10032,
          ENG_CALIB_DEAD_TOT     = 10040,
          ENG_CALIB_DEAD_EMB0    = 10041,
          ENG_CALIB_DEAD_TILE0   = 10042,
          ENG_CALIB_DEAD_TILEG3  = 10043,
          ENG_CALIB_DEAD_EME0    = 10044,
          ENG_CALIB_DEAD_HEC0    = 10045,
          ENG_CALIB_DEAD_FCAL    = 10046,
          ENG_CALIB_DEAD_LEAKAGE = 10047,
          ENG_CALIB_DEAD_UNCLASS = 10048,
          ENG_CALIB_FRAC_EM      = 10051,
          ENG_CALIB_FRAC_HAD     = 10052,
          ENG_CALIB_FRAC_REST    = 10053,
  
  
          ENERGY_DigiHSTruth         = 40101, 
          ETA_DigiHSTruth         = 401024, 
          PHI_DigiHSTruth         = 401034, 
          TIME_DigiHSTruth         = 40104, 
          ENERGY_CALIB_DigiHSTruth         = 40105, 
          ETA_CALIB_DigiHSTruth         = 40106, 
          PHI_CALIB_DigiHSTruth         = 40107, 
          TIME_CALIB_DigiHSTruth         = 40108, 
          FIRST_PHI_DigiHSTruth         = 50101, 
          FIRST_ETA_DigiHSTruth         = 50102, 
          SECOND_R_DigiHSTruth          = 50201, 
          SECOND_LAMBDA_DigiHSTruth     = 50202, 
          DELTA_PHI_DigiHSTruth         = 50301,
          DELTA_THETA_DigiHSTruth       = 50302,
          DELTA_ALPHA_DigiHSTruth       = 50303,
          CENTER_X_DigiHSTruth          = 50401, 
          CENTER_Y_DigiHSTruth          = 50402, 
          CENTER_Z_DigiHSTruth          = 50403, 
          CENTER_MAG_DigiHSTruth        = 50404,
          CENTER_LAMBDA_DigiHSTruth     = 50501, 
          LATERAL_DigiHSTruth           = 50601, 
          LONGITUDINAL_DigiHSTruth      = 50602, 
          ENG_FRAC_EM_DigiHSTruth       = 50701, 
          ENG_FRAC_MAX_DigiHSTruth      = 50702, 
          ENG_FRAC_CORE_DigiHSTruth     = 75003,
          FIRST_ENG_DENS_DigiHSTruth    = 50804, 
          SECOND_ENG_DENS_DigiHSTruth   = 50805, 
          ISOLATION_DigiHSTruth         = 50806,
          ENG_BAD_CELLS_DigiHSTruth     = 50807,
          N_BAD_CELLS_DigiHSTruth       = 50808, 
          N_BAD_CELLS_CORR_DigiHSTruth  = 50809,
          BAD_CELLS_CORR_E_DigiHSTruth  = 50813,
          BADLARQ_FRAC_DigiHSTruth      = 50821,
          ENG_POS_DigiHSTruth           = 50822, 
          SIGNIFICANCE_DigiHSTruth      = 50823, 
          CELL_SIGNIFICANCE_DigiHSTruth = 50824,
          CELL_SIG_SAMPLING_DigiHSTruth = 50825,
          AVG_LAR_Q_DigiHSTruth         = 50826,
          AVG_TILE_Q_DigiHSTruth        = 50827,
          ENG_BAD_HV_CELLS_DigiHSTruth  = 50828,
          N_BAD_HV_CELLS_DigiHSTruth    = 50829, 
          EM_PROBABILITY_DigiHSTruth    = 50900, 
          HAD_WEIGHT_DigiHSTruth        = 50901, 
          OOC_WEIGHT_DigiHSTruth        = 50902, 
          DM_WEIGHT_DigiHSTruth         = 50903  
       };

◆ PrivateStoreState

enum SG::IAuxElement::PrivateStoreState : uint8_t

strongprivateinherited

The current private data state.

Enumerator
NO_PRIVATE
HAVE_PRIVATE
HAD_PRIVATE

Definition at line 131 of file IAuxElement.h.

   {
     NO_PRIVATE = 0,
     HAVE_PRIVATE = 1,
     HAD_PRIVATE = 2,
   };

◆ State

enum xAOD::CaloCluster_v1::State

enum of possible signal states.

Enumerator
UNKNOWN
UNCALIBRATED
CALIBRATED
ALTCALIBRATED
NSTATES

Definition at line 307 of file CaloCluster_v1.h.

                 {
        UNKNOWN             = -1,
        UNCALIBRATED        =  0,
        CALIBRATED          =  1,
        ALTCALIBRATED       =  2,
        NSTATES             =  3
      };

Constructor & Destructor Documentation

◆ CaloCluster_v1() [1/2]

xAOD::CaloCluster_v1::CaloCluster_v1 ( )

Default constructor.

Definition at line 23 of file CaloCluster_v1.cxx.

      : IParticle(),
        m_samplingPattern(0),
        m_cellLinks(nullptr)
    {
      setSignalState(CALIBRATED);
    }

◆ CaloCluster_v1() [2/2]

xAOD::CaloCluster_v1::CaloCluster_v1 ( const CaloCluster_v1 & other )

Copy constructor.

Definition at line 32 of file CaloCluster_v1.cxx.

     : IParticle(other),
       m_samplingPattern(other.samplingPattern()),
       m_cellLinks(nullptr),
       m_recoStatus(other.m_recoStatus),
       m_secondTime(other.m_secondTime) {
     setSignalState(other.signalState());
     this->makePrivateStore(other);
 #if !(defined(SIMULATIONBASE) || defined(XAOD_ANALYSIS))
     const CaloClusterCellLink* links=other.getCellLinks();
     if (links) {
       this->addCellLink(std::make_unique<CaloClusterCellLink>(*links));
     }
     static const Accessor<ElementLink<CaloClusterCellLinkContainer> > accCellLinks("CellLink");
     if (accCellLinks.isAvailable(*this)) { //In case an element link was copied by makePrivateStore, invalidate it
       accCellLinks(*this).reset();
     } //end if have element link to CaloClusterCellLink
 #endif // not defined(SIMULATIONBASE) || defined(XAOD_ANALYSIS)
   }

◆ ~CaloCluster_v1()

xAOD::CaloCluster_v1::~CaloCluster_v1 ( )

virtual

Destructor.

Definition at line 78 of file CaloCluster_v1.cxx.

78 {

79 }

Member Function Documentation

◆ addCell()

bool xAOD::CaloCluster_v1::addCell	(	const unsigned	index,
		const double	weight
	)

inline

Method to add a cell to the cluster (Beware: Kinematics not updated!)

Parameters

index	Index of the cell in the CaloCelLContainer
weight	Weight of the cell in the cluster

Returns: true if the link to the CaloClusterCellLinkContainer exists, false otherwise

Definition at line 774 of file CaloCluster_v1.h.

                                                              {
        if (!m_cellLinks) {
          return false;
        }
        return m_cellLinks->addCell(index, weight);
      }

◆ addCellLink() [1/2]

void xAOD::CaloCluster_v1::addCellLink ( CaloClusterCellLink * CCCL )

inline

Definition at line 724 of file CaloCluster_v1.h.

                                                  {
        m_cellLinks.reset(CCCL);
      }

◆ addCellLink() [2/2]

void xAOD::CaloCluster_v1::addCellLink ( std::unique_ptr< CaloClusterCellLink > CCCL )

inline

Set up an ElementLink to a CaloClusterCellLink object.

Definition at line 729 of file CaloCluster_v1.h.

                                                                {
        m_cellLinks=std::move(CCCL);
      }

◆ adjustToRange()

template<class UNSIGNED , class CCTYPE >

CCTYPE xAOD::CaloCluster_v1::adjustToRange ( UNSIGNED count ) const

inlineprivate

< reduce value range to min and max counts

Definition at line 704 of file CaloCluster_v1.h.

705 { return static_cast<CCTYPE>(std::min(std::max(count,lowerCellCountBound< UNSIGNED >()),upperCellCountBound< UNSIGNED >())); }

◆ altE()

flt_t xAOD::CaloCluster_v1::altE ( ) const

Get Energy in signal state ALTCALIBRATED.

◆ altEta()

flt_t xAOD::CaloCluster_v1::altEta ( ) const

Get $\eta$ in signal state ALTCALIBRATED.

◆ altM()

flt_t xAOD::CaloCluster_v1::altM ( ) const

Get mass in signal state ALTCALIBRATED.

◆ altPhi()

flt_t xAOD::CaloCluster_v1::altPhi ( ) const

Get $\phi$ in signal state ALTCALIBRATED.

◆ assign()

void SG::AuxElement::assign	(	const AuxElement &	other,
		bool	warnUnlocked = `false`
	)

inherited

Assignment.

Parameters

other	The object from which we're assigning.
warnUnlocked	If true, then warn when we skip unlocked decorations.

We don't copy container/index, as assignment doesn't change where this object is. However, if we have aux data, then we copy aux data if we're copying from an object that also has it; otherwise, if we're copying from an object with no aux data, then we clear ours.

◆ auxdata() [1/4]

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Accessor<T, ALLOC>::reference_type SG::AuxElement::auxdata ( const std::string & name )

inherited

Fetch an aux data variable, as a non-const reference.

Parameters

name	Name of the aux variable.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

◆ auxdata() [2/4]

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Accessor<T, ALLOC>::const_reference_type SG::AuxElement::auxdata ( const std::string & name ) const

inherited

Fetch an aux data variable, as a const reference.

Parameters

name	Name of the aux variable.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor or ConstAccessor classes.

◆ auxdata() [3/4]

template<class T >

XAOD_AUXDATA_DEPRECATED T& xAOD::IParticle::auxdata	(	const std::string &	name,
		const std::string &	clsname = `""`
	)

inlineinherited

Fetch an aux data variable, as a non-const reference.

This function provides an easy way for users to decorate objects with auxiliary data.

Take note that this function is slow. Should not be used inside time-critical code.

Parameters

name	Name of the aux variable
clsname	The name of the associated class. May be blank

Returns: A modifiable reference to the decoration

Definition at line 98 of file Event/xAOD/xAODBase/xAODBase/IParticle.h.

                                                   {
  
          return SG::Accessor< T >(name, clsname)(*this);
       }

◆ auxdata() [4/4]

template<class T >

XAOD_AUXDATA_DEPRECATED const T& xAOD::IParticle::auxdata	(	const std::string &	name,
		const std::string &	clsname = `""`
	)		const

inlineinherited

Fetch an aux data variable, as a const reference.

This function provides an easy way for users to retrieve auxiliary decorations from an object.

Take note that this function is slow. Should not be used inside time-critical code.

Parameters

name	Name of the aux variable
clsname	The name of the associated class. May be blank

Returns: A constant reference to the decoration

Definition at line 118 of file Event/xAOD/xAODBase/xAODBase/IParticle.h.

                                                               {
         
          return SG::ConstAccessor< T >( name, clsname )( *this );
       }

◆ auxdataConst() [1/2]

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Accessor<T, ALLOC>::const_reference_type SG::AuxElement::auxdataConst ( const std::string & name ) const

inherited

Fetch an aux data variable, as a const reference.

Parameters

name	Name of the aux variable.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the ConstAccessor class.

◆ auxdataConst() [2/2]

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Accessor<T, ALLOC>::const_reference_type SG::AuxElement::auxdataConst	(	const std::string &	name,
		const std::string &	clsname
	)		const

inherited

Fetch an aux data variable, as a const reference.

Parameters

name	Name of the aux variable.
clsname	The name of the associated class. May be blank.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the ConstAccessor class.

◆ auxdecor() [1/2]

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Decorator<T, ALLOC>::reference_type SG::AuxElement::auxdecor ( const std::string & name ) const

inherited

Fetch an aux decoration, as a non-const reference.

Parameters

name	Name of the aux variable.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

If the container is locked, this will allow fetching only variables that do not yet exist (in which case they will be marked as decorations) or variables already marked as decorations.

◆ auxdecor() [2/2]

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Decorator<T, ALLOC>::reference_type SG::AuxElement::auxdecor	(	const std::string &	name,
		const std::string &	clsname
	)		const

inherited

Fetch an aux decoration, as a non-const reference.

Parameters

name	Name of the aux variable.
clsname	The name of the associated class. May be blank.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

If the container is locked, this will allow fetching only variables that do not yet exist (in which case they will be marked as decorations) or variables already marked as decorations.

◆ badChannelList()

const CaloClusterBadChannelList & xAOD::CaloCluster_v1::badChannelList ( ) const

Definition at line 279 of file CaloCluster_v1.cxx.

                                                                          {
     static const Accessor<xAOD::CaloClusterBadChannelList> accBCL("BadChannelList");
     return accBCL(*this);
   }

◆ begin() [1/2]

iterator xAOD::CaloCluster_v1::begin ( )

inline

Definition at line 831 of file CaloCluster_v1.h.

831 { return cell_begin(); }

◆ begin() [2/2]

const_iterator xAOD::CaloCluster_v1::begin ( ) const

inline

Definition at line 827 of file CaloCluster_v1.h.

827 { return cell_cbegin(); }

◆ calE()

flt_t xAOD::CaloCluster_v1::calE ( ) const

Geet Energy in signal state CALIBRATED.

◆ calEta()

flt_t xAOD::CaloCluster_v1::calEta ( ) const

Get $\eta$ in signal state CALIBRATED.

◆ calM()

flt_t xAOD::CaloCluster_v1::calM ( ) const

Get mass in signal state CALIBRATED.

◆ calPhi()

flt_t xAOD::CaloCluster_v1::calPhi ( ) const

Get $\phi$ in signal state CALIBRATED.

◆ cbegin()

const_iterator xAOD::CaloCluster_v1::cbegin ( ) const

inline

Definition at line 829 of file CaloCluster_v1.h.

829 { return cell_cbegin(); }

◆ cell_begin() [1/2]

cell_iterator xAOD::CaloCluster_v1::cell_begin ( )

inline

Definition at line 821 of file CaloCluster_v1.h.

821 { return getOwnCellLinks()->begin();}

◆ cell_begin() [2/2]

const_cell_iterator xAOD::CaloCluster_v1::cell_begin ( ) const

inline

Iterator of the underlying CaloClusterCellLink (const version)

Definition at line 815 of file CaloCluster_v1.h.

815 { return cell_cbegin(); }

◆ cell_cbegin()

const_cell_iterator xAOD::CaloCluster_v1::cell_cbegin ( ) const

inline

Definition at line 798 of file CaloCluster_v1.h.

       {
         const CaloClusterCellLink* links = getCellLinks();
         if (!links) {
           return CaloClusterCellLink::dummyIt;
         }
         return links->begin();
       }

◆ cell_cend()

const_cell_iterator xAOD::CaloCluster_v1::cell_cend ( ) const

inline

Definition at line 806 of file CaloCluster_v1.h.

                                            {
        const CaloClusterCellLink* links=getCellLinks();
        if (!links) {
          return CaloClusterCellLink::dummyIt;
        }
          return getCellLinks()->end();
      }

◆ cell_end() [1/2]

cell_iterator xAOD::CaloCluster_v1::cell_end ( )

inline

Definition at line 822 of file CaloCluster_v1.h.

822 { return getOwnCellLinks()->end();}

◆ cell_end() [2/2]

const_cell_iterator xAOD::CaloCluster_v1::cell_end ( ) const

inline

Definition at line 816 of file CaloCluster_v1.h.

816 { return cell_cend(); }

◆ cend()

const_iterator xAOD::CaloCluster_v1::cend ( ) const

inline

Definition at line 830 of file CaloCluster_v1.h.

830 { return cell_cend(); }

◆ clearAux()

void SG::AuxElement::clearAux ( )

privateinherited

Clear all aux data associated with this element.

If this object has no associated store, this does nothing. If the associated aux data is const, this throws ExcConstAuxData.

Definition at line 580 of file AuxElement.cxx.

 {
   if (!m_container) return;
   if (!m_container->hasStore()) return;
   if (!m_container->hasNonConstStore())
     throw SG::ExcConstAuxData ("clearAux", SG::null_auxid);
  
   SG::AuxTypeRegistry& r = SG::AuxTypeRegistry::instance();
   for (SG::auxid_t auxid : m_container->getWritableAuxIDs()) {
     r.clear (auxid, *container(), index(), 1);
   }
 }

◆ clearCache()

void SG::AuxElement::clearCache ( )

inherited

Clear the cached aux data pointers.

You should call this any time something changes in the aux store that could invalidate the vector pointers.

Definition at line 339 of file AuxElement.cxx.

 {
   if (container())
     container()->clearCache();
 }

◆ clearDecorations()

bool SG::AuxElement::clearDecorations ( ) const

inherited

Clear all decorations.

Erase all decorations from an associated store, restoring the state to when lock was called.

Returns true if there were any decorations that were cleared, false if the store did not contain any decorations.

Definition at line 428 of file AuxElement.cxx.

 {
   if (havePrivateData())
     return m_container->clearDecorations();
   return false;
 }

◆ clearSamplingData()

void xAOD::CaloCluster_v1::clearSamplingData ( )

Clear the sampling data.

Definition at line 671 of file CaloCluster_v1.cxx.

                                            {
  
       static const Accessor< std::vector< float > > etaAcc( "eta_sampl" );
       static const Accessor< std::vector< float > > phiAcc( "phi_sampl" );
       static const Accessor< std::vector< float > > eAcc( "e_sampl" );
       static const Accessor< std::vector< float > > emaxAcc( "emax_sampl" );
       static const Accessor< std::vector< float > > etamaxAcc( "etamax_sampl" );
       static const Accessor< std::vector< float > > phimaxAcc( "phimax_sampl" );
       static const Accessor< std::vector< float > > etasizeAcc( "etasize_sampl" );
       static const Accessor< std::vector< float > > phisizeAcc( "phisize_sampl" );
  
       static const std::array< const Accessor< std::vector< float > >*, 8 > allAcc = {
         { &etaAcc, &phiAcc, &eAcc, &emaxAcc, &phimaxAcc, &etamaxAcc,
           &etasizeAcc, &phisizeAcc } };
       for (const auto *a : allAcc) {
         if (a->isAvailableWritable(*this)) {
           (*a)(*this).clear();
         }
       }
    }

◆ clusterSize()

CaloCluster_v1::ClusterSize xAOD::CaloCluster_v1::clusterSize ( ) const

Get cluster size.

Definition at line 364 of file CaloCluster_v1.cxx.

                                                                {
     static const Accessor<unsigned> acc("clusterSize");
     return (CaloCluster_v1::ClusterSize)acc(*this);
   }

◆ container() [1/2]

SG::AuxVectorData* SG::AuxElement::container ( )

inherited

Return the container holding this element.

◆ container() [2/2]

const SG::AuxVectorData* SG::AuxElement::container ( ) const

inherited

Return the container holding this element.

◆ copyAux()

void SG::AuxElement::copyAux	(	const ConstAuxElement &	other,
		bool	warnUnlocked = `false`
	)

privateinherited

Copy aux data from another object.

Parameters

other	The object from which to copy.
warnUnlocked	If true, then warn when we skip unlocked decorations.

If this object has no associated store, this does nothing. If the associated aux data is const, this throws ExcConstAuxData.

All aux data items from other are copied to this object. Any aux data items associated with this object that are not present in other are cleared. (If other has no aux data, then all aux data items for this object are cleared.)

Definition at line 607 of file AuxElement.cxx.

 {
   if (!m_container) return;
   if (!m_container->hasStore()) return;
   if (!m_container->hasNonConstStore())
     throw SG::ExcConstAuxData ("copyAux");
  
   const SG::AuxVectorData* ocont = other.container();
  
   if (!ocont || !ocont->hasStore()) {
     this->clearAux();
     return;
   }
  
   size_t oindex = other.index();
   SG::auxid_set_t other_ids = ocont->getAuxIDs();
 #ifndef XAOD_STANDALONE
   SG::auxid_set_t other_decors = ocont->getDecorIDs();
 #endif
  
   SG::AuxTypeRegistry& r = SG::AuxTypeRegistry::instance();
  
   SG::AuxVectorData& cont = *container();
   for (SG::auxid_t auxid : other_ids) {
 #ifndef XAOD_STANDALONE
     if (other_decors.test (auxid)) {
       // Don't copy decorations --- another thread may be modifying them.
       other_ids.reset (auxid);
       // Warn if we skip a decoration (except for mcEventWeights,
       // for which this is expected).
       if (warnUnlocked && r.getName(auxid) != "mcEventWeights") {
         std::ostringstream ss;
         ss << "skipped unlocked decoration " << r.getName(auxid)
            << " (" << auxid << ")";
         ATHCONTAINERS_WARNING("copyAux", ss.str());
       }
     }
     else
 #endif
     if (!r.isLinked (auxid)) {
       r.copy (auxid, cont, index(), *ocont, oindex, 1);
     }
   }
  
   for (SG::auxid_t auxid : m_container->getWritableAuxIDs()) {
     if (!other_ids.test (auxid)) {
       r.clear (auxid, cont, index(), 1);
     }
   }
 }

◆ e() [1/2]

double xAOD::CaloCluster_v1::e ( ) const

virtual

The total energy of the particle.

Implements xAOD::IParticle.

Definition at line 265 of file CaloCluster_v1.cxx.

                                   {
     return e(m_signalState);
    }

◆ e() [2/2]

double xAOD::CaloCluster_v1::e ( const State s ) const

energy with a given signal state

Return eta for a specific signal state.

Parameters

s	The desired signal state.

Definition at line 167 of file CaloCluster_v1.cxx.

   {
     switch (s) {
     case CALIBRATED:
       return calE();
       break;
     case UNCALIBRATED:
       return rawE();
       break;
     case ALTCALIBRATED:
       return altE();
       break;
     default:
       return 0;
     }
   }

◆ end() [1/2]

iterator xAOD::CaloCluster_v1::end ( )

inline

Definition at line 832 of file CaloCluster_v1.h.

832 { return cell_end(); }

◆ end() [2/2]

const_iterator xAOD::CaloCluster_v1::end ( ) const

inline

Definition at line 828 of file CaloCluster_v1.h.

828 { return cell_cend(); }

◆ energy_max()

float xAOD::CaloCluster_v1::energy_max ( const CaloSample sampling ) const

Retrieve maximum cell energy in given sampling.

Definition at line 556 of file CaloCluster_v1.cxx.

                                                                   {
     static const Accessor< std::vector <float > > emaxAcc("emax_sampl");
     if (!emaxAcc.isAvailable( *this )){
       return 0.0;
     }
       return getSamplVarFromAcc(emaxAcc,sampling,0.0); //Return energy 0 in case of failure (eg. sampling not set)
   }

◆ energyBE()

float xAOD::CaloCluster_v1::energyBE ( const unsigned layer ) const

Get the energy in one layer of the EM Calo.

Parameters

layer Layer between 0 (Presampler) and 3 (Back)

Returns: energy Works for both, barrel and endcap

Definition at line 623 of file CaloCluster_v1.cxx.

                                                             {
     static const Accessor< std::vector <float > > eAcc("e_sampl");
     return CaloClusterDetails::energyBE(sample,m_samplingPattern,eAcc(*this));
   }

◆ eSample()

float xAOD::CaloCluster_v1::eSample ( const CaloSample sampling ) const

Definition at line 514 of file CaloCluster_v1.cxx.

                                                            {
     static const Accessor< std::vector <float > > eAcc("e_sampl");
     return getSamplVarFromAcc(eAcc,sampling,0.0); //Return energy 0 in case of failure (eg. sampling not set)
   }

◆ et()

double xAOD::CaloCluster_v1::et ( ) const

inline

Definition at line 859 of file CaloCluster_v1.h.

                                           {
     if (this->m() == 0) {
       return this->pt();
     }
  
       return this->p4().Et();
   }

◆ eta() [1/2]

double xAOD::CaloCluster_v1::eta ( ) const

virtual

The pseudorapidity ( $\eta$ ) of the particle.

Implements xAOD::IParticle.

Definition at line 251 of file CaloCluster_v1.cxx.

   {
     return eta (m_signalState);
   }

◆ eta() [2/2]

double xAOD::CaloCluster_v1::eta ( const State s ) const

eta with a given signal state

Return eta for a specific signal state.

Parameters

s	The desired signal state.

Definition at line 188 of file CaloCluster_v1.cxx.

   {
     switch (s) {
     case CALIBRATED:
       return calEta();
       break;
     case UNCALIBRATED:
       return rawEta();
       break;
     case ALTCALIBRATED:
       return altEta();
       break;
     default:
       return -999;
     }
   }

◆ eta0()

flt_t xAOD::CaloCluster_v1::eta0 ( ) const

Returns raw $\eta$ of cluster seed.

◆ etaBE()

float xAOD::CaloCluster_v1::etaBE ( const unsigned layer ) const

Get the eta in one layer of the EM Calo.

Parameters

layer Layer between 0 (Presampler) and 3 (Back)

Returns: energy Works for both, barrel and endcap

Definition at line 628 of file CaloCluster_v1.cxx.

                                                          {
     static const Accessor< std::vector <float > > eAcc("e_sampl");
     static const Accessor< std::vector <float > > etaAcc("eta_sampl");
     return CaloClusterDetails::etaBE(sample,m_samplingPattern,eAcc(*this),etaAcc(*this));
   }

◆ etamax()

float xAOD::CaloCluster_v1::etamax ( const CaloSample sampling ) const

Retrieve $\eta$ of cell with maximum energy in given sampling.

Definition at line 569 of file CaloCluster_v1.cxx.

                                                               {
     static const Accessor< std::vector <float > > etamaxAcc("etamax_sampl");
     if (!etamaxAcc.isAvailable( *this )){
       return -999;
     }
       return getSamplVarFromAcc(etamaxAcc,sampling);
   }

◆ etaSample()

float xAOD::CaloCluster_v1::etaSample ( const CaloSample sampling ) const

Retrieve barycenter $\eta$ in a given sample.

Definition at line 525 of file CaloCluster_v1.cxx.

                                                                  {
     static const Accessor< std::vector <float > > etaAcc("eta_sampl");
     if (!etaAcc.isAvailable( *this )){
       return -999;
     }
  
       return getSamplVarFromAcc(etaAcc,sampling);
   }

◆ etasize()

float xAOD::CaloCluster_v1::etasize ( const CaloSample sampling ) const

Returns cluster size in $\eta$ for a given sampling.

Definition at line 596 of file CaloCluster_v1.cxx.

                                                                {
     static const Accessor< std::vector <float > > etasizeAcc("etasize_sampl");
     if (!etasizeAcc.isAvailable( *this )){
       return -999;
     }
     return getSamplVarFromAcc(etasizeAcc, sampling);
   }

◆ extractLowerCount()

template<class UNSIGNED >

UNSIGNED xAOD::CaloCluster_v1::extractLowerCount ( ncells_store_t::value_type cdata ) const

inlineprivate

extract lower cell count from data

Definition at line 696 of file CaloCluster_v1.h.

◆ extractUpperCount()

template<class UNSIGNED >

UNSIGNED xAOD::CaloCluster_v1::extractUpperCount ( ncells_store_t::value_type cdata ) const

inlineprivate

extract upper cell count from data

Definition at line 697 of file CaloCluster_v1.h.

◆ genvecP4() [1/2]

CaloCluster_v1::GenVecFourMom_t xAOD::CaloCluster_v1::genvecP4 ( ) const

The full 4-momentum of the particle : GenVector type.

Definition at line 457 of file CaloCluster_v1.cxx.

                                                                {
     return genvecP4(m_signalState);
   }

◆ genvecP4() [2/2]

CaloCluster_v1::GenVecFourMom_t xAOD::CaloCluster_v1::genvecP4 ( const State s ) const

The full 4-momentum of the particle : GenVector type.

Definition at line 445 of file CaloCluster_v1.cxx.

                                                                                           {
     switch (s) {
     case CALIBRATED:
       return GenVecFourMom_t(pt(s),calEta(),calPhi(),calM());
     case UNCALIBRATED:
       return GenVecFourMom_t(pt(s),rawEta(),rawPhi(), rawM());
     case ALTCALIBRATED:
       return GenVecFourMom_t(pt(s),altEta(),altPhi(), altM());
     default:
       return GenVecFourMom_t();
     }
   }

◆ getAuxIDs()

const SG::auxid_set_t & SG::AuxElement::getAuxIDs ( ) const

inherited

Return a set of identifiers for existing data items for this object.

If this object has a private or standalone store, then information from that will be returned. Otherwise, if this element is part of a container, then information for the container will be returned. Otherwise, return an empty set.

Definition at line 355 of file AuxElement.cxx.

 {
 #ifdef ATHCONTAINERS_R21_COMPAT
   if (havePrivateData())
     return m_container->getConstStore()->getAuxIDs();
   if (container())
     return container()->getAuxIDs();
   static const SG::auxid_set_t null_set;
   return null_set;
 #else
   return ConstAuxElement::getAuxIDs();
 #endif
 }

◆ getCellLinks()

const CaloClusterCellLink * xAOD::CaloCluster_v1::getCellLinks ( ) const

Get a pointer to the CaloClusterCellLink object (const version)

Returns: ptr to CaloClusterCellLink obj, NULL if no valid link

Definition at line 859 of file CaloCluster_v1.cxx.

   {
     if (m_cellLinks) {
       return m_cellLinks.get();
     }
     static const Accessor<ElementLink<CaloClusterCellLinkContainer> > accCellLinks("CellLink");
     if (!accCellLinks.isAvailable(*this)){
       return nullptr;
     }
  
     const ElementLink<CaloClusterCellLinkContainer>& el=accCellLinks(*this);
     if (el.isValid()){
       return *el;
     }
  
       return nullptr;
   }

◆ getClusterEtaSize()

unsigned int xAOD::CaloCluster_v1::getClusterEtaSize ( ) const

Get eta size from cluster size.

Definition at line 777 of file CaloCluster_v1.cxx.

                                                       {
     const unsigned clustersize=clusterSize();
     unsigned int size = 0;
     if(clustersize==SW_55ele ||
        clustersize==SW_55gam ||
        clustersize==SW_55Econv){
       size = 5;
     }else if(clustersize==SW_35ele ||
          clustersize==SW_37ele ||
          clustersize==SW_35gam ||
          clustersize==SW_37gam ||
          clustersize==SW_35Econv ||
          clustersize==SW_37Econv){
       size = 3;
     }else if(clustersize==SW_7_11){
       size = 7;
     }
  
     return size;
  
   }

◆ getClusterPhiSize()

unsigned int xAOD::CaloCluster_v1::getClusterPhiSize ( ) const

Get phi size from cluster size.

Definition at line 799 of file CaloCluster_v1.cxx.

                                                       {
     const ClusterSize clustersize=clusterSize();
     unsigned int size = 0;
     if(clustersize==SW_55ele ||
        clustersize==SW_55gam ||
        clustersize==SW_55Econv ||
        clustersize==SW_35ele ||
        clustersize==SW_35gam ||
        clustersize==SW_35Econv){
       size = 5;
     }else if(
          clustersize==SW_37ele ||
          clustersize==SW_37gam ||
          clustersize==SW_37Econv){
       size = 7;
     }else if(clustersize==SW_7_11){
       size = 11;
     }
     return size;
   }

◆ getConstStore()

const SG::IConstAuxStore * SG::AuxElement::getConstStore ( ) const

inherited

Return the current store, as a const interface.

This will be non-zero if either a const or non-const store is associated with this object. This will fetch either a private or standalone store.

Definition at line 304 of file AuxElement.cxx.

 {
   if (havePrivateData()) {
     return m_container->getConstStore();
   }
   return 0;
 }

◆ getDecorIDs()

const SG::auxid_set_t & SG::AuxElement::getDecorIDs ( ) const

inherited

Return a set of identifiers for decorations for this object.

   If this object has a private or standalone store, then information
   from that will be returned.  Otherwise, if this element
   is part of a container, then information for the container
   will be returned.  Otherwise, return an empty set.

Definition at line 378 of file AuxElement.cxx.

 {
 #ifdef ATHCONTAINERS_R21_COMPAT
   if (havePrivateData())
     return m_container->getConstStore()->getDecorIDs();
   if (container())
     return container()->getDecorIDs();
   static const SG::auxid_set_t null_set;
   return null_set;
 #else
   return ConstAuxElement::getDecorIDs();
 #endif
 }

◆ getMomentValue()

double xAOD::CaloCluster_v1::getMomentValue ( CaloCluster_v1::MomentType type ) const

inline

Retrieve individual moment - no check for existance! Returns -999 on error.

Definition at line 897 of file CaloCluster_v1.h.

                                                                                    {
     double value=-999;
     (void)this->retrieveMoment(type,value);
     return value;
   }

◆ getNumberCellsInSampling()

template<class CDATA >

bool xAOD::CaloCluster_v1::getNumberCellsInSampling ( CDATA & cdata ) const

inline

Get number of cells for all sampling layer.

This returns the number of cells in all sampling layers covered by the cluster, in a basic data type (c.f. retrieveMoment, which returns the internally used data store type) defined by the client. Only the inclucive number of cells per sampling are considered.

Definition at line 430 of file CaloCluster_v1.h.

                                                        {
        ncells_store_t clist;
        if ( !retrieveMoment(NCELL_SAMPLING,clist) ) { return false; }
        cdata.clear(); cdata.reserve(clist.size());
        for ( auto cn : clist ) { cdata.push_back(extractLowerCount<typename CDATA::value_type>(cn)); }
        return true;
      }

◆ getOwnCellLinks()

CaloClusterCellLink* xAOD::CaloCluster_v1::getOwnCellLinks ( )

inline

Get a pointer to the owned CaloClusterCellLink object (non-const version)

Returns: ptr to CaloClusterCellLink obj, NULL if no valid owned cell links.

Definition at line 765 of file CaloCluster_v1.h.

                                             {
        return m_cellLinks.get();
      }

◆ getSamplVarFromAcc()

float xAOD::CaloCluster_v1::getSamplVarFromAcc	(	const Accessor< std::vector< float > > &	acc,
		const CaloSample	sampling,
		const float	errorvalue = `CaloClusterDetails::defaultErrorValue`
	)		const

private

Definition at line 494 of file CaloCluster_v1.cxx.

                                                                                                                                               {
     return CaloClusterDetails::getSamplVar(sampling,m_samplingPattern,acc(*this),errorvalue);
   }

◆ getSisterCluster()

const CaloCluster_v1 * xAOD::CaloCluster_v1::getSisterCluster ( ) const

Get a pointer to a 'sister' cluster (eg the non-calibrated counterpart)

Definition at line 911 of file CaloCluster_v1.cxx.

                                                                {
     static const Accessor< ElementLink< xAOD::CaloClusterContainer_v1 > > accSisterCluster("SisterCluster");
     if (!accSisterCluster.isAvailable(*this)){
       return nullptr;
     }
     const ElementLink<CaloClusterContainer_v1>& el = accSisterCluster(*this);
     if (el.isValid()) {
       return *el;
     }
       return nullptr;
   }

◆ getSisterClusterLink()

const ElementLink< xAOD::CaloClusterContainer_v1 > & xAOD::CaloCluster_v1::getSisterClusterLink ( ) const

Get a link to a 'sister' cluster (eg the non-calibrated counterpart)

Definition at line 923 of file CaloCluster_v1.cxx.

                                                                                              {
     static const Accessor< ElementLink< xAOD::CaloClusterContainer_v1 > > accSisterCluster("SisterCluster");
     static const ElementLink<xAOD::CaloClusterContainer_v1> empty;
     if (!accSisterCluster.isAvailable(*this)){
       return empty;
     }
     return accSisterCluster(*this);
   }

◆ getStore()

SG::IAuxStore * SG::AuxElement::getStore ( ) const

inherited

Return the current store, as a non-const interface.

This will be non-zero if a non-const store is associated with this object. This will fetch either a private or standalone store.

Definition at line 319 of file AuxElement.cxx.

 {
   if (havePrivateData()) {
 #ifdef ATHCONTAINERS_R21_COMPAT
     SG::AuxVectorData* container_nc ATLAS_THREAD_SAFE = m_container;
 #else
     SG::AuxVectorData* container_nc ATLAS_THREAD_SAFE = const_cast<SG::AuxVectorData*>(container());
 #endif
     return container_nc->getStore();
   }
   return 0;
 }

◆ hadPrivateData()

bool SG::IAuxElement::hadPrivateData ( ) const

protectedinherited

True if this element had private data before it was added to its current container.

◆ hasNonConstStore()

bool SG::AuxElement::hasNonConstStore ( ) const

inherited

Return true if this object has an associated non-const store.

This will be true for either a private or standalone store.

Definition at line 411 of file AuxElement.cxx.

 {
   if (havePrivateData())
     return m_container->hasNonConstStore();
   return false;
 }

◆ hasSampling()

bool xAOD::CaloCluster_v1::hasSampling ( const CaloSample s ) const

inline

Checks if certain smapling contributes to cluster.

Definition at line 882 of file CaloCluster_v1.h.

                                                                   {
     return CaloClusterDetails::hasSampling(s,m_samplingPattern);
   }

◆ hasStore()

bool SG::AuxElement::hasStore ( ) const

inherited

Return true if this object has an associated store.

This will be true for either a private or standalone store.

Definition at line 398 of file AuxElement.cxx.

 {
   if (havePrivateData())
     return m_container->hasStore();
   return false;
 }

◆ havePrivateData()

bool SG::IAuxElement::havePrivateData ( ) const

protectedinherited

True if this element currently has private data.

◆ inBarrel()

bool xAOD::CaloCluster_v1::inBarrel ( ) const

inline

Returns true if at least one clustered cell in the barrel.

Definition at line 887 of file CaloCluster_v1.h.

                                              {
        return (m_samplingPattern & CaloSampling::barrelPattern());
   }

◆ index() [1/2]

size_t SG::IAuxElement::index ( ) const

inherited

Return the index of this element within its container.

◆ index() [2/2]

size_t SG::IAuxElement::index

inherited

Return the index of this element within its container.

Inherited from IAuxElement.

◆ inEndcap()

bool xAOD::CaloCluster_v1::inEndcap ( ) const

inline

Returns true if at least one clustered cell in the endcap.

Definition at line 892 of file CaloCluster_v1.h.

                                              {
     return (m_samplingPattern & CaloSampling::endcapPattern());
   }

◆ insertMoment() [1/2]

void xAOD::CaloCluster_v1::insertMoment	(	MomentType	type,
		const ncells_store_t &	values
	)

Insert number of cells/sampling moment (non-scalar)

Warning: Due to the store complexity, clients should use the xAOD::CaloCluster_v1::setNumberCellsInSampling method.

Definition at line 713 of file CaloCluster_v1.cxx.

                                                                                   {  
     const Accessor<ncells_store_t>* acc = momentContainerAccessorV1(type);
     // only implemented for one moment
     if ( acc != nullptr ) { (*acc)(*this) = values; }
   }

◆ insertMoment() [2/2]

void xAOD::CaloCluster_v1::insertMoment	(	MomentType	type,
		double	value
	)

Definition at line 708 of file CaloCluster_v1.cxx.

                                                                    {
     const Accessor<float>* acc = momentAccessorV1(type); 
     if ( acc != nullptr ) { (*acc)(*this) = value; } // new protection needed non-scalar moment type!
   }

◆ isAvailable()

template<class T >

XAOD_AUXDATA_DEPRECATED bool xAOD::IParticle::isAvailable	(	const std::string &	name,
		const std::string &	clsname = `""`
	)		const

inlineinherited

Check if a user property is available for reading or not.

This function should be used to check if a user property which may or may not exist, is set on the object.

Parameters

name	Name of the auxiliary variable
clsname	The name of the associated class. May be blank

Returns: Whether the decoration exists or not

Definition at line 135 of file Event/xAOD/xAODBase/xAODBase/IParticle.h.

                                                               {
  
          return SG::ConstAccessor< T >(name, clsname).isAvailable(*this);
       }

◆ isAvailableWritable() [1/2]

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED bool SG::AuxElement::isAvailableWritable	(	const std::string &	name,
		const std::string &	clsname = `""`
	)

inherited

Check if an aux variable is available for writing.

Parameters

name	Name of the aux variable.
clsname	The name of the associated class. May be blank.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

◆ isAvailableWritable() [2/2]

template<class T >

XAOD_AUXDATA_DEPRECATED bool xAOD::IParticle::isAvailableWritable	(	const std::string &	name,
		const std::string &	clsname = `""`
	)		const

inlineinherited

Check if a user property is available for writing or not.

This function can be used to check whether it will be possible to set a user property on the object.

Parameters

name	Name of the auxiliary variable
clsname	The name of the associated class. May be blank

Returns: Whether the decoration is possible to set

Definition at line 152 of file Event/xAOD/xAODBase/xAODBase/IParticle.h.

                                                                       {
  
          return SG::Accessor< T >(name, clsname).isAvailableWritable(*this);
       }

◆ isAvailableWritableAsDecoration()

template<class T , class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED bool SG::AuxElement::isAvailableWritableAsDecoration	(	const std::string &	name,
		const std::string &	clsname = `""`
	)		const

inherited

Check if an aux variable is available for writing as a decoration.

Parameters

name	Name of the aux variable.
clsname	The name of the associated class. May be blank.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

◆ lowerCellCountBound()

template<class UNSIGNED >

UNSIGNED xAOD::CaloCluster_v1::lowerCellCountBound ( ) const

inlineprivate

lower value boundary for cell count

Definition at line 702 of file CaloCluster_v1.h.

◆ m() [1/2]

double xAOD::CaloCluster_v1::m ( ) const

virtual

The invariant mass of the particle.

Implements xAOD::IParticle.

Definition at line 261 of file CaloCluster_v1.cxx.

                                  {
     return m(m_signalState);
    }

◆ m() [2/2]

double xAOD::CaloCluster_v1::m ( const State s ) const

m with a given signal state

Return m for a specific signal state.

Parameters

s	The desired signal state.

Definition at line 230 of file CaloCluster_v1.cxx.

                                              {
     switch (s) {
     case CALIBRATED:
       return calM();
       break;
     case UNCALIBRATED:
       return rawM();
       break;
     case ALTCALIBRATED:
       return altM();
       break;
     default:
       return -999;
       }
    }

◆ makePrivateStore() [1/3]

void SG::AuxElement::makePrivateStore ( )

inherited

Create a new (empty) private store for this object.

ExcBadPrivateStore will be thrown if this object is already associated with a store.

Definition at line 192 of file AuxElement.cxx.

 {
   if (m_container) {
     throw SG::ExcBadPrivateStore ("store already exists");
   }
  
   m_container = new SG::AuxElementPrivateData;
   IAuxElement::setIndex (0);
   IAuxElement::setHavePrivateData();
 }

◆ makePrivateStore() [2/3]

template<class U1 >

void SG::AuxElement::makePrivateStore	(	const U1 &	other,
		bool	warnUnlocked = `false`
	)

inherited

Create a new private store for this object and copy aux data.

Parameters

other	The object from which aux data should be copied.
warnUnlocked	If true, then warn when we skip unlocked decorations.

ExcBadPrivateStore will be thrown if this object is already associated with a store.

If other is an object that has aux data, then those data will be copied; otherwise, nothing will be done.

◆ makePrivateStore() [3/3]

template<class U1 >

void SG::AuxElement::makePrivateStore	(	const U1 *	other,
		bool	warnUnlocked = `false`
	)

inherited

Create a new private store for this object and copy aux data.

Parameters

other	The object from which aux data should be copied.
warnUnlocked	If true, then warn when we skip unlocked decorations.

ExcBadPrivateStore will be thrown if this object is already associated with a store.

If other is an object that has aux data, then those data will be copied; otherwise, nothing will be done.

◆ makePrivateStore1() [1/2]

void SG::AuxElement::makePrivateStore1	(	const AuxElement *	other,
		bool	warnUnlocked
	)

privateinherited

Create a new private store for this object and copy aux data.

Parameters

other	The object from which aux data should be copied.
warnUnlocked	If true, then warn when we skip unlocked decorations.

ExcBadPrivateStore will be thrown if this object is already associated with a store.

This overload handles the case where other does have aux data.

Definition at line 565 of file AuxElement.cxx.

 {
   makePrivateStore();
   if (other)
     this->copyAux (*other, warnUnlocked);
 }

◆ makePrivateStore1() [2/2]

void SG::AuxElement::makePrivateStore1	(	const void *	other,
		bool	warnUnlocked
	)

privateinherited

Create a new private store for this object and copy aux data.

Parameters

other	The object from which aux data should be copied.
warnUnlocked	If true, then warn when we skip unlocked decorations.

ExcBadPrivateStore will be thrown if this object is already associated with a store.

This overload handles the case where other does not have aux data.

◆ noPrivateData()

bool SG::IAuxElement::noPrivateData ( ) const

protectedinherited

True if this element has no private data.

◆ nSamples()

unsigned xAOD::CaloCluster_v1::nSamples ( ) const

inline

Definition at line 876 of file CaloCluster_v1.h.

                                                  {
     const uint32_t pattern=samplingPattern();
     return  std::popcount(pattern);
   }

◆ numberCells()

int xAOD::CaloCluster_v1::numberCells ( ) const

Return total number of cells in cluster.

This method sums up the number of cells in all samplings. This should be identical to CaloCluster_v1::size() for clusters which still have all included cells linked.

Returns: Number of cells in cluster (> 0) for clusters that have the number of cells in sampling moment NCELL_SAMPLING set. In case this moment is not available, 0 is returned.

Definition at line 772 of file CaloCluster_v1.cxx.

                                         { 
     std::vector<int> ncells; 
     return getNumberCellsInSampling<std::vector<int> >(ncells) ? std::accumulate(ncells.begin(),ncells.end(),0) : 0; 
   }

◆ numberCellsInSampling()

int xAOD::CaloCluster_v1::numberCellsInSampling	(	const CaloSample	samp,
		bool	isInnerWheel = `false`
	)		const

Returns number of cells in given sampling.

This method returns the number of cells in a given sampling. All cells with $E \neq 0$ are counted, independent of the signal quality. Due to the strong reduction of the readout granularity of the electromagnmetic endcaps for $|\eta| > 2.5$ the returned number of cells in EME2 can be customized for clusters spanning this boundary. By default (isInnerWheel=false ) the number of all cells in EME2 is returned (inclusive count, consistent with the behaviour for all other samplings). For isInnerWheel=true the number of EME2 cells in the inner wheel are returned.

Parameters

samp	sampling id
isInnerWheel	returns number of cells in small wheel (for `EME2` only)

Definition at line 756 of file CaloCluster_v1.cxx.

                                                                                                { 
     const Accessor<ncells_store_t>* acc = momentContainerAccessorV1(NCELL_SAMPLING); 
     //
     if ( acc != nullptr && acc->isAvailable(*this) ) { 
       size_t idx((size_t)samp); 
       return ( idx < (*acc)(*this).size() )             // valid sampling 
     ? isInnerWheel                                  // check if inner wheel cell count is requested
     ? extractUpperCount<int>((*acc)(*this)[idx])
     : extractLowerCount<int>((*acc)(*this)[idx])
     : 0; 
     } else { 
       return 0;
     }
   }

◆ operator=()

CaloCluster_v1 & xAOD::CaloCluster_v1::operator= ( const xAOD::CaloCluster_v1 & other )

Assignment operator.

Definition at line 53 of file CaloCluster_v1.cxx.

                                                                            {
     if (this == &other) {
       return *this;
     }
  
     SG::AuxElement::operator=( other ); //Call assignment operator of base-class
     m_recoStatus=other.m_recoStatus;
     setSignalState(other.signalState());
     m_samplingPattern=other.m_samplingPattern;
     m_secondTime = other.m_secondTime;
  
 #if !(defined(SIMULATIONBASE) || defined(XAOD_ANALYSIS))
      const CaloClusterCellLink* links=other.getCellLinks();
      if (links) {
        this->addCellLink(std::make_unique<CaloClusterCellLink>(*links));
      }
      static const Accessor<ElementLink<CaloClusterCellLinkContainer> > accCellLinks("CellLink");
      if (accCellLinks.isAvailable(*this)) { //In case an element link was copied by  SG::AuxElement::operator=, invalidate it
        accCellLinks(*this).reset();
      } //end if have element link to CaloClusterCellLink
 #endif // not defined(SIMULATIONBASE) || defined(XAOD_ANALYSIS)
      return *this;
   }

◆ p4() [1/2]

CaloCluster_v1::FourMom_t xAOD::CaloCluster_v1::p4 ( ) const

virtual

The full 4-momentum of the particle.

Implements xAOD::IParticle.

Definition at line 465 of file CaloCluster_v1.cxx.

                                                    {
     return p4(m_signalState);
   }

◆ p4() [2/2]

CaloCluster_v1::FourMom_t xAOD::CaloCluster_v1::p4 ( const State s ) const

Definition at line 470 of file CaloCluster_v1.cxx.

                                                                                 {
     CaloCluster_v1::FourMom_t p4;
     switch(s) {
     case CALIBRATED:
       p4.SetPtEtaPhiM(pt(s),calEta(),calPhi(),calM());
       break;
     case UNCALIBRATED:
       p4.SetPtEtaPhiM(pt(s),rawEta(),rawPhi(), rawM());
       break;
     case ALTCALIBRATED:
       p4.SetPtEtaPhiM(pt(s),altEta(),altPhi(), altM());
       break;
     default:
       break;
     }
     return p4;
   }

◆ phi() [1/2]

double xAOD::CaloCluster_v1::phi ( ) const

virtual

The azimuthal angle ( $\phi$ ) of the particle.

Implements xAOD::IParticle.

Definition at line 256 of file CaloCluster_v1.cxx.

   {
     return phi (m_signalState);
   }

◆ phi() [2/2]

double xAOD::CaloCluster_v1::phi ( const State s ) const

phi with a given signal state

Return phi for a specific signal state.

Parameters

s	The desired signal state.

Definition at line 210 of file CaloCluster_v1.cxx.

   {
     switch (s) {
     case CALIBRATED:
       return calPhi();
       break;
     case UNCALIBRATED:
       return rawPhi();
       break;
     case ALTCALIBRATED:
       return altPhi();
       break;
     default:
       return -999;
     }
   }

◆ phi0()

flt_t xAOD::CaloCluster_v1::phi0 ( ) const

Returns raw $\phi$ of cluster seed.

◆ phiBE()

float xAOD::CaloCluster_v1::phiBE ( const unsigned layer ) const

Get the phi in one layer of the EM Calo.

Parameters

layer Layer between 0 (Presampler) and 3 (Back)

Returns: energy Works for both, barrel and endcap

Definition at line 634 of file CaloCluster_v1.cxx.

                                                         {
     if (sample>3) {return -999;}
     const CaloSample barrelSample=(CaloSample)(CaloSampling::PreSamplerB+sample);
     const CaloSample endcapSample=(CaloSample)(CaloSampling::PreSamplerE+sample);
     const bool haveBarrel=this->hasSampling(barrelSample);
     const bool haveEndcap=this->hasSampling(endcapSample);
     if (haveBarrel && haveEndcap) {
       //cluster spans barren and endcap
        float eBarrel=eSample(barrelSample);  //Check for errorcode? Should not happen...
        float eEndcap=eSample(endcapSample);
        float eSum=eBarrel+eEndcap;
        float phiBarrel=phiSample(barrelSample);
        float phiEndcap=phiSample(endcapSample);
        if (eSum != 0.0) {
      if ((eBarrel > 0 && eEndcap > 0) || (eBarrel < 0 && eEndcap < 0)) {
        float phiSum = eSum * phiBarrel + eEndcap * CaloPhiRange::diff(phiEndcap, phiBarrel);
        return CaloPhiRange::fix(phiSum / eSum);
      } else if (eBarrel > 0)
        return phiBarrel;
      else
        return phiEndcap;
        }
        // energy==0 case, should never happen
        return CaloPhiRange::fix(0.5 * (phiBarrel + phiEndcap));
     }
     if  (haveBarrel) {
       return phiSample(barrelSample);
     }
     if (haveEndcap) {
       return phiSample(endcapSample);
     }
  
     //Should never reach this point ...
     return -999;
   }

◆ phimax()

float xAOD::CaloCluster_v1::phimax ( const CaloSample sampling ) const

Retrieve $\varphi$ of cell with maximum energy in given sampling.

Definition at line 582 of file CaloCluster_v1.cxx.

                                                               {
     static const Accessor< std::vector <float > > phimaxAcc("phimax_sampl");
     if (!phimaxAcc.isAvailable( *this )){
       return -999;
     }
       return getSamplVarFromAcc(phimaxAcc,sampling);
   }

◆ phiSample()

float xAOD::CaloCluster_v1::phiSample ( const CaloSample sampling ) const

Retrieve barycenter $\varphi$ in a given sample.

Definition at line 540 of file CaloCluster_v1.cxx.

                                                                  {
     static const Accessor< std::vector <float > > phiAcc("phi_sampl");
     if (!phiAcc.isAvailable( *this )){
       return -999;
     }
  
       return getSamplVarFromAcc(phiAcc,sampling);
   }

◆ phisize()

float xAOD::CaloCluster_v1::phisize ( const CaloSample sampling ) const

Returns cluster size in $\varphi$ for a given sampling.

Definition at line 609 of file CaloCluster_v1.cxx.

                                                                {
     static const Accessor< std::vector <float > > phisizeAcc("phisize_sampl");
     if (!phisizeAcc.isAvailable( *this )){
       return -999;
     }
       return getSamplVarFromAcc(phisizeAcc,sampling);
   }

◆ pt() [1/2]

double xAOD::CaloCluster_v1::pt ( ) const

virtual

The transverse momentum ( $p_T$ ) of the particle (negative for negative-energy clusters)

Implements xAOD::IParticle.

Definition at line 247 of file CaloCluster_v1.cxx.

                                   {
     return pt(m_signalState);
   }

◆ pt() [2/2]

double xAOD::CaloCluster_v1::pt ( const State s ) const

pt with a given signal state

Notice that this function is very slow for calorimeter clusters, so it should be called as few times as possible.

Returns: The transverse momentum of the cluster

Definition at line 121 of file CaloCluster_v1.cxx.

                                                {
     // Calculate the momentum of the object:
     double theE = 0;
     double theM = 0;
     switch (s) {
     case CALIBRATED:
       theE=calE();
       theM=calM();
       break;
     case UNCALIBRATED:
       theE=rawE();
       theM=rawM();
       break;
     case ALTCALIBRATED:
       theE=altE();
       theM=altM();
       break;
     default:
       break;
     }
  
     double p = 0.0;
     if( std::abs( theM ) < 0.00001 ) {
       p = theE;
     } else {
       p = std::sqrt( theE * theE - theM * theM );
       if( theE < 0 ) {
         p = -p;
       }
     }
  
     // Calculate sinTh:
     double aEta = std::abs( eta(s) );
     if( aEta > 710.0 ) {
       aEta = 710.0;
     }
     const double sinTh = 1.0 / std::cosh( aEta );
  
     // Calculate pT from these two:
     return p * sinTh;
   }

◆ rapidity()

double xAOD::CaloCluster_v1::rapidity ( ) const

virtual

The true rapidity (y) of the particle.

Implements xAOD::IParticle.

Definition at line 461 of file CaloCluster_v1.cxx.

                                         {
     return genvecP4().Rapidity();
   }

◆ rawE()

flt_t xAOD::CaloCluster_v1::rawE ( ) const

◆ rawEta()

flt_t xAOD::CaloCluster_v1::rawEta ( ) const

Get $\eta$ in signal state UNCALIBRATED.

◆ rawM()

flt_t xAOD::CaloCluster_v1::rawM ( ) const

Get mass in signal state UNCALIBRATED.

◆ rawPhi()

flt_t xAOD::CaloCluster_v1::rawPhi ( ) const

Get $\phi$ in signal state UNCALIBRATED.

◆ recoStatus() [1/2]

CaloRecoStatus& xAOD::CaloCluster_v1::recoStatus ( )

inline

Accesssor to CaloRecoStatus (non-const)

Returns: Reference to the CaloRecoStatus of this cluster

Definition at line 843 of file CaloCluster_v1.h.

843 {return m_recoStatus;}

◆ recoStatus() [2/2]

const CaloRecoStatus& xAOD::CaloCluster_v1::recoStatus ( ) const

inline

Accesssor to CaloRecoStatus (const)

Returns: const reference to the CaloRecoStatus of this cluster

Definition at line 848 of file CaloCluster_v1.h.

848 {return m_recoStatus;}

◆ releasePrivateStore()

void SG::AuxElement::releasePrivateStore ( )

inherited

Release and free any private store associated with this object.

ExcBadPrivateStore will be thrown if this object does not have a private store.

Definition at line 210 of file AuxElement.cxx.

 {
   if (hadPrivateData()) {
     // We had a private store, but it was released because this object
     // was added to a container.  Just forget about it.
     IAuxElement::setNoPrivateData();
     return;
   }
  
   if (!havePrivateData() ||
       !m_container ||
       typeid(*m_container) != typeid(AuxElementPrivateData))
   {
     throw SG::ExcBadPrivateStore ("no private store exists");
   }
  
   IAuxElement::setIndex (0);
   IAuxElement::setNoPrivateData();
   delete m_container;
   m_container = 0;
 }

◆ releasePrivateStoreForDtor()

void SG::AuxElement::releasePrivateStoreForDtor ( )

privateinherited

Out-of-line portion of destructor.

Delete a private store if we have one.

Definition at line 441 of file AuxElement.cxx.

 {
 #ifdef ATHCONTAINERS_R21_COMPAT
   if (havePrivateData()) {
     delete m_container;
   }
 #else
   ConstAuxElement::releasePrivateStoreForDtor();
 #endif
 }

◆ removeCell()

bool xAOD::CaloCluster_v1::removeCell ( const CaloCell * ptr )

Method to remove a cell to the cluster (slow!) (Beware: Kinematics not updated!)

Parameters

index Index of the cell in the CaloCelLContainer

Returns: true on success, false if the cell or the CaloCellLinkContainer is not found A more efficient way to remove cells is to use the iterator fucnctionality of the linked CaloCellLink object and use the remove(iterator) method from there.

Definition at line 877 of file CaloCluster_v1.cxx.

                                                              {
     //1. Get a ptr to the CaloClusterCellLink
     CaloClusterCellLink* cccl=getOwnCellLinks();
     if (!cccl){
       return false; // No link found (expected for TopoClusters in xAOD files)
     }
     // 2. Remove cell
     return cccl->removeCell(ptrToDelete);
   }

◆ retrieveMoment() [1/2]

bool xAOD::CaloCluster_v1::retrieveMoment	(	MomentType	type,
		double &	value
	)		const

Retrieve individual moment.

Definition at line 692 of file CaloCluster_v1.cxx.

                                                                             {
  
       // Get the moment accessor:
       const Accessor< float >* acc = momentAccessorV1( type );
       if (!acc){
         return false;
       }
       // Check if the moment is available:
       if( ! acc->isAvailable( *this ) ) {
          return false;
       }
       // Retrieve the moment:
       value = ( *acc )( *this );
       return true;
    }

◆ retrieveMoment() [2/2]

bool xAOD::CaloCluster_v1::retrieveMoment	(	MomentType	type,
		ncells_store_t &	values
	)		const

Retrieve non-scalar moments.

Warning: Due to the store complexity, clients should use the xAOD::CaloCluster_v1::numberCellsInSampling method.

Definition at line 719 of file CaloCluster_v1.cxx.

                                                                                      { 
     const Accessor<ncells_store_t>* acc = momentContainerAccessorV1(type); 
     // only known moments of this type
     if ( acc == nullptr || !acc->isAvailable(*this)  ) { return false; }
     // retrieve data
     values = (*acc)(*this); 
     return true; 
   }

◆ reweightCell()

void xAOD::CaloCluster_v1::reweightCell	(	cell_iterator	it,
		const double	weight
	)

inline

Method to reweight a cell in the cluster (Beware: Kinematics not updated!)

Parameters

it	Non-const cell-iterator
weight	The new weight

Definition at line 838 of file CaloCluster_v1.h.

838 {it.reweight(weight);}

◆ samplingPattern()

unsigned xAOD::CaloCluster_v1::samplingPattern ( ) const

inline

Access to sampling pattern (one bit per sampling) (Method may be removed later)

Definition at line 867 of file CaloCluster_v1.h.

                                                         {
     return m_samplingPattern;
   }

◆ sampVarIdx()

unsigned xAOD::CaloCluster_v1::sampVarIdx ( const CaloSample ) const

inlineprivate

Definition at line 871 of file CaloCluster_v1.h.

                                                                                    {
     return CaloClusterDetails::sampVarIdx(s,m_samplingPattern);
   }

◆ secondTime()

CaloCluster_v1::flt_t xAOD::CaloCluster_v1::secondTime ( ) const

Access second moment of cell timing distribution.

For clusters read from persistent storage, this method returns the value stored for the SECOND_TIME moment.

Return values

0	if (1) moment is not available, (2) the cluster time could not be calculated, or (3) the cluster has only one cell or all cells have exactly the same time.

Definition at line 941 of file CaloCluster_v1.cxx.

                                                        {
     if ( m_secondTime < 0. ) { 
       double stime(0.); return this->retrieveMoment(SECOND_TIME,stime) ? stime : 0.; 
     } else { 
       return m_secondTime; 
     }
   }

◆ setAltE()

void xAOD::CaloCluster_v1::setAltE ( const CaloCluster_v1::flt_t value )

Set Energy for signal state ALTCALIBRATED.

Definition at line 328 of file CaloCluster_v1.cxx.

                                                               {
     static const Accessor<CaloCluster_v1::flt_t> accAltE("altE");
     accAltE(*this)=value;
   }

◆ setAltEta()

void xAOD::CaloCluster_v1::setAltEta ( const CaloCluster_v1::flt_t value )

Set $\eta$ for signal state ALTCALIBRATED.

Definition at line 333 of file CaloCluster_v1.cxx.

                                                                 {
     static const Accessor<CaloCluster_v1::flt_t> accAltEta("altEta");
     accAltEta(*this)=value;
   }

◆ setAltM()

void xAOD::CaloCluster_v1::setAltM ( const CaloCluster_v1::flt_t value )

Set mass for singal state ALTCALIBRATED.

Definition at line 343 of file CaloCluster_v1.cxx.

                                                               {
     static const Accessor<CaloCluster_v1::flt_t> accAltM("altM");
     accAltM(*this)=value;
   }

◆ setAltPhi()

void xAOD::CaloCluster_v1::setAltPhi ( const CaloCluster_v1::flt_t value )

Set $\phi$ for signal state ALTCALIBRATED.

Definition at line 338 of file CaloCluster_v1.cxx.

                                                                 {
     static const Accessor<CaloCluster_v1::flt_t> accAltPhi("altPhi");
     accAltPhi(*this)=value;
   }

◆ setBadChannelList()

void xAOD::CaloCluster_v1::setBadChannelList ( const CaloClusterBadChannelList & bcl )

Definition at line 274 of file CaloCluster_v1.cxx.

                                                                              {
     static const Accessor<xAOD::CaloClusterBadChannelList> accBCL("BadChannelList");
     accBCL(*this)=bcl;
  }

◆ setCalE()

void xAOD::CaloCluster_v1::setCalE ( const CaloCluster_v1::flt_t value )

Set Energy for signal state CALIBRATED.

Definition at line 306 of file CaloCluster_v1.cxx.

                                                               {
     static const Accessor<CaloCluster_v1::flt_t> accCalE("calE");
     accCalE(*this)=value;
   }

◆ setCalEta()

void xAOD::CaloCluster_v1::setCalEta ( const CaloCluster_v1::flt_t value )

Set $\eta$ for signal state CALIBRATED.

Definition at line 311 of file CaloCluster_v1.cxx.

                                                                 {
     static const Accessor<CaloCluster_v1::flt_t> accCalEta("calEta");
     accCalEta(*this)=value;
   }

◆ setCalM()

void xAOD::CaloCluster_v1::setCalM ( const CaloCluster_v1::flt_t value )

Set mass for singal state CALIBRATED.

Definition at line 321 of file CaloCluster_v1.cxx.

                                                               {
     static const Accessor<CaloCluster_v1::flt_t> accCalM("calM");
     accCalM(*this)=value;
   }

◆ setCalPhi()

void xAOD::CaloCluster_v1::setCalPhi ( const CaloCluster_v1::flt_t value )

Set $\phi$ for signal state CALIBRATED.

Definition at line 316 of file CaloCluster_v1.cxx.

                                                                 {
     static const Accessor<CaloCluster_v1::flt_t> accCalPhi("calPhi");
     accCalPhi(*this)=value;
   }

◆ setClusterSize()

void xAOD::CaloCluster_v1::setClusterSize ( const ClusterSize )

Get cluster size.

Definition at line 369 of file CaloCluster_v1.cxx.

                                                                    {
     static const Accessor<unsigned> acc("clusterSize");
     acc(*this)=sc;
   }

◆ setConstStore()

void SG::AuxElement::setConstStore ( const SG::IConstAuxStore * store )

inherited

Synonym for setStore with IConstAuxStore.

Parameters

store The new store.

◆ setE()

void xAOD::CaloCluster_v1::setE ( CaloCluster_v1::flt_t theE )

Definition at line 375 of file CaloCluster_v1.cxx.

                                                     {
     switch (m_signalState) {
     case CALIBRATED:
       return setCalE(theE);
       break;
     case UNCALIBRATED:
       return setRawE(theE);
        break;
      case ALTCALIBRATED:
        return setAltE(theE);
        break;
      default:
        break;
      }
      }

◆ setEmax()

bool xAOD::CaloCluster_v1::setEmax	(	const CaloSample	sampling,
		const float	eMax
	)

Set the Energy of the cell with the highest energy in a particular sampling.

Definition at line 564 of file CaloCluster_v1.cxx.

                                                                            {
     static const Accessor< std::vector <float > > emaxAcc("emax_sampl");
     return setSamplVarFromAcc(emaxAcc,sampling,eMax);
   }

◆ setEnergy()

bool xAOD::CaloCluster_v1::setEnergy	(	const CaloSample	sampling,
		const float	e
	)

Set energy for a given sampling. Returns false if the sample isn't part of the cluster.

Definition at line 519 of file CaloCluster_v1.cxx.

                                                                                  {
     static const Accessor< std::vector <float > > eAcc("e_sampl");
     return setSamplVarFromAcc(eAcc,sampling,theEnergy);
   }

◆ setEta() [1/2]

bool xAOD::CaloCluster_v1::setEta	(	const CaloSample	sampling,
		const float	eta
	)

Set $\eta$ in a given sampling. Returns false if the sample isn't part of the cluster.

Definition at line 534 of file CaloCluster_v1.cxx.

                                                                         {
     static const Accessor< std::vector <float > > etaAcc("eta_sampl");
     return setSamplVarFromAcc(etaAcc,sampling,eta);
    }

◆ setEta() [2/2]

void xAOD::CaloCluster_v1::setEta ( CaloCluster_v1::flt_t theEta )

Set Eta for the current signal state.

Definition at line 391 of file CaloCluster_v1.cxx.

                                                         {
     switch (m_signalState) {
     case CALIBRATED:
       return setCalEta(theEta);
       break;
     case UNCALIBRATED:
       return setRawEta(theEta);
        break;
      case ALTCALIBRATED:
        return setAltEta(theEta);
        break;
      default:
        break;
      }
      }

◆ setEta0()

void xAOD::CaloCluster_v1::setEta0 ( flt_t )

◆ setEtamax()

bool xAOD::CaloCluster_v1::setEtamax	(	const CaloSample	sampling,
		const float	etaMax
	)

Set the eta of the cell with the highest energy in a particular sampling.

Definition at line 577 of file CaloCluster_v1.cxx.

                                                                                {
     static const Accessor< std::vector <float > > etamaxAcc("etamax_sampl");
     return setSamplVarFromAcc(etamaxAcc,sampling,etaMax);
   }

◆ setEtasize()

bool xAOD::CaloCluster_v1::setEtasize	(	const CaloSample	sampling,
		const float	etaSize
	)

Set the cluster size in $\varphi$ for a given sampling.

Definition at line 604 of file CaloCluster_v1.cxx.

                                                                                  {
     static const Accessor< std::vector <float > > etasizeAcc("etasize_sampl");
     return setSamplVarFromAcc(etasizeAcc,sampling,etaSize);
   }

◆ setHadPrivateData()

void SG::IAuxElement::setHadPrivateData ( )

privateinherited

Record that this element used to have private data.

◆ setHavePrivateData()

void SG::IAuxElement::setHavePrivateData ( )

privateinherited

Record that this element currently has private data.

◆ setIndex()

void SG::AuxElement::setIndex	(	size_t	index,
		SG::AuxVectorData *	container
	)

privateinherited

Set the index/container for this element.

Parameters

index	The index of this object within the container.
container	The container holding this object. May be null if this object is being removed from a container.

Usually this simply sets the index and container members of this object. However, in the case where this object has an associated private store, then we need to deal with releasing the store if the object is being added to a container, or making a new store if the object is being removed from a container.

◆ setIndexPrivate()

bool SG::AuxElement::setIndexPrivate	(	size_t	index,
		SG::AuxVectorData *	container
	)

privateinherited

Set the index/container for this element.

Parameters

index	The index of this object within the container.
container	The container holding this object. May be null if this object is being removed from a container.

This is called from setIndex when we have a private store to deal with.

Definition at line 505 of file AuxElement.cxx.

 {
 #ifdef ATHCONTAINERS_R21_COMPAT
   if (hadPrivateData()) {
     // We had a private store, but it was released because we were added
     // to a container.
  
     if (container == 0) {
       // We're being moved out of the container.  Make a new private
       // store, copy the data, and switch to it.
       auto privateData = new SG::AuxElementPrivateData;
       AuxElement to (privateData, 0);
       to.copyAux (*this);
       IAuxElement::setIndex (0);
       IAuxElement::setHavePrivateData();
       m_container = privateData;
       return true;
     }
   }
   else if (havePrivateData() &&
            typeid(*m_container) == typeid(AuxElementPrivateData))
   {
     // We currently have a private store.
  
     if (container != 0 && container != m_container) {
       // We're being added to a container.
       // Aux data has already been copied.
       // Release private store.
       IAuxElement::setIndex (index);
       IAuxElement::setHadPrivateData();
       delete m_container;
       m_container = container;
       return false;
     }
   }
   else {
     // We have a standalone store.
     throw SG::ExcBadPrivateStore ("Attempt to add/remove a standalone object "
                                   "from a container.");
   }
  
   IAuxElement::setIndex (index);
   m_container = container;
   return false;
 #else
   return ConstAuxElement::setIndexPrivate (index, container);
 #endif
 }

◆ setLink() [1/2]

bool xAOD::CaloCluster_v1::setLink	(	CaloClusterCellLinkContainer *	CCCL,
		const EventContext &	ctx
	)

Push the CaloClusterCellLink object into the cell-link container and hand-over ownership to it.

Parameters

CCCL	pointer to the CaloClusterCellLinkContainer
EventContext	Explicitly specify the EventContext to use for the ElementLink.

Returns: true on success

Definition at line 841 of file CaloCluster_v1.cxx.

   {
     if (!m_cellLinks || !cccl) {
       return false;
     }
     // The links are now owned by the container
     cccl->push_back(m_cellLinks.release());
     const size_t idx = cccl->size() - 1; // Use index for speed
     static const Accessor<ElementLink<CaloClusterCellLinkContainer>>
       accCellLinks("CellLink");
     const CaloClusterCellLinkContainer& ref = *cccl;
     ElementLink<CaloClusterCellLinkContainer> el(ref, idx, ctx);
     accCellLinks(*this) = el;
     return true;
   }

◆ setLink() [2/2]

bool xAOD::CaloCluster_v1::setLink	(	CaloClusterCellLinkContainer *	CCCL,
		IProxyDict *	sg = `nullptr`
	)

Set up an ElementLink to a CaloClusterCellLink object.

Parameters

CCCL_key	StoreGate key of the CaloClusterCellLinkContainer
index	Index of inside the CaloClusterCellLinkContainer container

Returns: true on success

Push the CaloClusterCellLink object into the cell-link container and hand-over ownership to it

Parameters

CCCL	pointer to the CaloClusterCellLinkContainer
sg	Explicitly specify the store to use for the ElementLink.

Returns: true on success

Definition at line 826 of file CaloCluster_v1.cxx.

   {
     if (!m_cellLinks || !cccl){
       return false;
     }
     cccl->push_back(m_cellLinks.release());//The links are now owned by the container
     const size_t idx=cccl->size()-1; //Use index for speed
     static const Accessor<ElementLink<CaloClusterCellLinkContainer> > accCellLinks("CellLink");
     const CaloClusterCellLinkContainer& ref=*cccl;
     ElementLink<CaloClusterCellLinkContainer> el(ref,idx,sg);
     accCellLinks(*this)=el;
     return true;
   }

◆ setLowerCount()

template<class UNSIGNED >

ncells_store_t::value_type xAOD::CaloCluster_v1::setLowerCount	(	ncells_store_t::value_type	cdata,
		UNSIGNED	clower
	)

inlineprivate

Parameters

clower add lower cell count to data

Definition at line 698 of file CaloCluster_v1.h.

699 { return static_cast<ncells_store_t::value_type>((cdata & 0xff00)|(clower & 0x00ff)); }

◆ setM()

void xAOD::CaloCluster_v1::setM ( CaloCluster_v1::flt_t theM )

Set Mass for the current signal state.

Definition at line 424 of file CaloCluster_v1.cxx.

                                                     {
     switch (m_signalState) {
     case CALIBRATED:
       return setCalM(theM);
       break;
     case UNCALIBRATED:
       return setRawM(theM);
        break;
      case ALTCALIBRATED:
        return setAltM(theM);
        break;
      default:
        break;
      }
      }

◆ setNonConstStore()

void SG::AuxElement::setNonConstStore ( SG::IAuxStore * store )

inherited

Synonym for setStore with IAuxStore.

Parameters

store The new store.

◆ setNoPrivateData()

void SG::IAuxElement::setNoPrivateData ( )

privateinherited

Record that this element does not have private data.

◆ setNumberCellsInSampling()

void xAOD::CaloCluster_v1::setNumberCellsInSampling	(	CaloSampling::CaloSample	samp,
		int	ncells,
		bool	isInnerWheel = `false`
	)

Set the number of cells in a sampling layer.

for debugging only ...

std::vector<std::pair<std::string,float> > CaloCluster_v1::getAllMoments() { std::vector<std::pair<std::string,float> > retval; const SG::auxid_set_t& auxIds=container()->getAuxIDs(); //->getDynamicAuxIDs(); const size_t idx= this->index(); for (auto ai: auxIds) { const std::string& auxName=SG::AuxTypeRegistry::instance().getName(ai); const float v=container()->getData<float>(ai,idx); std::cout << "Index=" <<idx << ", Auxid=" << ai << ", Name=" << auxName << " value=" << v << std::endl; retval.push_back(std::make_pair(auxName,v)); } return retval; }

Definition at line 744 of file CaloCluster_v1.cxx.

                                                                                                         { 
     const Accessor<ncells_store_t>* acc = momentContainerAccessorV1(NCELL_SAMPLING); // should always be valid!
     // cast to cell counter type and limit value range
     ncells_t nc(adjustToRange<int,ncells_t>(ncells)); 
     // check index and extend store if needed
     size_t idx((size_t)samp); 
     if ( idx >= (*acc)(*this).size() ) { (*acc)(*this).resize(idx+1,0); }
     // set counts
     (*acc)(*this)[idx] = isInnerWheel ? setUpperCount<ncells_t>((*acc)(*this)[idx],nc) : setLowerCount<ncells_t>((*acc)(*this)[idx],nc);   
   }

◆ setPhi() [1/2]

bool xAOD::CaloCluster_v1::setPhi	(	const CaloSample	sampling,
		const float	phi
	)

Set $\varphi$ in a given sampling. Returns false if the sample isn't part of the cluster.

Definition at line 549 of file CaloCluster_v1.cxx.

                                                                         {
     static const Accessor< std::vector <float > > phiAcc("phi_sampl");
     return setSamplVarFromAcc(phiAcc,sampling,phi);
   }

◆ setPhi() [2/2]

void xAOD::CaloCluster_v1::setPhi ( CaloCluster_v1::flt_t thePhi )

Set Phi for the current signal state.

Definition at line 407 of file CaloCluster_v1.cxx.

                                                         {
     switch (m_signalState) {
     case CALIBRATED:
       return setCalPhi(thePhi);
       break;
     case UNCALIBRATED:
       return setRawPhi(thePhi);
        break;
      case ALTCALIBRATED:
        return setAltPhi(thePhi);
        break;
      default:
        break;
      }
      }

◆ setPhi0()

void xAOD::CaloCluster_v1::setPhi0 ( flt_t )

Set raw $\phi$ of cluster seed.

◆ setPhimax()

bool xAOD::CaloCluster_v1::setPhimax	(	const CaloSample	sampling,
		const float	phiMax
	)

Set the phi of the cell with the highest energy in a particular sampling.

Definition at line 590 of file CaloCluster_v1.cxx.

                                                                                {
     static const Accessor< std::vector <float > > phimaxAcc("phimax_sampl");
     return setSamplVarFromAcc(phimaxAcc,sampling,phiMax);
   }

◆ setPhisize()

bool xAOD::CaloCluster_v1::setPhisize	(	const CaloSample	sampling,
		const float	phiSize
	)

Set the cluster size in $\vareta$ for a given sampling.

Definition at line 617 of file CaloCluster_v1.cxx.

                                                                                  {
     static const Accessor< std::vector <float > > phisizeAcc("phisize_sampl");
     return setSamplVarFromAcc(phisizeAcc,sampling,phiSize);
   }

◆ setRawE()

void xAOD::CaloCluster_v1::setRawE ( const CaloCluster_v1::flt_t value )

Set Energy for signal state UNCALIBRATED.

Definition at line 284 of file CaloCluster_v1.cxx.

                                                               {
     static const Accessor<CaloCluster_v1::flt_t> accRawE("rawE");
     accRawE(*this)=value;
   }

◆ setRawEta()

void xAOD::CaloCluster_v1::setRawEta ( const CaloCluster_v1::flt_t value )

Set $\eta$ for signal state UNCALIBRATED.

Definition at line 289 of file CaloCluster_v1.cxx.

                                                                 {
     static const Accessor<CaloCluster_v1::flt_t> accRawEta("rawEta");
     accRawEta(*this)=value;
   }

◆ setRawM()

void xAOD::CaloCluster_v1::setRawM ( const CaloCluster_v1::flt_t value )

Set mass for singal state UNCALIBRATED.

Definition at line 299 of file CaloCluster_v1.cxx.

                                                               {
     static const Accessor<CaloCluster_v1::flt_t> accRawM("rawM");
     accRawM(*this)=value;
   }

◆ setRawPhi()

void xAOD::CaloCluster_v1::setRawPhi ( const CaloCluster_v1::flt_t value )

Set $\phi$ for signal state UNCALIBRATED.

Definition at line 294 of file CaloCluster_v1.cxx.

                                                                 {
     static const Accessor<CaloCluster_v1::flt_t> accRawPhi("rawPhi");
     accRawPhi(*this)=value;
   }

◆ setSamplingPattern()

void xAOD::CaloCluster_v1::setSamplingPattern	(	const unsigned	sp,
		const bool	clearSamplingVars = `false`
	)

Set sampling pattern (one bit per sampling.

Definition at line 81 of file CaloCluster_v1.cxx.

                                                                                           {
  
       // Check sampling variables ....
       static const Accessor< std::vector< float > > etaAcc( "eta_sampl" );
       static const Accessor< std::vector< float > > phiAcc( "phi_sampl" );
       static const Accessor< std::vector< float > > eAcc( "e_sampl" );
       static const Accessor< std::vector< float > > emaxAcc( "emax_sampl" );
       static const Accessor< std::vector< float > > etamaxAcc( "etamax_sampl" );
       static const Accessor< std::vector< float > > phimaxAcc( "phimax_sampl" );
       static const Accessor< std::vector< float > > etasizeAcc( "etasize_sampl" );
       static const Accessor< std::vector< float > > phisizeAcc( "phisize_sampl" );
  
       static const std::array< const Accessor< std::vector< float > >*, 8 > allAcc = {
          { &etaAcc, &phiAcc, &eAcc, &emaxAcc, &phimaxAcc, &etamaxAcc, &etasizeAcc,
            &phisizeAcc } };
       for( const auto *a : allAcc ) {
          if( a->isAvailable( *this ) ) {
            if (!(*a)(*this).empty()) {
              if (clearSamplingVars){
                (*a)(*this).clear();
              }
              else{
                std::cerr << "CaloCluster_v1 ERROR Attempt update sampling "
                          << "pattern while sampling variables are already set!"
                          << std::endl;
              }
           //std::abort();
            }
          }
       }
  
       m_samplingPattern=sp;
    }

◆ setSamplVarFromAcc()

bool xAOD::CaloCluster_v1::setSamplVarFromAcc	(	const Accessor< std::vector< float > > &	acc,
		const CaloSample	sampling,
		const float	value
	)

private

Definition at line 498 of file CaloCluster_v1.cxx.

                                                                                                                                  {
     const unsigned idx=sampVarIdx(sampling);
     std::vector<float>& vec=acc(*this);
     //std::cout << "Set sampling var. Sampling " << sampling << ", index=" << idx << " size=" << vec.size() << std::endl;
     if (idx==CaloSampling::Unknown) {
       std::cout << "ERROR: Sampling #" << sampling << " is not part of this cluster!" << std::endl;
       return false;
     }
  
     if (vec.size()<nSamples())
       vec.resize(nSamples());
     vec[idx]=value;
     return true;
   }

◆ setSecondTime()

void xAOD::CaloCluster_v1::setSecondTime ( CaloCluster_v1::flt_t stime )

Set second moment of cell timing distribution.

Definition at line 939 of file CaloCluster_v1.cxx.

939 { m_secondTime = stime; }

◆ setSignalState()

bool xAOD::CaloCluster_v1::setSignalState ( const State s )

private

Switch signal state.

Definition at line 440 of file CaloCluster_v1.cxx.

                                                              {
     m_signalState=s;
     return true;
   }

◆ setSisterClusterLink()

bool xAOD::CaloCluster_v1::setSisterClusterLink ( const ElementLink< CaloClusterContainer_v1 > & sister )

Set a link to a 'sister' cluster (eg the non-calibrated counterpart)

Definition at line 932 of file CaloCluster_v1.cxx.

   {
     static const Accessor< ElementLink<xAOD::CaloClusterContainer_v1 > > accSisterCluster("SisterCluster");
     accSisterCluster(*this)=sister;
     return true;
   }

◆ setStore() [1/3]

void SG::AuxElement::setStore ( const DataLink< SG::IConstAuxStore > & store )

inherited

Set the store associated with this object.

Parameters

store The new store.

If store is nonzero, this adds a standalone store to the object. The object must not be in a container and must not have a private store. If store is zero, this removes a standalone store.

Parameters

store Link to the new store.

Definition at line 269 of file AuxElement.cxx.

 {
   AuxElementStandaloneData* data = setStore1 (store);
   if (store)
     data->setStore (store);
 }

◆ setStore() [2/3]

void SG::AuxElement::setStore ( const SG::IConstAuxStore * store )

inherited

Set the store associated with this object.

Parameters

store The new store.

If store is nonzero, this adds a standalone store to the object. The object must not be in a container and must not have a private store. If store is zero, this removes a standalone store.

Definition at line 241 of file AuxElement.cxx.

 {
   AuxElementStandaloneData* data = setStore1 (store);
   if (store)
     data->setStore (store);
 }

◆ setStore() [3/3]

void SG::AuxElement::setStore ( SG::IAuxStore * store )

inherited

Set the store associated with this object.

Parameters

store The new store.

If store is nonzero, this adds a standalone store to the object. The object must not be in a container and must not have a private store. If store is zero, this removes a standalone store.

Definition at line 257 of file AuxElement.cxx.

 {
   AuxElementStandaloneData* data = setStore1 (store);
   if (store)
     data->setStore (store);
 }

◆ setStore1()

AuxElementStandaloneData * SG::AuxElement::setStore1 ( const SG::IConstAuxStore * store )

privateinherited

Set the store associated with this object.

Parameters

store The new store.

Helper for setStore. Creates the AuxElementStandaloneData object if needed and returns it.

Parameters

store The new store.

Helper for setStore. Creates the @x AuxElementStandaloneData object if needed and returns it.

Definition at line 461 of file AuxElement.cxx.

 {
   if (store) {
     // Want this object be standalone.
     if (!m_container) {
       // Not in a container (and no private store).  Make a new object.
       AuxElementStandaloneData* data = new AuxElementStandaloneData;
       IAuxElement::setHavePrivateData();
       m_container = data;
       return data;
     }
     if (usingStandaloneStore()) {
       // Standalone --- return existing object.
       return static_cast<AuxElementStandaloneData*> (container());
     }
     // Otherwise, it's an error.
     throw ExcBadPrivateStore ("Attempt to attach a standalone store to an "
                               "object in a container or with a private store.");
   }
  
   else {
     // Getting rid of a standalone store.
     if (usingStandaloneStore()) {
       IAuxElement::setNoPrivateData();
       delete m_container;
       m_container = 0;
     }
     else if (m_container != 0)
       throw ExcBadPrivateStore ("Attempt to remove a standalone store from an "
                                 "object in a container or with a private store.");
     return 0;
   }
 }

◆ setTime()

void xAOD::CaloCluster_v1::setTime ( flt_t )

Set cluster time.

◆ setUpperCount()

template<class UNSIGNED >

ncells_store_t::value_type xAOD::CaloCluster_v1::setUpperCount	(	ncells_store_t::value_type	cdata,
		UNSIGNED	cupper
	)

inlineprivate

Parameters

cupper add upper cell count to data

Definition at line 700 of file CaloCluster_v1.h.

701 { return static_cast<ncells_store_t::value_type>((cdata & 0x00ff)|((cupper & 0x00ff)<<8)); }

◆ signalState()

State xAOD::CaloCluster_v1::signalState ( ) const

inline

Get the current signal state.

Definition at line 636 of file CaloCluster_v1.h.

636 {return m_signalState;}

◆ size()

size_t xAOD::CaloCluster_v1::size ( ) const

size method (forwarded from CaloClusterCellLink obj)

Returns: The number of cells

Definition at line 950 of file CaloCluster_v1.cxx.

                                   {
     const CaloClusterCellLink* cl= getCellLinks();
     if (!cl) return 0;
     return cl->size();
   }

◆ time()

flt_t xAOD::CaloCluster_v1::time ( ) const

Access cluster time.

◆ toPersistent()

void xAOD::CaloCluster_v1::toPersistent ( )

Function preparing the object to be persistified.

This function takes care of preparing (all) the ElementLink(s) in the object to be persistified.

Definition at line 893 of file CaloCluster_v1.cxx.

                                      {
  
 #if !(defined(SIMULATIONBASE) || defined(XAOD_ANALYSIS))
       static const Accessor< ElementLink< CaloClusterCellLinkContainer > >
          accCellLinks( "CellLink" );
       if( accCellLinks.isAvailableWritable( *this ) ) {
          accCellLinks( *this ).toPersistent();
       }
 #endif // not defined(SIMULATIONBASE) || defined(XAOD_ANALYSIS)
  
       static const Accessor< ElementLink< xAOD::CaloClusterContainer_v1 > > accSisterCluster("SisterCluster");
       if( accSisterCluster.isAvailableWritable( *this ) ) {
          accSisterCluster( *this ).toPersistent();
       }
  
       // Return gracefully:
         }

◆ trackIndices()

bool SG::AuxElement::trackIndices ( ) const

inherited

Return true if index tracking is enabled for this object.

Always returns true. Included here to be consistent with AuxVectorBase when standalone objects may be used as template parameters.

◆ type()

Type::ObjectType xAOD::CaloCluster_v1::type ( ) const

virtual

The type of the object as a simple enumeration.

Implements xAOD::IParticle.

Definition at line 489 of file CaloCluster_v1.cxx.

                                             {
     return Type::CaloCluster;
   }

◆ upperCellCountBound()

template<class UNSIGNED >

UNSIGNED xAOD::CaloCluster_v1::upperCellCountBound ( ) const

inlineprivate

upper boundary for cell count

Definition at line 703 of file CaloCluster_v1.h.

◆ usingPrivateStore()

bool SG::AuxElement::usingPrivateStore ( ) const

inherited

Test to see if this object is currently using a private store.

Definition at line 280 of file AuxElement.cxx.

 {
   return havePrivateData() && 
     typeid(*m_container) == typeid(AuxElementPrivateData);
 }

◆ usingStandaloneStore()

bool SG::AuxElement::usingStandaloneStore ( ) const

inherited

Test to see if this object is currently using a standalone store.

Test to see if this object is currently using a private store.

Definition at line 290 of file AuxElement.cxx.

 {
   return havePrivateData() &&
     typeid(*m_container) == typeid(AuxElementStandaloneData);
 }

Friends And Related Function Documentation

◆ ::CaloClusterChangeSignalState

friend class ::CaloClusterChangeSignalState

friend

Definition at line 63 of file CaloCluster_v1.h.

Member Data Documentation

◆ m_cellLinks

std::unique_ptr<CaloClusterCellLink> xAOD::CaloCluster_v1::m_cellLinks

private

Unique ptr to cell links.

For cluster building transient only , holds cells owned by the cluster if non-nullptr

Definition at line 686 of file CaloCluster_v1.h.

◆ m_container

const SG::AuxVectorData* SG::ConstAuxElement::m_container

privateinherited

The container of which this object is an element.

Should be null if this object is not within a container, except that it may also point at a private store.

Definition at line 335 of file AuxElement.h.

◆ m_index

size_t SG::IAuxElement::m_index

privateinherited

The index of this element within its container.

Should be 0 if this object is not within a container.

Definition at line 128 of file IAuxElement.h.

◆ m_privateStoreState

PrivateStoreState SG::IAuxElement::m_privateStoreState

privateinherited

Definition at line 137 of file IAuxElement.h.

◆ m_recoStatus

CaloRecoStatus xAOD::CaloCluster_v1::m_recoStatus

private

Reco status (transient only)

Definition at line 689 of file CaloCluster_v1.h.

◆ m_samplingPattern

unsigned xAOD::CaloCluster_v1::m_samplingPattern

private

bit-pattern describing the calo samplings contributing to this cluster

Definition at line 680 of file CaloCluster_v1.h.

◆ m_secondTime

double xAOD::CaloCluster_v1::m_secondTime = { -1. }

private

Second cell time moment (transient only)

Definition at line 692 of file CaloCluster_v1.h.

◆ m_signalState

State xAOD::CaloCluster_v1::m_signalState

private

Current signal state.

Definition at line 683 of file CaloCluster_v1.h.

◆ supportsThinning

constexpr bool SG::AuxElement::supportsThinning = true

staticconstexprinherited

Mark that this type supports thinning operations.

See AthContainers/supportsThinning.h and AthenaPoolCnvSvc/T_AthenaPoolCnv.h. Helps guide which pool converter template will be used. If false, the default pool converter will be used rather than the aux store-specific one. Ordinary xAOD type should not touch this, but may be overridden in a derived class to handle certain special cases.

Definition at line 959 of file AuxElement.h.

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

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Functions implementing the xAOD::IParticle interface

4Momentum in different signal states

Athena-only methods, used during building stage

Detailed Description

Member Typedef Documentation

◆ Accessor

◆ CaloSample

◆ cell_iterator

◆ const_cell_iterator

◆ const_iterator

◆ ConstAccessor

◆ Decorator

◆ flt_t

◆ FourMom_t

◆ GenVecFourMom_t

◆ iterator

◆ ncells_store_t

◆ ncells_t

◆ TypelessConstAccessor

Member Enumeration Documentation

◆ ClusterSize

◆ MomentType

◆ PrivateStoreState

◆ State

Constructor & Destructor Documentation

◆ CaloCluster_v1() [1/2]

◆ CaloCluster_v1() [2/2]

◆ ~CaloCluster_v1()

Member Function Documentation

◆ addCell()

◆ addCellLink() [1/2]

◆ addCellLink() [2/2]

◆ adjustToRange()

◆ altE()

◆ altEta()

◆ altM()

◆ altPhi()

◆ assign()

◆ auxdata() [1/4]

◆ auxdata() [2/4]

◆ auxdata() [3/4]

◆ auxdata() [4/4]

◆ auxdataConst() [1/2]

◆ auxdataConst() [2/2]

◆ auxdecor() [1/2]

◆ auxdecor() [2/2]

◆ badChannelList()

◆ begin() [1/2]

◆ begin() [2/2]

◆ calE()

◆ calEta()

◆ calM()

◆ calPhi()

◆ cbegin()

◆ cell_begin() [1/2]

◆ cell_begin() [2/2]

◆ cell_cbegin()

◆ cell_cend()

◆ cell_end() [1/2]

◆ cell_end() [2/2]

◆ cend()

◆ clearAux()

◆ clearCache()

◆ clearDecorations()

◆ clearSamplingData()

◆ clusterSize()

◆ container() [1/2]

◆ container() [2/2]

◆ copyAux()

◆ e() [1/2]

◆ e() [2/2]

◆ end() [1/2]