Class describing HGTD clusters. More...

#include <PixelCluster_v1.h>

Inheritance diagram for xAOD::PixelCluster_v1:

Collaboration diagram for xAOD::PixelCluster_v1:

Classes
struct	ClusterVars

Public Member Functions
	PixelCluster_v1 ()=default
	Default constructor.
virtual	~PixelCluster_v1 ()=default
	Virtual destructor.
Functions to get pixel cluster properties
xAOD::UncalibMeasType	type () const override final
	Returns the type of the pixel cluster as a simple enumeration.
unsigned int	numDimensions () const override final
	Returns the number of dimensions of the measurement.
ConstVectorMap< 3 >	globalPosition () const
	Returns the global position of the pixel cluster.
VectorMap< 3 >	globalPosition ()
SG::ConstAccessor< SG::JaggedVecElt< Identifier::value_type > >::element_type	rdoList () const
	Returns the list of identifiers of the channels building the cluster.
int	channelsInPhi () const
	Returns the dimensions of the cluster in numbers of channels in phi (x) and eta (y) directions, respectively.
int	channelsInEta () const
float	widthInEta () const
	Returns the width of the cluster in phi (x) and eta (y) directions, respectively.
SG::ConstAccessor< SG::JaggedVecElt< int > >::element_type	totList () const
	Returns the list of ToT of the channels building the cluster.
SG::ConstAccessor< SG::JaggedVecElt< float > >::element_type	chargeList () const
	Returns the list of charges of the channels building the cluster.
float	totalCharge () const
	Returns the sum of the charges of the channels building the cluster.
float	energyLoss () const
	Return the energy loss in the cluster in MeV.
int	lvl1a () const
	Return the LVL1 accept.
Functions to get measurement properties
DetectorIDHashType	identifierHash () const
	Returns the IdentifierHash of the measurement (corresponds to the detector element IdentifierHash).
DetectorIdentType	identifier () const
	Returns the full Identifier of the measurement.
template<int N>
ConstVectorMap< N >	localPosition () const
	Returns the local position of the measurement.
template<int N>
VectorMap< N >	localPosition ()
	Returns the local position as mutable eigen map which can be assigned as well.
template<int N>
ConstMatrixMap< N >	localCovariance () const
	Returns the local covariance of the measurement.
template<int N>
MatrixMap< N >	localCovariance ()
	Returns the local covariance as mutable eigen map which can be assigned as well.
Functions to set measurement properties
void	setIdentifierHash (const DetectorIDHashType idHash)
	Sets the IdentifierHash of the measurement (corresponds to the detector element IdentifierHash).
void	setIdentifier (const DetectorIdentType measId)
	Sets the full Identifier of the measurement.
Direct method to set measurement properties
template<int N>
void	setMeasurement (const DetectorIDHashType idHash, MeasVector< N > locPos, MeasMatrix< N > locCov)
	Sets IdentifierHash, local position and local covariance of the measurement.

Static Protected Attributes
static const SG::AuxElement::Accessor< SG::JaggedVecElt< Identifier::value_type > >	s_rdoListAcc
static const SG::AuxElement::Accessor< SG::JaggedVecElt< int > >	s_totListAcc
static const SG::AuxElement::Accessor< SG::JaggedVecElt< float > >	s_chargeListAcc

Functions to set pixel cluster properties
void	setRDOlist (const std::vector< Identifier > &rdolist)
	Sets the list of identifiers of the channels building the cluster.
void	setRDOlist (std::vector< Identifier::value_type > &&rdolist)
	Setter with std::move if the value_type is already available.
void	setRDOlist (std::span< Identifier::value_type > rdolist)
	Setter with std::move if the value_type is already available.
void	setChannelsInPhiEta (int channelsInPhi, int channelsInEta)
	Sets the dimensions of the cluster in numbers of channels in phi (x) and eta (y) directions.
void	setWidthInEta (float widthInEta)
	Sets the width of the cluster in eta (y) direction.
