Ringer::CaloCornerRingsBuilder Class Reference

#include <CaloCornerRingsBuilder.h>

Inheritance diagram for Ringer::CaloCornerRingsBuilder:

Collaboration diagram for Ringer::CaloCornerRingsBuilder:

Public Member Functions
virtual StatusCode	execute (const xAOD::CaloCluster &cluster, ElementLink< xAOD::CaloRingsContainer > &clRings) override
	Tool main methods:
virtual StatusCode	execute (const xAOD::IParticle &particle, ElementLink< xAOD::CaloRingsContainer > &clRings) override
	execute method for IParticle
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.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const
CaloCornerRingsBuilder ctors and dtors:
	CaloCornerRingsBuilder (const std::string &type, const std::string &name, const IInterface *parent)
	Default constructor.
	~CaloCornerRingsBuilder ()
	Destructor.
virtual StatusCode	initialize () override
	Tool main methods:
virtual StatusCode	preExecute (xAOD::CaloRingsContainer *crCont, xAOD::RingSetContainer *rsCont, const std::size_t nReserve=0) override
	method for working on containers
virtual StatusCode	finalize () override
	finalize method
const xAOD::RingSetConf::RawConfCollection &	rawConf () override
	Extra methods:
bool	useShowerShapeBarycenter () override
	Retrieve whether it was set used shower shape barycenter.

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

Protected Member Functions
virtual StatusCode	buildRingSet (const xAOD::RingSetConf::RawConf &rawConf, const AtlasGeoPoint &seed, xAOD::RingSet *rs, const unsigned int offset, const unsigned int nSubRings)
StatusCode	getCornerRingsSeeds (const xAOD::RingSetConf::RawConf &rawConf, const AtlasGeoPoint &centralSeed, std::vector< AtlasGeoPoint > &cornerSeeds)
	Get the seeds for the corner rings (top-left, etc).
virtual StatusCode	buildRingSet (const xAOD::RingSetConf::RawConf &rawConf, const AtlasGeoPoint &seed, xAOD::RingSet *rs)
	Tool protected methods:
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
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.

Protected Attributes
Gaudi::Property< int >	m_cornerShift
	Number of cells to shift for corner seeds (top-left, etc).
SG::WriteHandleKey< xAOD::CaloRingsContainer >	m_crContName
	Tool props (python configurables):
SG::WriteHandleKey< xAOD::RingSetContainer >	m_rsContName
	Name of RingSetContainer on Event StoreGate.
SG::ReadHandleKey< CaloCellContainer >	m_cellsContName
	Name of CaloCellContainer.
Gaudi::Property< std::vector< float > >	m_etaWidth
	Width of the ring in eta.
Gaudi::Property< std::vector< float > >	m_phiWidth
	Width of the ring in phi.
Gaudi::Property< float >	m_cellMaxDEtaDist
	Maximum cell distance in eta to seed.
Gaudi::Property< float >	m_cellMaxDPhiDist
	Maximum cell distance in phi to seed.
Gaudi::Property< std::vector< unsigned int > >	m_nRings
	Number of rings in a ringset.
Gaudi::Property< float >	m_minEnergy
	Minimum particle energy to build rings (GeV).
Gaudi::Property< std::vector< int > >	m_layers
	Calorimeter layers in each ringset.
Gaudi::Property< std::vector< unsigned int > >	m_nLayers
	Number of calorimeter layers in each ringset.
Gaudi::Property< bool >	m_useShowShapeBarycenter
	Switch to use shower barycenter seed for each RingSets.
Gaudi::Property< bool >	m_doTransverseEnergy
	Switch to use raw cell energy instead ET.
SG::ReadCondHandleKey< CaloDetDescrManager >	m_caloMgrKey {this, "CaloDetDescrManager", "CaloDetDescrManager"}

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>
template<typename T>
StatusCode	executeTemp (const T &input, ElementLink< xAOD::CaloRingsContainer > &crEL)
	Tool private methods:

Private Attributes
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default).
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default).
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared
xAOD::RingSetContainer *	m_rsCont
	Tool props (non configurables):
xAOD::CaloRingsContainer *	m_crCont
	Create and hold CaloRingsContainer for each event.
xAOD::RingSetConf::RawConfCollection	m_rsRawConfCol
	holds each RingSet configuration (filled at initialize)
AtlasGeoPoint	m_lastValidSeed
	last valid RingSet seed
size_t	m_nRingSets
	hold the number of RingSets we are building for each CaloRings
static const CaloPhiRange	m_phiHelper
	used for phi wrap-around
StatusCode	getRingSetSeed (const xAOD::RingSetConf::RawConf &conf, const xAOD::CaloCluster &cluster, AtlasGeoPoint &seed)
	Fill RingSet seed for CaloCluster.
