CscClusterUtilTool Class Reference

#include <CscClusterUtilTool.h>

Inheritance diagram for CscClusterUtilTool:

Collaboration diagram for CscClusterUtilTool:

Public Member Functions
	CscClusterUtilTool (const std::string &, const std::string &, const IInterface *)
	~CscClusterUtilTool ()=default
StatusCode	initialize ()
ICscClusterFitter::Results	getRefitCluster (const Muon::CscPrepData *MClus, double tantheta) const
void	getStripFits (const Trk::RIO_OnTrack *rot, ICscClusterFitter::StripFitList &sfits) const
void	getStripFits (const Muon::CscClusterOnTrack *pclu, ICscClusterFitter::StripFitList &sfits) const
void	getStripFits (const Muon::CscPrepData *, ICscClusterFitter::StripFitList &) const
std::vector< const Muon::CscStripPrepData * >	getStrips (const Muon::CscPrepData *MClus) const
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 ()

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
const CscIdHelper *	m_phelper
ToolHandle< ICscStripFitter >	m_stripFitter
ToolHandle< ICscClusterFitter >	m_precClusterFitter
SG::ReadHandleKey< Muon::CscStripPrepDataContainer >	m_cscStripLocation
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

Detailed Description

Definition at line 30 of file CscClusterUtilTool.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

CscClusterUtilTool()

CscClusterUtilTool::CscClusterUtilTool	(	const std::string &	type,
		const std::string &	aname,
		const IInterface *	parent )

Definition at line 24 of file CscClusterUtilTool.cxx.

                                                                                                              :
    AthAlgTool(type, aname, parent), m_phelper(nullptr), m_cscStripLocation("CSC_Measurements") {
    declareInterface<ICscClusterUtilTool>(this);
    declareProperty("CscStripPrepDataLocation", m_cscStripLocation);
}

~CscClusterUtilTool()

CscClusterUtilTool::~CscClusterUtilTool ( )

default

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

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

getRefitCluster()

ICscClusterFitter::Results CscClusterUtilTool::getRefitCluster ( const Muon::CscPrepData * MClus, double tantheta ) const

virtual

Implements ICscClusterUtilTool.

Definition at line 101 of file CscClusterUtilTool.cxx.

                                                                                                            {
    ICscClusterFitter::Results results;
    if (!MClus) {
        ATH_MSG_WARNING(" Muon::CscPrepData* pprd is empty !");
        return results;
    }
 
    ICscClusterFitter::StripFitList sfits;
    sfits.clear();
 
    getStripFits(MClus, sfits);
    results = m_precClusterFitter->fit(sfits, tantheta);
 
    return results;
}

getStripFits() [1/3]

void CscClusterUtilTool::getStripFits ( const Muon::CscClusterOnTrack * pclu, ICscClusterFitter::StripFitList & sfits ) const

virtual

Implements ICscClusterUtilTool.

Definition at line 68 of file CscClusterUtilTool.cxx.

                                                                                                                   {
    if (!pclu) {
        ATH_MSG_WARNING(" Muon::CscClusterOnTrack* pclu is empty !");
        return;
    }
    const Muon::CscPrepData* pprd = pclu->prepRawData();
    if (!pprd) {
        ATH_MSG_WARNING(" Muon::CscPrepData* pprd is empty !");
        return;
    }
 
    getStripFits(pprd, sfits);
}

getStripFits() [2/3]

void CscClusterUtilTool::getStripFits ( const Muon::CscPrepData * MClus, ICscClusterFitter::StripFitList & sfits ) const

virtual

Implements ICscClusterUtilTool.

Definition at line 82 of file CscClusterUtilTool.cxx.

                                                                                                          {
    if (!MClus) {
        ATH_MSG_WARNING(" Muon::CscPrepData* pprd is empty !");
        return;
    }
 
    sfits.clear();
 
    std::vector<const CscStripPrepData*> strPrepDatas = getStrips(MClus);
    for (unsigned int i = 0; i < strPrepDatas.size(); ++i) {
        ICscClusterFitter::StripFit sfit;
        sfit = m_stripFitter->fit(*strPrepDatas[i]);
        ATH_MSG_VERBOSE(" in loop charge " << sfit.charge);
        //    if (sfit.charge == 0.) // It's the case of narrow strips...in QratStripFitter
        //      sfit.charge = 40.;  // 0 charge is set to minimal non zero to do fit e.g. dead channel case
        sfits.push_back(sfit);
    }
    }

getStripFits() [3/3]

void CscClusterUtilTool::getStripFits ( const Trk::RIO_OnTrack * rot, ICscClusterFitter::StripFitList & sfits ) const

virtual

Implements ICscClusterUtilTool.

