egammaLargeClusterCellRecoveryTool Class Reference

Recovers large 7x11 clusters for clusters in EMB & EMEC. More...

#include <egammaLargeClusterCellRecoveryTool.h>

Inheritance diagram for egammaLargeClusterCellRecoveryTool:

Collaboration diagram for egammaLargeClusterCellRecoveryTool:

Public Member Functions
	egammaLargeClusterCellRecoveryTool (const std::string &type, const std::string &name, const IInterface *parent)
	Constructor.
virtual	~egammaLargeClusterCellRecoveryTool ()=default
	Destructor.
virtual StatusCode	initialize () override
	Initialize method.
virtual StatusCode	execute (const xAOD::CaloCluster *cluster, const CaloDetDescrManager *cmgr, const CaloCellContainer *cell_container, Info &info) const override final
	Method to recover large clusters.
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

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

Protected Member Functions
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.

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>

Private Attributes
ToolHandle< CaloClusterProcessor >	m_caloFillRectangularTool
	Tool to fill rectangular 7x11 cluster.
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

Static Private Attributes
static constexpr int	m_neta = 7
static constexpr int	m_nphi = 7
static constexpr double	m_centEtThr = 3000.

Detailed Description

Recovers large 7x11 clusters for clusters in EMB & EMEC.

Interface for the Reconstruction/egamma/egammaCaloTools/egammaLargeClusterCellRecoveryTool.cxx.

Author

Gabriel P. Matos gpinh.nosp@m.eir@.nosp@m.cern..nosp@m.ch Following discussions with Christos Anastopoulos.

Definition at line 21 of file egammaLargeClusterCellRecoveryTool.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

egammaLargeClusterCellRecoveryTool()

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

Constructor.

Definition at line 22 of file egammaLargeClusterCellRecoveryTool.cxx.

    : AthAlgTool(type, name, parent) {
    declareInterface<IegammaLargeClusterCellRecoveryTool>(this);
}

~egammaLargeClusterCellRecoveryTool()

virtual egammaLargeClusterCellRecoveryTool::~egammaLargeClusterCellRecoveryTool ( )

virtualdefault

Destructor.

Member Function Documentation

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

StatusCode egammaLargeClusterCellRecoveryTool::execute ( const xAOD::CaloCluster * cluster, const CaloDetDescrManager * cmgr, const CaloCellContainer * cell_container, Info & info ) const

finaloverridevirtual

Method to recover large clusters.

FIXME: this tool should probably return the cluster object

Implements IegammaLargeClusterCellRecoveryTool.

