#include <McAodTupleWriterTool.h>

Inheritance diagram for McAodTupleWriterTool:

Collaboration diagram for McAodTupleWriterTool:

Classes
struct	McAodParticles
	A simple representation of a `TruthParticle`. More...

Public Member Functions
	McAodTupleWriterTool (const std::string &type, const std::string &name, const IInterface *parent)
	Constructor with parameters:
virtual	~McAodTupleWriterTool ()
	Destructor:
StatusCode	initialize ()
	Athena Algorithm's Hooks.
StatusCode	execute ()
StatusCode	finalize ()
StatusCode	write (const TruthParticleContainer *mcAod)
	Process the `TruthParticleContainer` through the I/O backend.
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 ()
	Inline methods:

Protected Member Functions
	McAodTupleWriterTool ()
	Default constructor:
void	setupBackend (Gaudi::Details::PropertyBase &outputFileName)
	Method to configure the back-end to write out the `HepMC::GenEvent`.
void	bookTuple ()
	book the tuple
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
McAodParticles	m_particles {}
	our cached particles
ServiceHandle< ITHistSvc >	m_tupleSvc
	Pointer to @ ITHistSvc.
StringProperty	m_truthParticlesName
	Location of the `TruthParticleContainer` to be written out.
StringProperty	m_outputFileName
	Name of the output tuple file.
StringProperty	m_outputStreamName
	Name of the output tuple stream.
TTree *	m_tuple
	cached pointer to the tuple

Static Protected Attributes
static const int	s_nMax = 2000
	maximum number of particles per event

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
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 31 of file McAodTupleWriterTool.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

◆ McAodTupleWriterTool() [1/2]

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

Constructor with parameters:

Public methods:

Constructors

Definition at line 35 of file McAodTupleWriterTool.cxx.

                                                   : 
  AthAlgTool( type, name, parent ),
  m_tupleSvc ( "THistSvc",     name ),
  m_tuple    ( nullptr )
{
  //
  // Property declaration
  // 
 
  declareProperty( "Output", 
           m_outputFileName = "mcaod.root", 
           "Name of the output file which will contain the McAod "
           "tuple. Ex: mcaod.root" );
  m_outputFileName.declareUpdateHandler( &McAodTupleWriterTool::setupBackend,
                     this );
 
  declareProperty( "OutputStream", 
           m_outputStreamName = "mcaod", 
           "Name of the stream which will contain the McAod tuple. "
           "Ex: mcaod" );
 
  declareProperty( "TruthParticles",
           m_truthParticlesName = "GEN_EVENT",
           "Input location of the TruthParticleContainer to write "
           "out." );
 
  declareInterface<IIOMcAodTool>(this);
}

◆ ~McAodTupleWriterTool()

McAodTupleWriterTool::~McAodTupleWriterTool ( )

virtual

Destructor:

Destructor.

Definition at line 68 of file McAodTupleWriterTool.cxx.

{ 
  ATH_MSG_DEBUG("Calling destructor");
 
}

◆ McAodTupleWriterTool() [2/2]

McAodTupleWriterTool::McAodTupleWriterTool ( )

protected

Default constructor:

Member Function Documentation

◆ bookTuple()

void McAodTupleWriterTool::bookTuple ( )

protected

book the tuple

Definition at line 212 of file McAodTupleWriterTool.cxx.

