Principal data class for CaloCell clusters. More...

#include <CaloCluster.h>

Inheritance diagram for CaloCluster:

Classes
class	MomentStoreIter
	Internal cell iterator. More...

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 , Unknown = 99 }
	enums to identify different cluster size More...
typedef CaloCompositeCellBase< CaloClusterNavigable >::cell_iterator	cell_iterator
	Iterator on CaloCell s.
typedef CaloSampling::CaloSample	sampling_type
	Sampling indicator.
typedef CaloVariableType::VariableType	variable_type
	Data type indicator.
typedef double	value_type
	Variable value type.
typedef CaloClusterMomentStore	moment_store
	Store type for cluster moments.
typedef moment_store::moment_type	moment_type
	Cluster moment indicator type.
typedef moment_store::moment_value	moment_value
	Cluster moment value type.
typedef moment_store::moment_iterator	moment_iterator_i
	Cluster moment store iterator type.
typedef moment_type	MomentType
typedef double(CaloCluster::*	GET_VALUE) () const
typedef void(CaloCluster::*	SET_VALUE) (double v)
typedef P4SignalState	statename_t
typedef P4SignalState::State	signalstate_t
typedef MomentStoreIter	moment_iterator
	Moment iterator type for CaloCluster clients.
typedef std::vector< CaloClusterBadChannelData >	badChannelList
	Get Bad Channel information.
enum	Kind { P4EETAPHIM , P4IPTCOTTHPHIM , P4PTETAPHIM , P4PXPYPZE , UNKNOWN }
typedef CaloCellLink::cell_iterator	object_iter
	external cell iterator type
typedef CaloClusterLinkTemplate< CaloCellLinkContainer >::link_type	cell_link_type

Public Member Functions
	CaloCluster (double eta0=0, double phi0=0, unsigned int varTypePattern=0x00000000, unsigned int clusterSize=CaloCluster::SW_55ele)
	Constructor.
virtual	~CaloCluster ()
	Destructor.
	CaloCluster (const CaloCluster *pCluster)
	Copy constructor.
	CaloCluster (const CaloCluster &rCluster)
double	getVariable (const variable_type &varType, const sampling_type &samType, bool useLink=true) const
	General sampling variable access.
bool	getVariable (const variable_type &varType, std::vector< double > &varList, bool useLink=true) const
	General access to variables of a given type in all samplings.
bool	setVariable (const variable_type &varType, const sampling_type &samType, const double &varData, bool useLink=false)
	General sampling variable setter.
bool	setVariable (const variable_type &varType, const std::vector< double > &varList, bool useLink=false)
	Set variables of a given type in all samplings at once.
bool	lockVariable (const variable_type &varType)
	Lock variable (protect against future updates)
bool	unlockVariable (const variable_type &varType)
	Unlock variable (remove lock)
bool	isLocked (const variable_type &varType) const
	Check lock status of variable.
bool	isLocked (const unsigned int &bitPattern) const
bool	allLocked () const
	Check if all variables are locked.
virtual CLHEP::HepLorentzVector	hlv () const
	redefine hlv() here to avoid ambiguities
virtual CLHEP::HepLorentzVector	hlv (signalstate_t s) const
	retrieve the 4-momentum at a given signal state
virtual double	e () const
	Retrieve energy independent of signal state.
virtual double	eta () const
	Retrieve eta independent of signal state.
virtual double	phi () const
	Retrieve phi independent of signal state.
virtual double	m () const
	Retrieve mass independent of signal state.
double	e (signalstate_t s) const
	Retrieve energy for a specific signal state.
double	eta (signalstate_t s) const
	Retrieve eta for a specific signal state.
double	phi (signalstate_t s) const
	Retrieve phi for a specific signal state.
double	m (signalstate_t s) const
	Retrieve mass for a specific signal state.
virtual void	setE (double e)
	Set energy.
virtual void	setEta (double eta)
	Set eta.
virtual void	setPhi (double phi)
	Set phi.
virtual void	setM (double m)
	Set mass.
virtual void	set4Mom (const I4Momentum *const pMom)
	Set kinematics from four-vector.
virtual void	set4Mom (const I4Momentum &rMom)
	Set kinematics directly from four-vector.
virtual void	set4Mom (const CLHEP::HepLorentzVector &rVec)
	Set kinematics directly from HLV.
unsigned int	nSamples () const
	Retrieve number of samplings in this cluster.
double	eSample (sampling_type sampling) const
	Retrieve energy in a given sampling.
double	etaSample (sampling_type sampling) const
	Retrieve barycenter \( \eta \) in a given sample.
double	phiSample (sampling_type sampling) const
	Retrieve barycenter \( \varphi \) in a given sample.
void	getEInSamples (std::vector< double > &theEnergies) const
	Retrieve energy for all samplings into a vector.
void	getEtaInSamples (std::vector< double > &theEtas) const
	Retrieve \( \eta \) for all samplings into a vector.
void	getPhiInSamples (std::vector< double > &thePhis) const
	Retrieve \( \varphi \) for all samplings into a vector.
void	setEInSamples (const std::vector< double > &theEnergies)
	Set energy in all samplings from a vector.
void	setEtaInSamples (const std::vector< double > &theEtas)
	Set \( \eta \) in all samplings from a vector.
void	setPhiInSamples (const std::vector< double > &thePhis)
	Set \( \varphi \) in all samplings from a vector.
virtual double	getBasicEnergy () const
	Access basic energy scale signal.
virtual void	setBasicEnergy (double theEnergy)
	Set basic energy scale signal.
double	getTime () const
	Access cluster time.
void	setTime (double theTime)
	Set cluster time.
void	setClusterSize (unsigned int theClusterSize)
	Set cluster size.
unsigned int	getClusterSize () const
	Get cluster size.
unsigned int	getClusterEtaSize () const
unsigned int	getClusterPhiSize () const
void	setenergy (sampling_type sampling, double e)
	Set energy for a given sampling.
void	seteta (sampling_type sampling, double eta)
	Set \( \eta \) in a given sampling.
void	setphi (sampling_type sampling, double phi)
	Set \( \varphi \) in a given sampling.
void	insertMoment (const moment_type &momType, const moment_value &momValue, bool useLink=true)
	Set individual moment.
moment_iterator	beginMoment (bool useLink=true) const
	First iterator on moment store.
moment_iterator	endMoment (bool useLink=true) const
	Last iterator on moment store.
bool	retrieveMoment (const moment_type &momType, moment_value &momValue, bool useLink=true) const
	Retrieve individual moment.
bool	retrieveMoment (const moment_type &momType, double &momData, bool useLink=true) const
moment_value	getMoment (const moment_type &momType, bool useLink=true) const
	Get individual moment.
moment_value	getMoment (const moment_iterator &momIter) const
	Get individual moment.
double	getMomentValue (const moment_type &momType, bool useLink=true) const
	Get moment value.
double	getMomentValue (const moment_iterator &momIter) const
moment_type	getMomentType (const moment_iterator &momIter) const
	Get moment type.
bool	is_valid_sampling (const sampling_type &sampling) const
	Checks if cells from a given sampling in EMB or EMEC (!) are in cluster.
bool	isEMSampling (const sampling_type &theSampling) const
	Checks if cells from a given sampling in EMB and EMEC are in the cluster.
bool	hasSampling (const sampling_type &theSampling) const
	Checks if certain sampling contributes to cluster.
unsigned int	samplingPattern () const
	Get sampling bitmask.
double	eta0 () const
	Returns raw \( \eta \) of cluster seed.
double	phi0 () const
	Returns raw \( \phi \) of cluster seed.
double	etasize (sampling_type sampling) const
	Returns cluster size in \( \eta \) for a given sampling.
double	phisize (sampling_type sampling) const
	Returns cluster size in \( \varphi \) for a given sampling.
void	setetasize (sampling_type sampling, double size)
	Set the cluster size in \( \eta \) for a given sampling.
void	setphisize (sampling_type sampling, double size)
	Set the cluster size in \( \varphi \) for a given sampling.
double	energy_max (sampling_type sampling) const
	Retrieve maximum cell energy in given sampling.
double	etamax (sampling_type sampling) const
	Retrieve \( \eta \) of cell with maximum energy in given sampling.
double	phimax (sampling_type sampling) const
	Retrieve \( \varphi \) of cell with maximum energy in given sampling.
void	setenergymax (sampling_type sampling, double m)
	Set the maximum energy in a given sampling.
void	setetamax (sampling_type sampling, double m)
	Set the \( \eta \) of cell with maximum energy in a given sampling.
void	setphimax (sampling_type sampling, double m)
	Set the \( \varphi \) of cell with maximum energy in a given sampling.
double	etaBE (int sampling) const
	EMB/EMEC combined barycenter \( \eta \).
double	phiBE (int sampling) const
	EMB/EMEC combined barycenter \( \varphi \).
double	energyBE (int sampling) const
	EMB/EMEC combined signal.
bool	inBarrel () const
	Returns true if at least one clustered cell in EMB.
bool	inEndcap () const
	Returns true if at least one clustered cell in EMEC.
void	setBarrel (bool barrel)
	Sets EMB indicator.
void	setEndcap (bool endcap)
	Sets EMEC indicator.
void	addBadChannel (const CaloClusterBadChannelData &badChannel)
	Add Bad channel information.
void	resetBadChannel ()
	Reset Bad channel list.
const badChannelList *	getBadChannel () const
bool	containsBadCells () const
	Check if cluster has any bad channel in it.
void	calculateKine (const bool useweight=true, const bool updateLayers=true)
	Calculate cluster kinematics from contained cells.
signalstate_t	signalState () const
	Retrieve signal state.
signalstate_t	defaultSignalState () const
	Retrieve default signal state.
virtual bool	hasSignalState (signalstate_t s) const
	check if signal state exists for current implementation
virtual bool	isAtSignalState (signalstate_t s) const
	check if we are at the passed state
data_link_type	getMomentStoreLink () const
virtual double	energy () const
	Return energy.
double	energy_nonvirt () const
	Return energy (nonvirtual version)
void	setRecoStatus (const CaloRecoStatus &recStatus)
	Set the reconstruction status.
void	setRecoStatus (const CaloRecoStatus::StatusIndicator &recIndic)
	Set the reconstruction status indicator (recommended)
bool	checkRecoStatus (const CaloRecoStatus::StatusIndicator &recIndic) const
	Check if a given indicator is set.
void	removeRecoStatus (const CaloRecoStatus::StatusIndicator &recIndic)
	Remove a given indicator.
void	removeRecoStatus ()
	Remove all indicators.
const CaloRecoStatus &	getRecoStatus () const
	Retrieve the reconstruction status.
virtual const I4MomentumError *	errors () const
	Access to errors, if available; returns 0 if no errors.
virtual double	px () const
	x component of momentum
virtual double	py () const
	y component of momentum
virtual double	pz () const
	z component of momentum
virtual double	et () const
	transverse energy defined to be e*sin(theta)
virtual double	p () const
	magnitude of 3-momentum.
virtual double	p2 () const
	square of momentum magnitude
virtual double	m2 () const
	mass squared
virtual double	pt () const
	transverse momentum
virtual double	iPt () const
	inverse of transverse momentum
virtual double	rapidity () const
	rapidity
virtual double	cosPhi () const
	cosinus phi
virtual double	sinPhi () const
	sinus phi
virtual double	cotTh () const
	cottan theta
virtual double	cosTh () const
	cosinus theta
virtual double	sinTh () const
	sinus theta
virtual double	tanTh () const
	tan theta
I4Momentum::Kind	kind () const
	tells what kind of P4XYZT this is
virtual std::ostream &	dump (std::ostream &out=std::cout) const
	Print `I4Momentum` content.
void	addCell (const CaloCellContainer pContainer, const CaloCell pCell, double weight, size_t iCell=static_cast< size_t >(-1))
	Add a cell with global kinematic update (slow)
void	addUniqueCell (const CaloCellContainer *theContainer, size_t theIndex, double weight, size_t size_hint=0)
	Add a cell with global kinematic update (fast)
void	addUniqueCellNoKine (const CaloCellContainer *theContainer, size_t theIndex, double weight, size_t size_hint=0)
	Add a cell with no kinematic update (fast)
void	reweightCell (const CaloCell *pCell, double weight)
	Reweight a cell with kinematic update.
void	removeCell (const CaloCell *pCell)
	Remove a cell with kinematic update.
void	removeCells ()
	Remove all cells without kinematic update.
double	getCellWeight (const CaloCell *pCell) const
	Retrieve the kinematic weight of a given cell.
const CaloCellContainer *	getCellContainer (const CaloCell *pCell) const
	Retrieve the pointer to the original cell container for a given cell.
bool	getCellIndex (const CaloCell *pCell, size_t &iCell) const
	Retrieve the index of a given cell in the cell container.
cell_iterator	cell_begin () const
	Retrieve a STL-type begin() iterator for the cell store.
cell_iterator	cell_end () const
	Retrieve a STL-type end() iterator for the cell store.
unsigned int	getNumberOfCells () const
	Return the number of cells in the store.
void	putElement (const CaloCellContainer pContainer, const CaloCell pCell, const double &weight=double(1.))
	add element to the Navigable: use pointer
void	putElement (const CaloCellContainer *pContainer, size_t &iCell, const double &weight=double(1.))
	add element to the Navigable: use element index (direct access!)
void	insertElement (const CaloCellContainer pContainer, const CaloCell pCell, const double &weight=double(1.))
	insert element without checking if already in store: use element pointer
void	insertElement (const CaloCellContainer *pContainer, size_t &iCell, const double &weight=double(1.))
	insert element without checking if already in store: use index
void	insertElement (const CaloCellContainer *pContainer, size_t iCell, const double weight, size_t size_hint)
	same, with a size hint.
void	insertElement (const ElementLink< CaloCellContainer > &el, const double weight, size_t size_hint=0)
	Insert element via ElementLink.
void	reweight (const CaloCell *pCell, const double &weight=double(1.))
	re-weight (overwrite old weight)
void	reweight (const CaloCellContainer *pContainer, size_t &iCell, const double &weight=double(1.))
	re-weight (overwrite old weight)
void	reweight (object_iter &cellIter, const double &weight=double(1.))
	re-weight (overwrite old weight)
bool	remove (const CaloCell *pCell)
	remove object from the Navigable
bool	remove (const CaloCellContainer *pContainer, size_t &iCell)
	remove object from the Navigable
bool	removeAll ()
	remove all objects from the Navigable
bool	contains (const CaloCell *pCell) const
	check if constituent is already there
bool	contains (const CaloCellContainer *pContainer, size_t &iCell) const
	check if constituent is already there
virtual object_iter	begin () const
	begin iterator for public object access
virtual object_iter	end () const
	end iterator for public object access
virtual unsigned int	nCells () const
	size of object access
double	getParameter (const CaloCell *pCell) const
	public container access: relational parameter retrieval
double	getParameter (const CaloCellContainer *pContainer, size_t &iCell) const
	public container access: relational parameter retrieval
double	getParameter (object_iter &cellIter) const
	public container access: relational parameter retrieval
const CaloCellContainer *	getContainer (const CaloCell *pCell) const
	public container access: retrieve Container for given object pointer
const CaloCellContainer *	getContainer (object_iter cellIter) const
	public container access: retrieve Container for given object iterator
bool	getIndex (const CaloCell *pCell, size_t &iCell) const
	get index of child in original container, given a pointer
bool	getIndex (object_iter cellIter, size_t &iCell) const
	get index of child in original container, given an iterator
virtual void	fillToken (INavigationToken &iToken) const
	fill token for navigation
virtual void	fillToken (INavigationToken &iToken, const std::any &rPar) const
	fill token for navigation
virtual bool	isCellLinkValid () const
const cell_link_type &	cellLink () const
	Access to underlying link.
void	resetCellLink (const cell_link_type &cellLink)
virtual AthenaBarCode_t	getAthenaBarCode () const
virtual void	setAthenaBarCode (AthenaBarCode_t id)
virtual bool	hasSameAthenaBarCode (const IAthenaBarCode &obj) const
virtual bool	hasSameAthenaBarCodeExceptVersion (const IAthenaBarCode &obj) const
virtual AthenaBarCodeVersion_t	getVersion () const
virtual void	newVersion ()
virtual void	setVersion (AthenaBarCodeVersion_t newversion)
std::ostream &	dump (std::ostream &out) const
bool	createdInCurrentJob () const
AthenaBarCode_t	getReserveBits () const
void	setReserveBits (AthenaBarCode_t id)

Static Public Member Functions
static void	setDefaultHash (const char *jobid)

Static Public Attributes
static const unsigned short	TotalBits = 64
static const unsigned short	UUIDBits = 32
static const unsigned short	CounterBits = 26
static const unsigned short	VersionBits = 4
static const unsigned short	ReserveBits = 2
static const unsigned short	SUUIDBits = 0
static const unsigned short	SCounterBits = UUIDBits
static const unsigned short	SVersionBits = UUIDBits+CounterBits
static const unsigned short	SReserveBits = UUIDBits+CounterBits+VersionBits
static const AthenaBarCode_t	UNDEFINEDBARCODE = (AthenaBarCode_t)(-1)
static const AthenaBarCode_t	UNDEFINEDVERSION = UNDEFINEDBARCODE

Protected Types
typedef CaloClusterLinkTemplate< CaloShowerContainer >::link_type	data_link_type

Protected Member Functions
virtual void	updateKine (const CaloCell *theCell, double weight)
	Updates cluster kinematics when cell is added.
double	variableBE (const variable_type &theVariable, const int &samplingIndex) const
	Rewrite \( e_{0} \varphi_{0} + e_{1} \varphi_{1} \) as \( \left( e_{0} + e_{1} \right) \varphi_{0} + e_{1} \left( \varphi_{1} - \varphi_{0} \right) \) for \( \varphi \) calculation.
CaloSamplingData *	getDataStore (const variable_type &theVariable, bool useLink=true)
const CaloSamplingData *	getDataStore (const variable_type &theVariable, bool useLink=false) const
CaloClusterMomentStore *	getMomentStore (bool useLink=true)
const CaloClusterMomentStore *	getMomentStore (bool useLink=false) const
const CaloClusterMomentStore *	getMomentStore (const moment_type &theMoment, bool useLink=false) const
CaloClusterMomentStore *	getMomentStore (const moment_type &theMoment, bool useLink=true)
bool	getMomentStorePtrs (const CaloClusterMomentStore &pFirstStore, const CaloClusterMomentStore &pSecndStore, bool useLink) const
bool	setDataLink (CaloShowerContainer *pDataLink)
	Set element link for shower data.
bool	setStores (CaloShower pData, CaloCellLink pLink, bool ownStores=true)
	Setup internal store.
bool	setDataStore (CaloShower *pData, bool ownStores=true)
	Setup data store.
