Ringer::CaloRingsBuilder Class Reference

#include <CaloRingsBuilder.h>

Inheritance diagram for Ringer::CaloRingsBuilder:

Collaboration diagram for Ringer::CaloRingsBuilder:

Public Member Functions
std::size_t	nRingSets () const override
const SG::WriteHandleKey< xAOD::CaloRingsContainer > &	crContName () const override
const SG::WriteHandleKey< xAOD::RingSetContainer > &	rsContName () const override
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc. More...
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm. More...
virtual StatusCode	sysStart () override
	Handle START transition. More...
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &t)
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
MsgStream &	msg (const MSG::Level lvl) const
bool	msgLvl (const MSG::Level lvl) const
CaloRingsBuilder ctors and dtors:
	CaloRingsBuilder (const std::string &type, const std::string &name, const IInterface *parent)
	Default constructor. More...
	~CaloRingsBuilder ()
	Destructor. More...

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	AlgTool interface methods. More...

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed. More...

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared
virtual StatusCode	initialize () override
	Tool main methods: More...
virtual StatusCode	preExecute (xAOD::CaloRingsContainer *crCont, xAOD::RingSetContainer *rsCont, const std::size_t nReserve=0) override
	method for working on containers More...
virtual StatusCode	execute (const xAOD::IParticle &particle, ElementLink< xAOD::CaloRingsContainer > &clRingsLink) override
	build CaloRings for IParticle More...
virtual StatusCode	execute (const xAOD::CaloCluster &cluster, ElementLink< xAOD::CaloRingsContainer > &clRingsLink) override
	build CaloRings for CaloCluster More...
virtual StatusCode	finalize () override
	finalize method More...
template<typename T >
StatusCode	executeTemp (const T &input, ElementLink< xAOD::CaloRingsContainer > &crEL)
	Tool protected methods: More...
virtual StatusCode	buildRingSet (const xAOD::RingSetConf::RawConf &rawConf, const AtlasGeoPoint &seed, xAOD::RingSet *rs)
	main method where the RingSets are built. More...
StatusCode	getRingSetSeed (const xAOD::RingSetConf::RawConf &conf, const xAOD::CaloCluster &cluster, AtlasGeoPoint &seed)
	Fill RingSet seed for CaloCluster. More...
static StatusCode	getRingSetSeed (const xAOD::RingSetConf::RawConf &, const xAOD::IParticle &part, AtlasGeoPoint &seed)
	Fill RingSet seed for IParticle. More...
SG::WriteHandleKey< xAOD::CaloRingsContainer >	m_crContName
	Tool props (python configurables): More...
SG::WriteHandleKey< xAOD::RingSetContainer >	m_rsContName
	Name of RingSetContainer on Event StoreGate. More...
SG::ReadHandleKey< CaloCellContainer >	m_cellsContName
	Name of CaloCellContainer. More...
Gaudi::Property< std::vector< float > >	m_etaWidth
	Width of the ring in eta. More...
Gaudi::Property< std::vector< float > >	m_phiWidth
	Width of the ring in phi. More...
Gaudi::Property< float >	m_cellMaxDEtaDist
	Maximum cell distance in eta to seed. More...
Gaudi::Property< float >	m_cellMaxDPhiDist
	Maximum cell distance in phi to seed. More...
Gaudi::Property< std::vector< unsigned int > >	m_nRings
	Number of rings in a ringset. More...
Gaudi::Property< float >	m_minEnergy
	Minimum particle energy to build rings (GeV) More...
Gaudi::Property< std::vector< int > >	m_layers
	Calorimeter layers in each ringset. More...
Gaudi::Property< std::vector< unsigned int > >	m_nLayers
	Number of calorimeter layers in each ringset. More...
Gaudi::Property< bool >	m_useShowShapeBarycenter
	Switch to use shower barycenter seed for each RingSets. More...
Gaudi::Property< bool >	m_doTransverseEnergy
	Switch to use raw cell energy instead ET. More...
SG::ReadCondHandleKey< CaloDetDescrManager >	m_caloMgrKey {this,"CaloDetDescrManager", "CaloDetDescrManager"}
xAOD::RingSetContainer *	m_rsCont
	Tool props (non configurables): More...
