Class summarizing the particle interaction throughout the Calorimeter (its shower shape). More...

#include <CaloRings_v1.h>

Inheritance diagram for xAOD::CaloRings_v1:

Collaboration diagram for xAOD::CaloRings_v1:

Public Member Functions
CaloRings_v1 ctors
	CaloRings_v1 ()
	Default empty ctor.
	CaloRings_v1 (const CaloRings_v1 &cr)
	Default copy ctor.
CaloRings_v1 dtors
	~CaloRings_v1 ()
RingSet Collection direct interation methods:
unsigned	nRingSets () const
	Number of RingSets ElementLinks available.
unsigned	size () const
	Number of RingSets ElementLinks available.
void	addRingSetEL (const ElementLink< RingSetContainer_v1 > &rsEL)
	Add ElementLink to holden vector.
void	clear ()
	Clear RingSet EL Collection.
RingSetLinks::iterator	begin ()
	returns iterator to the beginning of RingSet Collection.
RingSetLinks::iterator	end ()
	returns iterator to the ending of RingSet EL Collection.
RingSetLinks::const_iterator	begin () const
	returns const_iterator to the beginning of RingSet Collection.
RingSetLinks::const_iterator	end () const
	returns const_iterator to the ending of RingSet EL Collection.
const RingSet *	at (const unsigned index) const
	Return ith RingSet.
const RingSet *	operator[] (const unsigned index) const
	Return ith RingSet.
const RingSetLinks &	ringSetLinks () const
	Returns constant ringsets collection.
void	setRingSetLinks (const RingSetLinks &ringsets)
	Set this CaloRings RingSet Collection.
CaloRings_v1 operators overload:
CaloRings_v1 &	operator= (const CaloRings_v1 &clrings)
	Assignment Operator.

float	ringAt (const unsigned int rsIdx, const unsigned int ringIdx) const
	Navigate through eT rings methods.
float	ringAt (const unsigned int ringIdx) const
	Returns the ringIdx'th ring eT value from the vectorized representation.

void	exportRingsTo (std::vector< float > &ringStrip) const
	Export rings eT in vectorized representation.
rsIdx.
Returns the eT rings for RingSet index
void	exportRingsTo (std::vector< float > &ringStrip, const unsigned rsIdx) const
rsIdxStart to @name rsIdxEnd.
Returns the eT rings from RingSet index
void	exportRingsTo (std::vector< float > &ringStrip, const unsigned rsIdxStart, const unsigned rsIdxEnd) const
	Export rings eT in vectorized representation.
layerTypeIdx to @name layerEnd.
Returns the eT rings from Ringer::CalJointLayer
void	exportRingsTo (std::vector< float > &ringStrip, const RingSetConf_v1::RawConfCollection &clRingsRawConfCol, const Ringer::CalJointLayer layerTypeIdx) const
void	exportRingsTo (std::vector< float > &ringStrip, const RingSetConf_v1::RawConfCollection &clRingsRawConfCol, const Ringer::CalJointLayer layerTypeStart, const Ringer::CalJointLayer layerTypeEnd) const
sectionIdx
Returns the eT rings from Ringer::CalJointSection
void	exportRingsTo (std::vector< float > &ringStrip, const RingSetConf_v1::RawConfCollection &clRingsRawConfCol, const Ringer::CalJointSection sectionType) const
CaloRings_v1 using ostream:
Print
void	print (std::ostream &stream) const
	Print-out methods:

Private Member Functions

void	checkRingSetIndexWithinRange (unsigned index) const
	Check if index is within range, otherwise throws overflow_error:

Detailed Description

Class summarizing the particle interaction throughout the Calorimeter (its shower shape).

Definition at line 51 of file CaloRings_v1.h.

Constructor & Destructor Documentation

◆ CaloRings_v1() [1/2]

xAOD::CaloRings_v1::CaloRings_v1 ( )

inline

Default empty ctor.

Definition at line 60 of file CaloRings_v1.h.

60{;}

◆ CaloRings_v1() [2/2]

