JiveXML::MuonRetriever Class Reference

Retrieves all Muon objects (StacoMuonCollection etc.) More...

#include <MuonRetriever.h>

Inheritance diagram for JiveXML::MuonRetriever:

Collaboration diagram for JiveXML::MuonRetriever:

Public Member Functions
	MuonRetriever (const std::string &type, const std::string &name, const IInterface *parent)
	Standard Constructor.
virtual StatusCode	retrieve (ToolHandle< IFormatTool > &FormatTool)
	Retrieve all the data.
const DataMap	getData (const Analysis::MuonContainer *)
	Retrieve basic parameters, mainly four-vectors, for each collection.
virtual std::string	dataTypeName () const
	Return the name of the data type.
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 ()
	Return the interface identifier.

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 std::string	m_typeName
	The data type that is generated by this retriever.
std::string	m_sgKey
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

Retrieves all Muon objects (StacoMuonCollection etc.)

• Properties
  • StoreGateKey: First collection to be retrieved, displayed in Atlantis without switching. All other collections are also retrieved.
• Retrieved Data
  • Usual four-vectors: phi, eta, et etc.
  • Associations via ElementLink: key/index scheme

Definition at line 31 of file MuonRetriever.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

MuonRetriever()

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

Standard Constructor.

This is the standard AthAlgTool constructor.

Parameters

type	AlgTool type name
name	AlgTool instance name
parent	AlgTools parent owning this tool

Definition at line 23 of file MuonRetriever.cxx.

                                                                                                  :
    AthAlgTool(type,name,parent),
    m_typeName("Muon"){
 
    //Only declare the interface
    declareInterface<IDataRetriever>(this);
 
    declareProperty("StoreGateKey", m_sgKey= "Muons", 
        "Collection to be first in output, shown in Atlantis without switching");
  }

Member Function Documentation

dataTypeName()

virtual std::string JiveXML::MuonRetriever::dataTypeName ( ) const

inlinevirtual

Return the name of the data type.

Implements JiveXML::IDataRetriever.

Definition at line 44 of file MuonRetriever.h.

{ return m_typeName; };

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

getData()

const DataMap JiveXML::MuonRetriever::getData

(

const Analysis::MuonContainer *

muoncont

)

Retrieve basic parameters, mainly four-vectors, for each collection.

Also association with clusters and tracks (ElementLink).