Definition at line 39 of file egammaLargeClusterCellRecoveryTool.cxx.

                                                                      {
    ATH_MSG_DEBUG("Executing egammaLargeClusterRecoveryTool");
 
    if (cluster->et() < m_centEtThr) {
        ATH_MSG_DEBUG("Cluster Et below threshold for large cluster recovery: " << cluster->et());
        return StatusCode::SUCCESS;
    }
 
    if (!cluster->inBarrel() && !cluster->inEndcap()) {
        ATH_MSG_DEBUG("Cluster not in EMB or EMEC, skipping large cluster recovery.");
        return StatusCode::SUCCESS;
    }
 
    // Check if cluster is in barrel or endcap
    bool in_barrel = egammaEnergyPositionAllSamples::inBarrel(*cluster, 2);
    CaloSampling::CaloSample sam = CaloSampling::EMB2;
    if (!in_barrel) {
        sam = CaloSampling::EME2;
    }
 
    // (eta, phi) of the cluster in the 2nd sampling    
    auto eta = cluster->etaSample(sam);
    auto phi = cluster->phiSample(sam);
 
    if ((eta == 0. && phi == 0.) || std::abs(eta) > 100) {
        ATH_MSG_WARNING("Weird input cluster, eta = " << eta
                                                      << " phi = " << phi);
        return StatusCode::SUCCESS;
    }
 
    // Here decode_sample will overwrite these variables
    bool barrel = false;
    CaloCell_ID::SUBCALO subcalo = CaloCell_ID::LAREM;
    int sampling_or_module = 0;
 
    CaloDetDescrManager::decode_sample(
        subcalo, barrel, sampling_or_module, (CaloCell_ID::CaloSample)sam);
 
    // Get the corresponding granularities with CaloDetDescrElement
    const CaloDetDescrElement *dde = cmgr->get_element(
        CaloCell_ID::LAREM, sampling_or_module, barrel, eta, phi);
 
    // If the object does not exist then return
    if (!dde) {
        ATH_MSG_WARNING("Weird input cluster eta = " << eta
                                                     << " phi = " << phi);
        ATH_MSG_WARNING("No detetector element for seeding");
        return StatusCode::SUCCESS;
    }
 
    // Local granularity
    auto deta = dde->deta();
    auto dphi = dde->dphi();   
 
    // Search the hottest cell around the (eta,phi).
    // (eta,phi) are defined as etaSample() and phiSample().
    // Around this position a hot cell is searched for in a window
    // (m_neta*m_deta,m_nphi*m_dphi), by default (m_neta,m_nphi)=(7,7) 
    CaloLayerCalculator calc;
    StatusCode sc = 
        calc.fill(*cmgr, cell_container, cluster->etaSample(sam),
                  cluster->phiSample(sam), m_neta * deta, m_nphi * dphi,
                  (CaloSampling::CaloSample)sam);
                  
    if (sc.isFailure()) {
        ATH_MSG_WARNING("CaloLayerCalculator failed to fill");
        return StatusCode::SUCCESS;
    }
    double etamax = calc.etarmax();
    double phimax = calc.phirmax();
 
    // Create 7x11 cluster with hottest cell as seed
    std::unique_ptr<xAOD::CaloCluster> largeCluster = 
        CaloClusterStoreHelper::makeCluster(cell_container,
    etamax,
    phimax,
    xAOD::CaloCluster::SW_7_11);
 
    // Fill rectangular cluster
    if (!m_caloFillRectangularTool->execute(Gaudi::Hive::currentContext(), largeCluster.get()).isSuccess()) {
        ATH_MSG_WARNING("CaloFillRectangularCluster tool failed");
        return StatusCode::SUCCESS;
    }
 
    // Check that 7x11 cluster has cells
    if (largeCluster->size() == 0) {
        ATH_MSG_WARNING("Large cluster has no cells");
        return StatusCode::SUCCESS;
    }
    
    // Iterate through cells and store in info
    for (const CaloCell* cell : *largeCluster) {
        info.cells711.push_back(cell);
    }
 
    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

initialize()

StatusCode egammaLargeClusterCellRecoveryTool::initialize ( )

overridevirtual

Initialize method.

Definition at line 29 of file egammaLargeClusterCellRecoveryTool.cxx.

                                                          {
    ATH_MSG_DEBUG("Initializing egammaLargeClusterCellRecoveryTool");
 
    if (!m_caloFillRectangularTool.empty()) {
      ATH_CHECK( m_caloFillRectangularTool.retrieve());
    }
 
    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 & IegammaLargeClusterCellRecoveryTool::interfaceID ( )

inlinestaticinherited

AlgTool interface methods.

Definition at line 45 of file IegammaLargeClusterCellRecoveryTool.h.

{
  return IID_IegammaLargeClusterCellRecoveryTool;
}

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

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.

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

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

Member Data Documentation

m_caloFillRectangularTool

ToolHandle<CaloClusterProcessor> egammaLargeClusterCellRecoveryTool::m_caloFillRectangularTool

private

Initial value:

{
          this,
          "CaloFillRectangularClusterTool",
          "",
          "Handle of the CaloFillRectangularClusterTool"
        }

Tool to fill rectangular 7x11 cluster.

Definition at line 53 of file egammaLargeClusterCellRecoveryTool.h.

                                                                {
          this,
          "CaloFillRectangularClusterTool",
          "",
          "Handle of the CaloFillRectangularClusterTool"
        };

m_centEtThr

double egammaLargeClusterCellRecoveryTool::m_centEtThr = 3000.

staticconstexprprivate

Definition at line 50 of file egammaLargeClusterCellRecoveryTool.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_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_neta

int egammaLargeClusterCellRecoveryTool::m_neta = 7

staticconstexprprivate

Definition at line 46 of file egammaLargeClusterCellRecoveryTool.h.

m_nphi

int egammaLargeClusterCellRecoveryTool::m_nphi = 7

staticconstexprprivate

Definition at line 47 of file egammaLargeClusterCellRecoveryTool.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:

• egammaLargeClusterCellRecoveryTool.h
• egammaLargeClusterCellRecoveryTool.cxx