 |
ATLAS Offline Software
|
Loading...
Searching...
No Matches
|
ATLAS Offline Software
|
Description of a calorimeter cluster. More...
#include <CaloCluster_v1.h>
Public Member Functions | |
| CaloCluster_v1 () | |
| Default constructor. | |
| CaloCluster_v1 (const CaloCluster_v1 &other) | |
| Copy constructor. | |
| virtual | ~CaloCluster_v1 () |
| Destructor. | |
| CaloCluster_v1 & | operator= (const xAOD::CaloCluster_v1 &other) |
| Assignment operator. | |
| unsigned int | getClusterEtaSize () const |
| Get eta size from cluster size. | |
| unsigned int | getClusterPhiSize () const |
| Get phi size from cluster size. | |
| void | setBadChannelList (const CaloClusterBadChannelList &bcl) |
| const CaloClusterBadChannelList & | badChannelList () const |
| const CaloCluster_v1 * | getSisterCluster () const |
| Get a pointer to a 'sister' cluster (eg the non-calibrated counterpart) | |
| const ElementLink< xAOD::CaloClusterContainer_v1 > & | getSisterClusterLink () const |
| Get a link to a 'sister' cluster (eg the non-calibrated counterpart) | |
| bool | setSisterClusterLink (const ElementLink< CaloClusterContainer_v1 > &sister) |
| Set a link to a 'sister' cluster (eg the non-calibrated counterpart) | |
| void | toPersistent () |
| Function preparing the object to be persistified. | |
| template<class T, class ALLOC = AuxAllocator_t<T>> | |
| XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::reference_type | auxdata (const std::string &name) |
| Fetch an aux data variable, as a non-const reference. | |
| template<class T, class ALLOC = AuxAllocator_t<T>> | |
| XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type | auxdata (const std::string &name) const |
| Fetch an aux data variable, as a const reference. | |
| template<class T, class ALLOC = AuxAllocator_t<T>> | |
| XAOD_AUXDATA_DEPRECATED bool | isAvailableWritable (const std::string &name, const std::string &clsname="") |
| Check if an aux variable is available for writing. | |
| void | assign (const AuxElement &other, bool warnUnlocked=false) |
| Assignment. | |
| const SG::AuxVectorData * | container () const |
| Return the container holding this element. | |
| SG::AuxVectorData * | container () |
| Return the container holding this element. | |
| template<class T, class ALLOC = AuxAllocator_t<T>> | |
| XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type | auxdataConst (const std::string &name) const |
| Fetch an aux data variable, as a const reference. | |
| template<class T, class ALLOC = AuxAllocator_t<T>> | |
| XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type | auxdataConst (const std::string &name, const std::string &clsname) const |
| Fetch an aux data variable, as a const reference. | |
| template<class T, class ALLOC = AuxAllocator_t<T>> | |
| XAOD_AUXDATA_DEPRECATED bool | isAvailableWritableAsDecoration (const std::string &name, const std::string &clsname="") const |
| Check if an aux variable is available for writing as a decoration. | |
| template<class T, class ALLOC = AuxAllocator_t<T>> | |
| XAOD_AUXDATA_DEPRECATED Decorator< T, ALLOC >::reference_type | auxdecor (const std::string &name) const |
| Fetch an aux decoration, as a non-const reference. | |
| template<class T, class ALLOC = AuxAllocator_t<T>> | |
| XAOD_AUXDATA_DEPRECATED Decorator< T, ALLOC >::reference_type | auxdecor (const std::string &name, const std::string &clsname) const |
| Fetch an aux decoration, as a non-const reference. | |
| void | makePrivateStore () |
| Create a new (empty) private store for this object. | |
| template<class U1> | |
| void | makePrivateStore (const U1 &other, bool warnUnlocked=false) |
| Create a new private store for this object and copy aux data. | |
| template<class U1> | |
| void | makePrivateStore (const U1 *other, bool warnUnlocked=false) |
| Create a new private store for this object and copy aux data. | |
| void | releasePrivateStore () |
| Release and free any private store associated with this object. | |
| void | setStore (const SG::IConstAuxStore *store) |
| Set the store associated with this object. | |
| void | setStore (SG::IAuxStore *store) |
| Set the store associated with this object. | |
| void | setStore (const DataLink< SG::IConstAuxStore > &store) |
| Set the store associated with this object. | |
| void | setConstStore (const SG::IConstAuxStore *store) |
Synonym for setStore with IConstAuxStore. | |
| void | setNonConstStore (SG::IAuxStore *store) |
Synonym for setStore with IAuxStore. | |
| bool | usingPrivateStore () const |
| Test to see if this object is currently using a private store. | |
| bool | usingStandaloneStore () const |
| Test to see if this object is currently using a standalone store. | |
| void | clearCache () |
| Clear the cached aux data pointers. | |
| const SG::auxid_set_t & | getAuxIDs () const |
| Return a set of identifiers for existing data items for this object. | |
| const SG::auxid_set_t & | getDecorIDs () const |
| Return a set of identifiers for decorations for this object. | |
| bool | hasStore () const |
| Return true if this object has an associated store. | |
| bool | hasNonConstStore () const |
| Return true if this object has an associated non-const store. | |
| bool | clearDecorations () const |
| Clear all decorations. | |
| bool | trackIndices () const |
| Return true if index tracking is enabled for this object. | |
| size_t | index () const |
| Return the index of this element within its container. | |
convinience functions | |
{ The transverse energy of the cluster (negative for neg-Energy clusters with zero mass) | |
| double | et () const |
Energy/Eta/Phi/number of cells per sampling | |
} Retrieve energy in a given sampling | |
| float | eSample (const CaloSample sampling) const |
| float | etaSample (const CaloSample sampling) const |
| Retrieve barycenter \( \eta \) in a given sample. | |
| float | phiSample (const CaloSample sampling) const |
| Retrieve barycenter \( \varphi \) in a given sample. | |
| float | energy_max (const CaloSample sampling) const |
| Retrieve maximum cell energy in given sampling. | |
| float | etamax (const CaloSample sampling) const |
| Retrieve \( \eta \) of cell with maximum energy in given sampling. | |
| float | phimax (const CaloSample sampling) const |
| Retrieve \( \varphi \) of cell with maximum energy in given sampling. | |
| float | etasize (const CaloSample sampling) const |
| Returns cluster size in \( \eta \) for a given sampling. | |
| float | phisize (const CaloSample sampling) const |
| Returns cluster size in \( \varphi \) for a given sampling. | |
| int | numberCellsInSampling (const CaloSample samp, bool isInnerWheel=false) const |
| Returns number of cells in given sampling. | |
| void | setNumberCellsInSampling (CaloSampling::CaloSample samp, int ncells, bool isInnerWheel=false) |
| Set the number of cells in a sampling layer. | |
| int | numberCells () const |
| Return total number of cells in cluster. | |
| template<class CDATA> | |
| bool | getNumberCellsInSampling (CDATA &cdata) const |
| Get number of cells for all sampling layer. | |
| float | energyBE (const unsigned layer) const |
| Get the energy in one layer of the EM Calo. | |
| float | etaBE (const unsigned layer) const |
| Get the eta in one layer of the EM Calo. | |
| float | phiBE (const unsigned layer) const |
| Get the phi in one layer of the EM Calo. | |
| bool | setEnergy (const CaloSample sampling, const float e) |
| Set energy for a given sampling. Returns false if the sample isn't part of the cluster. | |
| bool | setEta (const CaloSample sampling, const float eta) |
| Set \( \eta \) in a given sampling. Returns false if the sample isn't part of the cluster. | |
| bool | setPhi (const CaloSample sampling, const float phi) |
| Set \( \varphi \) in a given sampling. Returns false if the sample isn't part of the cluster. | |
| bool | setEmax (const CaloSample sampling, const float eMax) |
| Set the Energy of the cell with the highest energy in a particular sampling. | |
| bool | setEtamax (const CaloSample sampling, const float etaMax) |
| Set the eta of the cell with the highest energy in a particular sampling. | |
| bool | setPhimax (const CaloSample sampling, const float phiMax) |
| Set the phi of the cell with the highest energy in a particular sampling. | |
| bool | setEtasize (const CaloSample sampling, const float etaSize) |
| Set the cluster size in \( \varphi \) for a given sampling. | |
| bool | setPhisize (const CaloSample sampling, const float phiSize) |
| Set the cluster size in \( \vareta \) for a given sampling. | |
Cluster moments | |
Set individual moment | |
| void | insertMoment (MomentType type, double value) |
| bool | retrieveMoment (MomentType type, double &value) const |
| Retrieve individual moment. | |
| double | getMomentValue (MomentType type) const |
| Retrieve individual moment - no check for existance! Returns -999 on error. | |
| void | insertMoment (MomentType type, const ncells_store_t &values) |
| Insert number of cells/sampling moment (non-scalar) | |
| bool | retrieveMoment (MomentType type, ncells_store_t &values) const |
| Retrieve non-scalar moments. | |
Special Cluster Variables | |
Set raw \( \eta \) of cluster seed | |
| void | setEta0 (flt_t) |
| flt_t | eta0 () const |
| Returns raw \( \eta \) of cluster seed. | |
| void | setPhi0 (flt_t) |
| Set raw \( \phi \) of cluster seed. | |
| flt_t | phi0 () const |
| Returns raw \( \phi \) of cluster seed. | |
| void | setTime (flt_t) |
| Set cluster time. | |
| flt_t | time () const |
| Access cluster time. | |
| void | setSecondTime (flt_t stime) |
| Set second moment of cell timing distribution. | |
| flt_t | secondTime () const |
| Access second moment of cell timing distribution. | |
| unsigned | samplingPattern () const |
| Access to sampling pattern (one bit per sampling) (Method may be removed later) | |
| void | setSamplingPattern (const unsigned sp, const bool clearSamplingVars=false) |
| Set sampling pattern (one bit per sampling. | |
| void | clearSamplingData () |
| Clear the sampling data. | |
| unsigned | nSamples () const |
| bool | hasSampling (const CaloSample s) const |
| Checks if certain smapling contributes to cluster. | |
| ClusterSize | clusterSize () const |
| Get cluster size. | |
| void | setClusterSize (const ClusterSize) |
| Get cluster size. | |
| bool | inBarrel () const |
| Returns true if at least one clustered cell in the barrel. | |
| bool | inEndcap () const |
| Returns true if at least one clustered cell in the endcap. | |
4Momentum setter (signal-state dependent) | |
| void | setE (flt_t) |
| void | setEta (flt_t) |
| Set Eta for the current signal state. | |
| void | setPhi (flt_t) |
| Set Phi for the current signal state. | |
| void | setM (flt_t) |
| Set Mass for the current signal state. | |
Functions for getting and setting user properties | |
| template<class T> | |
| XAOD_AUXDATA_DEPRECATED T & | auxdata (const std::string &name, const std::string &clsname="") |
| Fetch an aux data variable, as a non-const reference. | |
| template<class T> | |
| XAOD_AUXDATA_DEPRECATED const T & | auxdata (const std::string &name, const std::string &clsname="") const |
| Fetch an aux data variable, as a const reference. | |
| template<class T> | |
| XAOD_AUXDATA_DEPRECATED bool | isAvailable (const std::string &name, const std::string &clsname="") const |
| Check if a user property is available for reading or not. | |
| template<class T> | |
| XAOD_AUXDATA_DEPRECATED bool | isAvailableWritable (const std::string &name, const std::string &clsname="") const |
| Check if a user property is available for writing or not. | |
Static Public Attributes | |
| static constexpr bool | supportsThinning = true |
| Mark that this type supports thinning operations. | |
Protected Types | |
| template<class T, class ALLOC = AuxAllocator_t<T>> | |
| using | Accessor |
Protected Member Functions | |
| const SG::IConstAuxStore * | getConstStore () const |
| Return the current store, as a const interface. | |
| SG::IAuxStore * | getStore () const |
| Return the current store, as a non-const interface. | |
| bool | noPrivateData () const |
| True if this element has no private data. | |
| bool | havePrivateData () const |
| True if this element currently has private data. | |
| bool | hadPrivateData () const |
| True if this element had private data before it was added to its current container. | |
Private Types | |
| enum class | PrivateStoreState : uint8_t { NO_PRIVATE = 0 , HAVE_PRIVATE = 1 , HAD_PRIVATE = 2 } |
| The current private data state. More... | |
Private Member Functions | |
| unsigned | sampVarIdx (const CaloSample) const |
| float | getSamplVarFromAcc (const Accessor< std::vector< float > > &acc, const CaloSample sampling, const float errorvalue=CaloClusterDetails::defaultErrorValue) const |
| bool | setSamplVarFromAcc (const Accessor< std::vector< float > > &acc, const CaloSample sampling, const float value) |
| void | releasePrivateStoreForDtor () |
| Out-of-line portion of destructor. | |
| void | setIndex (size_t index, SG::AuxVectorData *container) |
| Set the index/container for this element. | |
| bool | setIndexPrivate (size_t index, SG::AuxVectorData *container) |
| Set the index/container for this element. | |
| void | makePrivateStore1 (const void *other, bool warnUnlocked) |
| Create a new private store for this object and copy aux data. | |
| void | makePrivateStore1 (const AuxElement *other, bool warnUnlocked) |
| Create a new private store for this object and copy aux data. | |
| AuxElementStandaloneData * | setStore1 (const SG::IConstAuxStore *store) |
| Set the store associated with this object. | |
| void | clearAux () |
| Clear all aux data associated with this element. | |
| void | copyAux (const ConstAuxElement &other, bool warnUnlocked=false) |
| Copy aux data from another object. | |
| void | setNoPrivateData () |
| Record that this element does not have private data. | |
| void | setHavePrivateData () |
| Record that this element currently has private data. | |
| void | setHadPrivateData () |
| Record that this element used to have private data. | |
Managing compound cell-in-sampling counting data | |
| template<class UNSIGNED> | |
| UNSIGNED | extractLowerCount (ncells_store_t::value_type cdata) const |
| extract lower cell count from data | |
| template<class UNSIGNED> | |
| UNSIGNED | extractUpperCount (ncells_store_t::value_type cdata) const |
| extract upper cell count from data | |
| template<class UNSIGNED> | |
| ncells_store_t::value_type | setLowerCount (ncells_store_t::value_type cdata, UNSIGNED clower) |
| template<class UNSIGNED> | |
| ncells_store_t::value_type | setUpperCount (ncells_store_t::value_type cdata, UNSIGNED cupper) |
| template<class UNSIGNED> | |
| UNSIGNED | lowerCellCountBound () const |
| lower value boundary for cell count | |
| template<class UNSIGNED> | |
| UNSIGNED | upperCellCountBound () const |
| upper boundary for cell count | |
| template<class UNSIGNED, class CCTYPE> | |
| CCTYPE | adjustToRange (UNSIGNED count) const |
| < reduce value range to min and max counts | |
Static Private Member Functions | |
| static void | clearAuxHelper (AuxVectorData &container, size_t index) |
| Clear all aux data associated with an element. | |
| static void | copyAuxHelper (AuxVectorData &container, size_t index, const ConstAuxElement &other, bool warnUnlocked) |
| Copy aux data from another object. | |
Private Attributes | |
| unsigned | m_samplingPattern |
| bit-pattern describing the calo samplings contributing to this cluster | |
| State | m_signalState |
| Current signal state. | |
| std::unique_ptr< CaloClusterCellLink > | m_cellLinks |
| Unique ptr to cell links. | |
| CaloRecoStatus | m_recoStatus |
| Reco status (transient only) | |
| double | m_secondTime = { -1. } |
| Second cell time moment (transient only) | |
| const SG::AuxVectorData * | m_container |
| The container of which this object is an element. | |
| size_t | m_index |
| The index of this element within its container. | |
| PrivateStoreState | m_privateStoreState |
Friends | |
| class | ::CaloClusterChangeSignalState |
Functions implementing the xAOD::IParticle interface | |
| typedef IParticle::FourMom_t | FourMom_t |
| Definition of the 4-momentum type. | |
| typedef ROOT::Math::LorentzVector< ROOT::Math::PtEtaPhiM4D< double > > | GenVecFourMom_t |
| Base 4 Momentum type for calo. | |
| virtual double | pt () const |
| The transverse momentum ( \(p_T\)) of the particle (negative for negative-energy clusters) | |
| virtual double | eta () const |
| The pseudorapidity ( \(\eta\)) of the particle. | |
| virtual double | phi () const |
| The azimuthal angle ( \(\phi\)) of the particle. | |
| virtual double | m () const |
| The invariant mass of the particle. | |
| virtual double | e () const |
| The total energy of the particle. | |
| virtual double | rapidity () const |
| The true rapidity (y) of the particle. | |
| GenVecFourMom_t | genvecP4 () const |
| The full 4-momentum of the particle : GenVector type. | |
| GenVecFourMom_t | genvecP4 (const State s) const |
| The full 4-momentum of the particle : GenVector type. | |
| virtual FourMom_t | p4 () const |
| The full 4-momentum of the particle. | |
| FourMom_t | p4 (const State s) const |
| virtual Type::ObjectType | type () const |
| The type of the object as a simple enumeration. | |
Athena-only methods, used during building stage | |
Set up an ElementLink to a CaloClusterCellLink object Takes ownership of CCCL. Deprecated; use the unique_ptr version for new code. | |
| typedef CaloClusterCellLink::const_iterator | const_cell_iterator |
| Iterator of the underlying CaloClusterCellLink (explicitly const version) | |
| typedef CaloClusterCellLink::iterator | cell_iterator |
| Iterator of the underlying CaloClusterCellLink (non-const version) | |
| typedef const_cell_iterator | const_iterator |
| STL-compatible iterators. | |
| typedef cell_iterator | iterator |
| void | addCellLink (CaloClusterCellLink *CCCL) |
| void | addCellLink (std::unique_ptr< CaloClusterCellLink > CCCL) |
| Set up an ElementLink to a CaloClusterCellLink object. | |
| bool | setLink (CaloClusterCellLinkContainer *CCCL, IProxyDict *sg=nullptr) |
| Set up an ElementLink to a CaloClusterCellLink object. | |
| bool | setLink (CaloClusterCellLinkContainer *CCCL, const EventContext &ctx) |
| Push the CaloClusterCellLink object into the cell-link container and hand-over ownership to it. | |
| const CaloClusterCellLink * | getCellLinks () const |
| Get a pointer to the CaloClusterCellLink object (const version) | |
| CaloClusterCellLink * | getOwnCellLinks () |
| Get a pointer to the owned CaloClusterCellLink object (non-const version) | |
| bool | addCell (const unsigned index, const double weight) |
| Method to add a cell to the cluster (Beware: Kinematics not updated!) | |
| bool | removeCell (const CaloCell *ptr) |
| Method to remove a cell to the cluster (slow!) (Beware: Kinematics not updated!) | |
| size_t | size () const |
| size method (forwarded from CaloClusterCellLink obj) | |
| const_cell_iterator | cell_cbegin () const |
| const_cell_iterator | cell_cend () const |
| const_cell_iterator | cell_begin () const |
| Iterator of the underlying CaloClusterCellLink (const version) | |
| const_cell_iterator | cell_end () const |
| cell_iterator | cell_begin () |
| cell_iterator | cell_end () |
| const_iterator | begin () const |
| const_iterator | end () const |
| const_iterator | cbegin () const |
| const_iterator | cend () const |
| iterator | begin () |
| iterator | end () |
| void | reweightCell (cell_iterator it, const double weight) |
| Method to reweight a cell in the cluster (Beware: Kinematics not updated!) | |
| CaloRecoStatus & | recoStatus () |
| Accesssor to CaloRecoStatus (non-const) | |
| const CaloRecoStatus & | recoStatus () const |
| Accesssor to CaloRecoStatus (const) | |
4Momentum in different signal states | |
}@ Get Energy in signal state UNCALIBRATED | |
| flt_t | rawE () const |
| void | setRawE (flt_t) |
| Set Energy for signal state UNCALIBRATED. | |
| flt_t | rawEta () const |
| Get \( \eta \) in signal state UNCALIBRATED. | |
| void | setRawEta (flt_t) |
| Set \( \eta \) for signal state UNCALIBRATED. | |
| flt_t | rawPhi () const |
| Get \( \phi \) in signal state UNCALIBRATED. | |
| void | setRawPhi (flt_t) |
| Set \( \phi \) for signal state UNCALIBRATED. | |
| flt_t | rawM () const |
| Get mass in signal state UNCALIBRATED. | |
| void | setRawM (flt_t) |
| Set mass for singal state UNCALIBRATED. | |
| flt_t | altE () const |
| Get Energy in signal state ALTCALIBRATED. | |
| void | setAltE (flt_t) |
| Set Energy for signal state ALTCALIBRATED. | |
| flt_t | altEta () const |
| Get \( \eta \) in signal state ALTCALIBRATED. | |
| void | setAltEta (flt_t) |
| Set \( \eta \) for signal state ALTCALIBRATED. | |
| flt_t | altPhi () const |
| Get \( \phi \) in signal state ALTCALIBRATED. | |
| void | setAltPhi (flt_t) |
| Set \( \phi \) for signal state ALTCALIBRATED. | |
| flt_t | altM () const |
| Get mass in signal state ALTCALIBRATED. | |
| void | setAltM (flt_t) |
| Set mass for singal state ALTCALIBRATED. | |
| flt_t | calE () const |
| Geet Energy in signal state CALIBRATED. | |
| void | setCalE (flt_t) |
| Set Energy for signal state CALIBRATED. | |
| flt_t | calEta () const |
| Get \( \eta \) in signal state CALIBRATED. | |
| void | setCalEta (flt_t) |
| Set \( \eta \) for signal state CALIBRATED. | |
| flt_t | calPhi () const |
| Get \( \phi \) in signal state CALIBRATED. | |
| void | setCalPhi (flt_t) |
| Set \( \phi \) for signal state CALIBRATED. | |
| flt_t | calM () const |
| Get mass in signal state CALIBRATED. | |
| void | setCalM (flt_t) |
| Set mass for singal state CALIBRATED. | |
| State | signalState () const |
| Get the current signal state. | |
| double | pt (const State s) const |
| pt with a given signal state | |
| double | e (const State s) const |
| energy with a given signal state | |
| double | eta (const State s) const |
| eta with a given signal state | |
| double | phi (const State s) const |
| phi with a given signal state | |
| double | m (const State s) const |
| m with a given signal state | |
| bool | setSignalState (const State s) |
| Switch signal state. | |
Description of a calorimeter cluster.
Definition at line 62 of file CaloCluster_v1.h.
|
protectedinherited |
Definition at line 572 of file AuxElement.h.
Definition at line 69 of file CaloCluster_v1.h.
Iterator of the underlying CaloClusterCellLink (non-const version)
Definition at line 819 of file CaloCluster_v1.h.
Iterator of the underlying CaloClusterCellLink (explicitly const version)
Definition at line 796 of file CaloCluster_v1.h.
STL-compatible iterators.
Definition at line 825 of file CaloCluster_v1.h.
|
inherited |
Definition at line 569 of file AuxElement.h.
|
inherited |
Definition at line 575 of file AuxElement.h.
| typedef float xAOD::CaloCluster_v1::flt_t |
Definition at line 67 of file CaloCluster_v1.h.
Definition of the 4-momentum type.
Definition at line 346 of file CaloCluster_v1.h.
| typedef ROOT::Math::LorentzVector<ROOT::Math::PtEtaPhiM4D<double> > xAOD::CaloCluster_v1::GenVecFourMom_t |
Base 4 Momentum type for calo.
Definition at line 349 of file CaloCluster_v1.h.
Definition at line 826 of file CaloCluster_v1.h.
| typedef std::vector<uint16_t> xAOD::CaloCluster_v1::ncells_store_t |
Store type for number-of-cells-in-sampling counter.
Due to the severe change of granularity of EME2 from the inner to the outer wheel, clusters spanning the region around \( |\eta| = 2.5 \) provide the exclusive count of EME2 cells together with the count of cells in the inner wheel. The persistent store to hold both counts for one given index (given by CaloSampling::CaloSample) therefore holds two 8-bit words/sampling.
Definition at line 83 of file CaloCluster_v1.h.
Type for number-of-cells-in-sampling counter.
The total number of cells in a given cluster from any given sampling is limited to [0,255] and thus stored in an 8-bit word.
Definition at line 75 of file CaloCluster_v1.h.
|
inherited |
Definition at line 566 of file AuxElement.h.
Enumeration to identify different cluster sizes.
Definition at line 89 of file CaloCluster_v1.h.
Enums to identify different moments.
Each enum corresponds to a different characteristic moment of a CaloCluster. The enums are loosly grouped by their type - i.e. first moment over an angle, second moment, angular deviations etc.
| Enumerator | |
|---|---|
| FIRST_PHI | First Moment in \(\phi\). |
| FIRST_ETA | First Moment in \(\eta\). |
| SECOND_R | Second Moment in \(r\). |
| SECOND_LAMBDA | Second Moment in \(\lambda\). |
| DELTA_PHI | Angular shower axis deviation ( \(\phi\)) from IP-to-Center. |
| DELTA_THETA | Angular shower axis deviation ( \(\theta\)) from IP-to-Center. |
| DELTA_ALPHA | Angular shower axis deviation ( \(\Delta\alpha\)) from IP-to-Center. |
| CENTER_X | Cluster Centroid ( \(x\)) |
| CENTER_Y | Cluster Centroid ( \(y\)) |
| CENTER_Z | Cluster Centroid ( \(z\)) |
| CENTER_MAG | Cluster Centroid ( \(\sqrt(x^2+y^2+z^2)\)) |
| CENTER_LAMBDA | Shower depth at Cluster Centroid. |
| LATERAL | Normalized lateral moment. |
| LONGITUDINAL | Normalized longitudinal moment. |
| ENG_FRAC_EM | Energy fraction in EM calorimeters. |
| ENG_FRAC_MAX | Energy fraction of hottest cell. |
| ENG_FRAC_CORE | Energy fraction of the sum of the hottest cells in each sampling. |
| FIRST_ENG_DENS | First Moment in E/V. |
| SECOND_ENG_DENS | Second Moment in E/V. |
| ISOLATION | Energy weighted fraction of non-clustered perimeter cells. |
| ENG_BAD_CELLS | Total em-scale energy of bad cells in this cluster. |
| N_BAD_CELLS | number of bad cells |
| N_BAD_CELLS_CORR | Number of bad cells with energy density average correction applied. |
| BAD_CELLS_CORR_E | Energy of bad cells with energy density average correction applied. |
| BADLARQ_FRAC | Energy fraction of LAr cells with quality larger than a given cut. |
| ENG_POS | Total positive Energy of this cluster. |
| SIGNIFICANCE | Cluster significance. |
| CELL_SIGNIFICANCE | Cell significance = E/sig of the cell with the largest |E|/sig. |
| CELL_SIG_SAMPLING | CaloSample of the cell with the largest |E|/sig. |
| AVG_LAR_Q | Sum(E_cell_LAr^2 Q_cell_LAr)/Sum(E_cell_LAr^2) |
| AVG_TILE_Q | Sum(E_cell_Tile^2 Q_cell_Tile)/Sum(E_cell_Tile^2) |
| ENG_BAD_HV_CELLS | Total em-scale energy of cells with bad HV in this cluster. |
| N_BAD_HV_CELLS | number of cells with bad HV |
| PTD | relative spread of pT of constiuent cells = sqrt(n)*RMS/Mean |
| MASS | cell based mass i.e. the mass of the 4-vector sum of all massless positive energetic cells |
| EM_PROBABILITY | Classification probability to be em-like. |
| HAD_WEIGHT | Hadronic weight (E_w/E_em) |
| OOC_WEIGHT | Out-of-cluster weight (E_ooc/E_w) |
| DM_WEIGHT | Dead-material weight (E_dm/E_ooc) |
| TILE_CONFIDENCE_LEVEL | Confidence Level of a tile calorimeter cluster to be noise. |
| SECOND_TIME | Second moment of cell time distribution in cluster. |
| NCELL_SAMPLING | Number of cells in sampling layer. |
| VERTEX_FRACTION | Vertex fraction of this cluster wrt. primary vertex of the event. Calculated in CaloRec/CaloClusterVertexFractionMaker.cxx |
| NVERTEX_FRACTION | slightly updated vertex fraction more pile up independent (similar to nJVF) |
| ETACALOFRAME | Eta in the calo frame (for egamma) |
| PHICALOFRAME | Phi in the calo frame (for egamma) |
| ETA1CALOFRAME | Eta of sampling 1 in the calo frame (for egamma) |
| PHI1CALOFRAME | Phi of sampling 1 in the calo frame (for egamma) |
| ETA2CALOFRAME | Eta of sampling 2 in the calo frame (for egamma) |
| PHI2CALOFRAME | Phi of sampling 2 in the calo frame (for egamma) |
| ENG_CALIB_TOT | Calibration Hit energy inside the cluster. |
| ENG_CALIB_OUT_L | Attached Calibration Hit energy outside clusters but inside the calorimeter with loose matching (Angle < 1.0) |
| ENG_CALIB_OUT_M | Attached Calibration Hit energy outside clusters but inside the calorimeter with medium matching (Angle < 0.5). |
| ENG_CALIB_OUT_T | Attached Calibration Hit energy outside clusters but inside the calorimeter with tight matching (Angle < 0.3). |
| ENG_CALIB_DEAD_L | Attached Calibration Hit energy in dead material with loose matching (Angle < 1.0). |
| ENG_CALIB_DEAD_M | Attached Calibration Hit energy in dead material with medium matching (Angle < 0.5). |
| ENG_CALIB_DEAD_T | Attached Calibration Hit energy in dead material with tight matching (Angle < 0.3). |
| ENG_CALIB_EMB0 | Calibration Hit energy inside the cluster barrel presampler. |
| ENG_CALIB_EME0 | Calibration Hit energy inside the cluster endcap presampler. |
| ENG_CALIB_TILEG3 | Calibration Hit energy inside the cluster scintillator. |
| ENG_CALIB_DEAD_TOT | Attached Calibration Hit energy in dead material. |
| ENG_CALIB_DEAD_EMB0 | Attached Calibration Hit energy in dead material before EMB0, between EMB0 and EMB1. |
| ENG_CALIB_DEAD_TILE0 | Attached Calibration Hit energy in dead material between EMB3 and TILE0. |
| ENG_CALIB_DEAD_TILEG3 | Attached Calibration Hit energy in dead material before scintillator. |
| ENG_CALIB_DEAD_EME0 | Attached Calibration Hit energy in dead material before EME0, between EME0 and EME1. |
| ENG_CALIB_DEAD_HEC0 | Attached Calibration Hit energy in dead material between EME3 and HEC0. |
| ENG_CALIB_DEAD_FCAL | Attached Calibration Hit energy in dead material before FCAL, between FCAL and HEC. |
| ENG_CALIB_DEAD_LEAKAGE | Attached Calibration Hit energy in dead material behind calorimeters. |
| ENG_CALIB_DEAD_UNCLASS | Attached Calibration Hit energy in dead material in unclassified areas of the detector. |
| ENG_CALIB_FRAC_EM | Calibration Hit energy inside the cluster caused by e/gamma/pi0. |
| ENG_CALIB_FRAC_HAD | Calibration Hit energy inside the cluster caused by charged pi+ and pi-. |
| ENG_CALIB_FRAC_REST | Calibration Hit energy inside the cluster caused by other particles. |
| ENERGY_DigiHSTruth | First Moment in \(\phi\). |
| ETA_DigiHSTruth | Eta moment that I am trying to include. |
| PHI_DigiHSTruth | phi moment I would like to have |
| TIME_DigiHSTruth | First Moment in \(\phi\). |
| ENERGY_CALIB_DigiHSTruth | First Moment in \(\phi\). |
| ETA_CALIB_DigiHSTruth | First Moment in \(\phi\). |
| PHI_CALIB_DigiHSTruth | First Moment in \(\phi\). |
| TIME_CALIB_DigiHSTruth | First Moment in \(\phi\). |
| FIRST_PHI_DigiHSTruth | First Moment in \(\phi\). |
| FIRST_ETA_DigiHSTruth | First Moment in \(\eta\). |
| SECOND_R_DigiHSTruth | Second Moment in \(r\). |
| SECOND_LAMBDA_DigiHSTruth | Second Moment in \(\lambda\). |
| DELTA_PHI_DigiHSTruth | |
| DELTA_THETA_DigiHSTruth | |
| DELTA_ALPHA_DigiHSTruth | |
| CENTER_X_DigiHSTruth | Cluster Centroid ( \(x\)) |
| CENTER_Y_DigiHSTruth | Cluster Centroid ( \(y\)) |
| CENTER_Z_DigiHSTruth | Cluster Centroid ( \(z\)) |
| CENTER_MAG_DigiHSTruth | |
| CENTER_LAMBDA_DigiHSTruth | Shower depth at Cluster Centroid. |
| LATERAL_DigiHSTruth | Normalized lateral moment. |
| LONGITUDINAL_DigiHSTruth | Normalized longitudinal moment. |
| ENG_FRAC_EM_DigiHSTruth | Energy fraction in EM calorimeters. |
| ENG_FRAC_MAX_DigiHSTruth | Energy fraction of hottest cell. |
| ENG_FRAC_CORE_DigiHSTruth | |
| FIRST_ENG_DENS_DigiHSTruth | First Moment in E/V. |
| SECOND_ENG_DENS_DigiHSTruth | Second Moment in E/V. |
| ISOLATION_DigiHSTruth | |
| ENG_BAD_CELLS_DigiHSTruth | |
| N_BAD_CELLS_DigiHSTruth | number of bad cells |
| N_BAD_CELLS_CORR_DigiHSTruth | |
| BAD_CELLS_CORR_E_DigiHSTruth | |
| BADLARQ_FRAC_DigiHSTruth | |
| ENG_POS_DigiHSTruth | Total positive Energy of this cluster. |
| SIGNIFICANCE_DigiHSTruth | Cluster significance. |
| CELL_SIGNIFICANCE_DigiHSTruth | |
| CELL_SIG_SAMPLING_DigiHSTruth | |
| AVG_LAR_Q_DigiHSTruth | |
| AVG_TILE_Q_DigiHSTruth | |
| ENG_BAD_HV_CELLS_DigiHSTruth | |
| N_BAD_HV_CELLS_DigiHSTruth | number of cells with bad HV |
| EM_PROBABILITY_DigiHSTruth | Classification probability to be em-like. |
| HAD_WEIGHT_DigiHSTruth | Hadronic weight (E_w/E_em) |
| OOC_WEIGHT_DigiHSTruth | Out-of-cluster weight (E_ooc/E_w) |
| DM_WEIGHT_DigiHSTruth | Dead-material weight (E_dm/E_ooc) |
Definition at line 123 of file CaloCluster_v1.h.
|
strongprivateinherited |
The current private data state.
| Enumerator | |
|---|---|
| NO_PRIVATE | |
| HAVE_PRIVATE | |
| HAD_PRIVATE | |
Definition at line 131 of file IAuxElement.h.
enum of possible signal states.
| Enumerator | |
|---|---|
| UNKNOWN | |
| UNCALIBRATED | |
| CALIBRATED | |
| ALTCALIBRATED | |
| NSTATES | |
Definition at line 307 of file CaloCluster_v1.h.
| xAOD::CaloCluster_v1::CaloCluster_v1 | ( | ) |
Default constructor.
Definition at line 23 of file CaloCluster_v1.cxx.
| xAOD::CaloCluster_v1::CaloCluster_v1 | ( | const CaloCluster_v1 & | other | ) |
Copy constructor.
Definition at line 32 of file CaloCluster_v1.cxx.
|
virtual |
Method to add a cell to the cluster (Beware: Kinematics not updated!)
| index | Index of the cell in the CaloCelLContainer |
| weight | Weight of the cell in the cluster |
Definition at line 774 of file CaloCluster_v1.h.
|
inline |
Definition at line 724 of file CaloCluster_v1.h.
|
inline |
Set up an ElementLink to a CaloClusterCellLink object.
Definition at line 729 of file CaloCluster_v1.h.
|
inlineprivate |
< reduce value range to min and max counts
Definition at line 704 of file CaloCluster_v1.h.
| flt_t xAOD::CaloCluster_v1::altEta | ( | ) | const |
Get \( \eta \) in signal state ALTCALIBRATED.
| flt_t xAOD::CaloCluster_v1::altM | ( | ) | const |
Get mass in signal state ALTCALIBRATED.
| flt_t xAOD::CaloCluster_v1::altPhi | ( | ) | const |
Get \( \phi \) in signal state ALTCALIBRATED.
|
inherited |
Assignment.
| other | The object from which we're assigning. |
| warnUnlocked | If true, then warn when we skip unlocked decorations. |
We don't copy container/index, as assignment doesn't change where this object is. However, if we have aux data, then we copy aux data if we're copying from an object that also has it; otherwise, if we're copying from an object with no aux data, then we clear ours.
|
inherited |
|
inherited |
Fetch an aux data variable, as a const reference.
| name | Name of the aux variable. |
This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor or ConstAccessor classes.
|
inlineinherited |
Fetch an aux data variable, as a non-const reference.
This function provides an easy way for users to decorate objects with auxiliary data.
Take note that this function is slow. Should not be used inside time-critical code.
| name | Name of the aux variable |
| clsname | The name of the associated class. May be blank |
Definition at line 98 of file Event/xAOD/xAODBase/xAODBase/IParticle.h.
|
inlineinherited |
Fetch an aux data variable, as a const reference.
This function provides an easy way for users to retrieve auxiliary decorations from an object.
Take note that this function is slow. Should not be used inside time-critical code.
| name | Name of the aux variable |
| clsname | The name of the associated class. May be blank |
Definition at line 118 of file Event/xAOD/xAODBase/xAODBase/IParticle.h.
|
inherited |
Fetch an aux data variable, as a const reference.
| name | Name of the aux variable. |
This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the ConstAccessor class.
|
inherited |
Fetch an aux data variable, as a const reference.
| name | Name of the aux variable. |
| clsname | The name of the associated class. May be blank. |
This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the ConstAccessor class.
|
inherited |
Fetch an aux decoration, as a non-const reference.
| name | Name of the aux variable. |
This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.
If the container is locked, this will allow fetching only variables that do not yet exist (in which case they will be marked as decorations) or variables already marked as decorations.
|
inherited |
Fetch an aux decoration, as a non-const reference.
| name | Name of the aux variable. |
| clsname | The name of the associated class. May be blank. |
This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.
If the container is locked, this will allow fetching only variables that do not yet exist (in which case they will be marked as decorations) or variables already marked as decorations.
| const CaloClusterBadChannelList & xAOD::CaloCluster_v1::badChannelList | ( | ) | const |
Definition at line 279 of file CaloCluster_v1.cxx.
|
inline |
Definition at line 831 of file CaloCluster_v1.h.
|
inline |
Definition at line 827 of file CaloCluster_v1.h.
| flt_t xAOD::CaloCluster_v1::calEta | ( | ) | const |
Get \( \eta \) in signal state CALIBRATED.
| flt_t xAOD::CaloCluster_v1::calM | ( | ) | const |
Get mass in signal state CALIBRATED.
| flt_t xAOD::CaloCluster_v1::calPhi | ( | ) | const |
Get \( \phi \) in signal state CALIBRATED.
|
inline |
Definition at line 829 of file CaloCluster_v1.h.
|
inline |
Definition at line 821 of file CaloCluster_v1.h.
|
inline |
Iterator of the underlying CaloClusterCellLink (const version)
Definition at line 815 of file CaloCluster_v1.h.
|
inline |
Definition at line 798 of file CaloCluster_v1.h.
|
inline |
Definition at line 806 of file CaloCluster_v1.h.
|
inline |
Definition at line 822 of file CaloCluster_v1.h.
|
inline |
Definition at line 816 of file CaloCluster_v1.h.
|
inline |
Definition at line 830 of file CaloCluster_v1.h.
|
privateinherited |
Clear all aux data associated with this element.
If this object has no associated store, this does nothing. If the associated aux data is const, this throws ExcConstAuxData.
Definition at line 580 of file AuxElement.cxx.
|
staticprivateinherited |
Clear all aux data associated with an element.
If the associated aux data is const, this throws ExcConstAuxData.
Definition at line 639 of file AuxElement.cxx.
|
inherited |
Clear the cached aux data pointers.
You should call this any time something changes in the aux store that could invalidate the vector pointers.
Definition at line 339 of file AuxElement.cxx.
|
inherited |
Clear all decorations.
Erase all decorations from an associated store, restoring the state to when lock was called.
Returns true if there were any decorations that were cleared, false if the store did not contain any decorations.
Definition at line 428 of file AuxElement.cxx.
| void xAOD::CaloCluster_v1::clearSamplingData | ( | ) |
Clear the sampling data.
Definition at line 641 of file CaloCluster_v1.cxx.
| CaloCluster_v1::ClusterSize xAOD::CaloCluster_v1::clusterSize | ( | ) | const |
Get cluster size.
Definition at line 364 of file CaloCluster_v1.cxx.
|
inherited |
Return the container holding this element.
|
inherited |
Return the container holding this element.
|
privateinherited |
Copy aux data from another object.
| other | The object from which to copy. |
| warnUnlocked | If true, then warn when we skip unlocked decorations. |
If this object has no associated store, this does nothing. If the associated aux data is const, this throws ExcConstAuxData.
All aux data items from other are copied to this object. Any aux data items associated with this object that are not present in other are cleared. (If other has no aux data, then all aux data items for this object are cleared.)
Definition at line 600 of file AuxElement.cxx.
|
staticprivateinherited |
Copy aux data from another object.
| container | Container of the element. |
| index | Index of this element within the container. |
| other | The object from which to copy. |
| warnUnlocked | If true, then warn when we skip unlocked decorations. |
If the associated aux data is const, this throws ExcConstAuxData.
All aux data items from other are copied to this object. Any aux data items associated with this object that are not present in other are cleared. (If other has no aux data, then all aux data items for this object are cleared.)
Definition at line 667 of file AuxElement.cxx.
|
virtual |
The total energy of the particle.
Implements xAOD::IParticle.
Definition at line 265 of file CaloCluster_v1.cxx.
energy with a given signal state
Return eta for a specific signal state.
| s | The desired signal state. |
Definition at line 167 of file CaloCluster_v1.cxx.
|
inline |
Definition at line 832 of file CaloCluster_v1.h.
|
inline |
Definition at line 828 of file CaloCluster_v1.h.
| float xAOD::CaloCluster_v1::energy_max | ( | const CaloSample | sampling | ) | const |
Retrieve maximum cell energy in given sampling.
Definition at line 556 of file CaloCluster_v1.cxx.
Get the energy in one layer of the EM Calo.
| layer | Layer between 0 (Presampler) and 3 (Back) |
Definition at line 623 of file CaloCluster_v1.cxx.
| float xAOD::CaloCluster_v1::eSample | ( | const CaloSample | sampling | ) | const |
Definition at line 514 of file CaloCluster_v1.cxx.
|
inline |
Definition at line 859 of file CaloCluster_v1.h.
|
virtual |
The pseudorapidity ( \(\eta\)) of the particle.
Implements xAOD::IParticle.
Definition at line 251 of file CaloCluster_v1.cxx.
eta with a given signal state
Return eta for a specific signal state.
| s | The desired signal state. |
Definition at line 188 of file CaloCluster_v1.cxx.
| flt_t xAOD::CaloCluster_v1::eta0 | ( | ) | const |
Returns raw \( \eta \) of cluster seed.
Get the eta in one layer of the EM Calo.
| layer | Layer between 0 (Presampler) and 3 (Back) |
Definition at line 628 of file CaloCluster_v1.cxx.
| float xAOD::CaloCluster_v1::etamax | ( | const CaloSample | sampling | ) | const |
Retrieve \( \eta \) of cell with maximum energy in given sampling.
Definition at line 569 of file CaloCluster_v1.cxx.
| float xAOD::CaloCluster_v1::etaSample | ( | const CaloSample | sampling | ) | const |
Retrieve barycenter \( \eta \) in a given sample.
Definition at line 525 of file CaloCluster_v1.cxx.
| float xAOD::CaloCluster_v1::etasize | ( | const CaloSample | sampling | ) | const |
Returns cluster size in \( \eta \) for a given sampling.
Definition at line 596 of file CaloCluster_v1.cxx.
|
inlineprivate |
extract lower cell count from data
Definition at line 696 of file CaloCluster_v1.h.
|
inlineprivate |
extract upper cell count from data
Definition at line 697 of file CaloCluster_v1.h.
| CaloCluster_v1::GenVecFourMom_t xAOD::CaloCluster_v1::genvecP4 | ( | ) | const |
The full 4-momentum of the particle : GenVector type.
Definition at line 457 of file CaloCluster_v1.cxx.
| CaloCluster_v1::GenVecFourMom_t xAOD::CaloCluster_v1::genvecP4 | ( | const State | s | ) | const |
The full 4-momentum of the particle : GenVector type.
Definition at line 445 of file CaloCluster_v1.cxx.
|
inherited |
Return a set of identifiers for existing data items for this object.
If this object has a private or standalone store, then information from that will be returned. Otherwise, if this element is part of a container, then information for the container will be returned. Otherwise, return an empty set.
Definition at line 355 of file AuxElement.cxx.
| const CaloClusterCellLink * xAOD::CaloCluster_v1::getCellLinks | ( | ) | const |
Get a pointer to the CaloClusterCellLink object (const version)
Definition at line 829 of file CaloCluster_v1.cxx.
Get eta size from cluster size.
Definition at line 747 of file CaloCluster_v1.cxx.
Get phi size from cluster size.
Definition at line 769 of file CaloCluster_v1.cxx.
|
protectedinherited |
Return the current store, as a const interface.
This will be non-zero if either a const or non-const store is associated with this object. This will fetch either a private or standalone store.
Definition at line 869 of file AuxElement.cxx.
|
inherited |
Return a set of identifiers for decorations for this object.
If this object has a private or standalone store, then information from that will be returned. Otherwise, if this element is part of a container, then information for the container will be returned. Otherwise, return an empty set.
Definition at line 378 of file AuxElement.cxx.
|
inline |
Retrieve individual moment - no check for existance! Returns -999 on error.
Definition at line 897 of file CaloCluster_v1.h.
|
inline |
Get number of cells for all sampling layer.
This returns the number of cells in all sampling layers covered by the cluster, in a basic data type (c.f. retrieveMoment, which returns the internally used data store type) defined by the client. Only the inclucive number of cells per sampling are considered.
Definition at line 430 of file CaloCluster_v1.h.
|
inline |
Get a pointer to the owned CaloClusterCellLink object (non-const version)
Definition at line 765 of file CaloCluster_v1.h.
|
private |
Definition at line 494 of file CaloCluster_v1.cxx.
| const CaloCluster_v1 * xAOD::CaloCluster_v1::getSisterCluster | ( | ) | const |
Get a pointer to a 'sister' cluster (eg the non-calibrated counterpart)
Definition at line 881 of file CaloCluster_v1.cxx.
| const ElementLink< xAOD::CaloClusterContainer_v1 > & xAOD::CaloCluster_v1::getSisterClusterLink | ( | ) | const |
Get a link to a 'sister' cluster (eg the non-calibrated counterpart)
Definition at line 893 of file CaloCluster_v1.cxx.
|
protectedinherited |
Return the current store, as a non-const interface.
This will be non-zero if a non-const store is associated with this object. This will fetch either a private or standalone store.
Definition at line 878 of file AuxElement.cxx.
|
protectedinherited |
True if this element had private data before it was added to its current container.
|
inherited |
Return true if this object has an associated non-const store.
This will be true for either a private or standalone store.
Definition at line 411 of file AuxElement.cxx.
|
inline |
Checks if certain smapling contributes to cluster.
Definition at line 882 of file CaloCluster_v1.h.
|
inherited |
Return true if this object has an associated store.
This will be true for either a private or standalone store.
Definition at line 398 of file AuxElement.cxx.
|
protectedinherited |
True if this element currently has private data.
|
inline |
Returns true if at least one clustered cell in the barrel.
Definition at line 887 of file CaloCluster_v1.h.
|
inherited |
Return the index of this element within its container.
Inherited from IAuxElement.
|
inline |
Returns true if at least one clustered cell in the endcap.
Definition at line 892 of file CaloCluster_v1.h.
| void xAOD::CaloCluster_v1::insertMoment | ( | MomentType | type, |
| const ncells_store_t & | values ) |
Insert number of cells/sampling moment (non-scalar)
xAOD::CaloCluster_v1::setNumberCellsInSampling method. Definition at line 683 of file CaloCluster_v1.cxx.
| void xAOD::CaloCluster_v1::insertMoment | ( | MomentType | type, |
| double | value ) |
Definition at line 678 of file CaloCluster_v1.cxx.
|
inlineinherited |
Check if a user property is available for reading or not.
This function should be used to check if a user property which may or may not exist, is set on the object.
| name | Name of the auxiliary variable |
| clsname | The name of the associated class. May be blank |
Definition at line 135 of file Event/xAOD/xAODBase/xAODBase/IParticle.h.
|
inherited |
Check if an aux variable is available for writing.
| name | Name of the aux variable. |
| clsname | The name of the associated class. May be blank. |
This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.
|
inlineinherited |
Check if a user property is available for writing or not.
This function can be used to check whether it will be possible to set a user property on the object.
| name | Name of the auxiliary variable |
| clsname | The name of the associated class. May be blank |
Definition at line 152 of file Event/xAOD/xAODBase/xAODBase/IParticle.h.
|
inherited |
Check if an aux variable is available for writing as a decoration.
| name | Name of the aux variable. |
| clsname | The name of the associated class. May be blank. |
This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.
|
inlineprivate |
lower value boundary for cell count
Definition at line 702 of file CaloCluster_v1.h.
|
virtual |
The invariant mass of the particle.
Implements xAOD::IParticle.
Definition at line 261 of file CaloCluster_v1.cxx.
m with a given signal state
Return m for a specific signal state.
| s | The desired signal state. |
Definition at line 230 of file CaloCluster_v1.cxx.
|
inherited |
Create a new (empty) private store for this object.
ExcBadPrivateStore will be thrown if this object is already associated with a store.
Definition at line 192 of file AuxElement.cxx.
|
inherited |
Create a new private store for this object and copy aux data.
| other | The object from which aux data should be copied. |
| warnUnlocked | If true, then warn when we skip unlocked decorations. |
ExcBadPrivateStore will be thrown if this object is already associated with a store.
If other is an object that has aux data, then those data will be copied; otherwise, nothing will be done.
|
inherited |
Create a new private store for this object and copy aux data.
| other | The object from which aux data should be copied. |
| warnUnlocked | If true, then warn when we skip unlocked decorations. |
ExcBadPrivateStore will be thrown if this object is already associated with a store.
If other is an object that has aux data, then those data will be copied; otherwise, nothing will be done.
|
privateinherited |
Create a new private store for this object and copy aux data.
| other | The object from which aux data should be copied. |
| warnUnlocked | If true, then warn when we skip unlocked decorations. |
ExcBadPrivateStore will be thrown if this object is already associated with a store.
This overload handles the case where other does have aux data.
Definition at line 565 of file AuxElement.cxx.
|
privateinherited |
Create a new private store for this object and copy aux data.
| other | The object from which aux data should be copied. |
| warnUnlocked | If true, then warn when we skip unlocked decorations. |
ExcBadPrivateStore will be thrown if this object is already associated with a store.
This overload handles the case where other does not have aux data.
|
protectedinherited |
True if this element has no private data.
|
inline |
Definition at line 876 of file CaloCluster_v1.h.
| int xAOD::CaloCluster_v1::numberCells | ( | ) | const |
Return total number of cells in cluster.
This method sums up the number of cells in all samplings. This should be identical to CaloCluster_v1::size() for clusters which still have all included cells linked.
NCELL_SAMPLING set. In case this moment is not available, 0 is returned. Definition at line 742 of file CaloCluster_v1.cxx.
| int xAOD::CaloCluster_v1::numberCellsInSampling | ( | const CaloSample | samp, |
| bool | isInnerWheel = false ) const |
Returns number of cells in given sampling.
This method returns the number of cells in a given sampling. All cells with \( E \neq 0 \) are counted, independent of the signal quality. Due to the strong reduction of the readout granularity of the electromagnmetic endcaps for \( |\eta| > 2.5 \) the returned number of cells in EME2 can be customized for clusters spanning this boundary. By default (isInnerWheel=false ) the number of all cells in EME2 is returned (inclusive count, consistent with the behaviour for all other samplings). For isInnerWheel=true the number of EME2 cells in the inner wheel are returned.
| samp | sampling id |
| isInnerWheel | returns number of cells in small wheel (for EME2 only) |
Definition at line 726 of file CaloCluster_v1.cxx.
| CaloCluster_v1 & xAOD::CaloCluster_v1::operator= | ( | const xAOD::CaloCluster_v1 & | other | ) |
Assignment operator.
Definition at line 53 of file CaloCluster_v1.cxx.
|
virtual |
The full 4-momentum of the particle.
Implements xAOD::IParticle.
Definition at line 465 of file CaloCluster_v1.cxx.
| CaloCluster_v1::FourMom_t xAOD::CaloCluster_v1::p4 | ( | const State | s | ) | const |
Definition at line 470 of file CaloCluster_v1.cxx.
|
virtual |
The azimuthal angle ( \(\phi\)) of the particle.
Implements xAOD::IParticle.
Definition at line 256 of file CaloCluster_v1.cxx.
phi with a given signal state
Return phi for a specific signal state.
| s | The desired signal state. |
Definition at line 210 of file CaloCluster_v1.cxx.
| flt_t xAOD::CaloCluster_v1::phi0 | ( | ) | const |
Returns raw \( \phi \) of cluster seed.
Get the phi in one layer of the EM Calo.
| layer | Layer between 0 (Presampler) and 3 (Back) |
Definition at line 634 of file CaloCluster_v1.cxx.
| float xAOD::CaloCluster_v1::phimax | ( | const CaloSample | sampling | ) | const |
Retrieve \( \varphi \) of cell with maximum energy in given sampling.
Definition at line 582 of file CaloCluster_v1.cxx.
| float xAOD::CaloCluster_v1::phiSample | ( | const CaloSample | sampling | ) | const |
Retrieve barycenter \( \varphi \) in a given sample.
Definition at line 540 of file CaloCluster_v1.cxx.
| float xAOD::CaloCluster_v1::phisize | ( | const CaloSample | sampling | ) | const |
Returns cluster size in \( \varphi \) for a given sampling.
Definition at line 609 of file CaloCluster_v1.cxx.
|
virtual |
The transverse momentum ( \(p_T\)) of the particle (negative for negative-energy clusters)
Implements xAOD::IParticle.
Definition at line 247 of file CaloCluster_v1.cxx.
pt with a given signal state
Notice that this function is very slow for calorimeter clusters, so it should be called as few times as possible.
Definition at line 121 of file CaloCluster_v1.cxx.
|
virtual |
The true rapidity (y) of the particle.
Implements xAOD::IParticle.
Definition at line 461 of file CaloCluster_v1.cxx.
| flt_t xAOD::CaloCluster_v1::rawE | ( | ) | const |
| flt_t xAOD::CaloCluster_v1::rawEta | ( | ) | const |
Get \( \eta \) in signal state UNCALIBRATED.
| flt_t xAOD::CaloCluster_v1::rawM | ( | ) | const |
Get mass in signal state UNCALIBRATED.
| flt_t xAOD::CaloCluster_v1::rawPhi | ( | ) | const |
Get \( \phi \) in signal state UNCALIBRATED.
|
inline |
Accesssor to CaloRecoStatus (non-const)
Definition at line 843 of file CaloCluster_v1.h.
|
inline |
Accesssor to CaloRecoStatus (const)
Definition at line 848 of file CaloCluster_v1.h.
|
inherited |
Release and free any private store associated with this object.
ExcBadPrivateStore will be thrown if this object does not have a private store.
Definition at line 210 of file AuxElement.cxx.
|
privateinherited |
Out-of-line portion of destructor.
Delete a private store if we have one.
Definition at line 441 of file AuxElement.cxx.
Method to remove a cell to the cluster (slow!) (Beware: Kinematics not updated!)
| index | Index of the cell in the CaloCelLContainer |
Definition at line 847 of file CaloCluster_v1.cxx.
| bool xAOD::CaloCluster_v1::retrieveMoment | ( | MomentType | type, |
| double & | value ) const |
Retrieve individual moment.
Definition at line 662 of file CaloCluster_v1.cxx.
| bool xAOD::CaloCluster_v1::retrieveMoment | ( | MomentType | type, |
| ncells_store_t & | values ) const |
Retrieve non-scalar moments.
xAOD::CaloCluster_v1::numberCellsInSampling method. Definition at line 689 of file CaloCluster_v1.cxx.
|
inline |
Method to reweight a cell in the cluster (Beware: Kinematics not updated!)
| it | Non-const cell-iterator |
| weight | The new weight |
Definition at line 838 of file CaloCluster_v1.h.
|
inline |
Access to sampling pattern (one bit per sampling) (Method may be removed later)
Definition at line 867 of file CaloCluster_v1.h.
|
inlineprivate |
Definition at line 871 of file CaloCluster_v1.h.
| CaloCluster_v1::flt_t xAOD::CaloCluster_v1::secondTime | ( | ) | const |
Access second moment of cell timing distribution.
For clusters read from persistent storage, this method returns the value stored for the SECOND_TIME moment.
| 0 | if (1) moment is not available, (2) the cluster time could not be calculated, or (3) the cluster has only one cell or all cells have exactly the same time. |
Definition at line 911 of file CaloCluster_v1.cxx.
| void xAOD::CaloCluster_v1::setAltE | ( | const CaloCluster_v1::flt_t | value | ) |
Set Energy for signal state ALTCALIBRATED.
Definition at line 328 of file CaloCluster_v1.cxx.
| void xAOD::CaloCluster_v1::setAltEta | ( | const CaloCluster_v1::flt_t | value | ) |
Set \( \eta \) for signal state ALTCALIBRATED.
Definition at line 333 of file CaloCluster_v1.cxx.
| void xAOD::CaloCluster_v1::setAltM | ( | const CaloCluster_v1::flt_t | value | ) |
Set mass for singal state ALTCALIBRATED.
Definition at line 343 of file CaloCluster_v1.cxx.
| void xAOD::CaloCluster_v1::setAltPhi | ( | const CaloCluster_v1::flt_t | value | ) |
Set \( \phi \) for signal state ALTCALIBRATED.
Definition at line 338 of file CaloCluster_v1.cxx.
| void xAOD::CaloCluster_v1::setBadChannelList | ( | const CaloClusterBadChannelList & | bcl | ) |
Definition at line 274 of file CaloCluster_v1.cxx.
| void xAOD::CaloCluster_v1::setCalE | ( | const CaloCluster_v1::flt_t | value | ) |
Set Energy for signal state CALIBRATED.
Definition at line 306 of file CaloCluster_v1.cxx.
| void xAOD::CaloCluster_v1::setCalEta | ( | const CaloCluster_v1::flt_t | value | ) |
Set \( \eta \) for signal state CALIBRATED.
Definition at line 311 of file CaloCluster_v1.cxx.
| void xAOD::CaloCluster_v1::setCalM | ( | const CaloCluster_v1::flt_t | value | ) |
Set mass for singal state CALIBRATED.
Definition at line 321 of file CaloCluster_v1.cxx.
| void xAOD::CaloCluster_v1::setCalPhi | ( | const CaloCluster_v1::flt_t | value | ) |
Set \( \phi \) for signal state CALIBRATED.
Definition at line 316 of file CaloCluster_v1.cxx.
| void xAOD::CaloCluster_v1::setClusterSize | ( | const ClusterSize | sc | ) |
|
inherited |
Synonym for setStore with IConstAuxStore.
| store | The new store. |
| void xAOD::CaloCluster_v1::setE | ( | CaloCluster_v1::flt_t | theE | ) |
Definition at line 375 of file CaloCluster_v1.cxx.
| bool xAOD::CaloCluster_v1::setEmax | ( | const CaloSample | sampling, |
| const float | eMax ) |
Set the Energy of the cell with the highest energy in a particular sampling.
Definition at line 564 of file CaloCluster_v1.cxx.
| bool xAOD::CaloCluster_v1::setEnergy | ( | const CaloSample | sampling, |
| const float | e ) |
Set energy for a given sampling. Returns false if the sample isn't part of the cluster.
Definition at line 519 of file CaloCluster_v1.cxx.
| bool xAOD::CaloCluster_v1::setEta | ( | const CaloSample | sampling, |
| const float | eta ) |
Set \( \eta \) in a given sampling. Returns false if the sample isn't part of the cluster.
Definition at line 534 of file CaloCluster_v1.cxx.
| void xAOD::CaloCluster_v1::setEta | ( | CaloCluster_v1::flt_t | theEta | ) |
Set Eta for the current signal state.
Definition at line 391 of file CaloCluster_v1.cxx.
| void xAOD::CaloCluster_v1::setEta0 | ( | flt_t | ) |
| bool xAOD::CaloCluster_v1::setEtamax | ( | const CaloSample | sampling, |
| const float | etaMax ) |
Set the eta of the cell with the highest energy in a particular sampling.
Definition at line 577 of file CaloCluster_v1.cxx.
| bool xAOD::CaloCluster_v1::setEtasize | ( | const CaloSample | sampling, |
| const float | etaSize ) |
Set the cluster size in \( \varphi \) for a given sampling.
Definition at line 604 of file CaloCluster_v1.cxx.
|
privateinherited |
Record that this element used to have private data.
|
privateinherited |
Record that this element currently has private data.
|
privateinherited |
Set the index/container for this element.
| index | The index of this object within the container. |
| container | The container holding this object. May be null if this object is being removed from a container. |
Usually this simply sets the index and container members of this object. However, in the case where this object has an associated private store, then we need to deal with releasing the store if the object is being added to a container, or making a new store if the object is being removed from a container.
|
privateinherited |
Set the index/container for this element.
| index | The index of this object within the container. |
| container | The container holding this object. May be null if this object is being removed from a container. |
This is called from setIndex when we have a private store to deal with.
Definition at line 505 of file AuxElement.cxx.
| bool xAOD::CaloCluster_v1::setLink | ( | CaloClusterCellLinkContainer * | CCCL, |
| const EventContext & | ctx ) |
Push the CaloClusterCellLink object into the cell-link container and hand-over ownership to it.
| CCCL | pointer to the CaloClusterCellLinkContainer |
| EventContext | Explicitly specify the EventContext to use for the ElementLink. |
Definition at line 811 of file CaloCluster_v1.cxx.
| bool xAOD::CaloCluster_v1::setLink | ( | CaloClusterCellLinkContainer * | CCCL, |
| IProxyDict * | sg = nullptr ) |
Set up an ElementLink to a CaloClusterCellLink object.
| CCCL_key | StoreGate key of the CaloClusterCellLinkContainer |
| index | Index of inside the CaloClusterCellLinkContainer container |
Push the CaloClusterCellLink object into the cell-link container and hand-over ownership to it
| CCCL | pointer to the CaloClusterCellLinkContainer |
| sg | Explicitly specify the store to use for the ElementLink. |
Definition at line 796 of file CaloCluster_v1.cxx.
|
inlineprivate |
| clower | add lower cell count to data |
Definition at line 698 of file CaloCluster_v1.h.
| void xAOD::CaloCluster_v1::setM | ( | CaloCluster_v1::flt_t | theM | ) |
Set Mass for the current signal state.
Definition at line 424 of file CaloCluster_v1.cxx.
|
inherited |
Synonym for setStore with IAuxStore.
| store | The new store. |
|
privateinherited |
Record that this element does not have private data.
| void xAOD::CaloCluster_v1::setNumberCellsInSampling | ( | CaloSampling::CaloSample | samp, |
| int | ncells, | ||
| bool | isInnerWheel = false ) |
Set the number of cells in a sampling layer.
for debugging only ... std::vector<std::pair<std::string,float> > CaloCluster_v1::getAllMoments() { std::vector<std::pair<std::string,float> > retval; const SG::auxid_set_t& auxIds=container()->getAuxIDs(); //->getDynamicAuxIDs(); const size_t idx= this->index(); for (auto ai: auxIds) { const std::string& auxName=SG::AuxTypeRegistry::instance().getName(ai); const float v=container()->getData<float>(ai,idx); std::cout << "Index=" <<idx << ", Auxid=" << ai << ", Name=" << auxName << " value=" << v << std::endl; retval.push_back(std::make_pair(auxName,v)); } return retval; }
Definition at line 714 of file CaloCluster_v1.cxx.
| bool xAOD::CaloCluster_v1::setPhi | ( | const CaloSample | sampling, |
| const float | phi ) |
Set \( \varphi \) in a given sampling. Returns false if the sample isn't part of the cluster.
Definition at line 549 of file CaloCluster_v1.cxx.
| void xAOD::CaloCluster_v1::setPhi | ( | CaloCluster_v1::flt_t | thePhi | ) |
Set Phi for the current signal state.
Definition at line 407 of file CaloCluster_v1.cxx.
| bool xAOD::CaloCluster_v1::setPhimax | ( | const CaloSample | sampling, |
| const float | phiMax ) |
Set the phi of the cell with the highest energy in a particular sampling.
Definition at line 590 of file CaloCluster_v1.cxx.
| bool xAOD::CaloCluster_v1::setPhisize | ( | const CaloSample | sampling, |
| const float | phiSize ) |
Set the cluster size in \( \vareta \) for a given sampling.
Definition at line 617 of file CaloCluster_v1.cxx.
| void xAOD::CaloCluster_v1::setRawE | ( | const CaloCluster_v1::flt_t | value | ) |
Set Energy for signal state UNCALIBRATED.
Definition at line 284 of file CaloCluster_v1.cxx.
| void xAOD::CaloCluster_v1::setRawEta | ( | const CaloCluster_v1::flt_t | value | ) |
Set \( \eta \) for signal state UNCALIBRATED.
Definition at line 289 of file CaloCluster_v1.cxx.
| void xAOD::CaloCluster_v1::setRawM | ( | const CaloCluster_v1::flt_t | value | ) |
Set mass for singal state UNCALIBRATED.
Definition at line 299 of file CaloCluster_v1.cxx.
| void xAOD::CaloCluster_v1::setRawPhi | ( | const CaloCluster_v1::flt_t | value | ) |
Set \( \phi \) for signal state UNCALIBRATED.
Definition at line 294 of file CaloCluster_v1.cxx.
| void xAOD::CaloCluster_v1::setSamplingPattern | ( | const unsigned | sp, |
| const bool | clearSamplingVars = false ) |
Set sampling pattern (one bit per sampling.
Definition at line 81 of file CaloCluster_v1.cxx.
|
private |
Definition at line 498 of file CaloCluster_v1.cxx.
| void xAOD::CaloCluster_v1::setSecondTime | ( | CaloCluster_v1::flt_t | stime | ) |
Switch signal state.
Definition at line 440 of file CaloCluster_v1.cxx.
| bool xAOD::CaloCluster_v1::setSisterClusterLink | ( | const ElementLink< CaloClusterContainer_v1 > & | sister | ) |
Set a link to a 'sister' cluster (eg the non-calibrated counterpart)
Definition at line 902 of file CaloCluster_v1.cxx.
|
inherited |
Set the store associated with this object.
| store | The new store. |
If store is nonzero, this adds a standalone store to the object. The object must not be in a container and must not have a private store. If store is zero, this removes a standalone store.
| store | Link to the new store. |
Definition at line 269 of file AuxElement.cxx.
|
inherited |
Set the store associated with this object.
| store | The new store. |
If store is nonzero, this adds a standalone store to the object. The object must not be in a container and must not have a private store. If store is zero, this removes a standalone store.
Definition at line 241 of file AuxElement.cxx.
|
inherited |
Set the store associated with this object.
| store | The new store. |
If store is nonzero, this adds a standalone store to the object. The object must not be in a container and must not have a private store. If store is zero, this removes a standalone store.
Definition at line 257 of file AuxElement.cxx.
|
privateinherited |
Set the store associated with this object.
| store | The new store. |
Helper for setStore. Creates the AuxElementStandaloneData object if needed and returns it.
| store | The new store. |
Helper for setStore. Creates the @x AuxElementStandaloneData object if needed and returns it.
Definition at line 461 of file AuxElement.cxx.
|
inlineprivate |
| cupper | add upper cell count to data |
Definition at line 700 of file CaloCluster_v1.h.
|
inline |
| size_t xAOD::CaloCluster_v1::size | ( | ) | const |
size method (forwarded from CaloClusterCellLink obj)
Definition at line 920 of file CaloCluster_v1.cxx.
| flt_t xAOD::CaloCluster_v1::time | ( | ) | const |
Access cluster time.
| void xAOD::CaloCluster_v1::toPersistent | ( | ) |
Function preparing the object to be persistified.
This function takes care of preparing (all) the ElementLink(s) in the object to be persistified.
Definition at line 863 of file CaloCluster_v1.cxx.
|
inherited |
Return true if index tracking is enabled for this object.
Always returns true. Included here to be consistent with AuxVectorBase when standalone objects may be used as template parameters.
|
virtual |
The type of the object as a simple enumeration.
Implements xAOD::IParticle.
Definition at line 489 of file CaloCluster_v1.cxx.
|
inlineprivate |
upper boundary for cell count
Definition at line 703 of file CaloCluster_v1.h.
|
inherited |
Test to see if this object is currently using a private store.
Definition at line 280 of file AuxElement.cxx.
|
inherited |
Test to see if this object is currently using a standalone store.
Test to see if this object is currently using a private store.
Definition at line 290 of file AuxElement.cxx.
|
friend |
Definition at line 63 of file CaloCluster_v1.h.
|
private |
Unique ptr to cell links.
For cluster building transient only , holds cells owned by the cluster if non-nullptr
Definition at line 686 of file CaloCluster_v1.h.
|
privateinherited |
The container of which this object is an element.
Should be null if this object is not within a container, except that it may also point at a private store.
Definition at line 335 of file AuxElement.h.
|
privateinherited |
The index of this element within its container.
Should be 0 if this object is not within a container.
Definition at line 128 of file IAuxElement.h.
|
privateinherited |
Definition at line 137 of file IAuxElement.h.
|
private |
Reco status (transient only)
Definition at line 689 of file CaloCluster_v1.h.
|
private |
bit-pattern describing the calo samplings contributing to this cluster
Definition at line 680 of file CaloCluster_v1.h.
|
private |
Second cell time moment (transient only)
Definition at line 692 of file CaloCluster_v1.h.
|
private |
Current signal state.
Definition at line 683 of file CaloCluster_v1.h.
|
staticconstexprinherited |
Mark that this type supports thinning operations.
See AthContainers/supportsThinning.h and AthenaPoolCnvSvc/T_AthenaPoolCnv.h. Helps guide which pool converter template will be used. If false, the default pool converter will be used rather than the aux store-specific one. Ordinary xAOD type should not touch this, but may be overridden in a derived class to handle certain special cases.
Definition at line 959 of file AuxElement.h.
1.14.0