virtual bool	setSignalState (signalstate_t s)
	Sets signal state.
virtual void	resetSignalState ()
	reset the signal state
bool	setDefaultSignalState (signalstate_t s)
	Sets default signal state.
CaloCellLink *	getCellLink ()
const CaloCellLink *	getCellLink () const
bool	setCellLink (CaloCellLinkContainer *pLink)
bool	setLinkStore (CaloCellLink *pLink, bool ownStores=true)
CaloCellLink *	getCellLinkPtr ()
const CaloCellLink *	getCellLinkPtr () const
void	setBits (unsigned short startbit, unsigned short nbits, AthenaBarCode_t id, AthenaBarCode_t &bc) const
AthenaBarCode_t	getBits (unsigned short startbit, unsigned short nbits) const
void	initABC () const

Protected Attributes
CaloSamplingData	m_dataStore
	{\ brief Cached Stores
CaloClusterMomentStore	m_momentStore
	cluster moments
bool	m_ownDataStore
	}
data_link_type	m_dataLink
	{
CaloShower *	m_shower
	}
double	m_basicSignal
	Stores basic energy signal.
double	m_time
	Cluster timing.
unsigned int	m_samplingPattern
	Sampling pattern.
CaloRecoStatus	m_status
	Calorimeter reconstruction status.
double	m_e
double	m_eta
double	m_phi
double	m_m
bool	m_ownLinkStore

Static Protected Attributes
static const double	m_errorValue = -999.
	Internal error return for real numbers.

Private Member Functions
template<class InputIterator>
void	maybeSetVariable (variable_type varType, InputIterator beg, InputIterator end)
	Set variables of a given type in all samplings at once, taking locking into account.
double	getRawE () const
	Access to raw energy.
double	getRawEta () const
	Access to raw eta.
double	getRawPhi () const
	Access to raw phi.
double	getRawM () const
	Access to raw mass.
double	getCalE () const
	Access to calibrated (LC) energy.
double	getCalEta () const
	Access to calibrated (LC) eta.
double	getCalPhi () const
	Access to calibrated (LC) phi.
double	getCalM () const
	Access to calibrated (LC) m.
double	getAltE () const
	Access to calibrated (cell weight) energy.
double	getAltEta () const
	Access to calibrated (cell weight) eta.
double	getAltPhi () const
	Access to calibrated (cell weight) phi.
double	getAltM () const
	Access to calibrated (cell weight) m.
void	setRawE (double e)
	Set raw energy.
void	setRawEta (double eta)
	Set raw eta.
void	setRawPhi (double phi)
	Set raw phi.
void	setRawM (double m)
	Set raw m.
void	setCalE (double e)
	Set calibrated (LC) energy.
void	setCalEta (double eta)
	Set calibrated (LC) eta.
void	setCalPhi (double phi)
	Set calibrated (LC) phi.
void	setCalM (double m)
	Set calibrated (LC) m.
void	setAltE (double e)
	Set calibrated (cell weight) energy.
void	setAltEta (double eta)
	Set calibrated (cell weight) eta.
void	setAltPhi (double phi)
	Set calibrated (cell weight) phi.
void	setAltM (double m)
	Set calibrated (cell weight) m.
bool	setStateRaw ()
	Helper to switch to raw state.
bool	setStateCal ()
	Helper to switch to calibrated (LC) state.
bool	setStateAlt ()
	Helper to switch to calibrated (cell weight) state.
CaloCluster &	operator= (const CaloCluster &)
	Disallow (avoid coverity warning).
AthenaBarCode_t	combineWithUUIDHash (const AthenaBarCode_t &) const
void	setUUIDHash (AthenaBarCode_t uuidhash)
AthenaBarCode_t	hasUUIDHash () const
AthenaBarCode_t	getUUIDHash () const

Static Private Member Functions
static AthenaBarCode_t	hashUUID (const char *)
static AthenaBarCode_t	getDefaultHash (const char *jobid=nullptr)
static AthenaBarCode_t	makeDefaultHash (const char *jobid)

Private Attributes
bool	m_barrel
	Flag is true if at least one cell in EMB.
bool	m_endcap
	Flag is true if at least one cell in EMB.
unsigned int	m_clusterSize
	Cluster size (e.g.
double	m_eta0
	Cluster seed \( \eta \).
double	m_phi0
	Cluster seed \( \varphi \).
double	m_timeNorm
	Stores the normalization for time calculation e.g.
double	m_posNorm
	Stores the normalization e.g.
std::vector< double >	m_posSamNorm
	Stores the normalization e.g.
int	m_nBarrel
	Counter for number of barrel cells with non-zero weight and energy.
int	m_nEndcap
	Counter for number of endcap cells with non-zero weight and energy.
unsigned int	m_lockPattern
	Variable lock pattern.
badChannelList	m_badChannelData
GET_VALUE	m_getE {}
	Pointer to getter functions.
GET_VALUE	m_getEta {}
	Pointer to getter functions.
GET_VALUE	m_getPhi {}
	Pointer to getter functions.
GET_VALUE	m_getM {}
	Pointer to getter functions.
SET_VALUE	m_setE {}
	Pointer to setter functions.
SET_VALUE	m_setEta {}
	Pointer to setter functions.
SET_VALUE	m_setPhi {}
	Pointer to setter functions.
SET_VALUE	m_setM {}
	Pointer to setter functions.
signalstate_t	m_signalState
	Stores actual signal state.
signalstate_t	m_defSigState
	Stores default signal state.
double	m_rawE
	Stores raw signal.
double	m_rawEta
	Stores raw signal.
double	m_rawPhi
	Stores raw signal.
double	m_rawM
	Stores raw signal.
double	m_altE
	Stores calibrated (cell weight) signal.
double	m_altEta
	Stores calibrated (cell weight) signal.
double	m_altPhi
	Stores calibrated (cell weight) signal.
double	m_altM
	Stores calibrated (cell weight) signal.
cell_link_type	m_cellLink
	Local pointer to cell store.
std::atomic< AthenaBarCode_t >	m_barcode

Static Private Attributes
static std::atomic< AthenaBarCode_t >	m_barcodeCounter = 0

Friends
class	CaloClusterStoreHelper
struct	CaloClusterSignalState
class	CaloClusterContainerCnv_p1
class	CaloClusterContainerCnv_p2
class	CaloClusterContainerCnv_p3
class	CaloClusterContainerCnv_p4
class	CaloClusterContainerCnv_p5
class	CaloClusterContainerCnv_p6
class	CaloClusterContainerCnv_p7
class	CaloClusterContainerCnvTest_p6
class	CaloClusterContainerCnvTest_p7

Detailed Description

Principal data class for CaloCell clusters.

Data class for CaloCell clusters

Author: H. Ma hma@b.nosp@m.nl.g.nosp@m.ov (original author); P. Loch loch@.nosp@m.phys.nosp@m.ics.a.nosp@m.rizo.nosp@m.na.ed.nosp@m.u; S. Menke Sven..nosp@m.Menk.nosp@m.e@cer.nosp@m.n.ch; M. Boonekamp Maart.nosp@m.en.B.nosp@m.oonek.nosp@m.amp@.nosp@m.cern..nosp@m.ch

Date: April 1, 2005; July 18, 2005 significant updates in cluster moment handling; September 23, 2005 complete change of underlying store structure; May 1, 2009 third signal state added (PL)

Version: 6

CaloCluster stores a list of CaloCell s with some correlated signal. In all generality this object describes an energy blob inside the calorimeter, with its location completely defined by the cell content. In particular, there is no assumption on any detector view (regular binning in a given coordinate system or similar) needed or used for the cluster description (unlike for CaloTower , for example). In general CaloCluster behaves like a navigable object with the default 4-momentum representation.

Remarks: The links to CaloCell objects are now stored externally in a CaloCellLink object. Also, a configurable set of sampling vaiables can be selected and stored directly in the cluster. The rest will automatically be stored in a associated CaloSamplingData object, which is linked to the cluster via a CaloShower object. Cluster moments are also kept in a split store following the same philosophy. All these features are completely transparent to clients of CaloCluster.

Todo

Definition at line 74 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

Member Typedef Documentation

◆ badChannelList

typedef std::vector<CaloClusterBadChannelData> CaloCluster::badChannelList

Get Bad Channel information.

Definition at line 458 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

◆ cell_iterator

typedef CaloCompositeCellBase<CaloClusterNavigable>::cell_iterator CaloCluster::cell_iterator

Iterator on CaloCell s.

Definition at line 115 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

◆ cell_link_type

typedef CaloClusterLinkTemplate<CaloCellLinkContainer>::link_type CaloClusterNavigable::cell_link_type

inherited

Definition at line 146 of file CaloClusterNavigable.h.

◆ data_link_type

typedef CaloClusterLinkTemplate<CaloShowerContainer>::link_type CaloCluster::data_link_type

protected

Definition at line 473 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

◆ GET_VALUE

typedef double(CaloCluster::* CaloCluster::GET_VALUE) () const

Definition at line 143 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

◆ moment_iterator

typedef MomentStoreIter CaloCluster::moment_iterator

Moment iterator type for CaloCluster clients.

Definition at line 205 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

◆ moment_iterator_i

typedef moment_store::moment_iterator CaloCluster::moment_iterator_i

Cluster moment store iterator type.

Note: This type is only used internally, and can easily change in future implementations. DO NOT USE!

Definition at line 138 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

◆ moment_store

typedef CaloClusterMomentStore CaloCluster::moment_store

Store type for cluster moments.

Definition at line 128 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

◆ moment_type

typedef moment_store::moment_type CaloCluster::moment_type

Cluster moment indicator type.

Definition at line 130 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

◆ moment_value

typedef moment_store::moment_value CaloCluster::moment_value

Cluster moment value type.

Definition at line 132 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

◆ MomentType

typedef moment_type CaloCluster::MomentType

Definition at line 141 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

◆ object_iter

typedef CaloCellLink::cell_iterator CaloClusterNavigable::object_iter

inherited

external cell iterator type

Definition at line 51 of file CaloClusterNavigable.h.

◆ sampling_type

typedef CaloSampling::CaloSample CaloCluster::sampling_type

Sampling indicator.

Definition at line 118 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

◆ SET_VALUE

typedef void(CaloCluster::* CaloCluster::SET_VALUE) (double v)

Definition at line 144 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

◆ signalstate_t

typedef P4SignalState::State CaloCluster::signalstate_t

Definition at line 147 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

◆ statename_t

typedef P4SignalState CaloCluster::statename_t

Definition at line 146 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

◆ value_type

typedef double CaloCluster::value_type

Variable value type.

Definition at line 124 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

◆ variable_type

typedef CaloVariableType::VariableType CaloCluster::variable_type

Data type indicator.

Definition at line 121 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

Member Enumeration Documentation

◆ ClusterSize

enum CaloCluster::ClusterSize

enums to identify different cluster size

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
Unknown

Definition at line 85 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.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,
    Unknown    = 99
  };

◆ Kind

enum I4Momentum::Kind

inherited

Enumerator
P4EETAPHIM
P4IPTCOTTHPHIM
P4PTETAPHIM
P4PXPYPZE
UNKNOWN

Definition at line 33 of file I4Momentum.h.

33{ P4EETAPHIM, P4IPTCOTTHPHIM, P4PTETAPHIM, P4PXPYPZE, UNKNOWN };

I4Momentum::P4PTETAPHIM

@ P4PTETAPHIM

Definition I4Momentum.h:33

I4Momentum::P4EETAPHIM

@ P4EETAPHIM

Definition I4Momentum.h:33

I4Momentum::P4IPTCOTTHPHIM

@ P4IPTCOTTHPHIM

Definition I4Momentum.h:33

I4Momentum::UNKNOWN

@ UNKNOWN

Definition I4Momentum.h:33

I4Momentum::P4PXPYPZE

@ P4PXPYPZE

Definition I4Momentum.h:33

Constructor & Destructor Documentation

◆ CaloCluster() [1/3]

CaloCluster::CaloCluster	(	double	eta0 = 0,
		double	phi0 = 0,
		unsigned int	varTypePattern = 0x00000000,
		unsigned int	clusterSize = CaloCluster::SW_55ele )

Constructor.

Definition at line 73 of file CaloCluster.cxx.

  : CaloCompositeKineBase(),
    CaloCompositeCellBase<CaloClusterNavigable>(),
    m_dataStore(varTypePattern),
    m_ownDataStore(false),
    m_shower(nullptr),
    m_basicSignal(0.),
    m_time(0.),
    m_samplingPattern(0),
    m_barrel (false),
    m_endcap (false),
    m_clusterSize(clusterSize),
    m_eta0 (eta0),
    m_phi0 (phi0),
    m_timeNorm(0.),
    m_posNorm(0.),
    m_posSamNorm(CaloSampling::Unknown,0.),
    m_nBarrel(0),
    m_nEndcap(0),
    m_lockPattern(0x00000000),
    m_rawE(0.),
    m_rawEta(0.),
    m_rawPhi(0.),
    m_rawM(0.),
    m_altE(0.),
    m_altEta(0.),
    m_altPhi(0.),
    m_altM(0.)
{
  this->setDefaultSignalState(statename_t::CALIBRATED);
  m_badChannelData.clear();
}

◆ ~CaloCluster()

CaloCluster::~CaloCluster ( )

virtual

Destructor.

The cluster destructs the associated external data objects CaloCellLink and CaloShower as long as it owns them.

Ownership is lost once these objects have been pushed into their corresponding storable collection. This is checked by the cluster on destruction.

Definition at line 248 of file CaloCluster.cxx.

{
  // If we own the store, the link holds the pointer directly.
  if ( m_ownDataStore ) delete m_dataLink.cachedElement();
}

◆ CaloCluster() [2/3]

CaloCluster::CaloCluster ( const CaloCluster * pCluster )

Copy constructor.

Parameters

pCluster pointer to non-modifiable cluster (origin)

The copy constructor for CaloCluster creates explicit copies of all data members, with the exception of the links to the external data objects. These are only partly copied, meaning the data object itself is copied (new instance), but the container information is NOT copied. The new cluster therefore owns the new external data objects until those are explictely pushed into a container. Then the owenership is transferred to the container.

Definition at line 120 of file CaloCluster.cxx.

  : CaloCompositeKineBase(),
    CaloCompositeCellBase<CaloClusterNavigable>(),
    m_dataStore(pCluster->m_dataStore),
    m_momentStore(pCluster->m_momentStore),
    m_ownDataStore(true),
    m_basicSignal(pCluster->m_basicSignal),
    m_time(pCluster->m_time),
    m_samplingPattern(pCluster->m_samplingPattern),
    m_barrel(pCluster->m_barrel),
    m_endcap(pCluster->m_endcap),
    m_clusterSize(pCluster->m_clusterSize),
    m_eta0(pCluster->m_eta0),
    m_phi0(pCluster->m_phi0),
    m_timeNorm(pCluster->m_timeNorm),
    m_posNorm(pCluster->m_posNorm),
    m_posSamNorm(pCluster->m_posSamNorm),
    m_nBarrel(pCluster->m_nBarrel),
    m_nEndcap(pCluster->m_nEndcap),
    m_lockPattern(pCluster->m_lockPattern),
    m_rawE(pCluster->m_rawE),
    m_rawEta(pCluster->m_rawEta),
    m_rawPhi(pCluster->m_rawPhi),
    m_rawM(pCluster->m_rawM),
    m_altE(pCluster->m_altE),
    m_altEta(pCluster->m_altEta),
    m_altPhi(pCluster->m_altPhi),
    m_altM(pCluster->m_altM)
{
  signalstate_t s = pCluster->m_defSigState;
  if (!this->hasSignalState(s)) s = statename_t::CALIBRATED;
  this->setDefaultSignalState(s);
  this->setSignalState(s);
  // deep copy external data
  bool isExternalShowerThere = false;
  if ( pCluster->m_dataLink.isValid()) {
   if (*(pCluster->m_dataLink) != nullptr) isExternalShowerThere  = true;
  }
  CaloShower* pData = isExternalShowerThere
    ? new CaloShower(*(pCluster->m_dataLink)) : new CaloShower();
  m_shower = pData;
  CaloCellLink* pLink = pCluster->getCellLink() != nullptr ? new CaloCellLink(pCluster->getCellLink()) : new CaloCellLink();
  this->setStores(pData,pLink,
          m_ownDataStore);
  P4EEtaPhiM::setE(pCluster->m_e);
  P4EEtaPhiM::setEta(pCluster->m_eta);
  P4EEtaPhiM::setPhi(pCluster->m_phi);
  P4EEtaPhiM::setM(pCluster->m_m);
  this->setRecoStatus(pCluster->getRecoStatus());
  m_badChannelData.reserve(pCluster->m_badChannelData.size());
  for (unsigned int i=0;i<pCluster->m_badChannelData.size();i++) {
    m_badChannelData.push_back(CaloClusterBadChannelData((pCluster->m_badChannelData)[i]));
  }
}

◆ CaloCluster() [3/3]

CaloCluster::CaloCluster ( const CaloCluster & rCluster )

Definition at line 175 of file CaloCluster.cxx.

  : I4Momentum(rCluster),
    P4EEtaPhiMBase(rCluster),
    INavigable(rCluster),
    IAthenaBarCode(rCluster),
    INavigable4Momentum(rCluster),
    CaloCompositeKineBase(rCluster),
    CaloCompositeCellBase<CaloClusterNavigable>(rCluster),
    ISignalState(),
    m_dataStore(rCluster.m_dataStore),
    m_momentStore(rCluster.m_momentStore),
    m_ownDataStore(true),
    m_basicSignal(rCluster.m_basicSignal),
    m_time(rCluster.m_time),
    m_samplingPattern(rCluster.m_samplingPattern),
    m_barrel(rCluster.m_barrel),
    m_endcap(rCluster.m_endcap),
    m_clusterSize(rCluster.m_clusterSize),
    m_eta0(rCluster.m_eta0),
    m_phi0(rCluster.m_phi0),
    m_timeNorm(rCluster.m_posNorm),
    m_posNorm(rCluster.m_posNorm),
    m_posSamNorm(rCluster.m_posSamNorm),
    m_nBarrel(rCluster.m_nBarrel),
    m_nEndcap(rCluster.m_nEndcap),
    m_lockPattern(rCluster.m_lockPattern),
    m_rawE(rCluster.m_rawE),
    m_rawEta(rCluster.m_rawEta),
    m_rawPhi(rCluster.m_rawPhi),
    m_rawM(rCluster.m_rawM),
    m_altE(rCluster.m_altE),
    m_altEta(rCluster.m_altEta),
    m_altPhi(rCluster.m_altPhi),
    m_altM(rCluster.m_altM)
{
  signalstate_t s = rCluster.m_defSigState;
  if (!this->hasSignalState(s)) s = statename_t::CALIBRATED;
  this->setDefaultSignalState(s);
  this->setSignalState(s);
  // deep copy external data
  bool isExternalShowerThere = false;
  if ( rCluster.m_dataLink.isValid()) {
   if (*(rCluster.m_dataLink) != nullptr) isExternalShowerThere  = true;
  }
  CaloShower* pData = isExternalShowerThere
    ? new CaloShower(*(rCluster.m_dataLink)) : new CaloShower();
  m_shower = pData;
  CaloCellLink* pLink = rCluster.getCellLink() != nullptr ? new CaloCellLink(rCluster.getCellLink()) : new CaloCellLink();
  this->setStores(pData,pLink,
          m_ownDataStore);
  // energy etc may be corrected, so overwrite!
  P4EEtaPhiM::setE(rCluster.m_e);
  P4EEtaPhiM::setEta(rCluster.m_eta);
  P4EEtaPhiM::setPhi(rCluster.m_phi);
  P4EEtaPhiM::setM(rCluster.m_m);
  this->setRecoStatus(rCluster.getRecoStatus());
  m_badChannelData.reserve(rCluster.m_badChannelData.size());
  for (unsigned int i=0;i<rCluster.m_badChannelData.size();i++) {
    m_badChannelData.push_back(CaloClusterBadChannelData((rCluster.m_badChannelData)[i]));
  }
}