static StatusCode	getRingSetSeed (const xAOD::RingSetConf::RawConf &, const xAOD::IParticle &part, AtlasGeoPoint &seed)
	Fill RingSet seed for IParticle.

Detailed Description

Definition at line 15 of file CaloCornerRingsBuilder.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

CaloCornerRingsBuilder()

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

Default constructor.

Definition at line 37 of file CaloCornerRingsBuilder.cxx.

        : CaloRingsBuilder(type, name, parent)
    {
 
        declareInterface<ICaloRingsBuilder>(this);
    }

~CaloCornerRingsBuilder()

Ringer::CaloCornerRingsBuilder::~CaloCornerRingsBuilder ( )

default

Destructor.

Member Function Documentation

buildRingSet() [1/2]

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

protectedvirtual

Tool protected methods:

main method where the RingSets are built.

Reimplemented from Ringer::CaloRingsBuilder.

Definition at line 118 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 = std::fabs(
                                           (cell->eta() - seed.eta())) /
                                       rawConf.etaWidth;
                // calculate the normalised difference in phi
                const float deltaPhi = std::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() / std::cosh(cell->eta());
                    }
                    else
                    {
                        rs->at(ringNumber) += cell->energy();
                    }
                }
            }
        }
 
        return StatusCode::SUCCESS;
    }

buildRingSet() [2/2]

StatusCode Ringer::CaloCornerRingsBuilder::buildRingSet ( const xAOD::RingSetConf::RawConf & rawConf, const AtlasGeoPoint & seed, xAOD::RingSet * rs, const unsigned int offset, const unsigned int nSubRings )

protectedvirtual

Definition at line 195 of file CaloCornerRingsBuilder.cxx.

    {
 
        SG::ReadHandle<CaloCellContainer> cellsCont(m_cellsContName);
        ATH_CHECK(cellsCont.isValid());
 
        SG::ReadCondHandle<CaloDetDescrManager> caloMgrHandle{m_caloMgrKey};
        ATH_CHECK(caloMgrHandle.isValid());
 
        const CaloDetDescrManager *caloMgr = *caloMgrHandle;
        CaloCellList cells(caloMgr, cellsCont.ptr());
 
        for (const int layer : rawConf.layers)
        {
 
            ATH_MSG_DEBUG("Selecting cells in layer " << layer);
 
            cells.select(seed.eta(), seed.phi(), m_cellMaxDEtaDist, m_cellMaxDPhiDist, layer);
 
            for (const CaloCell *cell : cells)
            {
 
                unsigned int ringNumber(0);
 
                const float deltaEta = std::abs((cell->eta() - seed.eta())) / rawConf.etaWidth;
                const float deltaPhi = std::abs(CaloPhiRange::diff(cell->phi(), seed.phi())) / rawConf.phiWidth;
 
                const float deltaGreater = std::max(deltaEta, deltaPhi);
 
                ringNumber = static_cast<unsigned int>(std::floor(deltaGreater + .5));
 
                if (ringNumber < nSubRings)
                {
                    ringNumber += offset;
 
                    float energyToAdd = 0;
 
                    if (m_doTransverseEnergy)
                    {
                        energyToAdd = cell->energy() / std::cosh(cell->eta());
                    }
                    else
                    {
                        energyToAdd = cell->energy();
                    }
 
                    rs->at(ringNumber) += energyToAdd;
 
                    ATH_MSG_DEBUG("New ring energy=" << rs->at(ringNumber));
                }
            }
        }
 
        return StatusCode::SUCCESS;
    }

crContName()

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

inlineoverridevirtualinherited

Implements Ringer::ICaloRingsBuilder.

Definition at line 109 of file CaloRingsBuilder.h.

{ return m_crContName; }

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T, V, H > & 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());
 
  }

declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & 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()

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; }

execute() [1/2]

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

overridevirtual

Tool main methods:

Reimplemented from Ringer::CaloRingsBuilder.

Definition at line 48 of file CaloCornerRingsBuilder.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)
        {
            // This now correctly calls the CaloCornerRingsBuilder::executeTemp
            return executeTemp(cluster, clRings);
        }
        else
        {
            ATH_MSG_DEBUG("Skipping cluster with low energy (" << et << " MeV) .");
            return StatusCode::SUCCESS;
        }
    }

execute() [2/2]

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

overridevirtual

execute method for IParticle

Reimplemented from Ringer::CaloRingsBuilder.

Definition at line 71 of file CaloCornerRingsBuilder.cxx.

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

executeTemp()

template<typename T>

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

private

Tool private methods:

unique execute method for integrating interface code.