xAOD::CaloRingsContainer *	m_crCont
	Create and hold CaloRingsContainer for each event. More...
xAOD::RingSetConf::RawConfCollection	m_rsRawConfCol
	holds each RingSet configuration (filled at initialize) More...
AtlasGeoPoint	m_lastValidSeed
	last valid RingSet seed More...
size_t	m_nRingSets
	hold the number of RingSets we are building for each CaloRings More...
static const CaloPhiRange	m_phiHelper
	used for phi wrap-around More...

Detailed Description

Definition at line 40 of file CaloRingsBuilder.h.

Member Typedef Documentation

StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

CaloRingsBuilder()

Ringer::CaloRingsBuilder::CaloRingsBuilder	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent
	)

Default constructor.

Definition at line 39 of file CaloRingsBuilder.cxx.

  : ::AthAlgTool(type, name, parent),
    m_rsCont(nullptr),
    m_crCont(nullptr),
    m_nRingSets(0)
{
  declareInterface<ICaloRingsBuilder>(this);
}

~CaloRingsBuilder()

Ringer::CaloRingsBuilder::~CaloRingsBuilder ( )

default

Destructor.

Member Function Documentation

buildRingSet()

StatusCode Ringer::CaloRingsBuilder::buildRingSet ( const xAOD::RingSetConf::RawConf &  rawConf, const AtlasGeoPoint &  seed, xAOD::RingSet *  rs  )

protectedvirtual

main method where the RingSets are built.

Reimplemented in Ringer::CaloAsymRingsBuilder, and Ringer::CaloStripsRingsBuilder.

Definition at line 304 of file CaloRingsBuilder.cxx.

{
  // Get this RingSet size:
  const auto nRings = rawConf.nRings;
 
  // Retrieve CaloCells
  SG::ReadHandle<CaloCellContainer> cellsCont(m_cellsContName);
  // check is only used for serial running; remove when MT scheduler used
  if(!cellsCont.isValid()) {
    ATH_MSG_FATAL("Failed to retrieve "<< m_cellsContName.key());
    return StatusCode::FAILURE;
  }
 
  SG::ReadCondHandle<CaloDetDescrManager> caloMgrHandle{m_caloMgrKey};
  const CaloDetDescrManager* caloMgr=*caloMgrHandle;
 
  CaloCellList cells(caloMgr,cellsCont.ptr() );
 
  // loop over cells
  for ( const int layer : rawConf.layers) { // We use int here because the
    // cells.select() method needs int as param
    cells.select(seed.eta(), seed.phi(), m_cellMaxDEtaDist, m_cellMaxDPhiDist, layer );
    for ( const CaloCell *cell : cells ) {
 
      unsigned int ringNumber(0);
 
      // calculate the normalised difference in eta
      const float deltaEta = fabs(
          (cell->eta() - seed.eta())
          ) / rawConf.etaWidth;
      // calculate the normalised difference in phi
      const float deltaPhi = fabs(
          CaloPhiRange::diff(cell->phi(), seed.phi())
          ) / rawConf.phiWidth;
      // The biggest difference indicates the ring number (we are using
      // squared-shape rings)
      const float deltaGreater = std::max(deltaEta, deltaPhi);
 
      // Round to nearest integer:
      ringNumber = static_cast<unsigned int>(std::floor(deltaGreater + .5));
      if ( ringNumber < nRings ){
        if(m_doTransverseEnergy){
          rs->at(ringNumber) += cell->energy()/cosh(cell->eta()); 
        }else{
          rs->at(ringNumber) += cell->energy();
        }
      }
    }
  }
 
  return StatusCode::SUCCESS;
}

crContName()

const SG::WriteHandleKey<xAOD::CaloRingsContainer>& Ringer::CaloRingsBuilder::crContName ( ) const

inlineoverridevirtual

Implements Ringer::ICaloRingsBuilder.

Definition at line 108 of file CaloRingsBuilder.h.

{ return m_crContName; }

declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl, const SG::VarHandleKeyArrayType &    )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKeyArray>