xAOD::CaloRings_v1::CaloRings_v1 ( const CaloRings_v1 & cr )

inline

Default copy ctor.

Definition at line 206 of file CaloRings_v1.h.

                                                      : 
  SG::AuxElement(clrings)
{
  this->makePrivateStore(clrings);
}

◆ ~CaloRings_v1()

xAOD::CaloRings_v1::~CaloRings_v1 ( )

inline

Definition at line 69 of file CaloRings_v1.h.

69{;}

Member Function Documentation

◆ addRingSetEL()

void xAOD::CaloRings_v1::addRingSetEL ( const ElementLink< RingSetContainer_v1 > & rsEL )

Add ElementLink to holden vector.

◆ at()

const RingSet * xAOD::CaloRings_v1::at ( const unsigned index ) const

Return ith RingSet.

Definition at line 85 of file CaloRings_v1.cxx.

{
  if ( i > nRingSets() ) 
    return nullptr;
  const ElementLink<RingSetContainer_v1> &rsEL = 
    constAccRingSetLinks( *this ).at(i);
  if ( !rsEL.isValid() ) {
    return nullptr;
  }
  return *rsEL;
}

◆ begin() [1/2]

RingSetLinks::iterator xAOD::CaloRings_v1::begin ( )

returns iterator to the beginning of RingSet Collection.

Definition at line 53 of file CaloRings_v1.cxx.

{
  return (accRingSetLinks.isAvailable( *this ) )?
              (accRingSetLinks( *this ).begin()):
              (RingSetLinks::iterator());
}

◆ begin() [2/2]

RingSetLinks::const_iterator xAOD::CaloRings_v1::begin ( ) const

returns const_iterator to the beginning of RingSet Collection.

Definition at line 69 of file CaloRings_v1.cxx.

{
  return (constAccRingSetLinks.isAvailable( *this ) )?
              (constAccRingSetLinks( *this ).begin()):
              (RingSetLinks::const_iterator());
}

◆ checkRingSetIndexWithinRange()

void xAOD::CaloRings_v1::checkRingSetIndexWithinRange ( unsigned index ) const

private

Check if index is within range, otherwise throws overflow_error:

Utilities methods:

Definition at line 298 of file CaloRings_v1.cxx.

{
  if ( index >= this->nRingSets() ) {
    throw std::overflow_error("Out of RingSet ElementLink vector range.");
  }
}

◆ clear()

void xAOD::CaloRings_v1::clear ( )

Clear RingSet EL Collection.

Definition at line 47 of file CaloRings_v1.cxx.

{
  accRingSetLinks( *this ).clear();
}

◆ end() [1/2]

RingSetLinks::iterator xAOD::CaloRings_v1::end ( )

returns iterator to the ending of RingSet EL Collection.

Definition at line 61 of file CaloRings_v1.cxx.

{
  return (accRingSetLinks.isAvailable( *this ) )?
              (accRingSetLinks( *this ).end()):
              (RingSetLinks::iterator());
}

◆ end() [2/2]

RingSetLinks::const_iterator xAOD::CaloRings_v1::end ( ) const

returns const_iterator to the ending of RingSet EL Collection.

Definition at line 77 of file CaloRings_v1.cxx.

{
  return (constAccRingSetLinks.isAvailable( *this ) )?
              (constAccRingSetLinks( *this ).end()):
              (RingSetLinks::const_iterator());
}

◆ exportRingsTo() [1/6]

void xAOD::CaloRings_v1::exportRingsTo ( std::vector< float > & ringStrip ) const

inline

Export rings eT in vectorized representation.

Returns the eT rings for all RingSets.

Definition at line 221 of file CaloRings_v1.h.

{
  exportRingsTo(ringStrip, 0, size()-1);
}

◆ exportRingsTo() [2/6]

void xAOD::CaloRings_v1::exportRingsTo	(	std::vector< float > &	ringStrip,
		const RingSetConf_v1::RawConfCollection &	clRingsRawConfCol,
		const Ringer::CalJointLayer	layerTypeIdx ) const

inline

Definition at line 237 of file CaloRings_v1.h.