Member Function Documentation

◆ addBadChannel()

void CaloCluster::addBadChannel ( const CaloClusterBadChannelData & badChannel )

Add Bad channel information.

Definition at line 1424 of file CaloCluster.cxx.

{
 m_badChannelData.push_back(badChannel);
}

◆ addCell()

void CaloCompositeCellBase< CaloClusterNavigable >::addCell	(	const CaloCellContainer *	pContainer,
		const CaloCell *	pCell,
		double	weight,
		size_t	iCell = static_cast<size_t>(-1) )

inherited

Add a cell with global kinematic update (slow)

Parameters

pContainer	input pointer to a CaloCellContainer (unchanged)
pCell	input pointer to a CaloCell (unchanged)
weight	signal weight asociated with this cell
iCell	input index of the CaloCell in the CaloCellContainer. This may be omitted, but if supplied, a potentially slow search of the CaloCellContainer for the CaloCell may be avoided.

Adding a cell usually changes the global kinematics. The concrete implementation is left to the updateKine method, which needs to be implemented by derived classes.

Adding cells without updating the global kinematics is also possible by using the corresponding putElement method in the Navigable<CaloCellContainer,double> base class.

◆ addUniqueCell()

void CaloCompositeCellBase< CaloClusterNavigable >::addUniqueCell	(	const CaloCellContainer *	theContainer,
		size_t	theIndex,
		double	weight,
		size_t	size_hint = 0 )

inherited

Add a cell with global kinematic update (fast)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

theContainer	input pointer to a CaloCellContainer (unchanged)
theIndex	input index of CaloCell in CaloCellConatiner (unchanged)
weight	signal weight asociated with this cell
size_hint	if non-zero, a hint about many cells are likely to be in the cluster.

Faster as index is already available, but has to rely on client to provide the correct (and valid) index.

The caller also guarantees that the cell is not already in the cluster.

◆ addUniqueCellNoKine()

void CaloCompositeCellBase< CaloClusterNavigable >::addUniqueCellNoKine	(	const CaloCellContainer *	theContainer,
		size_t	theIndex,
		double	weight,
		size_t	size_hint = 0 )

inherited

Add a cell with no kinematic update (fast)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

theContainer	input pointer to a CaloCellContainer (unchanged)
theIndex	input index of CaloCell in CaloCellConatiner (unchanged)
weight	signal weight asociated with this cell
size_hint	if non-zero, a hint about many cells are likely to be in the cluster.

Faster as index is already available, but has to rely on client to provide the correct (and valid) index.

The caller also guarantees that the cell is not already in the cluster.

◆ allLocked()

bool CaloCluster::allLocked ( ) const

inline

Check if all variables are locked.

Definition at line 1289 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

{
  return 
    ( m_lockPattern & CaloVariableType::getAllVariableBits() ) ==
    CaloVariableType::getAllVariableBits();
}

◆ begin()

CaloClusterNavigable::object_iter CaloClusterNavigable::begin ( ) const

inlinevirtualinherited

begin iterator for public object access

Definition at line 303 of file CaloClusterNavigable.h.

{
  return (this->getCellLink())->begin();
}

◆ beginMoment()

CaloCluster::moment_iterator CaloCluster::beginMoment ( bool useLink = true ) const

First iterator on moment store.

Definition at line 1119 of file CaloCluster.cxx.

{
  moment_iterator iMom;
  // get store pointers
  const CaloClusterMomentStore* pFirstMomStore = nullptr;
  const CaloClusterMomentStore* pSecndMomStore = nullptr;
  // try to return valid iterator to first data object...
  if ( this->getMomentStorePtrs(pFirstMomStore,pSecndMomStore,
                useLink) ) //DEBUG,"begin") )
    {
      iMom = moment_iterator(pFirstMomStore->begin(),pFirstMomStore,
                 pSecndMomStore);
    }
  else
    {
      iMom = moment_iterator();
    }
 
  return iMom;
}

◆ calculateKine()

void CaloCluster::calculateKine	(	const bool	useweight = true,
		const bool	updateLayers = true )

Calculate cluster kinematics from contained cells.

Definition at line 736 of file CaloCluster.cxx.

{
  //static CaloPhiRange range;
 
  // update global kinematics
  //
  // for the update of the position the normalization is not a trival
  // thing. The previous implementation used the sum of weighted
  // energies as normalization. This leads to unphysical eta and phi
  // values in case negative energies are added in. The new algorithm
  // takes therefore |E| instead of E which gives the same eta and phi
  // as before for the 2 cases where all cells are negative or all
  // cells are positive. In the mixed case it will give the direction
  // of activity in the calorimeter.
 
  m_posNorm = 0;
  m_nBarrel = 0;
  m_nEndcap = 0;
  m_timeNorm = 0.;
 
  std::fill (m_posSamNorm.begin(), m_posSamNorm.end(), 0);
 
  CellAccum accum (m_posNorm, m_posSamNorm, m_nBarrel, m_nEndcap, m_timeNorm);
  accum.theNewPhi = this->phi();
  if (useweight)
    accumCells (*this, accum, AccumWeight(this));
  else
    accumCells (*this, accum, AccumNoWeight());
 
  if ( m_posNorm != 0. )
  {
    double inorm = 1 / m_posNorm;
    this->setEta(accum.theNewEta * inorm);
    this->setPhi(CaloPhiRange::fix(accum.theNewPhi * inorm));
  }
  else
  {
    this->setEta(0);
    this->setPhi(0);
  }
 
  this->setE(accum.theNewEnergy);
 
  if ( m_timeNorm != 0. )
    this->setTime(accum.theNewTime/m_timeNorm);
  else
    this->setTime(0);
 
  // Check Sampling Variable Updates //
 
  if ( !updateLayers ) return;
  if ( this->allLocked() ) return;
  // update sampling quantities
 
  for(int i=0;i<(int)CaloSampling::Unknown;i++) {
    if ( !accum.PresenceInSample[i] ) continue;
    // check sampling bit
    CaloSampling::CaloSample sam = (CaloSampling::CaloSample)i;
    m_samplingPattern |= CaloSamplingHelper::getSamplingBit(sam);
    if ( m_posSamNorm[i] != 0 ) {
      double inorm = 1 / m_posSamNorm[i];
      accum.EtaInSample[i] *= inorm;
      accum.PhiInSample[i] = CaloPhiRange::fix (accum.PhiInSample[i] * inorm);
    }
  }
 
#define SETVAR(v, a) maybeSetVariable(v, a, (a)+sizeof(a)/sizeof((a)[0]))
  SETVAR (CaloVariableType::ENERGY,     accum.EnergyInSample);
  SETVAR (CaloVariableType::ETA,        accum.EtaInSample);
  SETVAR (CaloVariableType::PHI,        accum.PhiInSample);
  SETVAR (CaloVariableType::MAX_ENERGY, accum.MaxEnergyInSample);
  SETVAR (CaloVariableType::MAX_ETA,    accum.EtaMaxEnergyInSample);
  SETVAR (CaloVariableType::MAX_PHI,    accum.PhiMaxEnergyInSample);
#undef SETVAR
 
  if ( m_nBarrel < 0 ) m_nBarrel = 0;
  if ( m_nEndcap < 0 ) m_nEndcap = 0;
 
  m_barrel = (m_nBarrel>0);
  m_endcap = (m_nEndcap>0);
}

◆ cell_begin()

cell_iterator CaloCompositeCellBase< CaloClusterNavigable >::cell_begin ( ) const

inherited

Retrieve a STL-type begin() iterator for the cell store.

◆ cell_end()

cell_iterator CaloCompositeCellBase< CaloClusterNavigable >::cell_end ( ) const

inherited

Retrieve a STL-type end() iterator for the cell store.

◆ cellLink()

const cell_link_type & CaloClusterNavigable::cellLink ( ) const

inlineinherited

Access to underlying link.

Definition at line 149 of file CaloClusterNavigable.h.

149{ return m_cellLink; }

CaloClusterNavigable::m_cellLink

cell_link_type m_cellLink

Local pointer to cell store.

Definition CaloClusterNavigable.h:186

◆ checkRecoStatus()

bool CaloCompositeKineBase::checkRecoStatus ( const CaloRecoStatus::StatusIndicator & recIndic ) const

inlineinherited

Check if a given indicator is set.

Definition at line 91 of file CaloCompositeKineBase.h.

93{ return m_status.checkStatus(recIndic); }

CaloCompositeKineBase::m_status

CaloRecoStatus m_status

Calorimeter reconstruction status.

Definition CaloCompositeKineBase.h:58

◆ combineWithUUIDHash()

AthenaBarCode_t AthenaBarCodeImpl::combineWithUUIDHash ( const AthenaBarCode_t & hash ) const

inlineprivateinherited

Definition at line 119 of file AthenaBarCodeImpl.h.

                                                                     {
  
  AthenaBarCode_t tmp = 0;
  AthenaBarCode_t lowerh = ~tmp >> (TotalBits
                    - UUIDBits);
  AthenaBarCode_t higherh = ~tmp << (UUIDBits);
  
  AthenaBarCode_t lower = m_barcode & lowerh;
  AthenaBarCode_t higher = hash & higherh;
  
  /*
    std::cout << "AthenaBarCodeImpl::combineWithHash::hash=" << std::hex
    << hash << " lower=" << lower << " higher=" << higher << " lowerh="
    << lowerh << " higherh=" << higherh << " barcode=" << (lower
    | higher) << std::endl;
  */
  return lower | higher;
    
}

◆ contains() [1/2]

bool CaloClusterNavigable::contains ( const CaloCell * pCell ) const

inlineinherited

check if constituent is already there

Definition at line 290 of file CaloClusterNavigable.h.

{
  return (this->getCellLink())->contains(pCell);
}

◆ contains() [2/2]

bool CaloClusterNavigable::contains	(	const CaloCellContainer *	pContainer,
		size_t &	iCell ) const

inlineinherited

check if constituent is already there

Definition at line 296 of file CaloClusterNavigable.h.

{
  return (this->getCellLink())->contains(pContainer,iCell);
}

◆ containsBadCells()

bool CaloCluster::containsBadCells ( ) const

inline

Check if cluster has any bad channel in it.

Definition at line 1300 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

                                                {
  return !(this->getBadChannel()->empty());
}

◆ cosPhi()

double P4EEtaPhiMBase::cosPhi ( ) const

virtualinherited

cosinus phi

Implements I4Momentum.

Reimplemented in CaloCell, and CaloVertexedCell.

Definition at line 54 of file P4EEtaPhiMBase.cxx.

{ 
 return std::cos(this->phi());
}

◆ cosTh()

double P4EEtaPhiMBase::cosTh ( ) const

virtualinherited

cosinus theta

Implements I4Momentum.

Reimplemented in CaloCell, and CaloVertexedCell.

Definition at line 82 of file P4EEtaPhiMBase.cxx.

{
 return std::tanh(this->eta());
}

◆ cotTh()

double P4EEtaPhiMBase::cotTh ( ) const

virtualinherited

cottan theta

Implements I4Momentum.

Reimplemented in CaloCell.

Definition at line 77 of file P4EEtaPhiMBase.cxx.

{
 return std::sinh(this->eta());
}

◆ createdInCurrentJob()

bool AthenaBarCodeImpl::createdInCurrentJob ( ) const

inherited

Definition at line 181 of file AthenaBarCodeImpl.cxx.

                                             {
  if (m_barcode==IAthenaBarCode::UNDEFINEDBARCODE) 
    initABC();
 
  //FIXME: it is possible that m_defaultHash is not yet initialized.
  return getUUIDHash() == getDefaultHash();
}

◆ defaultSignalState()

CaloCluster::signalstate_t CaloCluster::defaultSignalState ( ) const

inline

Retrieve default signal state.

Definition at line 862 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

863{ return m_defSigState; }

◆ dump() [1/2]

std::ostream & AthenaBarCodeImpl::dump ( std::ostream & out ) const

inherited

Definition at line 172 of file AthenaBarCodeImpl.cxx.

                                             {
  if (m_barcode==IAthenaBarCode::UNDEFINEDBARCODE) 
    initABC();
 
  out << "\n[AthenaBarCode]= " << std::hex << (m_barcode) << std::dec << std::endl;
  return out;
}

◆ dump() [2/2]

std::ostream & P4EEtaPhiMBase::dump ( std::ostream & out = std::cout ) const

virtualinherited

Print I4Momentum content.

Implements I4Momentum.

Definition at line 159 of file P4EEtaPhiMBase.cxx.

{
 
  std::stringstream outx;
  outx << "[e,eta,phi,m] ="
         << std::right << std::scientific << std::setprecision(8) 
         << std::setw(16) << this->e()
         << std::setw(16) << this->eta()
         << std::setw(16) << this->phi()
         << std::setw(16) << this->m();
 
  out<<outx.str();
  
  return out;
}

◆ e() [1/2]

double CaloCluster::e ( ) const

inlinevirtual

Retrieve energy independent of signal state.

Reimplemented from P4EEtaPhiM.

Definition at line 753 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

754{ return (this->*m_getE)(); }

CaloCluster::m_getE

GET_VALUE m_getE

Pointer to getter functions.

Definition Calorimeter/CaloEvent/CaloEvent/CaloCluster.h:672

◆ e() [2/2]

double CaloCluster::e ( signalstate_t s ) const

inline

Retrieve energy for a specific signal state.

Definition at line 777 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

{
  if (!hasSignalState(s)) return m_errorValue;
  switch (s) {
  case statename_t::CALIBRATED:
    return P4EEtaPhiM::e();
  case statename_t::UNCALIBRATED:
    return m_rawE;
  case statename_t::ALTCALIBRATED:
    return m_altE;
  default:
    return m_errorValue;
  }
}

◆ end()

CaloClusterNavigable::object_iter CaloClusterNavigable::end ( ) const

inlinevirtualinherited

end iterator for public object access

Definition at line 309 of file CaloClusterNavigable.h.

{
  return (this->getCellLink())->end();
}

◆ endMoment()

CaloCluster::moment_iterator CaloCluster::endMoment ( bool useLink = true ) const

Last iterator on moment store.

Definition at line 1141 of file CaloCluster.cxx.

{
  const CaloClusterMomentStore* pFirstMomStore = nullptr;
  const CaloClusterMomentStore* pSecndMomStore = nullptr;
  if ( this->getMomentStorePtrs(pFirstMomStore,pSecndMomStore,useLink) )
                                //DEBUG,"end") )
    {
      CaloClusterMomentStore::moment_iterator lMom =
    pSecndMomStore != nullptr && pSecndMomStore->size() > 0
    ? pSecndMomStore->end()
    : pFirstMomStore->end();
      return moment_iterator(lMom,pFirstMomStore,pSecndMomStore);
    }
  else
    {
      return {};
    }
}

◆ energy()

double CaloCompositeKineBase::energy ( ) const

inlinevirtualinherited

Return energy.

Definition at line 70 of file CaloCompositeKineBase.h.

71{ return this->e(); }

◆ energy_max()

double CaloCluster::energy_max ( sampling_type sampling ) const

inline

Retrieve maximum cell energy in given sampling.

Parameters

sampling sampling indicator

Returns energy of cell with maximum signal in sampling.

Warning: Depreciated. This method should not be used anymore. Use getVariable(CaloVariableType::MAX_ENERGY,...) instead.

Definition at line 1096 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

{
  return this->isEMSampling(sampling)
    ? this->getVariable(CaloVariableType::MAX_ENERGY,sampling,true)
    : double(0);
}

◆ energy_nonvirt()

double CaloCompositeKineBase::energy_nonvirt ( ) const

inlineinherited

Return energy (nonvirtual version)

Definition at line 74 of file CaloCompositeKineBase.h.

75{ return this->m_e; }

◆ energyBE()

double CaloCluster::energyBE ( int sam ) const

inline

EMB/EMEC combined signal.

Parameters

sam	sampling counter

Warning: The sampling input argument refers to the sampling number (first, second, third,...) in the EMB and EMEC. It is not identical to the corresponding CaloSampling::CaloSample indicators in these calorimeters.

Definition at line 1219 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

1220{ return this->variableBE(CaloVariableType::ENERGY,sam); }

CaloCluster::variableBE

double variableBE(const variable_type &theVariable, const int &samplingIndex) const

Rewrite as for calculation.

Definition CaloCluster.cxx:953

◆ errors()

const I4MomentumError * P4EEtaPhiM::errors ( ) const

virtualinherited

Access to errors, if available; returns 0 if no errors.

Reimplemented from P4EEtaPhiMBase.

Definition at line 15 of file P4EEtaPhiM.cxx.

{
  return 0;
}

◆ eSample()

double CaloCluster::eSample ( sampling_type theSampling ) const

inline

Retrieve energy in a given sampling.

Parameters

theSampling sampling indicator

Returns the energy in a given sampling.

Definition at line 975 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

976{ return this->getVariable(CaloVariableType::ENERGY,theSampling,true); }

◆ et()

double P4EEtaPhiMBase::et ( ) const

virtualinherited

transverse energy defined to be e*sin(theta)

Implements I4Momentum.

Reimplemented in CaloCell.

Definition at line 106 of file P4EEtaPhiMBase.cxx.

   {
     return this->e()*this->sinTh();
   }

◆ eta() [1/2]

double CaloCluster::eta ( void ) const

inlinevirtual

Retrieve eta independent of signal state.