Definition at line 88 of file MuonRetriever.cxx.

                                                                            {
    
    ATH_MSG_DEBUG( "in getData()" );
 
    DataMap DataMap;
 
    DataVect phi; phi.reserve(muoncont->size());
    DataVect eta; eta.reserve(muoncont->size());
    DataVect pt; pt.reserve(muoncont->size());
    DataVect mass; mass.reserve(muoncont->size());
    DataVect energy; energy.reserve(muoncont->size());
    DataVect px; px.reserve(muoncont->size());
    DataVect py; py.reserve(muoncont->size());
    DataVect pz; pz.reserve(muoncont->size());
 
    DataVect dataType; dataType.reserve(muoncont->size());
    DataVect chi2; chi2.reserve(muoncont->size());
    DataVect pdgId; pdgId.reserve(muoncont->size());
    DataVect etConeIsol; etConeIsol.reserve(muoncont->size());
    DataVect author; author.reserve(muoncont->size());
 
    // for associations:
    DataVect clusterKeyVec; clusterKeyVec.reserve(muoncont->size());
    DataVect clusterIndexVec; clusterIndexVec.reserve(muoncont->size());
    DataVect trackKeyVec; trackKeyVec.reserve(muoncont->size());
    DataVect trackIndexVec; trackIndexVec.reserve(muoncont->size());
 
    Analysis::MuonContainer::const_iterator muonItr  = muoncont->begin();
    Analysis::MuonContainer::const_iterator muonItrE = muoncont->end();
 
    int MCdataType = 1;
    std::string clusterKey = "none"; // Storegate key of container 
    int clusterIndex = -1; // index number inside the container 
    std::string trackKey = "none"; // Storegate key of container 
    int trackIndex = -1; // index number inside the container 
 
    for (; muonItr != muonItrE; ++muonItr) {
      phi.emplace_back((*muonItr)->phi());
      eta.emplace_back((*muonItr)->eta());
      pt.emplace_back((*muonItr)->pt()/CLHEP::GeV);
      mass.emplace_back((*muonItr)->m()/CLHEP::GeV);
      energy.emplace_back( (*muonItr)->e()/CLHEP::GeV  );
      px.emplace_back( (*muonItr)->px()/CLHEP::GeV  );
      py.emplace_back( (*muonItr)->py()/CLHEP::GeV  );
      pz.emplace_back( (*muonItr)->pz()/CLHEP::GeV  );
 
      pdgId.emplace_back( (*muonItr)->pdgId()  );
 
      std::string muonAuthor = "none";
      if (( (*muonItr)->author()) == 0){ muonAuthor = "unknown"; } 
      if (( (*muonItr)->author()) == 1){ muonAuthor = "highpt"; } 
      if (( (*muonItr)->author()) == 2){ muonAuthor = "lowpt"; } 
      author.emplace_back(  muonAuthor  );
 
      MCdataType = (*muonItr)->dataType();
      dataType.emplace_back(   MCdataType  );
 
// check: full simulation input file (1) or fast (0) 
// code from:
// PhysicsAnalysis/AnalysisCommon/AnalysisExamples/src/MiscellaneousExamples.cxx
      if (MCdataType != 3){ // full simulation
          chi2.emplace_back( (*muonItr)->matchChi2OverDoF()  );
          etConeIsol.emplace_back( 
              ((*muonItr)->parameter(MuonParameters::etcone20))/CLHEP::GeV  );
 
// print some more variables, taken from: 
//   PhysicsAnalysis/EventViewBuilder/EventViewUserData/EVUDMuonAll
 
     ATH_MSG_DEBUG( 
       " Muon: matchChi2OverDoF: " << (*muonItr)->matchChi2OverDoF() << 
       ", matchChi2: " << (*muonItr)->matchChi2() << 
       ", fitChi2: " << (*muonItr)->fitChi2() << 
       ", isCombined: " << (int)(*muonItr)->isCombinedMuon() );
       
// parameters for associations:
// stricly speaking, these should be ElementLinkVectors (see TauJet association)
//   const ElementLinkVector<Rec::TrackParticleContainer> trackLink = (*muonItr)->trackLinkVector();
// necessary to change ?
 
          const ElementLink<Rec::TrackParticleContainer> trackLink = (*muonItr)->inDetTrackLink();
          if (trackLink.isValid()) {
             trackKey = trackLink.dataID(); // Storegate key of 
             trackIndex = trackLink.index(); // index into the contianer
         trackKeyVec.emplace_back( trackKey );
         trackIndexVec.emplace_back( trackIndex );
          } else {
             trackKeyVec.emplace_back(  "none"  );
             trackIndexVec.emplace_back(  -1  );
          }
          const ElementLink<CaloClusterContainer> clusterLink = (*muonItr)->clusterLink();
          if (clusterLink.isValid()) {
            clusterKey = clusterLink.dataID(); // Storegate key of container 
            clusterIndex = clusterLink.index(); // index number inside the container 
            clusterKeyVec.emplace_back( clusterKey );
        clusterIndexVec.emplace_back( clusterIndex );
          } else { // no clusterLink
        clusterKeyVec.emplace_back( "none" );
        clusterIndexVec.emplace_back( -1 );
          }
 
      } else {  // fast simulation
          chi2.emplace_back(  0  );
          etConeIsol.emplace_back(  0  );
          trackKeyVec.emplace_back( "none" );
          trackIndexVec.emplace_back( -1 );
          clusterKeyVec.emplace_back( "none");
          clusterIndexVec.emplace_back( -1 );
      }
    }
    // four-vectors
    const auto nEntries = phi.size();
    DataMap["phi"] = std::move(phi);
    DataMap["eta"] = std::move(eta);
    DataMap["pt"] = std::move(pt);
    DataMap["energy"] = std::move(energy);
    DataMap["mass"] = std::move(mass);
    DataMap["px"] = std::move(px);
    DataMap["py"] = std::move(py);
    DataMap["pz"] = std::move(pz);
 
    // special muon parameters
    DataMap["chi2"] = std::move(chi2);
    DataMap["etConeIsol"] = std::move(etConeIsol);
    DataMap["author"] = std::move(author);
    DataMap["pdgId"] = std::move(pdgId);
    DataMap["dataType"] = std::move(dataType);
    // further details and associations
    DataMap["clusterKey"] = std::move(clusterKeyVec);
    DataMap["clusterIndex"] = std::move(clusterIndexVec);
    DataMap["trackKey"] = std::move(trackKeyVec);
    DataMap["trackIndex"] = std::move(trackIndexVec);
 
    ATH_MSG_DEBUG( dataTypeName() << " retrieved with " << nEntries << " entries");
 
    //All collections retrieved okay
    return DataMap;
 
  } // retrieve

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 & JiveXML::IDataRetriever::interfaceID ( )

