#include <InDetV0Finder.h>

Inheritance diagram for InDet::InDetV0Finder:

Collaboration diagram for InDet::InDetV0Finder:

Public Member Functions
	InDetV0Finder (const std::string &name, ISvcLocator *pSvcLocator)
virtual	~InDetV0Finder ()
StatusCode	initialize ()
StatusCode	execute ()
StatusCode	finalize ()
StatusCode	resetStatistics ()
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
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	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.

Protected Attributes
SG::ReadHandleKey< xAOD::VertexContainer >	m_vertexKey
SG::WriteHandleKey< xAOD::VertexContainer >	m_v0Key { this, "V0ContainerName", "V0Candidates", "V0 container" }
SG::WriteHandleKey< xAOD::VertexContainer >	m_ksKey { this, "KshortContainerName", "KshortCandidates", "Ks container" }
SG::WriteHandleKey< xAOD::VertexContainer >	m_laKey
SG::WriteHandleKey< xAOD::VertexContainer >	m_lbKey
ToolHandle< InDet::InDetV0FinderTool >	m_v0FinderTool {this, "InDetV0FinderToolName", "InDet::InDetV0FinderTool"}
ToolHandle< InDet::V0MainDecorator >	m_v0DecoTool {this, "Decorator", "InDet::V0MainDecorator"}
BooleanProperty	m_decorate {this, "decorateV0", true}
	decorate V0 containers
long	m_events_processed = 0
long	m_V0s_stored = 0
long	m_Kshort_stored = 0
long	m_Lambda_stored = 0
long	m_Lambdabar_stored = 0

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
DataObjIDColl	m_extendedExtraObjects
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 38 of file InDetV0Finder.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Algorithm > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ InDetV0Finder()

InDet::InDetV0Finder::InDetV0Finder	(	const std::string &	name,
		ISvcLocator *	pSvcLocator )

Definition at line 30 of file InDetV0Finder.cxx.

31 :

32 AthAlgorithm(n, pSvcLoc) {}

AthAlgorithm::AthAlgorithm

AthAlgorithm()

Default constructor:

◆ ~InDetV0Finder()

InDet::InDetV0Finder::~InDetV0Finder ( )

virtualdefault

Member Function Documentation

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute()

StatusCode InDet::InDetV0Finder::execute ( )

Definition at line 57 of file InDetV0Finder.cxx.

{
 
  m_events_processed++;
  const EventContext& ctx = Gaudi::Hive::currentContext();
// Get primary vertex from StoreGate
  const xAOD::Vertex* primaryVertex = nullptr;
  SG::ReadHandle<xAOD::VertexContainer> importedVxContainer( m_vertexKey, ctx );
  if ( !importedVxContainer.isValid() )
  {
    ATH_MSG_WARNING("No xAOD::VertexContainer named " << m_vertexKey.key() << " found in StoreGate");
    return StatusCode::RECOVERABLE;    
  } else {
    ATH_MSG_DEBUG("Found xAOD::VertexContainer named " << m_vertexKey.key() );
  }
  if ( importedVxContainer->empty() ){
    ATH_MSG_WARNING("Primary vertex container is empty.");
  } else {
    primaryVertex = importedVxContainer->front();
  }
 
  //---- Recording section: write the results to StoreGate ---//
  SG::WriteHandle<xAOD::VertexContainer> h_V0( m_v0Key, ctx );
  if ( h_V0.record(std::make_unique<xAOD::VertexContainer>() ,std::make_unique<xAOD::VertexAuxContainer>()).isFailure()){
    ATH_MSG_ERROR("Storegate record of v0Container failed.");
    return StatusCode::FAILURE;
  }
 
  SG::WriteHandle<xAOD::VertexContainer> h_Ks( m_ksKey, ctx );
  if ( h_Ks.record(std::make_unique<xAOD::VertexContainer>() ,std::make_unique<xAOD::VertexAuxContainer>()).isFailure()){
    ATH_MSG_ERROR("Storegate record of ksContainer failed.");
    return StatusCode::FAILURE;
  }
 
  SG::WriteHandle<xAOD::VertexContainer> h_La( m_laKey, ctx );
  if( h_La.record(std::make_unique<xAOD::VertexContainer>() ,std::make_unique<xAOD::VertexAuxContainer>()).isFailure()){
    ATH_MSG_ERROR("Storegate record of laContainer failed.");
    return StatusCode::FAILURE;
 
  }
  SG::WriteHandle<xAOD::VertexContainer> h_Lb( m_lbKey, ctx );
  if(h_Lb.record(std::make_unique<xAOD::VertexContainer>() ,std::make_unique<xAOD::VertexAuxContainer>()).isFailure()){
    ATH_MSG_ERROR("Storegate record of lbContainer failed.");
    return StatusCode::FAILURE;
  }
 
 
  const auto statusOfSearch = m_v0FinderTool->performSearch(h_V0.ptr(),
             h_Ks.ptr(),
             h_La.ptr(),
             h_Lb.ptr(),
             primaryVertex, importedVxContainer.cptr(), ctx);
 
  if (statusOfSearch != StatusCode::SUCCESS){
    ATH_MSG_ERROR("Vertex search of v0Container failed.");
    return StatusCode::FAILURE;
  }
 
  if (m_decorate) {
    ATH_CHECK(m_v0DecoTool->decorateV0(h_V0.ptr(), ctx));
    ATH_CHECK(m_v0DecoTool->decorateks(h_Ks.ptr() ,ctx));
    ATH_CHECK(m_v0DecoTool->decoratela(h_La.ptr(), ctx));
    ATH_CHECK(m_v0DecoTool->decoratelb(h_Lb.ptr(), ctx));
  }
 
  m_V0s_stored += h_V0->size();
  m_Kshort_stored += h_Ks->size();
  m_Lambda_stored += h_La->size();
  m_Lambdabar_stored += h_Lb->size();
 
  return StatusCode::SUCCESS;
}// end execute block

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::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