Reimplemented from P4EEtaPhiM.

Definition at line 755 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

{
  return (this->*m_getEta)(); 
}

◆ eta() [2/2]

double CaloCluster::eta ( signalstate_t s ) const

inline

Retrieve eta for a specific signal state.

Definition at line 793 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

{
  if (!hasSignalState(s)) return m_errorValue;
  switch (s) {
  case statename_t::CALIBRATED:
    return P4EEtaPhiM::eta();
  case statename_t::UNCALIBRATED:
    return m_rawEta;
  case statename_t::ALTCALIBRATED:
    return m_altEta;
  default:
    return m_errorValue;
  }
}

◆ eta0()

double CaloCluster::eta0 ( ) const

inline

Returns raw \( \eta \) of cluster seed.

Returns seed \( \eta \) for cluster.

Definition at line 1180 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

1180{ return m_eta0; }

◆ etaBE()

double CaloCluster::etaBE ( int sam ) const

inline

EMB/EMEC combined barycenter \( \eta \).

Parameters

sam	sampling counter

Warning: The sam input argument refers to the sampling number (first, second, third,...) in the EMB and EMEC. It is not identical to the corresponding CaloSampling::CaloSample indicators in these calorimeters.

Definition at line 1199 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

1200{ return this->variableBE(CaloVariableType::ETA,sam); }

◆ etamax()

double CaloCluster::etamax ( sampling_type sampling ) const

inline

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

Parameters

sampling sampling indicator

Returns \( \eta \) of cell with maximum signal in sampling.

Warning: Depreciated. This method should not be used anymore. Use getVariable(CaloVariableType::MAX_ETA,...) instead.

Definition at line 1112 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

{
  return this->isEMSampling(sampling)
    ? this->getVariable(CaloVariableType::MAX_ETA,sampling,true)
    : double(0);
}

◆ etaSample()

double CaloCluster::etaSample ( sampling_type theSampling ) const

inline

Retrieve barycenter \( \eta \) in a given sample.

Parameters

theSampling sampling indicator

Returns \( \eta \) in sampling.

Definition at line 991 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

992{ return this->getVariable(CaloVariableType::ETA,theSampling,true); }

◆ etasize()

double CaloCluster::etasize ( sampling_type sampling ) const

inline

Returns cluster size in \( \eta \) for a given sampling.

Parameters

sampling sampling indicator

Returns eta size \( \Delta\eta \) of cluster in sampling.

Warning: Depreciated. This method should not be used anymore. Use getVariable(CaloVariableType::DELTA_ETA,...) instead.

Definition at line 1148 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

{
  return this->isEMSampling(sampling)
    ? this->getVariable(CaloVariableType::DELTA_ETA,sampling,true)
    : double(0);
}

◆ fillToken() [1/2]

void CaloClusterNavigable::fillToken ( INavigationToken & iToken ) const

inlinevirtualinherited

fill token for navigation

Implements INavigable.

Definition at line 390 of file CaloClusterNavigable.h.

{
  if ( this->getCellLink() )
    (this->getCellLink())->fillToken(iToken);
}

◆ fillToken() [2/2]

void CaloClusterNavigable::fillToken	(	INavigationToken &	iToken,
		const std::any &	rPar ) const

inlinevirtualinherited

fill token for navigation

Implements INavigable.

Definition at line 397 of file CaloClusterNavigable.h.

{
  if ( this->getCellLink() )
    (this->getCellLink())->fillToken(iToken,rPar);
}

◆ getAltE()

double CaloCluster::getAltE ( ) const

private

Access to calibrated (cell weight) energy.

Definition at line 1325 of file CaloCluster.cxx.

1325{ return m_altE; }

◆ getAltEta()

double CaloCluster::getAltEta ( ) const

private

Access to calibrated (cell weight) eta.

Definition at line 1326 of file CaloCluster.cxx.

1326{ return m_altEta; }

◆ getAltM()

double CaloCluster::getAltM ( ) const

private

Access to calibrated (cell weight) m.

Definition at line 1328 of file CaloCluster.cxx.

1328{ return m_altM; }

◆ getAltPhi()

double CaloCluster::getAltPhi ( ) const

private

Access to calibrated (cell weight) phi.

Definition at line 1327 of file CaloCluster.cxx.

1327{ return m_altPhi; }

◆ getAthenaBarCode()

AthenaBarCode_t AthenaBarCodeBase::getAthenaBarCode ( ) const

virtualinherited

Reimplemented from IAthenaBarCode.

Definition at line 22 of file AthenaBarCodeBase.cxx.

{
  return AthenaBarCodeImpl::getAthenaBarCode();
}

◆ getBadChannel()

const CaloCluster::badChannelList * CaloCluster::getBadChannel ( ) const

Definition at line 1434 of file CaloCluster.cxx.

{
 return &m_badChannelData;
}

◆ getBasicEnergy()

double CaloCluster::getBasicEnergy ( ) const

inlinevirtual

Access basic energy scale signal.

Implements CaloCompositeKineBase.

Definition at line 876 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

876{ return m_basicSignal; }

◆ getBits()

AthenaBarCode_t AthenaBarCodeImpl::getBits	(	unsigned short	startbit,
		unsigned short	nbits ) const

protectedinherited

Definition at line 249 of file AthenaBarCodeImpl.cxx.

                                                                              {
 
  AthenaBarCode_t tmp;
  //now m_barcode=aaaaaxxaa;
  tmp = m_barcode << (startbit); //tmp=xxaa00000;
  tmp = tmp >> (TotalBits - nbits); //tmp=0000000xx
 
  return tmp;
}

◆ getCalE()

double CaloCluster::getCalE ( ) const

private

const CaloCellContainer * CaloCompositeCellBase< CaloClusterNavigable >::getCellContainer ( const CaloCell * pCell ) const

inherited

Retrieve the pointer to the original cell container for a given cell.

Parameters

pCell pointer to the cell (unchanged)

Returns 0 if cell not in store.

◆ getCellIndex()

bool CaloCompositeCellBase< CaloClusterNavigable >::getCellIndex	(	const CaloCell *	pCell,
		size_t &	iCell ) const

inherited

Retrieve the index of a given cell in the cell container.

Parameters

pCell	pointer to the cell (unchanged)
iCell	reference to a modifiable index variable

Returns true and a valid index if cell is found in store. If cell is not found, the value of the index is unchanged (typically 0 if initialized properly by client).

Note that the index refers to the index of the cell in the cell container, not the index of the cell in the local store.

◆ getCellLink() [1/2]

CaloCellLink * CaloClusterNavigable::getCellLink ( )

protectedinherited

Definition at line 40 of file CaloClusterNavigable.cxx.

{
  if ( m_ownLinkStore )
    {
      if ( *m_cellLink == nullptr ) m_cellLink.setElement(new CaloCellLink());
      // Ok, because this happens only if we own the pointer.
      CaloCellLink* link ATLAS_THREAD_SAFE = const_cast<CaloCellLink*>(*m_cellLink);
      return link;
    }
  else
    {
      return (CaloCellLink*)nullptr;
    }
 
  // check if local pointer to store
  //  if ( m_cellLinkPointer != 0 ) { return m_cellLinkPointer;}
  // check if linked pointer to store
  //  if ( m_cellLink.isValid() && *m_cellLink != 0 ) 
  //    { 
      // FIXME
  //     CaloCellLink* pLink = const_cast<CaloCellLink*>(*m_cellLink);
  //      return pLink; 
  //    }
  // create a new local store/
  //  m_cellLinkPointer = new CaloCellLink();
  //  return m_cellLinkPointer;
}

◆ getCellLink() [2/2]

const CaloCellLink * CaloClusterNavigable::getCellLink ( ) const

protectedinherited

Definition at line 69 of file CaloClusterNavigable.cxx.

{
  // return *m_cellLink;
 
  //  if ( m_cellLinkPointer != 0 )
  //  {
      //      std::cout << "[CaloClusterNavigable@" << this << "] return "
      //        << "cell link @" << m_cellLinkPointer << std::endl;
      //      return m_cellLinkPointer;
      //    } 
  //  if ( *m_cellLink == 0 )
  //    {
  //      std::cout << "[CaloClusterNavigable@" << this << "] problem with "
  //        << "cell link store, unexpected pointer = "
  //        << *m_cellLink << std::endl;
  //    }
  return m_cellLink.isValid() ? *m_cellLink : nullptr;
}

◆ getCellLinkPtr() [1/2]

CaloCellLink * CaloClusterNavigable::getCellLinkPtr ( )

inlineprotectedinherited

Definition at line 426 of file CaloClusterNavigable.h.

{ 
  CaloCellLink* ret;
  if (m_cellLink.isValid())
    ret = const_cast<CaloCellLink*>(*m_cellLink); 
  else
    ret = 0;
  return ret;
 
}

◆ getCellLinkPtr() [2/2]

const CaloCellLink * CaloClusterNavigable::getCellLinkPtr ( ) const

inlineprotectedinherited

Definition at line 438 of file CaloClusterNavigable.h.

                                           { 
  const CaloCellLink* ret;
  if (m_cellLink.isValid())
    ret = *m_cellLink; 
  else
    ret = 0;
  return ret;
}

◆ getCellWeight()

double CaloCompositeCellBase< CaloClusterNavigable >::getCellWeight ( const CaloCell * pCell ) const

inherited

Retrieve the kinematic weight of a given cell.

Parameters

pCell pointer to the cell (unchanged)

Returns 0. if cell not in store.

◆ getClusterEtaSize()

unsigned int CaloCluster::getClusterEtaSize ( ) const

Definition at line 1439 of file CaloCluster.cxx.

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

◆ getClusterPhiSize()

unsigned int CaloCluster::getClusterPhiSize ( ) const

Definition at line 1461 of file CaloCluster.cxx.

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

◆ getClusterSize()

unsigned int CaloCluster::getClusterSize ( ) const

inline

Get cluster size.

Definition at line 895 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

895{ return m_clusterSize; }

◆ getContainer() [1/2]

const CaloCellContainer * CaloClusterNavigable::getContainer ( const CaloCell * pCell ) const

inlineinherited

public container access: retrieve Container for given object pointer

Definition at line 347 of file CaloClusterNavigable.h.

{
  return (this->getCellLink())->getContainer(pCell);
}

◆ getContainer() [2/2]

const CaloCellContainer * CaloClusterNavigable::getContainer ( object_iter cellIter ) const

inlineinherited

public container access: retrieve Container for given object iterator

Definition at line 354 of file CaloClusterNavigable.h.

{
  return (this->getCellLink())->getContainer(cellIter);
}

◆ getDataStore() [1/2]

const CaloSamplingData * CaloCluster::getDataStore	(	const variable_type &	varType,
		bool	traceLink = false ) const

protected

Parameters

varType	reference to non-modifiable variable type indicator
traceLink	flag allows tracing external storelinks if set true

Dynamically allocates the correct store (local cache or external) depending on availability and indicator. The store is non-modifiable.

Definition at line 1056 of file CaloCluster.cxx.

{
  //
  //DEBUGstd::cout << "[CaloCluster@" << this
    //DEBUG    << "]::getDataStore - const data store pointer requested, "
    //DEBUG    << "try internal pointer = " << &m_dataStore;
 
  // check if variable in local data store
  if ( m_dataStore.contains(varType) )
    {
      //      std::cout << "...successful!" << std::endl;
      return &m_dataStore;
    }
 
  // check linked data store if requested
  if ( traceLink && m_dataLink.isValid())
    {
  //DEBUG    std::cout << "... unsuccessful, use linked pointer "
  //DEBUG           << &((*m_dataLink)->getSamplingStore()) << std::endl;
      return &((*m_dataLink)->getSamplingStore());
    }
 
  //DEBUGstd::cout << "... failed, no external or internal pointer available!"
    //DEBUG    << std::endl;
  return (const CaloSamplingData*)nullptr;
}

◆ getDataStore() [2/2]

CaloSamplingData * CaloCluster::getDataStore	(	const variable_type &	varType,
		bool	traceLink = true )

protected

Parameters

varType	reference to non-modifiable variable type indicator
traceLink	if true return pointer to external store

Dynamically allocates the correct store (local cache or external) depending on availability and indicator. The store is modifiable, i.e. write access is granted.

Definition at line 1093 of file CaloCluster.cxx.

{
  if ( m_dataStore.contains(varType) )
    {
      return &m_dataStore;
    }
 
  // check external store if requested
  if ( m_ownDataStore && !m_dataLink.isValid()) {
    m_shower = new CaloShower();
    m_dataLink.setElement(m_shower);
  }
 
  // trace
  if ( ( traceLink || m_ownDataStore ) && m_shower )
    {
      return &(m_shower->getSamplingStore());
    }
 
  return (CaloSamplingData*)nullptr;
}

◆ getDefaultHash()

AthenaBarCode_t AthenaBarCodeImpl::getDefaultHash ( const char * jobid = nullptr )

staticprivateinherited

Definition at line 304 of file AthenaBarCodeImpl.cxx.

{
  static const AthenaBarCode_t defaultHash = makeDefaultHash (jobid);
  return defaultHash;
}

◆ getEInSamples()

void CaloCluster::getEInSamples ( std::vector< double > & theEnergies ) const

inline

Retrieve energy for all samplings into a vector.

Parameters

theEnergies reference to a modifiable vector

Warning: The vector referenced on input will be completely overwritten and resized.

Definition at line 983 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

984{ this->getVariable(CaloVariableType::ENERGY,theEnergies,true); }

◆ getEtaInSamples()

void CaloCluster::getEtaInSamples ( std::vector< double > & theEtas ) const

inline

Retrieve \( \eta \) for all samplings into a vector.

Parameters

theEtas reference to a modifiable vector

Warning: The vector referenced on input will be completely overwritten and resized.

Definition at line 999 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

1000{ this->getVariable(CaloVariableType::ETA,theEtas,true); }

◆ getIndex() [1/2]

bool CaloClusterNavigable::getIndex	(	const CaloCell *	pCell,
		size_t &	iCell ) const

inlineinherited

get index of child in original container, given a pointer

Definition at line 360 of file CaloClusterNavigable.h.

{
  return (this->getCellLink())->getIndex(pCell,iCell);
}

◆ getIndex() [2/2]

bool CaloClusterNavigable::getIndex	(	object_iter	cellIter,
		size_t &	iCell ) const

inlineinherited

get index of child in original container, given an iterator

Definition at line 366 of file CaloClusterNavigable.h.

{
  return (this->getCellLink())->getIndex(cellIter,iCell);
}

◆ getMoment() [1/2]

CaloClusterMoment CaloCluster::getMoment ( const moment_iterator & momIter ) const

inline

Get individual moment.

Definition at line 1236 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

1237{ return rMomIter.getMoment(); }

◆ getMoment() [2/2]

CaloClusterMoment CaloCluster::getMoment	(	const moment_type &	momType,
		bool	useLink = true ) const

inline

Get individual moment.

Definition at line 1227 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

                                                                    {  
  CaloClusterMoment value(0.0);
  if (!this->retrieveMoment(momType,value,useLink))
    value = 0; // Make coverity happy.
  return value;
}

◆ getMomentStore() [1/4]

const CaloClusterMomentStore * CaloCluster::getMomentStore ( bool useLink = false ) const

protected

Definition at line 1160 of file CaloCluster.cxx.

{
  // follow link policy
  if ( !useLink ) return &m_momentStore;
 
  // check on external link usage
  if ( ( m_dataLink.isValid() || m_ownDataStore ) && m_dataLink.isValid() )
    return &((*m_dataLink)->getMomentStore());
 
  return (const CaloClusterMomentStore*)nullptr;
}

◆ getMomentStore() [2/4]

CaloClusterMomentStore * CaloCluster::getMomentStore ( bool useLink = true )

protected

Definition at line 1172 of file CaloCluster.cxx.

{
  // follow link policy: do not use link!
  if ( !useLink ) return &m_momentStore;
 
  // follow link policy: use link!
  if ( m_ownDataStore && m_dataLink.isValid() == 0 )
    {
      m_shower = new CaloShower();
      m_dataLink.setElement(m_shower);
      return this->getMomentStore(useLink);
    }
 
  if ( m_shower || m_ownDataStore )
    {
      return &(m_shower->getMomentStore());
    }
  return (CaloClusterMomentStore*)nullptr;
}

◆ getMomentStore() [3/4]

const CaloClusterMomentStore * CaloCluster::getMomentStore	(	const moment_type &	theMoment,
		bool	useLink = false ) const

protected

Definition at line 1202 of file CaloCluster.cxx.

{
  // local store
  if ( m_momentStore.contains(momType) ) return &m_momentStore;
 
  // external store
  const CaloClusterMomentStore* pMomStore = this->getMomentStore(useLink);
 
  //
  return pMomStore != nullptr && pMomStore->contains(momType)
    ? pMomStore : (const CaloClusterMomentStore*) nullptr;
}

◆ getMomentStore() [4/4]

CaloClusterMomentStore * CaloCluster::getMomentStore	(	const moment_type &	theMoment,
		bool	useLink = true )

protected

Definition at line 1192 of file CaloCluster.cxx.

{
  // this is the "write" implementation!
  return m_momentStore.contains(momType)
    ? &m_momentStore                 // moment already in local store
    : this->getMomentStore(useLink); // retrieve local or external
}

◆ getMomentStoreLink()

data_link_type CaloCluster::getMomentStoreLink ( ) const

inline

Definition at line 725 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

726 { return m_dataLink; }

◆ getMomentStorePtrs()

bool CaloCluster::getMomentStorePtrs	(	const CaloClusterMomentStore *&	pFirstStore,
		const CaloClusterMomentStore *&	pSecndStore,
		bool	useLink ) const

protected

Definition at line 1216 of file CaloCluster.cxx.

{
  // first store is assumed local by default
  pFirstMomStore = this->getMomentStore();
  // second store is assumed NOT to exist by default
  pSecndMomStore = nullptr;
  // local first store does not exist or is empty...
  if ( pFirstMomStore == nullptr || pFirstMomStore->size() == 0 )
    {
      // ...try to make external store the first one!
      pFirstMomStore = this->getMomentStore(useLink);
    }
  // local first store exists...
  else
    {
      // ...check if second store available!
      pSecndMomStore = useLink ? this->getMomentStore(useLink) : nullptr;
    }
  return pFirstMomStore != nullptr;
}

◆ getMomentType()

CaloClusterMoment::MomentType CaloCluster::getMomentType ( const moment_iterator & momIter ) const

inline

Get moment type.

Definition at line 1254 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

1255{ return rMomIter.getMomentType(); }

◆ getMomentValue() [1/2]

double CaloCluster::getMomentValue ( const moment_iterator & momIter ) const

inline

Definition at line 1250 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

1251{ return (momIter.getMoment()).getValue(); }