{
  exportRingsTo(ringStrip, clRingsRawConfCol, layerTypeIdx, layerTypeIdx);
}

◆ exportRingsTo() [3/6]

void xAOD::CaloRings_v1::exportRingsTo	(	std::vector< float > &	ringStrip,
		const RingSetConf_v1::RawConfCollection &	clRingsRawConfCol,
		const Ringer::CalJointLayer	layerTypeStart,
		const Ringer::CalJointLayer	layerTypeEnd ) const

Definition at line 176 of file CaloRings_v1.cxx.

{
 
  if ( layerTypeEnd < layerTypeStart ) {
    throw std::invalid_argument( std::string(
          "Input layerTypeStart greater than layerTypeEnd") );
  }
 
  unsigned nRingSets = this->nRingSets();
 
  if ( nRingSets && clRingsRawConfCol.size() != nRingSets ) {
    throw std::invalid_argument( std::string(
          "The configuration struct seems not to be valid."));
  }
 
  // Prepare RingStrip vector to receive Rings energy vectorized representation
  ringStrip.clear();
 
  bool foundStartLayer = false;
 
  for ( unsigned rsIdx = 0; rsIdx < nRingSets; ++rsIdx ) {
    const RingSet* rs = this->at(rsIdx);
    if ( !rs ) {
      throw std::runtime_error( std::string(
          "Found invalid ElementLink") );
    }
    if ( !foundStartLayer ) {
      // Check if we found start layer:
      if ( clRingsRawConfCol[rsIdx].calJointLayer == layerTypeStart ) 
      {
        foundStartLayer = true;
        rs->copyTo(ringStrip);
      }
    } else {
      rs->copyTo(ringStrip);
    }
    // Check if we are at the last requested layer:
    if ( clRingsRawConfCol[rsIdx].calJointLayer == layerTypeEnd ) {
      break;
    }
  }
}

◆ exportRingsTo() [4/6]

void xAOD::CaloRings_v1::exportRingsTo	(	std::vector< float > &	ringStrip,
		const RingSetConf_v1::RawConfCollection &	clRingsRawConfCol,
		const Ringer::CalJointSection	sectionType ) const

Definition at line 224 of file CaloRings_v1.cxx.

{
 
  unsigned nRingSets = this->nRingSets();
 
  if ( nRingSets && clRingsRawConfCol.size() != nRingSets ) {
    throw std::invalid_argument( std::string(
          "The configuration struct seems not to be valid."));
  }
 
  // Prepare RingStrip vector to receive Rings energy vectorized representation
  ringStrip.clear();
 
  bool foundSection = false;
 
  for ( unsigned rsIdx = 0; rsIdx < nRingSets; ++rsIdx) {
    if ( clRingsRawConfCol[rsIdx].calJointSection == sectionType) {
      foundSection = true;
      const RingSet* rs = this->at(rsIdx);
      if ( !rs ) {
        throw std::runtime_error( std::string(
            "Found invalid ElementLink") );
      }
      rs->copyTo(ringStrip);
    } else if (foundSection) {
      break;
    }
  }
 
}

◆ exportRingsTo() [5/6]

void xAOD::CaloRings_v1::exportRingsTo	(	std::vector< float > &	ringStrip,
		const unsigned	rsIdx ) const

inline

Definition at line 228 of file CaloRings_v1.h.

{
  exportRingsTo(ringStrip, rsIdx, rsIdx);
}

◆ exportRingsTo() [6/6]

void xAOD::CaloRings_v1::exportRingsTo	(	std::vector< float > &	ringStrip,
		const unsigned	rsIdxStart,
		const unsigned	rsIdxEnd ) const

Export rings eT in vectorized representation.

Definition at line 153 of file CaloRings_v1.cxx.

{
 
  // Check if arguments are within range:
  checkRingSetIndexWithinRange(rsIdxStart);
  checkRingSetIndexWithinRange(rsIdxEnd);
 
  // Prepare RingStrip vector to receive ring strip information:
  ringStrip.clear();
 
  for ( unsigned idx = rsIdxStart; idx <= rsIdxEnd ; ++idx ) {
    const RingSet *rs = this->at( idx );
    if ( !rs ) {
      throw std::runtime_error("Found invalid ElementLink");
    }
    rs->copyTo(ringStrip);
  }
}