◆ extraOutputDeps()

const DataObjIDColl & AthAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 50 of file AthAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return Algorithm::extraOutputDeps();
}

◆ finalize()

StatusCode InDet::InDetV0Finder::finalize ( )

Definition at line 130 of file InDetV0Finder.cxx.

{
  msg(MSG::INFO)
    << "----------------------------------------------------------------------------------------------------------------------------------------------" << endmsg
    << "\tSummary" << endmsg 
    << "\tProcessed              : " << m_events_processed            << " events" << endmsg
    << "\tStored                 : " << m_V0s_stored                  << " V0s" << endmsg
    << "\tof which               : " << m_Kshort_stored               << " Kshorts" << endmsg
    << "\t                       : " << m_Lambda_stored               << " Lambdas" << endmsg
    << "\t                       : " << m_Lambdabar_stored            << " Lambdabars" << endmsg;
  msg(MSG::INFO) << "----------------------------------------------------------------------------------------------------------------------------------------------" << endmsg;
 
  return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode InDet::InDetV0Finder::initialize ( )

Definition at line 36 of file InDetV0Finder.cxx.

{
  ATH_CHECK( resetStatistics() );
 
  ATH_CHECK( m_vertexKey.initialize() );
  ATH_CHECK( m_v0Key.initialize() );
  ATH_CHECK( m_ksKey.initialize() );
  ATH_CHECK( m_laKey.initialize() );
  ATH_CHECK( m_lbKey.initialize() );
 
// uploading the V0Finding tools
  ATH_CHECK( m_v0FinderTool.retrieve() ); 
  ATH_MSG_DEBUG("Retrieved tool " << m_v0FinderTool);
  ATH_CHECK(m_v0DecoTool.retrieve(DisableTool{!m_decorate}));
 
  ATH_MSG_DEBUG("Initialization successful");
 
  return StatusCode::SUCCESS;
}

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< Algorithm >::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< Algorithm > >::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< Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ resetStatistics()

StatusCode InDet::InDetV0Finder::resetStatistics ( )

Definition at line 145 of file InDetV0Finder.cxx.

                                          {
    m_events_processed           = 0;
    m_V0s_stored                 = 0;
    m_Kshort_stored              = 0;
    m_Lambdabar_stored           = 0;
    m_Lambda_stored              = 0;
  
    return StatusCode :: SUCCESS;
}

◆ sysInitialize()

StatusCode AthAlgorithm::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Algorithm > >.

Reimplemented in AthAnalysisAlgorithm, AthFilterAlgorithm, AthHistogramAlgorithm, and PyAthena::Alg.

Definition at line 66 of file AthAlgorithm.cxx.

                                       {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<Algorithm>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;
}

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::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_decorate

BooleanProperty InDet::InDetV0Finder::m_decorate {this, "decorateV0", true}

protected

decorate V0 containers

Definition at line 68 of file InDetV0Finder.h.

68{this, "decorateV0", true};

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_events_processed

long InDet::InDetV0Finder::m_events_processed = 0

protected

Definition at line 70 of file InDetV0Finder.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects

privateinherited

Definition at line 79 of file AthAlgorithm.h.

◆ m_Kshort_stored

long InDet::InDetV0Finder::m_Kshort_stored = 0

protected

Definition at line 72 of file InDetV0Finder.h.

◆ m_ksKey

SG::WriteHandleKey<xAOD::VertexContainer> InDet::InDetV0Finder::m_ksKey { this, "KshortContainerName", "KshortCandidates", "Ks container" }

protected

Definition at line 55 of file InDetV0Finder.h.

55{ this, "KshortContainerName", "KshortCandidates", "Ks container" };

◆ m_laKey

SG::WriteHandleKey<xAOD::VertexContainer> InDet::InDetV0Finder::m_laKey

protected

Initial value:

{ this, "LambdaContainerName", "LambdaCandidates",

"Lambda container" }

Definition at line 56 of file InDetV0Finder.h.

56 { this, "LambdaContainerName", "LambdaCandidates",

57 "Lambda container" };

◆ m_Lambda_stored

long InDet::InDetV0Finder::m_Lambda_stored = 0

protected

Definition at line 73 of file InDetV0Finder.h.

◆ m_Lambdabar_stored

long InDet::InDetV0Finder::m_Lambdabar_stored = 0

protected

Definition at line 74 of file InDetV0Finder.h.

◆ m_lbKey

SG::WriteHandleKey<xAOD::VertexContainer> InDet::InDetV0Finder::m_lbKey

protected

Initial value:

{ this, "LambdabarContainerName", "LambdabarCandidates",

"Lambdabar container" }

Definition at line 58 of file InDetV0Finder.h.

58 { this, "LambdabarContainerName", "LambdabarCandidates",

59 "Lambdabar container" };

◆ m_v0DecoTool

ToolHandle<InDet::V0MainDecorator> InDet::InDetV0Finder::m_v0DecoTool {this, "Decorator", "InDet::V0MainDecorator"}

protected

Definition at line 64 of file InDetV0Finder.h.

64{this, "Decorator", "InDet::V0MainDecorator"};

◆ m_v0FinderTool

ToolHandle<InDet::InDetV0FinderTool> InDet::InDetV0Finder::m_v0FinderTool {this, "InDetV0FinderToolName", "InDet::InDetV0FinderTool"}

protected

Definition at line 63 of file InDetV0Finder.h.

63{this, "InDetV0FinderToolName", "InDet::InDetV0FinderTool"};

◆ m_v0Key

SG::WriteHandleKey<xAOD::VertexContainer> InDet::InDetV0Finder::m_v0Key { this, "V0ContainerName", "V0Candidates", "V0 container" }

protected

Definition at line 54 of file InDetV0Finder.h.

54{ this, "V0ContainerName", "V0Candidates", "V0 container" };

◆ m_V0s_stored

long InDet::InDetV0Finder::m_V0s_stored = 0

protected

Definition at line 71 of file InDetV0Finder.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vertexKey

SG::ReadHandleKey<xAOD::VertexContainer> InDet::InDetV0Finder::m_vertexKey

protected

Initial value:

{ this, "VxPrimaryCandidateName", "PrimaryVertices",

"key for retrieving vertices" }

Definition at line 51 of file InDetV0Finder.h.

51 { this, "VxPrimaryCandidateName", "PrimaryVertices",

52 "key for retrieving vertices" };

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Algorithm > >::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

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ InDetV0Finder()

◆ ~InDetV0Finder()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ resetStatistics()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_decorate

◆ m_detStore

◆ m_events_processed

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_Kshort_stored

◆ m_ksKey

◆ m_laKey

◆ m_Lambda_stored

◆ m_Lambdabar_stored

◆ m_lbKey

◆ m_v0DecoTool

◆ m_v0FinderTool

◆ m_v0Key

◆ m_V0s_stored

◆ m_varHandleArraysDeclared

◆ m_vertexKey

◆ m_vhka