◆ getMomentValue() [2/2]

double CaloCluster::getMomentValue	(	const moment_type &	momType,
		bool	useLink = true ) const

inline

Get moment value.

Definition at line 1240 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

                                                                         {
  double value(0.0);
  if (!this->retrieveMoment(momType,value,useLink))
    value = 0; // Make coverity happy.
  return value;
}

◆ getNumberOfCells()

unsigned int CaloCompositeCellBase< CaloClusterNavigable >::getNumberOfCells ( ) const

inherited

Return the number of cells in the store.

◆ getParameter() [1/3]

double CaloClusterNavigable::getParameter ( const CaloCell * pCell ) const

inlineinherited

public container access: relational parameter retrieval

Definition at line 327 of file CaloClusterNavigable.h.

{
  return (this->getCellLink())->getParameter(pCell);
}

◆ getParameter() [2/3]

double CaloClusterNavigable::getParameter	(	const CaloCellContainer *	pContainer,
		size_t &	iCell ) const

inlineinherited

public container access: relational parameter retrieval

Definition at line 333 of file CaloClusterNavigable.h.

{
  return (this->getCellLink())->getParameter(pContainer,iCell);
}

◆ getParameter() [3/3]

double CaloClusterNavigable::getParameter ( object_iter & cellIter ) const

inlineinherited

public container access: relational parameter retrieval

Definition at line 340 of file CaloClusterNavigable.h.

{
  return (this->getCellLink())->getParameter(cellIter);
}

◆ getPhiInSamples()

void CaloCluster::getPhiInSamples ( std::vector< double > & thePhis ) const

inline

Retrieve \( \varphi \) for all samplings into a vector.

Parameters

thePhis reference to a modifiable vector

Warning: The vector referenced on input will be completely overwritten and resized.

                                        {
  if (m_barcode==IAthenaBarCode::UNDEFINEDBARCODE) 
    initABC();
  return getBits(SReserveBits, ReserveBits);
}

◆ getTime()

double CaloCluster::getTime ( ) const

inline

Access cluster time.

Definition at line 886 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

886{ return m_time; }

◆ getUUIDHash()

AthenaBarCode_t AthenaBarCodeImpl::getUUIDHash ( ) const

privateinherited

Definition at line 244 of file AthenaBarCodeImpl.cxx.

                                     {
  return getBits(SUUIDBits, UUIDBits);
}

◆ getVariable() [1/2]

double CaloCluster::getVariable	(	const variable_type &	varType,
		const sampling_type &	samType,
		bool	useLink = true ) const

General sampling variable access.

Parameters

varType	variable type indicator
samType	sampling type indicator
useLink	extends checks to external data store only if true

This method first checks if the requested data is in the CaloCluster cache. If not, it tries to retrieve the data from the linked data store if the traceLink flag is set to true. This allows full control of the data source by the client.

Definition at line 837 of file CaloCluster.cxx.

{
  const CaloSamplingData* pDataStore = this->getDataStore(varType,useLink);
  return pDataStore != nullptr
    ? pDataStore->retrieveData(varType,samType)
    : double(0);
}

◆ getVariable() [2/2]

bool CaloCluster::getVariable	(	const variable_type &	varType,
		std::vector< double > &	varList,
		bool	useLink = true ) const

General access to variables of a given type in all samplings.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

varType	variable type
varList	reference to modifiable list of variable values
useLink	extends checks to external data store if true

Definition at line 857 of file CaloCluster.cxx.

{
  const CaloSamplingData* pDataStore = this->getDataStore(varType,useLink);
  return pDataStore != nullptr ? pDataStore->retrieveData(varType,varList) : false;
}

◆ getVersion()

AthenaBarCodeVersion_t AthenaBarCodeBase::getVersion ( ) const

virtualinherited

Reimplemented from IAthenaBarCode.

Definition at line 47 of file AthenaBarCodeBase.cxx.

{
  return AthenaBarCodeImpl::getVersion();
}

◆ hashUUID()

AthenaBarCode_t AthenaBarCodeImpl::hashUUID ( const char * guid )

staticprivateinherited

Definition at line 190 of file AthenaBarCodeImpl.cxx.

                                            {
  const int maxdigs = 16;
  AthenaBarCode_t tmp1 = static_cast<AthenaBarCode_t> (2166136261UL);
 
  for (int i = 0; i < maxdigs; i++) {
    tmp1 ^= (AthenaBarCode_t)(guid[i]);
    tmp1 *= 16777619UL;
  }
 
  return (tmp1 << (TotalBits - UUIDBits)) >> (TotalBits - UUIDBits);
}

◆ hasSameAthenaBarCode()

bool AthenaBarCodeBase::hasSameAthenaBarCode ( const IAthenaBarCode & obj ) const

virtualinherited

Reimplemented from IAthenaBarCode.

Definition at line 34 of file AthenaBarCodeBase.cxx.

{
  return AthenaBarCodeImpl::hasSameAthenaBarCode (obj);
}

◆ hasSameAthenaBarCodeExceptVersion()

bool AthenaBarCodeBase::hasSameAthenaBarCodeExceptVersion ( const IAthenaBarCode & obj ) const

virtualinherited

Reimplemented from IAthenaBarCode.

Definition at line 41 of file AthenaBarCodeBase.cxx.

{
  return AthenaBarCodeImpl::hasSameAthenaBarCodeExceptVersion (obj);
}

◆ hasSampling()

bool CaloCluster::hasSampling ( const sampling_type & theSampling ) const

inline

Checks if certain sampling contributes to cluster.

Definition at line 954 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

{
  unsigned int bitPattern = CaloSamplingHelper::getSamplingBit(theSampling);
  return (m_samplingPattern & bitPattern) == bitPattern;
}

◆ hasSignalState()

bool CaloCluster::hasSignalState ( signalstate_t s ) const

virtual

check if signal state exists for current implementation

Implements ISignalState.

Definition at line 1358 of file CaloCluster.cxx.

{
  return s == statename_t::CALIBRATED ||
         s == statename_t::UNCALIBRATED ||
         s == statename_t::ALTCALIBRATED;
}

◆ hasUUIDHash()

AthenaBarCode_t AthenaBarCodeImpl::hasUUIDHash ( ) const

privateinherited

Definition at line 239 of file AthenaBarCodeImpl.cxx.

                                     {
  return getUUIDHash();
}

◆ hlv() [1/2]

virtual CLHEP::HepLorentzVector CaloCluster::hlv ( ) const

inlinevirtual

redefine hlv() here to avoid ambiguities

Reimplemented from P4EEtaPhiMBase.

Definition at line 270 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

270{return CaloCompositeKineBase::hlv();}

I4Momentum::hlv

virtual CLHEP::HepLorentzVector hlv() const =0

CLHEP HepLorentzVector.

◆ hlv() [2/2]

CLHEP::HepLorentzVector CaloCluster::hlv ( CaloCluster::signalstate_t s ) const

virtual

retrieve the 4-momentum at a given signal state

Implements ISignalState.

Definition at line 1485 of file CaloCluster.cxx.

                                                 {
  if(hasSignalState(s)){
    switch (s) {
    case statename_t::CALIBRATED: {
      P4EEtaPhiM tmp = *this;
      return tmp.hlv();
    }
    case statename_t::UNCALIBRATED: {
      P4EEtaPhiM tmp (m_rawE, m_rawEta, m_rawPhi, m_rawM);
      return tmp.hlv();
    }
    case statename_t::ALTCALIBRATED: {
      P4EEtaPhiM tmp (m_altE, m_altEta, m_altPhi, m_altM);
      return tmp.hlv();
    }
    default:
      break;
    }
  }
  return this->hlv();
}

◆ inBarrel()

bool CaloCluster::inBarrel ( ) const

inline

Returns true if at least one clustered cell in EMB.

Returns true if cluster has more than one cell with positive signal in barrel calorimeter.

Definition at line 926 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

926{ return m_barrel; }

◆ inEndcap()

bool CaloCluster::inEndcap ( ) const

inline

Returns true if at least one clustered cell in EMEC.

Returns true if cluster has more than one cell with positive signal in endcap calorimeter.

Definition at line 931 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

931{ return m_endcap; }

◆ initABC()

void AthenaBarCodeImpl::initABC ( ) const

protectedinherited

Definition at line 24 of file AthenaBarCodeImpl.cxx.

                                      {
 
  //This function will be call the first time any "access" function is called
  //using const type because those "access" functions might be const
  //Will only change mutable variables
 
  //  std::cout<<"Calling AthenaBarCodeImpl::AthenaBarCodeImpl() "<<std::endl;
 
  //* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  //Set counter part
  //* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 
  const AthenaBarCode_t counter = m_barcodeCounter++;
 
  AthenaBarCode_t barcode = IAthenaBarCode::UNDEFINEDBARCODE;
 
  try {
    setBits(SCounterBits, CounterBits, counter & ((1u<<CounterBits)-1),
            barcode);
  }
  catch (const GaudiException& Exception) {
    throw std::runtime_error(
        "AthenaBarCodeImpl::Can not Set Counter Bit, Counter Overflow");
  }
 
  //* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  //Set reserve part
  //* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  try {
    setBits(SReserveBits, ReserveBits, 0, barcode);
  }
  catch (const GaudiException& Exception) {
    throw std::runtime_error(
        "AthenaBarCodeImpl::Can not initialize Reserve Bit");
  }
 
  //* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  //Set Version part
  //* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  try {
    setBits(SVersionBits, VersionBits, 0, barcode);
  }
  catch (const GaudiException& Exception) {
    throw std::runtime_error(
        "AthenaBarCodeImpl::Can not initialize Version Bit");
  }
 
 
  try {
    setBits(SUUIDBits, UUIDBits, getDefaultHash(), barcode);
  }
  catch (const GaudiException& Exception) {
    throw std::runtime_error("AthenaBarCodeImpl::Can not set UUID Hash Bits");
  }
 
  m_barcode = barcode;
 
  /*  std::cout << "[AthenaBarCodeImpl::m_barcode,m_defaultHash,m_barcodeCounter]= "
   << std::hex
   << (m_barcode)<< "\t"
   << m_defaultHash<< "\t"
   << (m_barcodeCounter)<<"\t"
   << std::dec
   << std::endl;
   */
}

◆ insertElement() [1/4]

void CaloClusterNavigable::insertElement	(	const CaloCellContainer *	pContainer,
		const CaloCell *	pCell,
		const double &	weight = double(1.) )

inlineinherited

insert element without checking if already in store: use element pointer

Definition at line 217 of file CaloClusterNavigable.h.

{
  (this->getCellLink())->insertElement(pContainer,pCell,weight);
}

◆ insertElement() [2/4]

void CaloClusterNavigable::insertElement	(	const CaloCellContainer *	pContainer,
		size_t &	iCell,
		const double &	weight = double(1.) )

inlineinherited

insert element without checking if already in store: use index

Definition at line 225 of file CaloClusterNavigable.h.

{
  (this->getCellLink())->insertElement(pContainer,iCell,weight);
}

◆ insertElement() [3/4]

void CaloClusterNavigable::insertElement	(	const CaloCellContainer *	pContainer,
		size_t	iCell,
		const double	weight,
		size_t	size_hint )

inlineinherited

same, with a size hint.

Definition at line 233 of file CaloClusterNavigable.h.

{
  (this->getCellLink())->insertElement(pContainer,iCell,weight,size_hint);
}

◆ insertElement() [4/4]

void CaloClusterNavigable::insertElement	(	const ElementLink< CaloCellContainer > &	el,
		const double	weight,
		size_t	size_hint = 0 )

inlineinherited

Insert element via ElementLink.

Definition at line 243 of file CaloClusterNavigable.h.

{
  (this->getCellLink())->insertElement(el,weight,size_hint);
}

◆ insertMoment()

void CaloCluster::insertMoment	(	const moment_type &	momType,
		const moment_value &	momData,
		bool	useLink = true )

Set individual moment.

Parameters

momType	reference to (non-modifiable) moment type indicator
momData	reference to (non-modifiable) moment value object
useLink	not used.

Definition at line 1247 of file CaloCluster.cxx.

{
  // use momType for getMomentStore to override useLink in case
  // the moment has already been stored and should just be updated ...
  CaloClusterMomentStore* pMomStore = this->getMomentStore(momType,useLink);
  if ( pMomStore != nullptr ) pMomStore->insert(momType,momData);
}

◆ iPt()

double P4EEtaPhiMBase::iPt ( ) const

virtualinherited

inverse of transverse momentum

Implements I4Momentum.

Definition at line 111 of file P4EEtaPhiMBase.cxx.

112 { return 1./this->pt();

113 }

P4EEtaPhiMBase::pt

virtual double pt() const

transverse momentum

Definition P4EEtaPhiMBase.cxx:101

◆ is_valid_sampling()

bool CaloCluster::is_valid_sampling ( const sampling_type & sampling ) const

inline

Checks if cells from a given sampling in EMB or EMEC (!) are in cluster.

Parameters

sampling calorimeter sampling indicator

Note: The original implementation only check on cells in the electromagnetic calorimeters. This method is depreciated, use isEMSampling(sampling) instead.

Definition at line 948 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

949{ return this->isEMSampling(sampling); }

◆ isAtSignalState()

bool CaloCluster::isAtSignalState ( signalstate_t s ) const

virtual

check if we are at the passed state

Implements ISignalState.

Definition at line 1365 of file CaloCluster.cxx.

{
  return s == m_signalState;
}

◆ isCellLinkValid()

bool CaloClusterNavigable::isCellLinkValid ( ) const

inlinevirtualinherited

Definition at line 449 of file CaloClusterNavigable.h.

{
  return this->getCellLinkPtr() !=0;
}

◆ isEMSampling()

bool CaloCluster::isEMSampling ( const sampling_type & theSampling ) const

inline

Checks if cells from a given sampling in EMB and EMEC are in the cluster.

Definition at line 951 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

952{ return CaloSamplingHelper::isEMSampling(theSampling); }

CaloSamplingHelper::isEMSampling

static bool isEMSampling(const CaloSample &rSample)

Get sampling characteristics.

Definition CaloEvent/src/CaloSamplingHelper.cxx:57

◆ isLocked() [1/2]

bool CaloCluster::isLocked ( const unsigned int & bitPattern ) const

inline

Definition at line 1283 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

{
  return ( m_lockPattern & bitPattern ) == bitPattern;
}

◆ isLocked() [2/2]

bool CaloCluster::isLocked ( const variable_type & varType ) const

inline

Check lock status of variable.

Definition at line 1278 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

{
  unsigned int bitPattern(CaloVariableType::getVariableBit(varType));
  return this->isLocked(bitPattern); 
}

◆ kind()

I4Momentum::Kind P4EEtaPhiMBase::kind ( ) const

inlinevirtualinherited

tells what kind of P4XYZT this is

Implements I4Momentum.

Definition at line 65 of file P4EEtaPhiMBase.h.

65{ return I4Momentum::P4EETAPHIM; };

◆ lockVariable()

bool CaloCluster::lockVariable ( const variable_type & varType )

Lock variable (protect against future updates)

Definition at line 1293 of file CaloCluster.cxx.

{
  unsigned int bitPattern(CaloVariableType::getVariableBit(varType));
  m_lockPattern = ( m_lockPattern | bitPattern );
  return this->isLocked(bitPattern);
}

◆ m() [1/2]

double CaloCluster::m ( void ) const

inlinevirtual

Retrieve mass independent of signal state.

Reimplemented from P4EEtaPhiM.

Definition at line 764 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

765{ return (this->*m_getM)(); }

CaloCluster::m_getM

GET_VALUE m_getM

Pointer to getter functions.

Definition Calorimeter/CaloEvent/CaloEvent/CaloCluster.h:678

◆ m() [2/2]

double CaloCluster::m ( signalstate_t s ) const

inline

Retrieve mass for a specific signal state.

Definition at line 825 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

{
  if (!hasSignalState(s)) return m_errorValue;
  switch (s) {
  case statename_t::CALIBRATED:
    return P4EEtaPhiM::m();
  case statename_t::UNCALIBRATED:
    return m_rawM;
  case statename_t::ALTCALIBRATED:
    return m_altM;
  default:
    return m_errorValue;
  }
}

◆ m2()

double P4EEtaPhiMBase::m2 ( ) const

virtualinherited

mass squared

Implements I4Momentum.

Definition at line 14 of file P4EEtaPhiMBase.cxx.

                                {
  const double theM = this->m();
  return theM*theM;
}

◆ makeDefaultHash()

AthenaBarCode_t AthenaBarCodeImpl::makeDefaultHash ( const char * jobid )

staticprivateinherited

Definition at line 312 of file AthenaBarCodeImpl.cxx.

{
  if (jobid) {
    return AthenaBarCodeImpl::hashUUID(jobid);
  }
 
  // First look for a uuid as an environment variable.
  // This can be set in cases where we don't have the full
  // Gaudi/Athena environment available (eg, ARA), and we
  // don't want to try to create JobIDSvc.  This has to be
  // communicated in some way external to this library,
  // as we may end up here while initializing the dictionary
  // for this library.
  const char* env_uuid = getenv ("_ATHENABARCODEIMPL_JOBUUID");
  if (env_uuid) {
    return AthenaBarCodeImpl::hashUUID(env_uuid);
  }
 
  //    std::cout<<"no UUID stored, generating."<<std::endl;
 
  ServiceHandle<IJobIDSvc> p_jobidsvc("JobIDSvc", "JobIDSvc");
  StatusCode sc = p_jobidsvc.retrieve();
  if (!sc.isSuccess() || 0 == p_jobidsvc) {
    //FIXME
    //use uuid instead if service not available
    JobID_t JobID;
    uuid_generate(JobID);
    return AthenaBarCodeImpl::hashUUID((const char *) JobID);
    /*      std::cout << "Could not find JobIDSvc, using uuid directly"
            <<"jobid "<<o.str()
            << std::endl;*/
  }
 
  PJobID_t pjobid = p_jobidsvc->getJobID();
  return AthenaBarCodeImpl::hashUUID((const char *) pjobid);
}

◆ maybeSetVariable()

template<class InputIterator>

void CaloCluster::maybeSetVariable	(	variable_type	varType,
		InputIterator	beg,
		InputIterator	end )

private

Set variables of a given type in all samplings at once, taking locking into account.

Definition at line 1317 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

{
  if (this->isLocked (varType)) return;
  CaloSamplingData* p = this->getDataStore (varType, true);
  if (p)
    p->storeData (varType, beg, end);
}

◆ nCells()

unsigned int CaloClusterNavigable::nCells ( ) const

inlinevirtualinherited

size of object access

Definition at line 315 of file CaloClusterNavigable.h.