void	setToTlist (const std::vector< int > &tots)
	Sets the list of ToT of the channels building the cluster.
void	setToTlist (std::span< int > tots)
void	setChargelist (const std::vector< float > &charges)
	Sets the list of charges of the channels building the cluster.
void	setChargelist (std::span< float > charges)
void	setTotalCharge (float totalCharge)
	Sets the total charge.
void	setEnergyLoss (float dEdX)
	Sets the energy loss in the cluster in MeV.
void	setLVL1A (int lvl1a)
	Sets the LVL1 accept.
static const SG::AuxElement::Accessor< SG::JaggedVecElt< Identifier::value_type > >	rdoListAcc ()
static const SG::AuxElement::Accessor< SG::JaggedVecElt< int > >	totListAcc ()
static const SG::AuxElement::Accessor< SG::JaggedVecElt< float > >	chargeListAcc ()

Detailed Description

Class describing HGTD clusters.

Class describing pixel clusters.

Definition at line 21 of file PixelCluster_v1.h.

Constructor & Destructor Documentation

◆ PixelCluster_v1()

xAOD::PixelCluster_v1::PixelCluster_v1 ( )

default

Default constructor.

◆ ~PixelCluster_v1()

virtual xAOD::PixelCluster_v1::~PixelCluster_v1 ( )

virtualdefault

Virtual destructor.

Member Function Documentation

◆ channelsInEta()

int xAOD::PixelCluster_v1::channelsInEta ( ) const

◆ channelsInPhi()

int xAOD::PixelCluster_v1::channelsInPhi ( ) const

Returns the dimensions of the cluster in numbers of channels in phi (x) and eta (y) directions, respectively.

◆ chargeList()

SG::ConstAccessor< SG::JaggedVecElt< float > >::element_type xAOD::PixelCluster_v1::chargeList ( ) const

inline

Returns the list of charges of the channels building the cluster.

Definition at line 162 of file PixelCluster_v1.h.

                                  {
   return s_chargeListAcc(*this);
}

◆ chargeListAcc()

const SG::AuxElement::Accessor< SG::JaggedVecElt< float > > xAOD::PixelCluster_v1::chargeListAcc ( )

inlinestatic

Definition at line 110 of file PixelCluster_v1.h.

110{ return s_chargeListAcc; }

◆ energyLoss()

float xAOD::PixelCluster_v1::energyLoss ( ) const

Return the energy loss in the cluster in MeV.

◆ globalPosition() [1/2]

xAOD::VectorMap< 3 > xAOD::PixelCluster_v1::globalPosition ( )

Definition at line 21 of file PixelCluster_v1.cxx.

                                                     {
    auto& values = globalPosAcc(*this);
    return VectorMap<3>{values.data()};
}

◆ globalPosition() [2/2]

xAOD::ConstVectorMap< 3 > xAOD::PixelCluster_v1::globalPosition ( ) const

Returns the global position of the pixel cluster.

Definition at line 16 of file PixelCluster_v1.cxx.

                                                                {
    const auto& values = globalPosAcc(*this);
    return ConstVectorMap<3>{values.data()};
}

◆ identifier()

DetectorIdentType xAOD::UncalibratedMeasurement_v1::identifier ( ) const

inherited

Returns the full Identifier of the measurement.

int xAOD::PixelCluster_v1::lvl1a ( ) const

Return the LVL1 accept.

◆ numDimensions()

unsigned int xAOD::PixelCluster_v1::numDimensions ( ) const

inlinefinaloverridevirtual

Returns the number of dimensions of the measurement.

Implements xAOD::UncalibratedMeasurement_v1.

Definition at line 36 of file PixelCluster_v1.h.

36{ return 2; }

◆ rdoList()

SG::ConstAccessor< SG::JaggedVecElt< Identifier::value_type > >::element_type xAOD::PixelCluster_v1::rdoList ( ) const

inline

Returns the list of identifiers of the channels building the cluster.