{
  delete m_tuple;
  const std::string streamName = m_outputStreamName.value();
  TTree* t = new TTree("mcaod","McAod validation tuple");
  if ( !m_tupleSvc->regTree( "/" + streamName + "/mcaod", t ).isSuccess() ) {
    ATH_MSG_ERROR("Could not register McAod validation tuple !!");
    delete t; t = nullptr;
    throw GaudiException( "Could not register McAod validation tuple !!",
              name(),
              StatusCode::FAILURE );
  }
 
  // booking branches
  t->Branch( "nParts", &m_particles.m_nParticles, "nParts/i" );
 
  t->Branch( "px", m_particles.m_px.data(),  "px[nParts]/D" );
  t->Branch( "py", m_particles.m_py.data(),  "py[nParts]/D" );
  t->Branch( "pz", m_particles.m_pz.data(),  "pz[nParts]/D" );
  t->Branch( "m",  m_particles.m_m.data(),   "m[nParts]/D"  );
  t->Branch( "e",  m_particles.m_ene.data(), "e[nParts]/D"  );
 
  t->Branch( "pdgId", m_particles.m_pdgId.data(),   "pdgId[nParts]/I" );
  t->Branch( "sc",    m_particles.m_status.data(),  "sc[nParts]/I" );
  t->Branch( "bc",    m_particles.m_barcode.data(), "bc[nParts]/I" );
 
  t->Branch( "etcone10",  m_particles.m_etcone10.data(), "etcone10[nParts]/D" );
  t->Branch( "etcone20",  m_particles.m_etcone20.data(), "etcone20[nParts]/D" );
  t->Branch( "etcone30",  m_particles.m_etcone30.data(), "etcone30[nParts]/D" );
  t->Branch( "etcone40",  m_particles.m_etcone40.data(), "etcone40[nParts]/D" );
  t->Branch( "etcone45",  m_particles.m_etcone45.data(), "etcone45[nParts]/D" );
  t->Branch( "etcone50",  m_particles.m_etcone50.data(), "etcone50[nParts]/D" );
  t->Branch( "etcone60",  m_particles.m_etcone60.data(), "etcone60[nParts]/D" );
  t->Branch( "etcone70",  m_particles.m_etcone70.data(), "etcone70[nParts]/D" );
 
  m_tuple = t;
}

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

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ 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

◆ execute()

StatusCode McAodTupleWriterTool::execute ( )

virtual

Implements IIOMcAodTool.

Definition at line 106 of file McAodTupleWriterTool.cxx.

{
  // retrieve the TruthParticleContainer
  const TruthParticleContainer * mc = nullptr;
  if ( evtStore()->retrieve( mc, m_truthParticlesName ).isFailure() ||
       nullptr == mc ) {
    ATH_MSG_ERROR("Could not retrieve a TruthParticleContainer at ["
          << m_truthParticlesName << "] !!");
    return StatusCode::FAILURE;
  }
 
  if ( mc->empty() ) {
    ATH_MSG_WARNING("TruthParticleContainer at [" << m_truthParticlesName
            << "] is EMPTY !!");
    return StatusCode::FAILURE;
  }
 
  return write(mc);
}

◆ 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

◆ finalize()

StatusCode McAodTupleWriterTool::finalize ( )

virtual

Implements IIOMcAodTool.

Definition at line 100 of file McAodTupleWriterTool.cxx.