{
 
  const CaloCellLink* link = this->getCellLinkPtr();
  if (link) 
    return link->size();
  else
    return 0; 
 
}

◆ newVersion()

void AthenaBarCodeBase::newVersion ( )

virtualinherited

Reimplemented from IAthenaBarCode.

Definition at line 53 of file AthenaBarCodeBase.cxx.

{
  AthenaBarCodeImpl::newVersion();
}

◆ nSamples()

unsigned int CaloCluster::nSamples ( ) const

inline

Retrieve number of samplings in this cluster.

Returns the maximum possible number of samplings, not the actual number contributing to the cluster!

Definition at line 968 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

969{ return CaloSampling::getNumberOfSamplings(); }

CaloSampling::getNumberOfSamplings

static constexpr unsigned int getNumberOfSamplings()

Get number of available samplings.

Definition Calorimeter/CaloGeoHelpers/CaloGeoHelpers/CaloSampling.h:30

◆ operator=()

CaloCluster & CaloCluster::operator= ( const CaloCluster & )

private

Disallow (avoid coverity warning).

◆ p()

double P4EEtaPhiMBase::p ( ) const

virtualinherited

magnitude of 3-momentum.

Special implementation from Frank Paige : if negative energy p is negative but eta and phi still the same.

Implements I4Momentum.

Definition at line 21 of file P4EEtaPhiMBase.cxx.

{ 
  const double theM=this->m();
  const double theE=this->e();
  //  if (theM==0.) return theE ;
  //    else return sqrt(theE*theE-theM*theM); 
  //DR from Frank Paige
  // if negative energy point in the opposite direction
  // BUT eta and phi still the same !!!
  if (theM==0.) {
    return theE;
  } else {
    double eSign = (theE >= 0) ? +1 : -1;
    return eSign*std::sqrt(theE*theE-theM*theM); 
  }
 
}

◆ p2()

double P4EEtaPhiMBase::p2 ( ) const

virtualinherited

square of momentum magnitude

This p2() implementaion is derived from the (somewhat unusual) Frank Paige implementation used to calculate p() above. What we do is look at what would happen if we were to square the answer returned by Frank's algorithm:

(1) The "eSign" would square to +1 and disappear, (2) The sqrt would disappear leaving theE*theE-theM*theM (3) In the event that theM==0, this theE*theE would indeed still equal theE*theE-theM*theM, so we simply return this quantity.

Implements I4Momentum.

Definition at line 39 of file P4EEtaPhiMBase.cxx.

{ 
  const double theM=this->m();
  const double theE=this->e();
  
  return theE*theE-theM*theM;
}

◆ phi() [1/2]

double CaloCluster::phi ( void ) const

inlinevirtual

Retrieve phi independent of signal state.

Reimplemented from P4EEtaPhiM.

Definition at line 759 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

{
  return (this->*m_getPhi)(); 
}

◆ phi() [2/2]

double CaloCluster::phi ( signalstate_t s ) const

inline

Retrieve phi for a specific signal state.

Definition at line 809 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

{
  if (!hasSignalState(s)) return m_errorValue;
  switch (s) {
  case statename_t::CALIBRATED:
    return P4EEtaPhiM::phi();
  case statename_t::UNCALIBRATED:
    return m_rawPhi;
  case statename_t::ALTCALIBRATED:
    return m_altPhi;
  default:
    return m_errorValue;
  }
}

◆ phi0()

double CaloCluster::phi0 ( ) const

inline

Returns raw \( \phi \) of cluster seed.

Returns seed \( \varphi \) for cluster.

Definition at line 1186 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

1186{ return m_phi0; }

◆ phiBE()

double CaloCluster::phiBE ( int sam ) const

inline

EMB/EMEC combined barycenter \( \varphi \).

Parameters

sam	sampling counter

Warning: The sampling input argument refers to the sampling number (first, second, third,...) in the EMB and EMEC. It is not identical to the corresponding CaloSampling::CaloSample indicators in these calorimeters.

Definition at line 1209 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

1210{ return this->variableBE(CaloVariableType::PHI,sam); }

◆ phimax()

double CaloCluster::phimax ( sampling_type sampling ) const

inline

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

Parameters

sampling sampling indicator

Returns \( \varphi \) of cell with maximum signal in sampling.

Warning: Depreciated. This method should not be used anymore. Use getVariable(CaloVariableType::MAX_PHI,...) instead.

Definition at line 1128 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

{
  return this->isEMSampling(sampling)
    ? this->getVariable(CaloVariableType::MAX_PHI,sampling,true)
    : double(0);
}

◆ phiSample()

double CaloCluster::phiSample ( sampling_type theSampling ) const

inline

Retrieve barycenter \( \varphi \) in a given sample.

Parameters

theSampling sampling indicator

Returns \( \varphi \) in sampling.

Definition at line 1006 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

1007{ return this->getVariable(CaloVariableType::PHI,theSampling,true); }

◆ phisize()

double CaloCluster::phisize ( sampling_type sampling ) const

inline

Returns cluster size in \( \varphi \) for a given sampling.

Parameters

sampling sampling indicator

Returns phi size \( \Delta\varphi \) of cluster in sampling.

Warning: Depreciated. This method should not be used anymore. Use getVariable(CaloVariableType::DELTA_PHI,...) instead.

Definition at line 1165 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

{
  return this->isEMSampling(sampling)
    ? this->getVariable(CaloVariableType::DELTA_PHI,sampling,true)
    : double(0);
}

◆ pt()

double P4EEtaPhiMBase::pt ( ) const

virtualinherited

transverse momentum

Implements I4Momentum.

Definition at line 101 of file P4EEtaPhiMBase.cxx.

   {
     return this->p()*this->sinTh();
   }

◆ putElement() [1/2]

void CaloClusterNavigable::putElement	(	const CaloCellContainer *	pContainer,
		const CaloCell *	pCell,
		const double &	weight = double(1.) )

inlineinherited

add element to the Navigable: use pointer

Definition at line 201 of file CaloClusterNavigable.h.

{
  (this->getCellLink())->putElement(pContainer,pCell,weight);
}

◆ putElement() [2/2]

void CaloClusterNavigable::putElement	(	const CaloCellContainer *	pContainer,
		size_t &	iCell,
		const double &	weight = double(1.) )

inlineinherited

add element to the Navigable: use element index (direct access!)

Definition at line 209 of file CaloClusterNavigable.h.

{
  (this->getCellLink())->putElement(pContainer,iCell,weight);
}

◆ px()

double P4EEtaPhiMBase::px ( ) const

virtualinherited

x component of momentum

Implements I4Momentum.

Definition at line 122 of file P4EEtaPhiMBase.cxx.

123 { return this->pt()*this->cosPhi();

124 }

P4EEtaPhiMBase::cosPhi

virtual double cosPhi() const

cosinus phi

Definition P4EEtaPhiMBase.cxx:54

◆ py()

double P4EEtaPhiMBase::py ( ) const

virtualinherited

y component of momentum

Implements I4Momentum.

Definition at line 126 of file P4EEtaPhiMBase.cxx.

127 { return this->pt()*this->sinPhi();

128 }

P4EEtaPhiMBase::sinPhi

virtual double sinPhi() const

sinus phi

Definition P4EEtaPhiMBase.cxx:59

◆ pz()

double P4EEtaPhiMBase::pz ( ) const

virtualinherited

z component of momentum

Implements I4Momentum.

Definition at line 130 of file P4EEtaPhiMBase.cxx.

131 { return this->p()*this->cosTh();

132 }

P4EEtaPhiMBase::cosTh

virtual double cosTh() const

cosinus theta

Definition P4EEtaPhiMBase.cxx:82

◆ rapidity()

double P4EEtaPhiMBase::rapidity ( ) const

virtualinherited

rapidity

Implements I4Momentum.

Definition at line 115 of file P4EEtaPhiMBase.cxx.

  {
    const double theE=this->e();
    const double thePz=this->pz();
    return 0.5*std::log((theE+thePz)/(theE-thePz));
   }

◆ remove() [1/2]

bool CaloClusterNavigable::remove ( const CaloCell * pCell )

inlineinherited

remove object from the Navigable

Definition at line 271 of file CaloClusterNavigable.h.

{
  return (this->getCellLink())->remove(pCell);
}

◆ remove() [2/2]

bool CaloClusterNavigable::remove	(	const CaloCellContainer *	pContainer,
		size_t &	iCell )

inlineinherited

remove object from the Navigable

Definition at line 277 of file CaloClusterNavigable.h.

{
  return (this->getCellLink())->remove(pContainer,iCell);
}

◆ removeAll()

bool CaloClusterNavigable::removeAll ( )

inlineinherited

remove all objects from the Navigable

Definition at line 284 of file CaloClusterNavigable.h.

{
  return (this->getCellLink())->removeAll();
}

◆ removeCell()

void CaloCompositeCellBase< CaloClusterNavigable >::removeCell ( const CaloCell * pCell )

inherited

Remove a cell with kinematic update.

Parameters

pCell pointer to a CaloCell object (unchanged)

Removes the cell pointed to by the input argument. The effect on the global kinematics is defined by the updateKine implementation in the derived classes.

The Navigable<CaloCellContainer,double> base class provides a remove method which can be used if no kinematic update is required.

◆ removeCells()

void CaloCompositeCellBase< CaloClusterNavigable >::removeCells ( )

inherited

Remove all cells without kinematic update.

◆ removeRecoStatus() [1/2]

void CaloCompositeKineBase::removeRecoStatus ( )

inlineinherited

Remove all indicators.

Definition at line 101 of file CaloCompositeKineBase.h.

102{ m_status.resetStatus(); }

◆ removeRecoStatus() [2/2]

void CaloCompositeKineBase::removeRecoStatus ( const CaloRecoStatus::StatusIndicator & recIndic )

inlineinherited

Remove a given indicator.

Definition at line 96 of file CaloCompositeKineBase.h.

98{ m_status.resetStatus(recIndic); }

◆ resetBadChannel()

void CaloCluster::resetBadChannel ( )

Reset Bad channel list.

Definition at line 1429 of file CaloCluster.cxx.

{
 m_badChannelData.clear();
}

◆ resetCellLink()

void CaloClusterNavigable::resetCellLink ( const cell_link_type & cellLink )

inlineinherited

Definition at line 151 of file CaloClusterNavigable.h.

  {
    m_cellLink = cellLink;
  }

◆ resetSignalState()

void CaloCluster::resetSignalState ( )

protectedvirtual

reset the signal state

Implements ISignalState.

Definition at line 1370 of file CaloCluster.cxx.

{
  this->setSignalState(m_defSigState);
}

◆ retrieveMoment() [1/2]

bool CaloCluster::retrieveMoment	(	const moment_type &	momType,
		double &	momData,
		bool	useLink = true ) const

Definition at line 1278 of file CaloCluster.cxx.

{
  CaloClusterMoment momData(0);
  if ( this->retrieveMoment(momType,momData,useLink) )
    {
      momValue = momData.getValue();
      return true;
    }
  return false;
}

◆ retrieveMoment() [2/2]

bool CaloCluster::retrieveMoment	(	const moment_type &	momType,
		moment_value &	momData,
		bool	useLink = true ) const

Retrieve individual moment.

Parameters

momType	reference to (non-modifiable) moment type indicator
momData	reference to (modifiable) moment value object
useLink	extends checks to external data store if true

Returns true if requested moment type in cluster.

Definition at line 1266 of file CaloCluster.cxx.

{
  const CaloClusterMomentStore* pMomStore = this->getMomentStore(momType,
                                 useLink);
  return pMomStore != nullptr
    ? pMomStore->retrieve(momType,momData)
    : false;
}

◆ reweight() [1/3]

void CaloClusterNavigable::reweight	(	const CaloCell *	pCell,
		const double &	weight = double(1.) )

inlineinherited

re-weight (overwrite old weight)

Definition at line 251 of file CaloClusterNavigable.h.

{
  (this->getCellLink())->reweight(pCell,weight);
}

◆ reweight() [2/3]

void CaloClusterNavigable::reweight	(	const CaloCellContainer *	pContainer,
		size_t &	iCell,
		const double &	weight = double(1.) )

inlineinherited

re-weight (overwrite old weight)

Definition at line 257 of file CaloClusterNavigable.h.

{
  (this->getCellLink())->reweight(pContainer,iCell,weight);
}

◆ reweight() [3/3]

void CaloClusterNavigable::reweight	(	object_iter &	cellIter,
		const double &	weight = double(1.) )

inlineinherited

re-weight (overwrite old weight)

Definition at line 265 of file CaloClusterNavigable.h.

{
  (this->getCellLink())->reweight(cellIter,weight);
}

◆ reweightCell()

void CaloCompositeCellBase< CaloClusterNavigable >::reweightCell	(	const CaloCell *	pCell,
		double	weight )

inherited

Reweight a cell with kinematic update.

Parameters

pCell	input pointer to a CaloCell object (unchanged)
weight	input new signal weight associated with this cell

Changes the kinematic weight of a cell in the cluster. No action if cell not in cluster. In particular, the cell is not added.

◆ samplingPattern()

unsigned int CaloCluster::samplingPattern ( ) const

Get sampling bitmask.

Definition at line 1507 of file CaloCluster.cxx.

{
  return m_samplingPattern;
}

◆ set4Mom() [1/3]

void CaloCluster::set4Mom ( const CLHEP::HepLorentzVector & rVec )

inlinevirtual

Set kinematics directly from HLV.

Reimplemented from P4EEtaPhiM.

Definition at line 852 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

{
  this->setE(rVec.e());
  this->setEta(rVec.eta());
  this->setPhi(rVec.phi());
  this->setM(rVec.m());
}

◆ set4Mom() [2/3]

void CaloCluster::set4Mom ( const I4Momentum & rMom )

inlinevirtual

Set kinematics directly from four-vector.

Reimplemented from P4EEtaPhiM.

Definition at line 849 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

850{ this->set4Mom(&rMom); }

CaloCluster::set4Mom

virtual void set4Mom(const I4Momentum *const pMom)

Set kinematics from four-vector.

Definition Calorimeter/CaloEvent/CaloEvent/CaloCluster.h:841

◆ set4Mom() [3/3]

void CaloCluster::set4Mom ( const I4Momentum *const pMom )

inlinevirtual

Set kinematics from four-vector.

Reimplemented from P4EEtaPhiM.

Definition at line 841 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

{
  this->setE(pMom->e());
  this->setEta(pMom->eta());
  this->setPhi(pMom->phi());
  this->setM(pMom->m());
}

◆ setAltE()

void CaloCluster::setAltE ( double e )

private

Set calibrated (cell weight) energy.

Definition at line 1330 of file CaloCluster.cxx.

1330{ m_altE = e; }

CaloCluster::e

virtual double e() const

Retrieve energy independent of signal state.

Definition Calorimeter/CaloEvent/CaloEvent/CaloCluster.h:753

◆ setAltEta()

void CaloCluster::setAltEta ( double eta )

private

Set calibrated (cell weight) eta.

Definition at line 1331 of file CaloCluster.cxx.

1331{ m_altEta = eta; }

CaloCluster::eta

virtual double eta() const

Retrieve eta independent of signal state.

Definition Calorimeter/CaloEvent/CaloEvent/CaloCluster.h:755

◆ setAltM()

void CaloCluster::setAltM ( double m )

private

Set calibrated (cell weight) m.

Definition at line 1333 of file CaloCluster.cxx.

1333{ m_altM = m; }

CaloCluster::m

virtual double m() const

Retrieve mass independent of signal state.

Definition Calorimeter/CaloEvent/CaloEvent/CaloCluster.h:764

◆ setAltPhi()

void CaloCluster::setAltPhi ( double phi )

private

Set calibrated (cell weight) phi.

Definition at line 1332 of file CaloCluster.cxx.

1332{ m_altPhi = phi; }

◆ setAthenaBarCode()

void AthenaBarCodeBase::setAthenaBarCode ( AthenaBarCode_t id )

virtualinherited

Reimplemented from IAthenaBarCode.

Definition at line 28 of file AthenaBarCodeBase.cxx.

{
  return AthenaBarCodeImpl::setAthenaBarCode (id);
}

◆ setBarrel()

void CaloCluster::setBarrel ( bool barrel )

inline

Sets EMB indicator.

Parameters

barrel input flag is true if at least one cell in EMB

Definition at line 935 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

935{ m_barrel = barrel; }

DetectorZone::barrel

@ barrel

Definition FPGATrackSimTypes.h:28

◆ setBasicEnergy()

void CaloCluster::setBasicEnergy ( double theEnergy )

inlinevirtual

Set basic energy scale signal.

Parameters

theEnergy basic energy signal

Overwrites default behaviour in CaloEnergyCluster base class

Implements CaloCompositeKineBase.

Definition at line 883 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

883{ m_basicSignal = theEnergy; }

PowhegPythia8EvtGen_jetjet.theEnergy

int theEnergy

Definition PowhegPythia8EvtGen_jetjet.py:12

◆ setBits()

void AthenaBarCodeImpl::setBits	(	unsigned short	startbit,
		unsigned short	nbits,
		AthenaBarCode_t	id,
		AthenaBarCode_t &	bc ) const

protectedinherited

now id=0000000xx;

Definition at line 260 of file AthenaBarCodeImpl.cxx.

{
  AthenaBarCode_t tmp;
  AthenaBarCode_t tmp2;
  tmp2 = 0;
 
  if ((id) >= ((~tmp2) >> (TotalBits - nbits))) {
 
    IMessageSvc *msgsvc = Athena::getMessageSvc();
    if (msgsvc) {
      MsgStream msg(msgsvc, "AthenaBarCodeImpl");
      msg << MSG::WARNING << "setBits::bit to be set:" << id
          << " is larger than limit:" << ((~tmp2) >> (TotalBits - nbits))
          << endmsg;
    }
    else {
      std::cout << "setBits::bit to be set:" << id << " is larger than limit:"
          << ((~tmp2) >> (TotalBits - nbits)) << std::endl;
    }
    throw std::runtime_error("AthenaBarCodeImpl::setBit Failed");
  }
  tmp = (id << (TotalBits - nbits - startbit)); //tmp=00000xx00
  tmp2 = ((~tmp2) >> (TotalBits - nbits)); //tmp2=000000011
 
  tmp2 = (tmp2 << (TotalBits - nbits - startbit)); //tmp2=000001100
  tmp2 = (~tmp2); //tmp2=111110011
 
  //now m_barcode=aaaaayyaa
  bc &= tmp2; //m_barcode=aaaaa00aa
  bc |= tmp; //m_barcode=aaaaaxxaa
 
}

◆ setCalE()

void CaloCluster::setCalE ( double e )

private

Set calibrated (LC) energy.

Definition at line 1340 of file CaloCluster.cxx.

1340{ P4EEtaPhiM::setE(e); }

