#include <SimpleSTgcClusterBuilderTool.h>

Inheritance diagram for Muon::SimpleSTgcClusterBuilderTool:

Collaboration diagram for Muon::SimpleSTgcClusterBuilderTool:

Public Member Functions
	SimpleSTgcClusterBuilderTool (const std::string &, const std::string &, const IInterface *)
	Default constructor.
virtual	~SimpleSTgcClusterBuilderTool ()=default
	Default destructor.
virtual StatusCode	initialize () override
	standard initialize method
StatusCode	getClusters (const EventContext &ctx, std::vector< Muon::sTgcPrepData > &&stripsVect, std::vector< std::unique_ptr< Muon::sTgcPrepData > > &clustersVect) const override
	DeclareInterfaceID (Muon::ISTgcClusterBuilderTool, 1, 0)
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

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
void	dumpStrips (std::vector< Muon::sTgcPrepData > &stripsVect, std::vector< Muon::sTgcPrepData * > &clustersVect) const
	private functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
Gaudi::Property< double >	m_chargeCut {this, "ChargeCut", 0.}
Gaudi::Property< unsigned int >	m_maxHoleSize {this, "maxHoleSize", 0}
ServiceHandle< Muon::IMuonIdHelperSvc >	m_idHelperSvc {this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"}
SG::ReadCondHandleKey< NswErrorCalibData >	m_uncertCalibKey
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 27 of file SimpleSTgcClusterBuilderTool.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

◆ SimpleSTgcClusterBuilderTool()

Muon::SimpleSTgcClusterBuilderTool::SimpleSTgcClusterBuilderTool	(	const std::string &	t,
		const std::string &	n,
		const IInterface *	p )

Default constructor.

Definition at line 15 of file SimpleSTgcClusterBuilderTool.cxx.

16: AthAlgTool(t,n,p) {}

AthAlgTool::AthAlgTool

AthAlgTool()

Default constructor:

◆ ~SimpleSTgcClusterBuilderTool()

virtual Muon::SimpleSTgcClusterBuilderTool::~SimpleSTgcClusterBuilderTool ( )

virtualdefault

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

◆ DeclareInterfaceID()

Muon::ISTgcClusterBuilderTool::DeclareInterfaceID	(	Muon::ISTgcClusterBuilderTool	,
		1	,
		0	)

inherited

◆ 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.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ dumpStrips()

void SimpleSTgcClusterBuilderTool::dumpStrips	(	std::vector< Muon::sTgcPrepData > &	stripsVect,
		std::vector< Muon::sTgcPrepData * > &	clustersVect ) const

private

private functions

sort the strips if needed

Definition at line 127 of file SimpleSTgcClusterBuilderTool.cxx.

                                                                                                                                        {
    ATH_MSG_INFO("====> Dumping all strips:  ");
    for ( const auto& it : stripsVect ) {
        Identifier stripId = it.identify(); 
        ATH_MSG_INFO("Strip identifier: " << m_idHelperSvc->stgcIdHelper().show_to_string(stripId) ); 
    }
 
    ATH_MSG_INFO("Dumping all clusters:  ");
    for ( auto *it : clustersVect ) {
        Identifier clusterId = it->identify(); 
        ATH_MSG_INFO("***> New cluster identifier: " << m_idHelperSvc->stgcIdHelper().show_to_string(clusterId) ); 
        ATH_MSG_INFO("Cluster size: " << it->rdoList().size() );
        ATH_MSG_INFO("List of associated RDO's: ");
    }
}

◆ 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.

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ 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

◆ getClusters()

StatusCode Muon::SimpleSTgcClusterBuilderTool::getClusters	(	const EventContext &	ctx,
		std::vector< Muon::sTgcPrepData > &&	stripsVect,
		std::vector< std::unique_ptr< Muon::sTgcPrepData > > &	clustersVect ) const

overridevirtual

Implements Muon::ISTgcClusterBuilderTool.

Definition at line 29 of file SimpleSTgcClusterBuilderTool.cxx.

                                                                                                                           {
 
    ATH_MSG_DEBUG("Size of the input vector: " << stripsVect.size()); 
 
    if (stripsVect.empty()) return StatusCode::SUCCESS;
  
 
    // define the identifier hash
    Identifier chanId = stripsVect.at(0).identify();
    IdentifierHash hash = m_idHelperSvc->moduleHash(chanId);
  
    double resolution = Amg::error(stripsVect.at(0).localCovariance(), Trk::locX);
    bool isStrip = ( m_idHelperSvc->stgcIdHelper().channelType(chanId) == sTgcIdHelper::Strip );
    ATH_MSG_DEBUG(" channelType " << m_idHelperSvc->stgcIdHelper().channelType(chanId));
    ATH_MSG_DEBUG(" isStrip: " << isStrip << "Single channel resolution: " << resolution);
 
    SG::ReadCondHandle<NswErrorCalibData> errorCalibDB{m_uncertCalibKey, ctx};
    if (!errorCalibDB.isValid()) {
        ATH_MSG_FATAL("Failed to retrieve the parameterized errors "<<m_uncertCalibKey.fullKey());
        return StatusCode::FAILURE;
    }
 
    Muon::STgcClusterBuilderCommon stgcClusterCommon(m_idHelperSvc->stgcIdHelper(), **errorCalibDB);
    std::array<std::vector<Muon::sTgcPrepData>, 8> stgcPrdsPerLayer = stgcClusterCommon.sortSTGCPrdPerLayer(std::move(stripsVect));
 
    for (std::vector<Muon::sTgcPrepData>& layPrds : stgcPrdsPerLayer) {
        // Get the strip clusters of the layer.
        std::vector<std::vector<Muon::sTgcPrepData>> layerClusters = stgcClusterCommon.findStripCluster(std::move(layPrds),
                                                                                                        m_maxHoleSize);
 
        // Loop on the clusters of that gap
        for (const std::vector<Muon::sTgcPrepData>& cluster: layerClusters) {
            if (cluster.empty()) continue;
 
            // Calculate the cluster position and error using the weighted average
            std::optional<Muon::STgcClusterPosition> optClusterPos = stgcClusterCommon.weightedAverage(cluster, resolution, isStrip);
            if (!optClusterPos) {
              if (msgLvl(MSG::VERBOSE)) {
                std::stringstream sstr{};
                for (const Muon::sTgcPrepData& prd : cluster) {
                    sstr << m_idHelperSvc->toString(prd.identify())
                         << ", local pos: "<< Amg::toString(prd.localPosition(), 2)
                         << "), charge: " << prd.charge() << ", time: " << static_cast<int>(prd.time())
                         << std::endl;
                }
                ATH_MSG_VERBOSE("Reject invalid cluster..." << std::endl << std::endl << sstr.str());
              }
              continue;
            }
 
            Identifier clusterId = (*optClusterPos).getClusterId();
            double posY = cluster[0].localPosition().y();
            Amg::Vector2D localPosition((*optClusterPos).getMeanPosition(), posY);
            auto covN = Amg::MatrixX(1,1);
            covN(0,0) = (*optClusterPos).getErrorSquared();
 
            std::vector<Identifier> rdoList;
            std::vector<int>        elementsCharge;
            std::vector<short int>  elementsTime;
            std::vector<uint16_t>   elementsChannel;
            for (const Muon::sTgcPrepData& prd : cluster ) {
                rdoList.push_back(prd.identify());
                elementsCharge.push_back(prd.charge());
                elementsChannel.push_back(m_idHelperSvc->stgcIdHelper().channel(prd.identify()));
                elementsTime.push_back(prd.time());
            }
 
            // memory allocated dynamically for the PrepRawData is managed by Event Store in the converters
            ATH_MSG_DEBUG("error on cluster " << std::sqrt((covN)(0,0)));
 
            std::unique_ptr<sTgcPrepData> prdN =  std::make_unique<sTgcPrepData>(
                                                      clusterId,
                                                      hash,
                                                      std::move(localPosition),
                                                      std::move(rdoList),
                                                      std::move(covN),
                                                      cluster.at(0).detectorElement(),
                                                      std::accumulate(elementsCharge.begin(), elementsCharge.end(), 0),
                                                      (short int)0,
                                                      std::move(elementsChannel),
                                                      std::move(elementsTime),
                                                      std::move(elementsCharge));
            
            prdN->setAuthor(sTgcPrepData::Author::SimpleClusterBuilder);
            clustersVect.push_back(std::move(prdN));
        }
    }
 
    ATH_MSG_DEBUG("Size of the output cluster vector: " << clustersVect.size());
 
    return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode Muon::SimpleSTgcClusterBuilderTool::initialize ( )

overridevirtual

standard initialize method

Definition at line 20 of file SimpleSTgcClusterBuilderTool.cxx.

                                                        {
    ATH_CHECK( m_idHelperSvc.retrieve() );
    ATH_CHECK(m_uncertCalibKey.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.

◆ 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_chargeCut

Gaudi::Property<double> Muon::SimpleSTgcClusterBuilderTool::m_chargeCut {this, "ChargeCut", 0.}

private

Definition at line 46 of file SimpleSTgcClusterBuilderTool.h.

46{this, "ChargeCut", 0.};

◆ 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_idHelperSvc

ServiceHandle<Muon::IMuonIdHelperSvc> Muon::SimpleSTgcClusterBuilderTool::m_idHelperSvc {this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"}

private

Definition at line 49 of file SimpleSTgcClusterBuilderTool.h.

49{this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"};

◆ m_maxHoleSize

Gaudi::Property<unsigned int> Muon::SimpleSTgcClusterBuilderTool::m_maxHoleSize {this, "maxHoleSize", 0}

private

Definition at line 47 of file SimpleSTgcClusterBuilderTool.h.

47{this, "maxHoleSize", 0};

◆ m_uncertCalibKey

SG::ReadCondHandleKey<NswErrorCalibData> Muon::SimpleSTgcClusterBuilderTool::m_uncertCalibKey

private

Initial value:

{this, "ErrorCalibKey", "NswUncertData",

"Key of the parametrized NSW uncertainties"}

Definition at line 51 of file SimpleSTgcClusterBuilderTool.h.

51 {this, "ErrorCalibKey", "NswUncertData",

52 "Key of the parametrized NSW uncertainties"};

◆ 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:

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ SimpleSTgcClusterBuilderTool()

◆ ~SimpleSTgcClusterBuilderTool()

Member Function Documentation

◆ declareGaudiProperty()

◆ DeclareInterfaceID()

◆ declareProperty()

◆ detStore()

◆ dumpStrips()

◆ evtStore()

◆ extraDeps_update_handler()

◆ getClusters()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_chargeCut

◆ m_detStore

◆ m_evtStore

◆ m_idHelperSvc

◆ m_maxHoleSize

◆ m_uncertCalibKey

◆ m_varHandleArraysDeclared

◆ m_vhka