Definition at line 88 of file CaloCornerRingsBuilder.cxx.

    {
 
        ATH_MSG_DEBUG("Entering executeTemp with input eta=" << input.eta()
                                                             << " phi=" << input.phi());
 
        xAOD::CaloRings *clRings = new xAOD::CaloRings();
        m_crCont->push_back(clRings);
 
        clRingsLink.toContainedElement(*m_crCont, clRings);
 
        if (!m_useShowShapeBarycenter)
        {
            m_lastValidSeed = AtlasGeoPoint(input.eta(), input.phi());
            ATH_MSG_DEBUG("Using input as seed eta=" << input.eta()
                                                     << " phi=" << input.phi());
        }
 
        for (const xAOD::RingSetConf::RawConf &rawConf : m_rsRawConfCol)
        {
 
            xAOD::RingSet *rs = new xAOD::RingSet(rawConf.nRings);
            m_rsCont->push_back(rs);
 
            unsigned int nSubRings = rawConf.nRings / 5;
 
            ATH_MSG_DEBUG("Creating RingSet with total rings=" << rawConf.nRings
                                                               << " subrings=" << nSubRings);
 
            std::vector<AtlasGeoPoint> seeds;
            seeds.reserve(5);
 
            AtlasGeoPoint centralSeed;
 
            CHECK(getRingSetSeed(rawConf, input, centralSeed));
 
            ATH_MSG_DEBUG("Central seed eta=" << centralSeed.eta()
                                              << " phi=" << centralSeed.phi());
 
            seeds.push_back(centralSeed);
 
            CHECK(getCornerRingsSeeds(rawConf, centralSeed, seeds));
 
            for (size_t i = 0; i < seeds.size(); ++i)
            {
                const AtlasGeoPoint &seed = seeds[i];
                const unsigned int offset = i * nSubRings;
 
                CHECK(buildRingSet(rawConf, seed, rs, offset, nSubRings));
            }
 
            ElementLink<xAOD::RingSetContainer> rsEL(rs, *m_rsCont);
            clRings->addRingSetEL(rsEL);
        }
 
        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 ( )

overridevirtualinherited

finalize method

Implements Ringer::ICaloRingsBuilder.

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

Definition at line 127 of file CaloRingsBuilder.cxx.

    {
        return StatusCode::SUCCESS;
    }

getCornerRingsSeeds()

StatusCode Ringer::CaloCornerRingsBuilder::getCornerRingsSeeds ( const xAOD::RingSetConf::RawConf & rawConf, const AtlasGeoPoint & centralSeed, std::vector< AtlasGeoPoint > & cornerSeeds )

protected

Get the seeds for the corner rings (top-left, etc).

Definition at line 155 of file CaloCornerRingsBuilder.cxx.

    {
 
        const float deltaEta = m_cornerShift * rawConf.etaWidth;
        const float deltaPhi = m_cornerShift * rawConf.phiWidth;
 
        ATH_MSG_DEBUG("Corner seed shifts: deltaEta=" << deltaEta
                                                      << " deltaPhi=" << deltaPhi);
 
        AtlasGeoPoint top_right, top_left, bottom_right, bottom_left;
 
        top_right.setEta(seed.eta() + deltaEta);
        top_right.setPhi(seed.phi() + deltaPhi);
 
        top_left.setEta(seed.eta() + deltaEta);
        top_left.setPhi(seed.phi() - deltaPhi);
 
        bottom_right.setEta(seed.eta() - deltaEta);
        bottom_right.setPhi(seed.phi() + deltaPhi);
 
        bottom_left.setEta(seed.eta() - deltaEta);
        bottom_left.setPhi(seed.phi() - deltaPhi);
 
        ATH_MSG_DEBUG("Corner seeds:");
        ATH_MSG_DEBUG("top_right eta=" << top_right.eta() << " phi=" << top_right.phi());
        ATH_MSG_DEBUG("top_left eta=" << top_left.eta() << " phi=" << top_left.phi());
        ATH_MSG_DEBUG("bottom_right eta=" << bottom_right.eta() << " phi=" << bottom_right.phi());
        ATH_MSG_DEBUG("bottom_left eta=" << bottom_left.eta() << " phi=" << bottom_left.phi());
 
        cornerSeeds.push_back(top_right);
        cornerSeeds.push_back(top_left);
        cornerSeeds.push_back(bottom_left);
        cornerSeeds.push_back(bottom_right);
 
        return StatusCode::SUCCESS;
    }

getRingSetSeed() [1/2]

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

staticprotectedinherited

Fill RingSet seed for IParticle.

Definition at line 303 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 )

protectedinherited

Fill RingSet seed for CaloCluster.

Definition at line 256 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 ( )

overridevirtualinherited

Tool main methods:

initialize method

Implements Ringer::ICaloRingsBuilder.

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