◆ setCalEta()

void CaloCluster::setCalEta ( double eta )

private

Set calibrated (LC) eta.

Definition at line 1341 of file CaloCluster.cxx.

1341{ P4EEtaPhiM::setEta(eta); }

◆ setCalM()

void CaloCluster::setCalM ( double m )

private

Set calibrated (LC) m.

Definition at line 1343 of file CaloCluster.cxx.

1343{ P4EEtaPhiM::setM(m); }

◆ setCalPhi()

void CaloCluster::setCalPhi ( double phi )

private

Set calibrated (LC) phi.

Definition at line 1342 of file CaloCluster.cxx.

1342{ P4EEtaPhiM::setPhi(phi); }

◆ setCellLink()

bool CaloClusterNavigable::setCellLink ( CaloCellLinkContainer * pLink )

inlineprotectedinherited

Definition at line 405 of file CaloClusterNavigable.h.

{
  if (!pLinkStore) 
    return false;
 
  CaloCellLink* pLink = *m_cellLink != 0 
    ? const_cast<CaloCellLink*>(*m_cellLink) : (CaloCellLink*)0;
 
  m_ownLinkStore = !pLinkStore->ownElements();
  return CaloClusterLinkTemplate<CaloCellLinkContainer>::setLink(pLinkStore,
                                 pLink,
                                 m_cellLink);
}

◆ setClusterSize()

void CaloCluster::setClusterSize ( unsigned int theClusterSize )

inline

Set cluster size.

Definition at line 892 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

892{ m_clusterSize = theClusterSize; }

◆ setDataLink()

bool CaloCluster::setDataLink ( CaloShowerContainer * pDataLink )

inlineprotected

Set element link for shower data.

Definition at line 1262 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

{
  if (!pDataLink) 
    return false;
  CaloShower* pData = m_shower;
  m_ownDataStore = !pDataLink->ownElements();
  return CaloClusterLinkTemplate<CaloShowerContainer>::setLink(pDataLink,
                                   pData,
                                   m_dataLink);
}

◆ setDataStore()

bool CaloCluster::setDataStore	(	CaloShower *	pData,
		bool	ownStores = true )

inlineprotected

Setup data store.

Definition at line 909 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

{ 
  //  m_dataStorePointer = pData;
  m_ownDataStore = ownStores;
  m_dataLink.setElement(pData);
  m_shower = pData;
  return m_dataLink.isValid(); 
} 

◆ setDefaultHash()

void AthenaBarCodeImpl::setDefaultHash ( const char * jobid )

staticinherited

Definition at line 298 of file AthenaBarCodeImpl.cxx.

                                                   {
  getDefaultHash (jobid);
}

◆ setDefaultSignalState()

bool CaloCluster::setDefaultSignalState ( signalstate_t s )

inlineprotected

Sets default signal state.

Definition at line 865 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

{
  m_defSigState = s;
  return this->setSignalState(s);
}

◆ setE()

void CaloCluster::setE ( double e )

inlinevirtual

Set energy.

Reimplemented from P4EEtaPhiM.

Definition at line 767 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

768{ (this->*m_setE)(e); }

CaloCluster::m_setE

SET_VALUE m_setE

Pointer to setter functions.

Definition Calorimeter/CaloEvent/CaloEvent/CaloCluster.h:681

◆ setEInSamples()

void CaloCluster::setEInSamples ( const std::vector< double > & theEnergies )

inline

Set energy in all samplings from a vector.

Parameters

theEnergies reference to a vector holding the energies in samplings (input unchanged)

Note: The CaloSampling::CaloSample indicator is interpreted as an (unsigned) int internally. The input vector should be set up such that the index to an energy value is understood to be the CaloSampling::CaloSample of the corresponding calorimeter sampling.

Definition at line 1041 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

1042{ this->setVariable(CaloVariableType::ENERGY,theEnergies,true); }

CaloCluster::setVariable

bool setVariable(const variable_type &varType, const sampling_type &samType, const double &varData, bool useLink=false)

General sampling variable setter.

Definition CaloCluster.cxx:872

◆ setEndcap()

void CaloCluster::setEndcap ( bool endcap )

inline

Sets EMEC indicator.

Parameters

endcap input flag is true if at least one cell in EMEC

Definition at line 939 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

939{ m_endcap = endcap; }

◆ setenergy()

void CaloCluster::setenergy	(	sampling_type	theSampling,
		double	theEnergy )

inline

Set energy for a given sampling.

Parameters

theSampling	sampling indicator
theEnergy	energy data

Depreciated. Sets the sampling energy without updating the global kinematics.

Definition at line 1029 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

1030{ this->setVariable(CaloVariableType::ENERGY,theSampling,theEnergy,true); }

◆ setenergymax()

void CaloCluster::setenergymax	(	sampling_type	sampling,
		double	m )

Set the maximum energy in a given sampling.

Definition at line 908 of file CaloCluster.cxx.

{
  if ( this->isEMSampling(sampling) )
    this->setVariable(CaloVariableType::MAX_ENERGY,sampling,m,true);
}

◆ setEta()

void CaloCluster::setEta ( double eta )

inlinevirtual

Set eta.

Reimplemented from P4EEtaPhiM.

Definition at line 769 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

770{ (this->*m_setEta)(eta); }

CaloCluster::m_setEta

SET_VALUE m_setEta

Pointer to setter functions.

Definition Calorimeter/CaloEvent/CaloEvent/CaloCluster.h:683

◆ seteta()

void CaloCluster::seteta	(	sampling_type	sampling,
		double	eta )

inline

Set \( \eta \) in a given sampling.

Parameters

sampling	calorimeter sampling indicator
eta	\( \eta \) value to be set

Definition at line 1048 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

1049{ this->setVariable(CaloVariableType::ETA,sampling,eta,true); }

◆ setEtaInSamples()

void CaloCluster::setEtaInSamples ( const std::vector< double > & theEtas )

inline

Set \( \eta \) in all samplings from a vector.

Parameters

theEtas reference to a vector holding the \( \eta \) in samplings (input unchanged)

Note: The CaloSampling::CaloSample indicator is interpreted as an (unsigned) int internally. The input vector should be set up such that the index to a \( \eta \) value is understood to be the CaloSampling::CaloSample of the corresponding calorimeter sampling.

Definition at line 1061 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

1062{ this->setVariable(CaloVariableType::ETA,theEtas,true); }

◆ setetamax()

void CaloCluster::setetamax	(	sampling_type	sampling,
		double	m )

Set the \( \eta \) of cell with maximum energy in a given sampling.

Definition at line 914 of file CaloCluster.cxx.

{
  if ( this->isEMSampling(sampling) )
    this->setVariable(CaloVariableType::MAX_ETA,sampling,m,true);
}

◆ setetasize()

void CaloCluster::setetasize	(	sampling_type	sampling,
		double	size )

Set the cluster size in \( \eta \) for a given sampling.

Parameters

sampling	calorimeter sampling indicator
size	input \( \Delta\eta \) cluster size

Definition at line 930 of file CaloCluster.cxx.

{
  if ( this->isEMSampling(sampling) )
    this->setVariable(CaloVariableType::DELTA_ETA,sampling,size,true);
}

◆ setLinkStore()

bool CaloClusterNavigable::setLinkStore	(	CaloCellLink *	pLink,
		bool	ownStores = true )

inlineprotectedinherited

Definition at line 191 of file CaloClusterNavigable.h.

{
  m_cellLink.setElement(pLink);
  m_ownLinkStore = ownStores;
  //  m_cellLinkPointer = pLink;
  return *m_cellLink != 0;
}

◆ setM()

void CaloCluster::setM ( double m )

inlinevirtual

Set mass.

Reimplemented from P4EEtaPhiM.

Definition at line 773 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

774{ (this->*m_setM)(m); }

CaloCluster::m_setM

SET_VALUE m_setM

Pointer to setter functions.

Definition Calorimeter/CaloEvent/CaloEvent/CaloCluster.h:687

◆ setPhi()

void CaloCluster::setPhi ( double phi )

inlinevirtual

Set phi.

Reimplemented from P4EEtaPhiM.

Definition at line 771 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

772{ (this->*m_setPhi)(phi); }

CaloCluster::m_setPhi

SET_VALUE m_setPhi

Pointer to setter functions.

Definition Calorimeter/CaloEvent/CaloEvent/CaloCluster.h:685

◆ setphi()

void CaloCluster::setphi	(	sampling_type	sampling,
		double	phi )

inline

Set \( \varphi \) in a given sampling.

Parameters

sampling	calorimeter sampling indicator
phi	\( \varphi \) value to be set

Definition at line 1068 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

1069{ this->setVariable(CaloVariableType::PHI,sampling,phi,true); }

◆ setPhiInSamples()

void CaloCluster::setPhiInSamples ( const std::vector< double > & thePhis )

inline

Set \( \varphi \) in all samplings from a vector.

Parameters

thePhis reference to a vector holding the \( \eta \) in samplings (input unchanged)

Note: The CaloSampling::CaloSample indicator is interpreted as an (unsigned) int internally. The input vector should be set up such that the index to a \( \varphi \) value is understood to be the CaloSampling::CaloSample of the corresponding calorimeter sampling.

Definition at line 1081 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

1082{ this->setVariable(CaloVariableType::PHI,thePhis,true); }

◆ setphimax()

void CaloCluster::setphimax	(	sampling_type	sampling,
		double	m )

Set the \( \varphi \) of cell with maximum energy in a given sampling.

Definition at line 920 of file CaloCluster.cxx.

{
  if ( this->isEMSampling(sampling) )
    this->setVariable(CaloVariableType::MAX_PHI,sampling,m,true);
}

◆ setphisize()

void CaloCluster::setphisize	(	sampling_type	sampling,
		double	size )

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

Parameters

sampling	calorimeter sampling indicator
size	input \( \Delta\varphi \) cluster size

Definition at line 940 of file CaloCluster.cxx.

{
  if ( this->isEMSampling(sampling) )
    this->setVariable(CaloVariableType::DELTA_PHI,sampling,size,true);
}

◆ setReserveBits()

void AthenaBarCodeImpl::setReserveBits ( AthenaBarCode_t id )

inherited

Definition at line 223 of file AthenaBarCodeImpl.cxx.

                                                    {
  if (m_barcode==IAthenaBarCode::UNDEFINEDBARCODE) 
    initABC();
 
  try {
    AthenaBarCode_t bc = m_barcode;
    setBits(SReserveBits, ReserveBits, id, bc);
    m_barcode = bc;
  }
  catch (const GaudiException& Exception) {
    throw std::runtime_error(
        "AthenaBarCodeImpl::newVersion()::Version Overflow");
  }
}

◆ setSignalState()

bool CaloCluster::setSignalState ( signalstate_t s )

protectedvirtual

Sets signal state.

Implements ISignalState.

Definition at line 1345 of file CaloCluster.cxx.

{
  if ( !this->hasSignalState(s) ) return false;
 
  m_signalState = s;
 
  return
    s == statename_t::CALIBRATED    ? this->setStateCal() :
    s == statename_t::ALTCALIBRATED ? this->setStateAlt() :
    s == statename_t::UNCALIBRATED  ? this->setStateRaw() :
    false;
}

◆ setStateAlt()

bool CaloCluster::setStateAlt ( )

private

Helper to switch to calibrated (cell weight) state.

Definition at line 1392 of file CaloCluster.cxx.

{
  // std::cout << "CaloCluster [" << this
  //        << "] setStateAlt()" << std::endl;
  m_getE   = &CaloCluster::getAltE;
  m_getEta = &CaloCluster::getAltEta;
  m_getPhi = &CaloCluster::getAltPhi;
  m_getM   = &CaloCluster::getAltM;
  //
  m_setE   = &CaloCluster::setAltE;
  m_setEta = &CaloCluster::setAltEta;
  m_setPhi = &CaloCluster::setAltPhi;
  m_setM   = &CaloCluster::setAltM;
  return true;
}

◆ setStateCal()

bool CaloCluster::setStateCal ( )

private

Helper to switch to calibrated (LC) state.

Definition at line 1408 of file CaloCluster.cxx.

{
  // std::cout << "CaloCluster [" << this
  //        << "] setStateCal()" << std::endl;
  m_getE   = &CaloCluster::getCalE;
  m_getEta = &CaloCluster::getCalEta;
  m_getPhi = &CaloCluster::getCalPhi;
  m_getM   = &CaloCluster::getCalM;
  //
  m_setE   = &CaloCluster::setCalE;
  m_setEta = &CaloCluster::setCalEta;
  m_setPhi = &CaloCluster::setCalPhi;
  m_setM   = &CaloCluster::setCalM;
  return true;
}

◆ setStateRaw()

bool CaloCluster::setStateRaw ( )

private

Helper to switch to raw state.

Definition at line 1375 of file CaloCluster.cxx.

{
  // std::cout << "CaloCluster [" << this
  //        << "] setStateRaw()" << std::endl;
  m_getE   = &CaloCluster::getRawE;
  m_getEta = &CaloCluster::getRawEta;
  m_getPhi = &CaloCluster::getRawPhi;
  m_getM   = &CaloCluster::getRawM;
  //
  m_setE   = &CaloCluster::setRawE;
  m_setEta = &CaloCluster::setRawEta;
  m_setPhi = &CaloCluster::setRawPhi;
  m_setM   = &CaloCluster::setRawM;
  //
  return true;
}

◆ setStores()

bool CaloCluster::setStores	(	CaloShower *	pData,
		CaloCellLink *	pLink,
		bool	ownStores = true )

inlineprotected

Setup internal store.

Definition at line 902 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

{
  return ( this->setDataStore(pData,ownStores) &&  
       this->setLinkStore(pLink,ownStores) );
}

◆ setTime()

void CaloCluster::setTime ( double theTime )

inline

Set cluster time.

Definition at line 889 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

889{ m_time = theTime; }

◆ setUUIDHash()

void AthenaBarCodeImpl::setUUIDHash ( AthenaBarCode_t uuidhash )

inlineprivateinherited

Definition at line 114 of file AthenaBarCodeImpl.h.

                                                                   {
  m_barcode = combineWithUUIDHash(uuidhash);
}

◆ setVariable() [1/2]

bool CaloCluster::setVariable	(	const variable_type &	varType,
		const sampling_type &	samType,
		const double &	varData,
		bool	useLink = false )

General sampling variable setter.

Parameters

varType	variable type
samType	sampling indicator
varData	data value
useLink	if true data is stored in external store

Definition at line 872 of file CaloCluster.cxx.

{
  // check samplingpattern
  if(!this->hasSampling(samType)){
    //    std::cout << " Cluster does not have sampling " << samType << std::endl;
    m_samplingPattern =
      m_samplingPattern | CaloSamplingHelper::getSamplingBit(samType);
  }
 
  // allocate modifiable data store
  CaloSamplingData* pDataStore = this->getDataStore(varType,useLink);
  return pDataStore != nullptr
    ? pDataStore->storeData(varType,samType,varData)
    : false;
}

◆ setVariable() [2/2]

bool CaloCluster::setVariable	(	const variable_type &	varType,
		const std::vector< double > &	varList,
		bool	useLink = false )

Set variables of a given type in all samplings at once.

Definition at line 892 of file CaloCluster.cxx.

{
  CaloSamplingData* pDataStore = this->getDataStore(varType,useLink);
  return pDataStore != nullptr
    ? pDataStore->storeData(varType,varList)
    : false;
}

◆ setVersion()

void AthenaBarCodeBase::setVersion ( AthenaBarCodeVersion_t newversion )

virtualinherited

Reimplemented from IAthenaBarCode.

Definition at line 59 of file AthenaBarCodeBase.cxx.

{
  AthenaBarCodeImpl::setVersion (newversion);
}

◆ signalState()

CaloCluster::signalstate_t CaloCluster::signalState ( ) const

inlinevirtual

Retrieve signal state.

Implements ISignalState.

Definition at line 860 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

861{ return m_signalState; }

◆ sinPhi()

double P4EEtaPhiMBase::sinPhi ( ) const

virtualinherited

sinus phi

Implements I4Momentum.

Reimplemented in CaloCell, and CaloVertexedCell.

Definition at line 59 of file P4EEtaPhiMBase.cxx.

{ 
 return std::sin(this->phi());
}

◆ sinTh()

double P4EEtaPhiMBase::sinTh ( ) const

virtualinherited

sinus theta

Implements I4Momentum.

Reimplemented in CaloCell, and CaloVertexedCell.

Definition at line 87 of file P4EEtaPhiMBase.cxx.

{ 
  // avoid numeric overflow if very large eta
 
  double aEta=std::abs(this->eta());
  if ( aEta>710) {
    aEta=710;
  }
 
  return 1./std::cosh(aEta);
  
}

◆ tanTh()

double P4EEtaPhiMBase::tanTh ( ) const

virtualinherited

tan theta

Implements I4Momentum.

Definition at line 64 of file P4EEtaPhiMBase.cxx.

{ 
  // avoid numeric overflow if very large eta
 
  double theEta=this->eta();
  if ( std::abs(theEta)>710) {
    theEta=theEta>0 ? 710 : -710;
    return 1./std::sinh(theEta);
  }
 
 return 1./this->cotTh();
}

◆ unlockVariable()

bool CaloCluster::unlockVariable ( const variable_type & varType )

Unlock variable (remove lock)

Definition at line 1301 of file CaloCluster.cxx.

{
  unsigned int bitPattern(CaloVariableType::getVariableBit(varType));
  if ( this->isLocked(bitPattern) )
    {
      m_lockPattern = m_lockPattern ^ bitPattern;
      return ! this->isLocked(bitPattern);
    }
  else
    {
      return false;
    }
}

◆ updateKine()

void CaloCluster::updateKine	(	const CaloCell *	theCell,
		double	weight )

protectedvirtual

Updates cluster kinematics when cell is added.

Parameters

theCell	pointer to a CaloCell
weight	signal weight of cell in cluster

Present implementation performs full four-vector update for each cell added.

Implements CaloCompositeCellBase< CaloClusterNavigable >.

Definition at line 263 of file CaloCluster.cxx.