Definition at line 55 of file CscClusterUtilTool.cxx.

                                                                                                           {
    if (!rot) {
        ATH_MSG_WARNING(" Trk::RIO_OnTrack* rot is empty !");
        return;
    }
    const Muon::CscClusterOnTrack* pclu = dynamic_cast<const Muon::CscClusterOnTrack*>(rot);
    if (!pclu) {
        ATH_MSG_WARNING(" Muon::CscClusterOnTrack* pclu is empty !");
        return;
    }
    getStripFits(pclu, sfits);
}

getStrips()

std::vector< const CscStripPrepData * > CscClusterUtilTool::getStrips ( const Muon::CscPrepData * MClus ) const

virtual

Implements ICscClusterUtilTool.

Definition at line 118 of file CscClusterUtilTool.cxx.

                                                                                               {
    std::vector<const CscStripPrepData*> strips;
    if (!MClus) {
        ATH_MSG_WARNING(" Muon::CscPrepData* pprd is empty !");
        return strips;
    }
 
    const std::vector<Identifier> &prd_digit_ids = MClus->rdoList();
 
    SG::ReadHandle<Muon::CscStripPrepDataContainer> pdigcont(m_cscStripLocation);
 
    if (!pdigcont.isValid()) {
        ATH_MSG_WARNING("Strip container " << m_cscStripLocation.key() << " not found in StoreGate!");
        return strips;
    }
    ATH_MSG_DEBUG("Retrieved " << m_cscStripLocation.key() << " successfully. ");
 
    IdentifierHash elhash = MClus->collectionHash();
    const auto *it = pdigcont->indexFindPtr(elhash);
 
    ATH_MSG_VERBOSE("Hash " << elhash << " converted to iterator of container successfully");
 
    if (it != nullptr) {
        ATH_MSG_VERBOSE(" it == pdigcont.end() passed");
        for (unsigned int istrip = 0; istrip < prd_digit_ids.size(); ++istrip) {
            const CscStripPrepDataCollection& col = *it;
            // Loop over digits and fill these arrays.
            for (CscStripPrepDataCollection::const_iterator idig = col.begin(); idig != col.end(); ++idig) {
                const CscStripPrepData& dig = **idig;
                Identifier stid = dig.identify();
                if (stid != prd_digit_ids[istrip]) continue;
                const CscStripPrepData* pstrip = &dig;
                ATH_MSG_VERBOSE("strip " << pstrip->timeOfFirstSample());
 
                strips.push_back(pstrip);
                break;
            }
        }
    }
    return strips;
}

initialize()

StatusCode CscClusterUtilTool::initialize

(

)

Definition at line 32 of file CscClusterUtilTool.cxx.

                                          {
    ATH_MSG_DEBUG("Initializing " << name());
    ATH_MSG_DEBUG("  Strip fitter is " << m_stripFitter.typeAndName());
    ATH_CHECK(m_cscStripLocation.initialize());
    ATH_MSG_DEBUG("  CscStripPrepDataLocation is " << m_cscStripLocation.key());
 
    // Retrieve the strip fitting tool.
    ATH_CHECK(m_stripFitter.retrieve());
    ATH_MSG_DEBUG("Retrieved strip fitting tool " << m_stripFitter);
 
    // Retrieve the precision cluster fitting tool.
    ATH_CHECK(m_precClusterFitter.retrieve());
    ATH_MSG_DEBUG("Retrieved CSC precision cluster fitting tool");
 
    const MuonGM::MuonDetectorManager* muDetMgr = nullptr;
    ATH_CHECK_RECOVERABLE(detStore()->retrieve(muDetMgr));
    ATH_MSG_DEBUG("Retrieved geometry.");
    m_phelper = muDetMgr->cscIdHelper();
 
    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 & ICscClusterUtilTool::interfaceID ( )

inlinestaticinherited

Definition at line 36 of file ICscClusterUtilTool.h.

{ return IID_ICscClusterUtilTool; }

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_cscStripLocation

SG::ReadHandleKey<Muon::CscStripPrepDataContainer> CscClusterUtilTool::m_cscStripLocation

private

Definition at line 63 of file CscClusterUtilTool.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_phelper

const CscIdHelper* CscClusterUtilTool::m_phelper

private

Definition at line 49 of file CscClusterUtilTool.h.

m_precClusterFitter

ToolHandle<ICscClusterFitter> CscClusterUtilTool::m_precClusterFitter

private

Initial value:

{
        this,
        "precision_fitter",
        "QratCscClusterFitter/QratCscClusterFitter",
    }

Definition at line 57 of file CscClusterUtilTool.h.

                                                     {
        this,
        "precision_fitter",
        "QratCscClusterFitter/QratCscClusterFitter",
    };

m_stripFitter

ToolHandle<ICscStripFitter> CscClusterUtilTool::m_stripFitter

private

Initial value:

{
        this,
        "strip_fitter",
        "CalibCscStripFitter/CalibCscStripFitter",
    }

Definition at line 52 of file CscClusterUtilTool.h.

                                             {
        this,
        "strip_fitter",
        "CalibCscStripFitter/CalibCscStripFitter",
    };

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:

• CscClusterUtilTool.h
• CscClusterUtilTool.cxx