{
  ATH_MSG_INFO("Finalizing " << name() << "...");
  return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode McAodTupleWriterTool::initialize ( )

virtual

Athena Algorithm's Hooks.

Implements IIOMcAodTool.

Definition at line 76 of file McAodTupleWriterTool.cxx.

{
  ATH_MSG_INFO("Initializing " << name() << "...");
  // Get pointer to StoreGateSvc and cache it :
  if ( !evtStore().retrieve().isSuccess() ) {
    ATH_MSG_ERROR("Unable to retrieve pointer to StoreGateSvc");
    return StatusCode::FAILURE;
  }
 
  // Get pointer to ITHistSvc and cache it :
  if ( !m_tupleSvc.retrieve().isSuccess() ) {
    ATH_MSG_ERROR("Unable to retrieve pointer to ITHistSvc");
    return StatusCode::FAILURE;
  }
 
  // setup backend
  setupBackend(m_outputFileName);
 
  // book tuple
  bookTuple();
 
  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 & IIOMcAodTool::interfaceID ( )

inlinestaticinherited

Inline methods:

Definition at line 59 of file IIOMcAodTool.h.

{ 
   return IID_IIOMcAodTool; 
}

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

◆ setupBackend()

void McAodTupleWriterTool::setupBackend ( Gaudi::Details::PropertyBase & outputFileName )

protected

Method to configure the back-end to write out the HepMC::GenEvent.

Protected methods:

Const methods: Non-const methods:

Definition at line 179 of file McAodTupleWriterTool.cxx.

{
  if ( m_tupleSvc.retrieve().isFailure() ) {
    ATH_MSG_ERROR("Could not retrieve THistSvc handle !!");
    throw GaudiException( "Could not retrieve THistSvc", 
              name(), 
              StatusCode::FAILURE );
  }
 
  SmartIF<IProperty> tSvc(m_tupleSvc.get());
  const std::string streamName = m_outputStreamName.value();
 
  const std::string propName = "Output";
  StringArrayProperty outputFileName;
  outputFileName.assign( tSvc->getProperty( propName ) );
  std::vector<std::string> updatedProp( outputFileName.value() );
  updatedProp.push_back
    ( streamName+" DATAFILE='"+m_outputFileName.value()+"' "
      "TYP='ROOT' "
      "OPT='RECREATE'" 
      );
  outputFileName.set( updatedProp );
  outputFileName.setName( std::move(propName) );
  if ( !tSvc->setProperty( outputFileName ).isSuccess() ) {
    ATH_MSG_ERROR("Could not configure the THistSvc's output filename ["
          << m_outputFileName.value() << "] !!");
    throw GaudiException( "Could not configure THistSvc output file !!", 
              name(),
              StatusCode::FAILURE );
  }
 
  }

◆ 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 >, and AthCheckedComponent<::AthAlgTool >.

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

◆ write()

StatusCode McAodTupleWriterTool::write ( const TruthParticleContainer * mc )

Process the TruthParticleContainer through the I/O backend.

Const methods:

Non-const methods:

Definition at line 134 of file McAodTupleWriterTool.cxx.

{
  m_particles.m_nParticles = std::min<std::size_t>( s_nMax, mc->size() );
  for ( std::size_t i = 0; i != m_particles.m_nParticles; ++i ) {
    const TruthParticle * p = (*mc)[i];
    m_particles.m_px [i] = p->px();
    m_particles.m_py [i] = p->py();
    m_particles.m_pz [i] = p->pz();
    m_particles.m_m  [i] = p->m();
    m_particles.m_ene[i] = p->e();
 
    m_particles.m_pdgId[i]    = p->pdgId();
    m_particles.m_status[i]   = p->status();
    m_particles.m_barcode[i]  = p->barcode();
 
    using namespace TruthParticleParameters;
 
    m_particles.m_etcone10[i] = p->etIsol(etcone10);
    m_particles.m_etcone20[i] = p->etIsol(etcone20);
    m_particles.m_etcone30[i] = p->etIsol(etcone30);
    m_particles.m_etcone40[i] = p->etIsol(etcone40);
    m_particles.m_etcone45[i] = p->etIsol(etcone  );
    m_particles.m_etcone50[i] = p->etIsol(etcone50);
    m_particles.m_etcone60[i] = p->etIsol(etcone60);
    m_particles.m_etcone70[i] = p->etIsol(etcone70);
  }
 
  // commit event
  m_tuple->Fill();
 
  return StatusCode::SUCCESS;
}

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_outputFileName

StringProperty McAodTupleWriterTool::m_outputFileName

protected

Name of the output tuple file.

Definition at line 126 of file McAodTupleWriterTool.h.

◆ m_outputStreamName

StringProperty McAodTupleWriterTool::m_outputStreamName

protected

Name of the output tuple stream.

Definition at line 129 of file McAodTupleWriterTool.h.

◆ m_particles

McAodParticles McAodTupleWriterTool::m_particles {}

protected

our cached particles

Definition at line 116 of file McAodTupleWriterTool.h.

116{};

◆ m_truthParticlesName

StringProperty McAodTupleWriterTool::m_truthParticlesName

protected

Location of the TruthParticleContainer to be written out.

Definition at line 123 of file McAodTupleWriterTool.h.

◆ m_tuple

TTree* McAodTupleWriterTool::m_tuple

protected

cached pointer to the tuple

Definition at line 132 of file McAodTupleWriterTool.h.

◆ m_tupleSvc

ServiceHandle<ITHistSvc> McAodTupleWriterTool::m_tupleSvc

protected

Pointer to @ ITHistSvc.

Definition at line 119 of file McAodTupleWriterTool.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.

◆ s_nMax

const int McAodTupleWriterTool::s_nMax = 2000

staticprotected

maximum number of particles per event

Definition at line 92 of file McAodTupleWriterTool.h.

The documentation for this class was generated from the following files:

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ McAodTupleWriterTool() [1/2]

◆ ~McAodTupleWriterTool()

◆ McAodTupleWriterTool() [2/2]

Member Function Documentation

◆ bookTuple()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ setupBackend()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

◆ write()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_outputFileName

◆ m_outputStreamName

◆ m_particles

◆ m_truthParticlesName

◆ m_tuple

◆ m_tupleSvc

◆ m_varHandleArraysDeclared

◆ m_vhka

◆ s_nMax