◆ nRingSets()

unsigned xAOD::CaloRings_v1::nRingSets ( ) const

Number of RingSets ElementLinks available.

◆ operator=()

CaloRings_v1 & xAOD::CaloRings_v1::operator= ( const CaloRings_v1 & clrings )

Assignment Operator.

Using the assignment of SG::AuxElement.

Definition at line 262 of file CaloRings_v1.cxx.

{
  if (this != &cl_rings){ // protect against invalid self-assignment
    if (!this->container() && !this->hasStore() ) {
      makePrivateStore();
    }
    this->SG::AuxElement::operator=( cl_rings );
  }
  // by convention, always return *this
  return *this;
}

◆ operator[]()

const RingSet * xAOD::CaloRings_v1::operator[] ( const unsigned index ) const

Return ith RingSet.

Definition at line 98 of file CaloRings_v1.cxx.

{
  if ( i > nRingSets() ) 
    return nullptr;
  const ElementLink<RingSetContainer_v1> &rsEL = 
    constAccRingSetLinks( *this )[i];
  if ( !rsEL.isValid() ) {
    return nullptr;
  }
  return *rsEL;
}

◆ print()

void xAOD::CaloRings_v1::print ( std::ostream & stream ) const

Print-out methods:

Definition at line 280 of file CaloRings_v1.cxx.

{
  stream << "CaloRings are : " << std::endl;
  for (unsigned rsIdx = 0; rsIdx < this->nRingSets(); ++rsIdx) {
    stream << "Ringset #" << rsIdx << " : "; 
    const RingSet* rs = this->at(rsIdx);
    if ( !rs ) {
      throw std::runtime_error( std::string(
          "Found invalid ElementLink") );
    }
    rs->print(stream);
  }
}

◆ ringAt() [1/2]

float xAOD::CaloRings_v1::ringAt ( const unsigned int ringIdx ) const

Returns the ringIdx'th ring eT value from the vectorized representation.

◆ ringAt() [2/2]

float xAOD::CaloRings_v1::ringAt	(	const unsigned int	rsIdx,
		const unsigned int	ringIdx ) const

Navigate through eT rings methods.

Returns ring eT at RingSet rsIdx and its ringIdx value.

◆ ringSetLinks()

const RingSetLinks & xAOD::CaloRings_v1::ringSetLinks ( ) const

Returns constant ringsets collection.

Set via AUXSTORE_OBJECT_SETTER_AND_GETTER marcro.

◆ setRingSetLinks()

void xAOD::CaloRings_v1::setRingSetLinks ( const RingSetLinks & ringsets )

Set this CaloRings RingSet Collection.

Set via AUXSTORE_OBJECT_SETTER_AND_GETTER marcro.

◆ size()

unsigned xAOD::CaloRings_v1::size ( ) const

inline

Number of RingSets ElementLinks available.

Definition at line 215 of file CaloRings_v1.h.

                                  {
  return nRingSets();
}

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

Public Member Functions

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ CaloRings_v1() [1/2]

◆ CaloRings_v1() [2/2]

◆ ~CaloRings_v1()

Member Function Documentation

◆ addRingSetEL()

◆ at()

◆ begin() [1/2]

◆ begin() [2/2]

◆ checkRingSetIndexWithinRange()

◆ clear()

◆ end() [1/2]

◆ end() [2/2]

◆ exportRingsTo() [1/6]

◆ exportRingsTo() [2/6]

◆ exportRingsTo() [3/6]

◆ exportRingsTo() [4/6]

◆ exportRingsTo() [5/6]

◆ exportRingsTo() [6/6]

◆ nRingSets()

◆ operator=()

◆ operator[]()

◆ print()

◆ ringAt() [1/2]

◆ ringAt() [2/2]

◆ ringSetLinks()

◆ setRingSetLinks()

◆ size()