{
 
  // update global kinematics
  //
  // for the update of the position the normalization is not a trival
  // thing. The previous implementation used the sum of weighted
  // energies as normalization. This leads to unphysical eta and phi
  // values in case negative energies are added in. The new algorithm
  // takes therefore |E| instead of E which gives the same eta and phi
  // as before for the 2 cases where all cells are negative or all
  // cells are positive. In the mixed case it will give the direction
  // of activity in the calorimeter.
 
  if (!theCell->caloDDE()) return;
 
  double theEnergyNoWeight = theCell->e();
  double theEnergy    = weight * theEnergyNoWeight;
  double cellEta = theCell->eta();
  double cellPhi = theCell->phi();
  // weight might be negative for removing cells
  // therefore the AbsEnergy can be negative ...
  double theAbsEnergy = weight * fabs(theEnergyNoWeight);
  double thePhi       = proxim(cellPhi,this->phi());
  double theNewEta    =
    m_posNorm * this->eta() + theAbsEnergy * cellEta;
  double theNewPhi    = m_posNorm * this->phi() + theAbsEnergy * thePhi;
  double theNewEnergy = this->e() + theEnergy;
  m_posNorm += theAbsEnergy;
 
  if ( m_posNorm != 0. )
    {
      this->setEta(theNewEta/m_posNorm);
      this->setPhi(CaloPhiRange::fix (theNewPhi/m_posNorm));
    }
  else
    {
      this->setEta(0);
      this->setPhi(0);
    }
 
  this->setE(theNewEnergy);
 
  // calculate the cluster time from cells which provide a time
  // two modes are under discussion - either use an energy^2 weighted
  // average (sigma_t ~ 1/E) or just the time of the leading cell
  // for now the energy^2 weighted average is implemented ...
 
  // need sampling number already for time
  CaloSampling::CaloSample sam = theCell->caloDDE()->getSampling();
  // unknown sampling
  if ( sam == CaloSampling::Unknown ) return;
 
  unsigned pmask = 0;
  if (sam != CaloSampling::PreSamplerB &&
      sam != CaloSampling::PreSamplerE)
  {
    if ( theCell->caloDDE()->is_tile() )
      pmask = 0x8080;
    else
      pmask = 0x2000;
  }
 
  // Is time defined?
  if ( theCell->provenance() & pmask ) {
    // keep the sign of weight for the time norm in case a cell is removed
    double theTimeNorm = fabs(weight) * theEnergy * theEnergyNoWeight;
 
    double theNewTime = m_timeNorm * this->getTime()
      + theTimeNorm * theCell->time();
 
    m_timeNorm += theTimeNorm;
 
    if ( m_timeNorm != 0. )
      {
    this->setTime(theNewTime/m_timeNorm);
      }
    else
      {
    this->setTime(0);
      }
  }
  // Check Sampling Variable Updates //
 
  // no update required
  if ( this->allLocked() ) return;
 
  // update sampling quantities
 
  // This has gotten a bit more involved. To handle the stores for the
  // data correctly, a pointer to each store (can be different for each
  // variable type) has to be retrieved first (internal function). As all
  // variables need the sampling energy, we start with this store. Note that
  // the store for each variable can be defined by calling the corresponding
  // set method before the first \a updateKine invocation.
  // Energy in Sampling //
 
  CaloVariableType::VariableType typeE = CaloVariableType::ENERGY;
  if ( ! this->isLocked(typeE) )
    {
      CaloSamplingData* pEStore = this->getDataStore(typeE,true);
      if ( pEStore != nullptr )
    {
      // note that this is a reference to a modifiable data word!
      pEStore->retrieveData(typeE,sam) += theEnergy;
    }
    }
 
  double theOldNorm(m_posSamNorm[sam]);
  m_posSamNorm[sam]+=theAbsEnergy;
  double theNewNorm(m_posSamNorm[sam]);
  // Azimuth //
 
  // azimuth
  CaloVariableType::VariableType typePhi = CaloVariableType::PHI;
  if ( ! this->isLocked(typePhi) )
    {
      // central azimuth
      CaloSamplingData* pPhiStore = this->getDataStore(typePhi,true);
      if ( pPhiStore != nullptr )
    {
      double& refPhiSamp = pPhiStore->retrieveData(typePhi,sam);
      thePhi     = proxim(cellPhi,refPhiSamp);
      theNewPhi  = theNewNorm != 0.
        ? CaloPhiRange::fix((theOldNorm*refPhiSamp+theAbsEnergy*thePhi)/theNewNorm)
        : double(0);
 
      // spread in azimuth
      CaloVariableType::VariableType typeDPhi =
        CaloVariableType::DELTA_PHI;
      if ( ! this->isLocked(typeDPhi) )
        {
          CaloSamplingData* pDPhiStore = this->getDataStore(typeDPhi,true);
          if ( pDPhiStore != nullptr )
        {
          // non-const reference -> modification in place!
          double& refDPhiSamp = pDPhiStore->retrieveData(typeDPhi,sam);
          double wP2
            = theOldNorm *
            ( refDPhiSamp*refDPhiSamp + refPhiSamp*refPhiSamp)
            + theAbsEnergy * thePhi * thePhi;
          refDPhiSamp = theNewNorm != 0.
            ? wP2 / theNewNorm - theNewPhi*theNewPhi
            : double(0);
          if ( refDPhiSamp > 0. )
            {
              refDPhiSamp = sqrt(refDPhiSamp);
            }
          else
            {
              refDPhiSamp = double(0);
            }
        }
        }
      // save the new phi value
      refPhiSamp = theNewPhi;
    }
    }
  // Rapidity //
 
 
  // rapidity
  CaloVariableType::VariableType typeEta = CaloVariableType::ETA;
  if ( ! this->isLocked(typeEta) )
    {
      CaloSamplingData* pEtaStore = this->getDataStore(typeEta,true);
      if ( pEtaStore != nullptr )
    {
      double& refEtaSamp = pEtaStore->retrieveData(typeEta,sam);
      double  theNewEta  = theNewNorm != 0.
        ? (theOldNorm*refEtaSamp+theAbsEnergy* cellEta)/theNewNorm
        : double(0);
 
      // spread in eta
      CaloVariableType::VariableType typeDEta =
        CaloVariableType::DELTA_ETA;
      if ( ! this->isLocked(typeDEta) )
        {
          CaloSamplingData* pDEtaStore = this->getDataStore(typeDEta,true);
          if ( pDEtaStore != nullptr )
        {
          double& refDEtaSamp = pDEtaStore->retrieveData(typeDEta,sam);
          double wE2 = theOldNorm * (refDEtaSamp * refDEtaSamp +
                         refEtaSamp  * refEtaSamp )
            + theAbsEnergy * cellEta * cellEta;
          refDEtaSamp = theNewNorm != 0
            ? wE2 / theNewNorm - theNewEta * theNewEta
            : double(0);
          if ( refDEtaSamp > 0. )
            {
              refDEtaSamp = sqrt(refDEtaSamp);
            }
          else
            {
              refDEtaSamp = double(0.0);
            }
        }
        }
      // save the new eta value
      refEtaSamp = theNewEta;
    }
    }
  // Maximum Energy Cell //
 
  CaloVariableType::VariableType typeEMax = CaloVariableType::MAX_ENERGY;
  if ( ! this->isLocked(typeEMax) )
    {
      CaloSamplingData* pEMaxStore = this->getDataStore(typeEMax,true);
      if ( pEMaxStore != nullptr )
    {
      double& refEMaxSamp = pEMaxStore->retrieveData(typeEMax,sam);
      if ( refEMaxSamp < theEnergy )
        {
          // set new maximum energy
          refEMaxSamp = theEnergy;
          // set new eta
          CaloVariableType::VariableType typeEtaMax =
        CaloVariableType::MAX_ETA;
          if ( ! this->isLocked(typeEtaMax) )
        {
          CaloSamplingData* pEtaMaxStore =
            this->getDataStore(typeEtaMax,true);
          if ( pEtaMaxStore != nullptr )
            {
              pEtaMaxStore->retrieveData(typeEtaMax,sam) =
            cellEta;
            }
        }
          // set new phi
          CaloVariableType::VariableType typePhiMax =
        CaloVariableType::MAX_PHI;
          if ( ! this->isLocked(typePhiMax) )
        {
          CaloSamplingData* pPhiMaxStore =
            this->getDataStore(typePhiMax,true);
          if ( pPhiMaxStore != nullptr )
            {
              pPhiMaxStore->retrieveData(typePhiMax,sam) = thePhi;
            }
        } // lock on phi of maximum sampling signal
        } // maximum condition
    } // data store pointer
    } // lock on max energy
 
  if ( theEnergy != 0)
    {
      // check sampling bit
      m_samplingPattern =
    m_samplingPattern | CaloSamplingHelper::getSamplingBit(sam);
      // count cells in endcap
 
      switch(sam)
    {
    case CaloSampling::PreSamplerE:
    case CaloSampling::EME1:
    case CaloSampling::EME2:
    case CaloSampling::EME3:
    case CaloSampling::HEC0:
    case CaloSampling::HEC1:
    case CaloSampling::HEC2:
    case CaloSampling::HEC3:
    case CaloSampling::FCAL0:
    case CaloSampling::FCAL1:
    case CaloSampling::FCAL2:
      m_nEndcap += (weight<0?-1:1);
      break;
    default:
      m_nBarrel += (weight<0?-1:1);
      break;
    }
    }
 
  if ( m_nBarrel < 0 ) m_nBarrel = 0;
  if ( m_nEndcap < 0 ) m_nEndcap = 0;
 
  m_barrel = (m_nBarrel>0);
  m_endcap = (m_nEndcap>0);
}

◆ variableBE()

double CaloCluster::variableBE	(	const variable_type &	theVariable,
		const int &	samplingIndex ) const

protected

Rewrite \( e_{0} \varphi_{0} + e_{1} \varphi_{1} \) as \( \left( e_{0} + e_{1} \right) \varphi_{0} + e_{1} \left( \varphi_{1} - \varphi_{0} \right) \) for \( \varphi \) calculation.

Definition at line 953 of file CaloCluster.cxx.

{
  // check input
  unsigned int iSamp((unsigned int)sam);
  if ( iSamp > 3 ) return m_errorValue;
 
  // barrel and endcap
  if ( this->inBarrel() && this->inEndcap() )
    {
      // offsets for sampling indicators
      unsigned int bOff = (unsigned int)CaloSampling::PreSamplerB;
      unsigned int eOff = (unsigned int)CaloSampling::PreSamplerE;
      CaloSampling::CaloSample bSample =
    (CaloSampling::CaloSample)(bOff+iSamp);
      CaloSampling::CaloSample eSample =
    (CaloSampling::CaloSample)(eOff+iSamp);
      double eBarrel = this->getVariable(CaloVariableType::ENERGY,
                         bSample,true);
      double eEndCap = this->getVariable(CaloVariableType::ENERGY,
                         eSample,true);
 
      double vBarrel = this->getVariable(varType,bSample,true);
      double vEndCap = this->getVariable(varType,eSample,true);
 
      // Deal with invalid eta/phi values.
      if (varType == CaloVariableType::PHI ||
          varType == CaloVariableType::ETA)
      {
        if (vBarrel <= m_errorValue) {
          vBarrel = 0;
          eBarrel = 0;
        }
        if (vEndCap <= m_errorValue) {
          vEndCap = 0;
          eEndCap = 0;
        }
      }
 
      // invalid signals
      double eSum = eBarrel + eEndCap;
      if ( eSum == 0. ) return m_errorValue;
      // average
      double vAverage(m_errorValue);
      switch ( varType )
    {
    case CaloVariableType::PHI:
      {
        double phiSum =
          eSum * vBarrel + eEndCap * CaloPhiRange::diff(vEndCap,vBarrel);
        vAverage = CaloPhiRange::fix(phiSum/eSum);
        break;
      }
    case CaloVariableType::ETA:
      {
        vAverage = ( eBarrel * vBarrel + eEndCap * vEndCap ) / eSum;
        break;
      }
    case CaloVariableType::ENERGY:
      {
        vAverage = eSum;
        break;
      }
    default:
      {
        break;
      }
    }
      return vAverage;
    }
 
  // barrel only
  if ( this->inBarrel() )
    {
      unsigned int bOff = (unsigned int)CaloSampling::PreSamplerB;
      CaloSampling::CaloSample bSample =
    (CaloSampling::CaloSample)(bOff+iSamp);
      return this->getVariable(varType,bSample);
    }
 
  // endcap only
  if ( this->inEndcap() )
    {
      unsigned int eOff = (unsigned int)CaloSampling::PreSamplerE;
      CaloSampling::CaloSample eSample =
    (CaloSampling::CaloSample)(eOff+iSamp);
      return this->getVariable(varType,eSample);
    }
 
  // just in case
  return m_errorValue;
}

Definition at line 44 of file AthenaBarCodeImpl.h.

◆ m_altE

double CaloCluster::m_altE

private

Stores calibrated (cell weight) signal.

Definition at line 705 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

◆ m_altEta

double CaloCluster::m_altEta

private

Stores calibrated (cell weight) signal.

Definition at line 707 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

◆ m_altM

double CaloCluster::m_altM

private

Stores calibrated (cell weight) signal.

Definition at line 711 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

◆ m_altPhi

double CaloCluster::m_altPhi

private

Stores calibrated (cell weight) signal.

Definition at line 709 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

◆ m_badChannelData

badChannelList CaloCluster::m_badChannelData

private

Definition at line 583 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

◆ m_barcode

std::atomic<AthenaBarCode_t> AthenaBarCodeImpl::m_barcode

mutableprivateinherited

Definition at line 110 of file AthenaBarCodeImpl.h.

◆ m_barcodeCounter

std::atomic< AthenaBarCode_t > AthenaBarCodeImpl::m_barcodeCounter = 0

staticprivateinherited

Definition at line 109 of file AthenaBarCodeImpl.h.

◆ m_barrel

bool CaloCluster::m_barrel

private

Flag is true if at least one cell in EMB.

Definition at line 549 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

◆ m_basicSignal

double CaloCluster::m_basicSignal

protected

Stores basic energy signal.

Definition at line 495 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

◆ m_cellLink

cell_link_type CaloClusterNavigable::m_cellLink

privateinherited

Local pointer to cell store.

Link to cell links object

Definition at line 186 of file CaloClusterNavigable.h.

◆ m_clusterSize

unsigned int CaloCluster::m_clusterSize

private

Cluster size (e.g.

5x5, 3.7, ...)

Definition at line 554 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

◆ m_dataLink

data_link_type CaloCluster::m_dataLink

protected

{

Linked Stores link to data

Definition at line 488 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

◆ m_dataStore

CaloSamplingData CaloCluster::m_dataStore

protected

{\ brief Cached Stores

sampling data

Definition at line 479 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

◆ m_defSigState

signalstate_t CaloCluster::m_defSigState

private

Stores default signal state.

Definition at line 693 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

◆ m_e

double P4EEtaPhiM::m_e

protectedinherited

Definition at line 75 of file P4EEtaPhiM.h.

◆ m_endcap

bool CaloCluster::m_endcap

private

Flag is true if at least one cell in EMB.

Definition at line 551 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

◆ m_errorValue

const double CaloCluster::m_errorValue = -999.

staticprotected

Internal error return for real numbers.

Definition at line 476 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

◆ m_eta

double P4EEtaPhiM::m_eta

protectedinherited

Definition at line 76 of file P4EEtaPhiM.h.

unsigned int CaloCluster::m_lockPattern

private

Variable lock pattern.

Definition at line 581 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

◆ m_m

double P4EEtaPhiM::m_m

protectedinherited

Definition at line 78 of file P4EEtaPhiM.h.

◆ m_momentStore

CaloClusterMomentStore CaloCluster::m_momentStore

protected

cluster moments

Definition at line 480 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

◆ m_nBarrel

int CaloCluster::m_nBarrel

private

Counter for number of barrel cells with non-zero weight and energy.

Definition at line 576 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

◆ m_nEndcap

int CaloCluster::m_nEndcap

private

Counter for number of endcap cells with non-zero weight and energy.

Definition at line 579 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

◆ m_ownDataStore

bool CaloCluster::m_ownDataStore

protected

}

Temporary stores

Definition at line 485 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

◆ m_ownLinkStore

bool CaloClusterNavigable::m_ownLinkStore

protectedinherited

Definition at line 178 of file CaloClusterNavigable.h.

◆ m_phi

double P4EEtaPhiM::m_phi

protectedinherited

Definition at line 77 of file P4EEtaPhiM.h.

◆ m_setEta

SET_VALUE CaloCluster::m_setEta {}

private

Pointer to setter functions.

Definition at line 683 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

683{};

◆ m_setM

SET_VALUE CaloCluster::m_setM {}

private

Pointer to setter functions.

Definition at line 687 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

687{};

◆ m_setPhi

SET_VALUE CaloCluster::m_setPhi {}

private

Pointer to setter functions.

Definition at line 685 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

685{};

◆ m_shower

CaloShower* CaloCluster::m_shower

protected

}

Non-const pointer to linked store.

Definition at line 492 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

◆ m_signalState

signalstate_t CaloCluster::m_signalState

private

Stores actual signal state.

Definition at line 691 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

◆ m_status

CaloRecoStatus CaloCompositeKineBase::m_status

protectedinherited

Calorimeter reconstruction status.

Definition at line 58 of file CaloCompositeKineBase.h.

◆ m_time

double CaloCluster::m_time

protected

Cluster timing.

Definition at line 498 of file Calorimeter/CaloEvent/CaloEvent/CaloCluster.h.

◆ m_timeNorm

double CaloCluster::m_timeNorm

private

const unsigned short AthenaBarCodeImpl::VersionBits = 4

staticinherited

Definition at line 45 of file AthenaBarCodeImpl.h.

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ badChannelList

◆ cell_iterator

◆ cell_link_type

◆ data_link_type

◆ GET_VALUE

◆ moment_iterator

◆ moment_iterator_i

◆ moment_store

◆ moment_type

◆ moment_value

◆ MomentType

◆ object_iter

◆ sampling_type

◆ SET_VALUE

◆ signalstate_t

◆ statename_t

◆ value_type

◆ variable_type

Member Enumeration Documentation

◆ ClusterSize

◆ Kind

Constructor & Destructor Documentation

◆ CaloCluster() [1/3]

◆ ~CaloCluster()

◆ CaloCluster() [2/3]

◆ CaloCluster() [3/3]

Member Function Documentation

◆ addBadChannel()

◆ addCell()

◆ addUniqueCell()

◆ addUniqueCellNoKine()

◆ allLocked()

◆ begin()

◆ beginMoment()

◆ calculateKine()

◆ cell_begin()

◆ cell_end()

◆ cellLink()

◆ checkRecoStatus()

◆ combineWithUUIDHash()

◆ contains() [1/2]

◆ contains() [2/2]

◆ containsBadCells()

◆ cosPhi()

◆ cosTh()

◆ cotTh()

◆ createdInCurrentJob()

◆ defaultSignalState()

◆ dump() [1/2]

◆ dump() [2/2]

◆ e() [1/2]

◆ e() [2/2]

◆ end()

◆ endMoment()

◆ energy()

◆ energy_max()

◆ energy_nonvirt()

◆ energyBE()

◆ errors()

◆ eSample()

◆ et()

◆ eta() [1/2]

◆ eta() [2/2]

◆ eta0()