Definition at line 170 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl, const SG::VarHandleKeyType &    )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl, const SG::VarHandleType &    )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleBase>

Definition at line 184 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
  }

declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  t, const SG::NotHandleType &    )

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

  {
    return PBASE::declareProperty(t);
  }

declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleBase &  hndl, const std::string &  doc, const SG::VarHandleType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

  {
    this->declare(hndl.vhKey());
    hndl.vhKey().setOwner(this);
 
    return PBASE::declareProperty(name,hndl,doc);
  }

declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleKey &  hndl, const std::string &  doc, const SG::VarHandleKeyType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

  {
    this->declare(hndl);
    hndl.setOwner(this);
 
    return PBASE::declareProperty(name,hndl,doc);
  }

declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleKeyArray &  hndArr, const std::string &  doc, const SG::VarHandleKeyArrayType &    )

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

  {
 
    // std::ostringstream ost;
    // ost << Algorithm::name() << " VHKA declareProp: " << name 
    //     << " size: " << hndArr.keys().size() 
    //     << " mode: " << hndArr.mode() 
    //     << "  vhka size: " << m_vhka.size()
    //     << "\n";
    // debug() << ost.str() << endmsg;
 
    hndArr.setOwner(this);
    m_vhka.push_back(&hndArr);
 
    Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
    if (p != 0) {
      p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
    } else {
      ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                    << name);
    }
 
    return p;
 
  }

declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, T &  property, const std::string &  doc, const SG::NotHandleType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

  {
    return PBASE::declareProperty(name, property, doc);
  }

declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, T &  property, const std::string &  doc = "none"  )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

  {
    typedef typename SG::HandleClassifier<T>::type htype;
    return declareProperty (name, property, doc, htype());
  }

declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T > &  t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                 {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

detStore()

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

evtStore() [1/2]

ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( ) const

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 90 of file AthCommonDataStore.h.

{ return m_evtStore; }

execute() [1/2]

StatusCode Ringer::CaloRingsBuilder::execute ( const xAOD::CaloCluster &  cluster, ElementLink< xAOD::CaloRingsContainer > &  clRingsLink  )

overridevirtual

build CaloRings for CaloCluster

Implements Ringer::ICaloRingsBuilder.

Definition at line 155 of file CaloRingsBuilder.cxx.

{
  double et(0.);
  const double eta2 = std::fabs(cluster.etaBE(2));
  const double energy =  cluster.e();
  if ( eta2 < 999.) {
    const double cosheta = std::cosh(eta2);
    et = (cosheta != 0.) ? energy /cosheta : 0.;
  }
  if ( et > m_minEnergy )
  {
    return executeTemp(cluster, clRings);
  } else {
    ATH_MSG_DEBUG( "Skipping cluster with low energy (" << et << " MeV) .");
    return StatusCode::SUCCESS;
  }
}

execute() [2/2]

StatusCode Ringer::CaloRingsBuilder::execute ( const xAOD::IParticle &  particle, ElementLink< xAOD::CaloRingsContainer > &  clRingsLink  )

overridevirtual

build CaloRings for IParticle

Implements Ringer::ICaloRingsBuilder.

Definition at line 175 of file CaloRingsBuilder.cxx.

{
  double et = particle.pt();
  if ( et > m_minEnergy )
  {
    return executeTemp(particle, clRings);
  } else {
    ATH_MSG_DEBUG( "Skipping particle with low energy (" << et << " MeV) .");
    return StatusCode::SUCCESS;
  }
}

executeTemp()

template<typename T >

StatusCode Ringer::CaloRingsBuilder::executeTemp ( const T &  input, ElementLink< xAOD::CaloRingsContainer > &  crEL  )

protected

Tool protected methods:

unique execute method for integrating interface code.

Definition at line 193 of file CaloRingsBuilder.cxx.

{
 
  ATH_MSG_DEBUG("Entering "<< name() << " execute.");
 
  // Create structure to hold rings:
  xAOD::CaloRings *clRings = new xAOD::CaloRings();
 
  // Add the CaloRings to the container:
  m_crCont->push_back(clRings);
 
  // Set elementLink reference to created CaloRings:
  clRingsLink.toContainedElement(*m_crCont, clRings);
 
  // If not using shower barycenter, we need to reset last valid seed to avoid
  // any possible issue:
  if ( !m_useShowShapeBarycenter ){
    m_lastValidSeed = AtlasGeoPoint(input.eta(),input.phi());
  }
 
  // Build this CaloRings RingSets:
  for ( const auto &rawConf : m_rsRawConfCol ) {
 
    // Create new RingSet and add it to the container:
    xAOD::RingSet* rs = new xAOD::RingSet( rawConf.nRings );
    m_rsCont->push_back(rs);
 
    // Get RingSet seed:
    AtlasGeoPoint seed;
    CHECK( getRingSetSeed( rawConf, input, seed ) );
 
    // Build it:
    CHECK( buildRingSet( rawConf, seed, rs ) );
 
    // Get the ElementLink and add it to our RingSet holder:
    ElementLink< xAOD::RingSetContainer > rsEL( rs, *m_rsCont );
    clRings->addRingSetEL( rsEL );
  }
 
  // Print CaloRings with DEBUG level:
  if (msgLevel() <= MSG::DEBUG){
    std::ostringstream str;
    clRings->print(str);
    ATH_MSG_DEBUG(str.str());
  }
 
  return StatusCode::SUCCESS;
}

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase &  ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

finalize()

StatusCode Ringer::CaloRingsBuilder::finalize ( )

overridevirtual

finalize method

Implements Ringer::ICaloRingsBuilder.

Reimplemented in Ringer::CaloAsymRingsBuilder, and Ringer::CaloStripsRingsBuilder.

Definition at line 125 of file CaloRingsBuilder.cxx.

{
  return StatusCode::SUCCESS;
}

getRingSetSeed() [1/2]

StatusCode Ringer::CaloRingsBuilder::getRingSetSeed ( const xAOD::RingSetConf::RawConf &  , const xAOD::IParticle &  part, AtlasGeoPoint &  seed  )

staticprotected

Fill RingSet seed for IParticle.

Definition at line 291 of file CaloRingsBuilder.cxx.

{
 
  seed.setEta( part.eta() );
  seed.setPhi( part.phi() );
 
  return StatusCode::SUCCESS;
}

getRingSetSeed() [2/2]

StatusCode Ringer::CaloRingsBuilder::getRingSetSeed ( const xAOD::RingSetConf::RawConf &  conf, const xAOD::CaloCluster &  cluster, AtlasGeoPoint &  seed  )

protected

Fill RingSet seed for CaloCluster.

Definition at line 245 of file CaloRingsBuilder.cxx.

{
  if ( !m_useShowShapeBarycenter ){
 
    seed.setEta( cluster.eta() );
    seed.setPhi( cluster.phi() );
 
    return StatusCode::SUCCESS;
 
  } else {
 
    bool foundValid = false, foundMultipleValid = false;
 
    for ( const auto layer : rawConf.layers ) {
 
      AtlasGeoPoint seedCandidate(
          cluster.etaSample( layer ),
          cluster.phiSample( layer )
        );
 
      ATH_MSG_DEBUG( "This layer (" << CaloSampling::getSamplingName(layer) <<
          ") seedCandidate is: (" <<
          seedCandidate.eta() << "," <<
          seedCandidate.phi() << ")" );
 
      if ( seedCandidate.isValid() ){
        m_lastValidSeed = seedCandidate;
        if ( foundValid )
          foundMultipleValid = true;
        foundValid = true;
      }
    }
 
    // If we get here, set it to the last valid seed:
    seed = m_lastValidSeed;
    if ( foundMultipleValid ){
      ATH_MSG_WARNING( "Found multiple valid seeds. Set to last valid candidate.");
    }
    return StatusCode::SUCCESS;
  }
}

initialize()

StatusCode Ringer::CaloRingsBuilder::initialize ( )

overridevirtual

Tool main methods:

initialize method

Implements Ringer::ICaloRingsBuilder.

Reimplemented in Ringer::CaloAsymRingsBuilder, and Ringer::CaloStripsRingsBuilder.

Definition at line 54 of file CaloRingsBuilder.cxx.

{
  ATH_MSG_DEBUG("Initializing " << name() );
 
  m_nRingSets = m_nRings.size();
 
  auto itr = m_layers.begin();
 
  // Build RingSets configuration:
  for (size_t rsConfIdx = 0; rsConfIdx < m_nRingSets; ++rsConfIdx) {
 
    const auto rsNLayers = m_nLayers[rsConfIdx];
 
    auto end_itr = itr + rsNLayers;
 
    const auto& caloSampleItr = reinterpret_cast<
        std::vector<CaloSampling::CaloSample>::iterator&
      >(itr);
    const auto& caloSampleEndItr = reinterpret_cast<
        std::vector<CaloSampling::CaloSample>::iterator&
      >(end_itr);
 
    std::vector<CaloSampling::CaloSample> rsLayers( caloSampleItr ,
        caloSampleEndItr);
 
    itr += rsNLayers;
 
    const auto rawConf = xAOD::RingSetConf::RawConf(
          m_nRings[rsConfIdx],
          rsLayers,
          m_etaWidth[rsConfIdx], m_phiWidth[rsConfIdx],
          m_cellMaxDEtaDist, m_cellMaxDPhiDist,
          xAOD::RingSetConf::whichLayer(rsLayers),
          xAOD::RingSetConf::whichSection(rsLayers)
        );
 
    // Build our raw configuration structure:
    m_rsRawConfCol.push_back(rawConf);
  }
 
  // We have finished filling the main raw configuration properties, now we add
  // it bounderies:
  try {
    xAOD::RingSetConf::addRawConfColBounderies(m_rsRawConfCol);
  } catch ( const std::runtime_error &e) {
    ATH_MSG_ERROR("Could not add collection bounderies due to: " << e.what() );
    ATH_MSG_ERROR("RawConfCollection is: ");
    std::ostringstream str;
    xAOD::RingSetConf::print(m_rsRawConfCol, str);
    ATH_MSG_ERROR(str.str());
    return StatusCode::FAILURE;
  }
 
  // Print our collection
  if (msgLevel() <= MSG::DEBUG){
    std::ostringstream str;
    xAOD::RingSetConf::print(m_rsRawConfCol, str);
    ATH_MSG_DEBUG(str.str());
  }
 
  // This will check that the properties were initialized properly
  // by job configuration.
  ATH_CHECK( m_crContName.initialize() );
  ATH_CHECK( m_rsContName.initialize() );
  ATH_CHECK( m_cellsContName.initialize() );
  ATH_CHECK( m_caloMgrKey.initialize() );
 
  return StatusCode::SUCCESS;
}

inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

interfaceID()

const InterfaceID & ICaloRingsBuilder::interfaceID ( )

inlinestaticinherited

AlgTool interface methods.

Definition at line 83 of file ICaloRingsBuilder.h.

{
  return IID_ICaloRingsBuilder;
}

msg() [1/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg() [2/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( const MSG::Level  lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                  {
    return this->msgStream(lvl);
  }

msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level  lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

nRingSets()

std::size_t Ringer::CaloRingsBuilder::nRingSets ( ) const

inlineoverridevirtual

Implements Ringer::ICaloRingsBuilder.

Definition at line 106 of file CaloRingsBuilder.h.

{ return m_nRingSets; }

outputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

preExecute()

StatusCode Ringer::CaloRingsBuilder::preExecute ( xAOD::CaloRingsContainer *  crCont, xAOD::RingSetContainer *  rsCont, const std::size_t  nReserve = 0  )

overridevirtual

method for working on containers

Implements Ringer::ICaloRingsBuilder.

Definition at line 131 of file CaloRingsBuilder.cxx.

{
  if ( crCont && rsCont ){
    m_crCont = crCont;
    m_rsCont = rsCont;
  } else {
    ATH_MSG_ERROR( "Attempted to set CaloRingsContainer and/or RingSetContainer to invalid pointers");
    return StatusCode::FAILURE;
  }
  // Reserve container space if required:
  if (nReserve) {
    // Reserve one CaloRings per particle
    m_crCont->reserve( nReserve );
    // We need to reserve more space for the RingSet container, there will be
    // the number of RawConfig available in our raw configuration collection.
    m_rsCont->reserve( nReserve * m_nRingSets );
  }
 
  return StatusCode::SUCCESS;
}

rawConf()

const xAOD::RingSetConf::RawConfCollection& Ringer::CaloRingsBuilder::rawConf ( )

inlineoverridevirtual

Extra methods:

Retrieve RawConfiguration Collection

Implements Ringer::ICaloRingsBuilder.

Definition at line 95 of file CaloRingsBuilder.h.

                                                               {
      return m_rsRawConfCol;
    };

renounce()

std::enable_if_t<std::is_void_v<std::result_of_t<decltype(&T::renounce)(T)> > && !std::is_base_of_v<SG::VarHandleKeyArray, T> && std::is_base_of_v<Gaudi::DataHandle, T>, void> AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T &  h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray &  handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

rsContName()

const SG::WriteHandleKey<xAOD::RingSetContainer>& Ringer::CaloRingsBuilder::rsContName ( ) const

inlineoverridevirtual

Implements Ringer::ICaloRingsBuilder.

Definition at line 109 of file CaloRingsBuilder.h.

{ return m_rsContName; }

sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in DerivationFramework::CfAthAlgTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and asg::AsgMetadataTool.

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase &  )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

useShowerShapeBarycenter()

bool Ringer::CaloRingsBuilder::useShowerShapeBarycenter ( )

inlineoverridevirtual

Retrieve whether it was set used shower shape barycenter.

Implements Ringer::ICaloRingsBuilder.

Definition at line 101 of file CaloRingsBuilder.h.

                                             {
      return m_useShowShapeBarycenter;
    };

Member Data Documentation

m_caloMgrKey

SG::ReadCondHandleKey<CaloDetDescrManager> Ringer::CaloRingsBuilder::m_caloMgrKey {this,"CaloDetDescrManager", "CaloDetDescrManager"}

protected

Definition at line 245 of file CaloRingsBuilder.h.

m_cellMaxDEtaDist

Gaudi::Property<float> Ringer::CaloRingsBuilder::m_cellMaxDEtaDist

protected

Initial value:

{this,
          "CellMaxDEtaDist", 0,
          "Maximum cell distance to the seed in eta."}

Maximum cell distance in eta to seed.

Definition at line 185 of file CaloRingsBuilder.h.

m_cellMaxDPhiDist

Gaudi::Property<float> Ringer::CaloRingsBuilder::m_cellMaxDPhiDist

protected

Initial value:

{this,
          "CellMaxDPhiDist", 0,
          "Maximum cell distance to the seed in phi."}

Maximum cell distance in phi to seed.

Definition at line 191 of file CaloRingsBuilder.h.

m_cellsContName

SG::ReadHandleKey<CaloCellContainer> Ringer::CaloRingsBuilder::m_cellsContName

protected

Initial value:

{this,
      "CellsContainerName",
      "AllCalo",
      "Key to obtain the cell container"}

Name of CaloCellContainer.

Definition at line 167 of file CaloRingsBuilder.h.

m_crCont

xAOD::CaloRingsContainer* Ringer::CaloRingsBuilder::m_crCont

protected

Create and hold CaloRingsContainer for each event.

Definition at line 258 of file CaloRingsBuilder.h.

m_crContName

SG::WriteHandleKey<xAOD::CaloRingsContainer> Ringer::CaloRingsBuilder::m_crContName

protected

Initial value:

{this,
      "CaloRingsContainerName",
      "CaloRings",
      "Name of the CaloRings container"}

Tool props (python configurables):

Name of CaloRingsContainer on Event StoreGate

electron collection input name

Definition at line 151 of file CaloRingsBuilder.h.

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

m_doTransverseEnergy

Gaudi::Property<bool> Ringer::CaloRingsBuilder::m_doTransverseEnergy

protected

Initial value:

{this,
            "doTransverseEnergy", false,
            "Switch to use raw cell energy, "
            "instead of cells ET."}

Switch to use raw cell energy instead ET.

Definition at line 240 of file CaloRingsBuilder.h.

m_etaWidth

Gaudi::Property<std::vector<float> > Ringer::CaloRingsBuilder::m_etaWidth

protected

Initial value:

{this,
          "EtaWidth", {}, "Each RingSet ring eta width."}

Width of the ring in eta.

Definition at line 175 of file CaloRingsBuilder.h.

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

m_lastValidSeed

AtlasGeoPoint Ringer::CaloRingsBuilder::m_lastValidSeed

protected

last valid RingSet seed

Propagate other layer centroids in case a layer centroid is not valid.

Definition at line 268 of file CaloRingsBuilder.h.

m_layers

Gaudi::Property<std::vector<int> > Ringer::CaloRingsBuilder::m_layers

protected

Initial value:

{this,
          "Layers", {},
          "Concatenated list of layers which will be used "
          "to build the RingSets"}

Calorimeter layers in each ringset.

This property should be read as: std::vector<CaloSampling::CaloSample> m_layersRings;

Definition at line 215 of file CaloRingsBuilder.h.

m_minEnergy

Gaudi::Property<float> Ringer::CaloRingsBuilder::m_minEnergy

protected

Initial value:

{this,
          "MinPartEnergy", std::numeric_limits<float>::lowest(),
          "Minimum particle/cluster energy to build rings (GeV)."}

Minimum particle energy to build rings (GeV)

Definition at line 203 of file CaloRingsBuilder.h.

m_nLayers

Gaudi::Property<std::vector<unsigned int> > Ringer::CaloRingsBuilder::m_nLayers

protected

Initial value:

{this,
            "RingSetNLayers", {},
            "Each RingSet number of layers from the Layers "
            "configurable property to use."}

Number of calorimeter layers in each ringset.

Definition at line 222 of file CaloRingsBuilder.h.

m_nRings

Gaudi::Property<std::vector<unsigned int> > Ringer::CaloRingsBuilder::m_nRings

protected

Initial value:

{this,
          "NRings", {},
          "Each RingSet number of rings."}

Number of rings in a ringset.

Definition at line 197 of file CaloRingsBuilder.h.

m_nRingSets

size_t Ringer::CaloRingsBuilder::m_nRingSets

protected

hold the number of RingSets we are building for each CaloRings

Definition at line 276 of file CaloRingsBuilder.h.

m_phiHelper

const CaloPhiRange Ringer::CaloRingsBuilder::m_phiHelper

staticprotected

used for phi wrap-around

Definition at line 272 of file CaloRingsBuilder.h.

m_phiWidth

Gaudi::Property<std::vector<float> > Ringer::CaloRingsBuilder::m_phiWidth

protected

Initial value:

{this,
          "PhiWidth", {}, "Each RingSet ring phi width."}

Width of the ring in phi.

Definition at line 180 of file CaloRingsBuilder.h.

m_rsCont

xAOD::RingSetContainer* Ringer::CaloRingsBuilder::m_rsCont

protected

Tool props (non configurables):

Create and hold RingSetContainer for each event

Definition at line 254 of file CaloRingsBuilder.h.

m_rsContName

SG::WriteHandleKey<xAOD::RingSetContainer> Ringer::CaloRingsBuilder::m_rsContName

protected

Initial value:

{this,
      "RingSetContainerName",
      "RingSets",
      "Name of the RingSets container"}

Name of RingSetContainer on Event StoreGate.

Definition at line 159 of file CaloRingsBuilder.h.

m_rsRawConfCol

xAOD::RingSetConf::RawConfCollection Ringer::CaloRingsBuilder::m_rsRawConfCol

protected

holds each RingSet configuration (filled at initialize)

Definition at line 262 of file CaloRingsBuilder.h.

m_useShowShapeBarycenter

Gaudi::Property<bool> Ringer::CaloRingsBuilder::m_useShowShapeBarycenter

protected

Initial value:

{this,
            "useShowerShapeBarycenter", false,
            "Switch to use shower barycenter for each layer, "
            "instead of the cluster center."}

Switch to use shower barycenter seed for each RingSets.

This can be set to false if using cluster information to use the cluster center instead of its layer energy baricenter.

Definition at line 232 of file CaloRingsBuilder.h.

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

---

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

• CaloRingsBuilder.h
• CaloRingsBuilder.cxx