inlinestaticinherited

Return the interface identifier.

Definition at line 40 of file IDataRetriever.h.

{ return IID_IDataRetriever; }

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

retrieve()

StatusCode JiveXML::MuonRetriever::retrieve ( ToolHandle< IFormatTool > & FormatTool )

virtual

Retrieve all the data.

For each jet collections retrieve basic parameters.

Parameters

FormatTool

the tool that will create formated output from the DataMap

Implements JiveXML::IDataRetriever.

Definition at line 38 of file MuonRetriever.cxx.

                                                                        {
    
    ATH_MSG_DEBUG( "in retrieveAll()" );
    
    SG::ConstIterator<Analysis::MuonContainer> iterator, end;
    const Analysis::MuonContainer* muCont;
    
    //obtain the default collection first
    ATH_MSG_DEBUG( "Trying to retrieve " << dataTypeName() << " (" << m_sgKey << ")" );
    StatusCode sc = evtStore()->retrieve(muCont, m_sgKey);
    if (sc.isFailure() ) {
      ATH_MSG_WARNING( "Collection " << m_sgKey << " not found in SG " ); 
    }else{
      DataMap data = getData(muCont);
      if ( FormatTool->AddToEvent(dataTypeName(), m_sgKey, &data).isFailure()){
    ATH_MSG_WARNING( "Collection " << m_sgKey << " not found in SG " );
      }else{
         ATH_MSG_DEBUG( dataTypeName() << " (" << m_sgKey << ") Muon retrieved" );
      }
    }
 
    //obtain all other collections from StoreGate
    if (( evtStore()->retrieve(iterator, end)).isFailure()){
       ATH_MSG_WARNING( "Unable to retrieve iterator for Jet collection" );
    }
      
    for (; iterator!=end; ++iterator) {
      // hack to remove CaloMuons, jpt 31Mar10 
      if ((iterator.key() != m_sgKey) && (iterator.key() != "CaloMuonCollection") && 
      (iterator.key() != "CaloESDMuonCollection" ))  {
      //       if (iterator.key()!=m_sgKey) {
          if (msgLvl(MSG::DEBUG)) msg(MSG::DEBUG)  << "Trying to retrieve all " << dataTypeName() << " (" << iterator.key() << ")" << endmsg;
            DataMap data = getData(&(*iterator));
            if ( FormatTool->AddToEvent(dataTypeName(), iterator.key(), &data).isFailure()){
           ATH_MSG_WARNING( "Collection " << iterator.key() << " not found in SG " );
        }else{
          ATH_MSG_DEBUG( dataTypeName() << " (" << iterator.key() << ") Muon retrieved" );
            }
      }
    }     
    //All collections retrieved okay
    return StatusCode::SUCCESS;
  }

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_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_sgKey

std::string JiveXML::MuonRetriever::m_sgKey

private

Definition at line 50 of file MuonRetriever.h.

m_typeName

const std::string JiveXML::MuonRetriever::m_typeName

private

The data type that is generated by this retriever.

Definition at line 48 of file MuonRetriever.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:

• MuonRetriever.h
• MuonRetriever.cxx