Definition at line 150 of file PixelCluster_v1.h.

                               {
   return s_rdoListAcc(*this);
}

◆ rdoListAcc()

const SG::AuxElement::Accessor< SG::JaggedVecElt< Identifier::value_type > > xAOD::PixelCluster_v1::rdoListAcc ( )

inlinestatic

Definition at line 108 of file PixelCluster_v1.h.

108{ return s_rdoListAcc; }

◆ setChannelsInPhiEta()

void xAOD::PixelCluster_v1::setChannelsInPhiEta	(	int	channelsInPhi,
		int	channelsInEta )

Sets the dimensions of the cluster in numbers of channels in phi (x) and eta (y) directions.

◆ setChargelist() [1/2]

void xAOD::PixelCluster_v1::setChargelist ( const std::vector< float > & charges )

Sets the list of charges of the channels building the cluster.

Definition at line 56 of file PixelCluster_v1.cxx.

                                                                       {
   s_chargeListAcc.set(*this,charges);
}

◆ setChargelist() [2/2]

void xAOD::PixelCluster_v1::setChargelist ( std::span< float > charges )

Definition at line 60 of file PixelCluster_v1.cxx.

                                                              {
   s_chargeListAcc.set(*this,charges);
}

◆ setEnergyLoss()

void xAOD::PixelCluster_v1::setEnergyLoss ( float dEdX )

Sets the energy loss in the cluster in MeV.

◆ setIdentifier()

void xAOD::UncalibratedMeasurement_v1::setIdentifier ( const DetectorIdentType measId )

inherited

Sets the full Identifier of the measurement.

◆ setIdentifierHash()

void xAOD::UncalibratedMeasurement_v1::setIdentifierHash ( const DetectorIDHashType idHash )

inherited

Sets the IdentifierHash of the measurement (corresponds to the detector element IdentifierHash).

◆ setLVL1A()

void xAOD::PixelCluster_v1::setLVL1A ( int lvl1a )

Sets the LVL1 accept.

◆ setMeasurement()

template<int N>

void xAOD::UncalibratedMeasurement_v1::setMeasurement	(	const DetectorIDHashType	idHash,
		MeasVector< N >	locPos,
		MeasMatrix< N >	locCov )

inherited

Sets IdentifierHash, local position and local covariance of the measurement.

◆ setRDOlist() [1/3]

void xAOD::PixelCluster_v1::setRDOlist ( const std::vector< Identifier > & rdolist )

Sets the list of identifiers of the channels building the cluster.

Definition at line 35 of file PixelCluster_v1.cxx.

                                                                         {
    std::vector<Identifier::value_type> rdos(rdoList.size());
    for (std::size_t i(0); i < rdos.size(); ++i) {
        rdos[i] = rdoList[i].get_compact();
    }
    s_rdoListAcc.set(*this,rdos);
}

◆ setRDOlist() [2/3]

void xAOD::PixelCluster_v1::setRDOlist ( std::span< Identifier::value_type > rdolist )

Setter with std::move if the value_type is already available.

Definition at line 30 of file PixelCluster_v1.cxx.

                                                                          {
   s_rdoListAcc.set(*this,rdoList);
}

◆ setRDOlist() [3/3]

void xAOD::PixelCluster_v1::setRDOlist ( std::vector< Identifier::value_type > && rdolist )

Setter with std::move if the value_type is already available.

Definition at line 27 of file PixelCluster_v1.cxx.

                                                                              {
   s_rdoListAcc.set(*this,rdoList);
}

◆ setTotalCharge()

void xAOD::PixelCluster_v1::setTotalCharge ( float totalCharge )

Sets the total charge.

◆ setToTlist() [1/2]

void xAOD::PixelCluster_v1::setToTlist ( const std::vector< int > & tots )

Sets the list of ToT of the channels building the cluster.

Definition at line 46 of file PixelCluster_v1.cxx.

                                                               {
   s_totListAcc.set(*this,tots);
}

◆ setToTlist() [2/2]