Definition at line 56 of file CaloRingsBuilder.cxx.

    {
        ATH_MSG_DEBUG("Initializing " << name());
 
        m_nRingSets = m_nRings.size();
 
        // Build RingSets configuration:
        size_t offset = 0;
 
        // Build RingSets configuration:
        for (size_t rsConfIdx = 0; rsConfIdx < m_nRingSets; ++rsConfIdx)
        {
            const auto rsNLayers = m_nLayers[rsConfIdx];
 
            std::vector<CaloSampling::CaloSample> rsLayers;
            rsLayers.reserve(rsNLayers);
 
            for (unsigned int s : std::span(m_layers.value().data() + offset, rsNLayers))
            {
                rsLayers.push_back(static_cast<CaloSampling::CaloSample>(s));
            }
 
            offset += 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(std::move(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()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

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

inlineoverridevirtualinherited

Implements Ringer::ICaloRingsBuilder.

Definition at line 107 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 )

overridevirtualinherited

method for working on containers

Implements Ringer::ICaloRingsBuilder.

Definition at line 133 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 ( )

inlineoverridevirtualinherited

Extra methods:

Retrieve RawConfiguration Collection

Implements Ringer::ICaloRingsBuilder.

Definition at line 94 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

inlineoverridevirtualinherited

Implements Ringer::ICaloRingsBuilder.

Definition at line 110 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 asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

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 ( )

inlineoverridevirtualinherited

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"}

protectedinherited

Definition at line 258 of file CaloRingsBuilder.h.

{this, "CaloDetDescrManager", "CaloDetDescrManager"};

m_cellMaxDEtaDist

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

protectedinherited

Initial value:

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

Maximum cell distance in eta to seed.

Definition at line 187 of file CaloRingsBuilder.h.

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

m_cellMaxDPhiDist

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

protectedinherited

Initial value:

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

Maximum cell distance in phi to seed.

Definition at line 194 of file CaloRingsBuilder.h.

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

m_cellsContName

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

protectedinherited

Initial value:

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

Name of CaloCellContainer.

Definition at line 162 of file CaloRingsBuilder.h.

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

m_cornerShift

Gaudi::Property<int> Ringer::CaloCornerRingsBuilder::m_cornerShift

protected

Initial value:

{
            this,
            "CornerShift",
            3,
            "Number of cells to shift for corner seeds (top-left, etc)"}

Number of cells to shift for corner seeds (top-left, etc).

Definition at line 72 of file CaloCornerRingsBuilder.h.

                                        {
            this,
            "CornerShift",
            3,
            "Number of cells to shift for corner seeds (top-left, etc)"};

m_crCont

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

protectedinherited

Create and hold CaloRingsContainer for each event.

Definition at line 271 of file CaloRingsBuilder.h.

m_crContName

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

protectedinherited

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 144 of file CaloRingsBuilder.h.

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

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

protectedinherited

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 252 of file CaloRingsBuilder.h.

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

m_etaWidth

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

protectedinherited

Initial value:

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

Width of the ring in eta.

Definition at line 171 of file CaloRingsBuilder.h.

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

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

protectedinherited

last valid RingSet seed

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

Definition at line 281 of file CaloRingsBuilder.h.

m_layers

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

protectedinherited

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 222 of file CaloRingsBuilder.h.

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

m_minEnergy

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

protectedinherited

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 209 of file CaloRingsBuilder.h.

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

m_nLayers

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

protectedinherited

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 231 of file CaloRingsBuilder.h.

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

m_nRings

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

protectedinherited

Initial value:

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

Number of rings in a ringset.

Definition at line 201 of file CaloRingsBuilder.h.

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

m_nRingSets

size_t Ringer::CaloRingsBuilder::m_nRingSets

protectedinherited

hold the number of RingSets we are building for each CaloRings

Definition at line 289 of file CaloRingsBuilder.h.

m_phiHelper

const CaloPhiRange Ringer::CaloRingsBuilder::m_phiHelper

staticprotectedinherited

used for phi wrap-around

Definition at line 285 of file CaloRingsBuilder.h.

m_phiWidth

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

protectedinherited

Initial value:

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

Width of the ring in phi.

Definition at line 179 of file CaloRingsBuilder.h.

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

m_rsCont

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

protectedinherited

Tool props (non configurables):

Create and hold RingSetContainer for each event

Definition at line 267 of file CaloRingsBuilder.h.

m_rsContName

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

protectedinherited

Initial value:

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

Name of RingSetContainer on Event StoreGate.

Definition at line 153 of file CaloRingsBuilder.h.

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

m_rsRawConfCol

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

protectedinherited

holds each RingSet configuration (filled at initialize)

Definition at line 275 of file CaloRingsBuilder.h.

m_useShowShapeBarycenter

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

protectedinherited

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 243 of file CaloRingsBuilder.h.

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

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:

• CaloCornerRingsBuilder.h
• CaloCornerRingsBuilder.cxx