void xAOD::PixelCluster_v1::setToTlist ( std::span< int > tots )

Definition at line 50 of file PixelCluster_v1.cxx.

                                                      {
   s_totListAcc.set(*this,tots);
}

◆ setWidthInEta()

void xAOD::PixelCluster_v1::setWidthInEta ( float widthInEta )

Sets the width of the cluster in eta (y) direction.

◆ totalCharge()

float xAOD::PixelCluster_v1::totalCharge ( ) const

Returns the sum of the charges of the channels building the cluster.

◆ totList()

SG::ConstAccessor< SG::JaggedVecElt< int > >::element_type xAOD::PixelCluster_v1::totList ( ) const

inline

Returns the list of ToT of the channels building the cluster.

Definition at line 156 of file PixelCluster_v1.h.

                               {
   return s_totListAcc(*this);
}

◆ totListAcc()

const SG::AuxElement::Accessor< SG::JaggedVecElt< int > > xAOD::PixelCluster_v1::totListAcc ( )

inlinestatic

Definition at line 109 of file PixelCluster_v1.h.

109{ return s_totListAcc; }

◆ type()

xAOD::UncalibMeasType xAOD::PixelCluster_v1::type ( ) const

inlinefinaloverridevirtual

Returns the type of the pixel cluster as a simple enumeration.

Implements xAOD::UncalibratedMeasurement_v1.

Definition at line 33 of file PixelCluster_v1.h.

                                                    {
        return xAOD::UncalibMeasType::PixelClusterType;
    }

◆ widthInEta()

float xAOD::PixelCluster_v1::widthInEta ( ) const

Returns the width of the cluster in phi (x) and eta (y) directions, respectively.

Member Data Documentation

◆ s_chargeListAcc

const SG::AuxElement::Accessor< SG::JaggedVecElt< float > > xAOD::PixelCluster_v1::s_chargeListAcc

staticprotected

Definition at line 115 of file PixelCluster_v1.h.

◆ s_rdoListAcc

const SG::AuxElement::Accessor< SG::JaggedVecElt< Identifier::value_type > > xAOD::PixelCluster_v1::s_rdoListAcc

staticprotected

Definition at line 113 of file PixelCluster_v1.h.

◆ s_totListAcc

const SG::AuxElement::Accessor< SG::JaggedVecElt< int > > xAOD::PixelCluster_v1::s_totListAcc

staticprotected

Definition at line 114 of file PixelCluster_v1.h.

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

Classes

Public Member Functions

Static Protected Attributes

Functions to set pixel cluster properties

Detailed Description

Constructor & Destructor Documentation

◆ PixelCluster_v1()

◆ ~PixelCluster_v1()

Member Function Documentation

◆ channelsInEta()

◆ channelsInPhi()

◆ chargeList()

◆ chargeListAcc()

◆ energyLoss()

◆ globalPosition() [1/2]

◆ globalPosition() [2/2]

◆ identifier()

◆ identifierHash()

◆ localCovariance() [1/2]

◆ localCovariance() [2/2]

◆ localPosition() [1/2]

◆ localPosition() [2/2]

◆ lvl1a()

◆ numDimensions()

◆ rdoList()

◆ rdoListAcc()

◆ setChannelsInPhiEta()

◆ setChargelist() [1/2]

◆ setChargelist() [2/2]

◆ setEnergyLoss()

◆ setIdentifier()

◆ setIdentifierHash()

◆ setLVL1A()

◆ setMeasurement()

◆ setRDOlist() [1/3]

◆ setRDOlist() [2/3]

◆ setRDOlist() [3/3]

◆ setTotalCharge()

◆ setToTlist() [1/2]

◆ setToTlist() [2/2]

◆ setWidthInEta()

◆ totalCharge()

◆ totList()

◆ totListAcc()

◆ type()

◆ widthInEta()

Member Data Documentation

◆ s_chargeListAcc

◆ s_rdoListAcc

◆ s_totListAcc