PanTau::Tool_InputConverter Class Reference

#include <Tool_InputConverter.h>

Inheritance diagram for PanTau::Tool_InputConverter:

Collaboration diagram for PanTau::Tool_InputConverter:

Public Member Functions
	Tool_InputConverter (const std::string &name)
virtual	~Tool_InputConverter ()
virtual StatusCode	initialize ()
	Dummy implementation of the initialisation function.
virtual StatusCode	ConvertToTauConstituent (const xAOD::PFO *pfo, PanTau::TauConstituent *&tauConstituent, const xAOD::TauJet *tauJet) const
bool	isInitialized ()
virtual void	print () const
	Print the state of the tool.
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
Additional helper functions, not directly mimicking Athena
template<class T>
const T *	getProperty (const std::string &name) const
	Get one of the tool's properties.
const std::string &	msg_level_name () const __attribute__((deprecated))
	A deprecated function for getting the message level's name.
const std::string &	getName (const void *ptr) const
	Get the name of an object that is / should be in the event store.
SG::sgkey_t	getKey (const void *ptr) const
	Get the (hashed) key of an object that is in the event store.

Protected Member Functions
virtual bool	passesPreselectionEnergy (double energy) const
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
ToolHandle< PanTau::ITool_InformationStore >	m_Tool_InformationStore {this, "Tool_InformationStore", "PanTau::Tool_InformationStore/Tool_InformationStore","Link to tool with all information"}
Gaudi::Property< std::string >	m_Tool_InformationStoreName {this, "Tool_InformationStoreName", "", "Optional Name for InformationStore instance in ABR"}
int	m_Config_UsePionMass = 0
double	m_Config_TauConstituents_Types_DeltaRCore = 0.0
double	m_Config_TauConstituents_PreselectionMinEnergy = 0.0
bool	m_init =false

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 34 of file Tool_InputConverter.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

Tool_InputConverter()

PanTau::Tool_InputConverter::Tool_InputConverter

(

const std::string &

name

)

Definition at line 12 of file Tool_InputConverter.cxx.

                                                                      :
  asg::AsgTool(name)
{}

~Tool_InputConverter()

PanTau::Tool_InputConverter::~Tool_InputConverter ( )

virtualdefault

Member Function Documentation

ConvertToTauConstituent()

StatusCode PanTau::Tool_InputConverter::ConvertToTauConstituent ( const xAOD::PFO * pfo, PanTau::TauConstituent *& tauConstituent, const xAOD::TauJet * tauJet ) const

virtual

Implements PanTau::ITool_InputConverter.

Definition at line 41 of file Tool_InputConverter.cxx.

                                                                {
    
  // check for invalid eta, phi, e "NAN" values -- likely no longer needed, raise severity to be sure
  if (pfo->eta() != pfo->eta() || pfo->phi() != pfo->phi() || pfo->e() != pfo->e()) {
    ATH_MSG_ERROR("Will not convert PFO with eta value of " << pfo->eta() << " -> return to Tool_TauConstituentGetter");
    return StatusCode::FAILURE;
  }
  
  // Check whether neutral input pfo has pion mass (it may have if xAOD is being reprocessed)
  // If it does, 
  // - old (R21) approach: make it massless again and use that
  // - new (R22) approach: complain and abort, reconstruction from AOD implies rebuilding PFOs upstream, so the mass should not have been set at that point
  if (!pfo->isCharged() && pfo->m() != 0) {
    ATH_MSG_ERROR("Input neutral PFO should have null mass. If reconstruction runs from AOD, PFOs must be rebuilt!");
    return StatusCode::FAILURE;
  }
    
  // preselection to veto very low energy PFOs
  if (!passesPreselectionEnergy(pfo->e())) {
    ATH_MSG_DEBUG("EFO of charge " << static_cast<int>(pfo->charge()) << " and energy " << pfo->e() << " does not pass presel Energy cut of " << m_Config_TauConstituents_PreselectionMinEnergy);
    return StatusCode::SUCCESS;
  }
        
  // get the mass correct & build 4-vector
  double constituentMass = pfo->m();
  if (m_Config_UsePionMass) {
    
    // clusters: don't touch the measured energy. set mass to pion mass, so momentum will be altered
    if (!pfo->isCharged()) {
      constituentMass = ParticleConstants::piZeroMassInMeV;
    }
  }
 
  TLorentzVector momentum; 
  PanTau::SetP4EEtaPhiM( momentum, pfo->e(), pfo->eta(), pfo->phi(), constituentMass);
    
  // get type (based on charge and DR to tau)
  std::vector<int> typeFlags = std::vector<int>((unsigned int)PanTau::TauConstituent::t_nTypes, 0);
  if (typeFlags.size() < (unsigned int)PanTau::TauConstituent::t_nTypes) std::abort(); // suppress cppcheck warning
  typeFlags.at(static_cast<int>(PanTau::TauConstituent::t_NoType)) = 1;
    
  double mvaValue = PanTau::TauConstituent::DefaultBDTValue();
 
  TLorentzVector tlv_intAxis = tauJet->p4(xAOD::TauJetParameters::IntermediateAxis);
  double deltaR_toTauJet = tlv_intAxis.DeltaR( pfo->p4() );
    
  if (deltaR_toTauJet > m_Config_TauConstituents_Types_DeltaRCore) {
    if (pfo->isCharged()) {
      typeFlags.at(static_cast<int>(PanTau::TauConstituent::t_Charged)) = 1;
    }
  }//end if pfo is not in core
    
  if (deltaR_toTauJet <= m_Config_TauConstituents_Types_DeltaRCore) {
    
    if (pfo->isCharged()) {
      typeFlags.at(static_cast<int>(PanTau::TauConstituent::t_Charged)) = 1;
    }
    else {
      typeFlags.at(static_cast<int>(PanTau::TauConstituent::t_Neutral)) = 1;
            
      //neutral PFO arranging --- check for pi0 tag
      mvaValue = pfo->bdtPi0Score();
            
      int nPi0sPerCluster = 0;
      if ( !pfo->attribute(xAOD::PFODetails::nPi0Proto, nPi0sPerCluster) ) {
    ATH_MSG_WARNING("WARNING: Could not retrieve nPi0Proto. Will set it to 1.");
    nPi0sPerCluster = 1;
      }
      if (nPi0sPerCluster > 0) typeFlags.at(static_cast<int>(PanTau::TauConstituent::t_Pi0Neut)) = 1;
 
    }
  }//end if pfo is in core
    
  // create the tau constituent
  tauConstituent = new PanTau::TauConstituent(momentum, static_cast<int>(pfo->charge()), typeFlags, mvaValue, pfo);
  tauConstituent->makePrivateStore();
    
  // Check if the pfo object has shots:
  std::vector<const xAOD::IParticle*> list_TauShots = std::vector<const xAOD::IParticle*>(0);
  if (!(pfo->associatedParticles(xAOD::PFODetails::TauShot, list_TauShots))) {
    ATH_MSG_DEBUG("WARNING: Could not get shots from current pfo");
  }
    
  for (unsigned int iShot=0; iShot<list_TauShots.size(); iShot++) {
    
    if (list_TauShots.at(iShot) == nullptr) {
      ATH_MSG_WARNING("Shot number " << iShot << " points to 0! Skip it");
      continue;
    }
    
    const xAOD::PFO*        curShot         = dynamic_cast<const xAOD::PFO*>(list_TauShots.at(iShot));
    TLorentzVector          shotMomentum;
    PanTau::SetP4EEtaPhiM( shotMomentum, curShot->e(), curShot->eta(), curShot->phi(), curShot->m());
    std::vector<int>        shotTypeFlags   = std::vector<int>((unsigned int)PanTau::TauConstituent::t_nTypes, 0);
    PanTau::TauConstituent* shotConstituent = new PanTau::TauConstituent(shotMomentum, 0, typeFlags, PanTau::TauConstituent::DefaultBDTValue(), curShot);
    shotConstituent->makePrivateStore();
    
    int nPhotons = 0;
    if (!curShot->attribute(xAOD::PFODetails::tauShots_nPhotons, nPhotons)) {
      nPhotons = -1;
      ATH_MSG_DEBUG("WARNING: Could not get nPhotons for this shot! Set to -1");
    }
    shotConstituent->setNPhotonsInShot(nPhotons);
    tauConstituent->addShot(shotConstituent);            
  }//end loop over shots
    
  return StatusCode::SUCCESS;
}

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

getKey()

SG::sgkey_t asg::AsgTool::getKey ( const void * ptr ) const

inherited

Get the (hashed) key of an object that is in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the SG::sgkey_t key for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also

asg::AsgTool::getName

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns

The hashed key of the object in the store. If not found, an invalid (zero) key.

Definition at line 119 of file AsgTool.cxx.

                                                    {
 
#ifdef XAOD_STANDALONE
      // In case we use @c xAOD::TEvent, we have a direct function call
      // for this.
      return evtStore()->event()->getKey( ptr );
#else
      const SG::DataProxy* proxy = evtStore()->proxy( ptr );
      return ( proxy == nullptr ? 0 : proxy->sgkey() );
#endif // XAOD_STANDALONE
   }

getName()

const std::string & asg::AsgTool::getName ( const void * ptr ) const

inherited

Get the name of an object that is / should be in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the std::string name for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also

asg::AsgTool::getKey

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns

The string name of the object in the store. If not found, an empty string.

Definition at line 106 of file AsgTool.cxx.

                                                            {
 
#ifdef XAOD_STANDALONE
      // In case we use @c xAOD::TEvent, we have a direct function call
      // for this.
      return evtStore()->event()->getName( ptr );
#else
      const SG::DataProxy* proxy = evtStore()->proxy( ptr );
      static const std::string dummy = "";
      return ( proxy == nullptr ? dummy : proxy->name() );
#endif // XAOD_STANDALONE
   }

getProperty()

template<class T>

const T * asg::AsgTool::getProperty ( const std::string & name ) const

inherited

Get one of the tool's properties.

initialize()

StatusCode PanTau::Tool_InputConverter::initialize ( void )

virtual

Dummy implementation of the initialisation function.

It's here to allow the dual-use tools to skip defining an initialisation function. Since many are doing so...

Reimplemented from asg::AsgTool.

Definition at line 18 of file Tool_InputConverter.cxx.

                                                 {
 
  ATH_MSG_INFO(" initialize()");
  m_init=true;
 
  ATH_CHECK( HelperFunctions::bindToolHandle( m_Tool_InformationStore, m_Tool_InformationStoreName) ); //ABR only
 
  ATH_CHECK( m_Tool_InformationStore.retrieve() );
    
  ATH_CHECK( m_Tool_InformationStore->getInfo_Int("TauConstituents_UsePionMass", m_Config_UsePionMass) );
  ATH_CHECK( m_Tool_InformationStore->getInfo_Double("TauConstituents_Types_DeltaRCore", m_Config_TauConstituents_Types_DeltaRCore) );
  ATH_CHECK( m_Tool_InformationStore->getInfo_Double("TauConstituents_PreselectionMinEnergy", m_Config_TauConstituents_PreselectionMinEnergy) );
 
  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.

isInitialized()

bool PanTau::Tool_InputConverter::isInitialized ( )

inlinevirtual

Implements PanTau::ITool_InputConverter.

Definition at line 64 of file Tool_InputConverter.h.

{return m_init;}

msg()

MsgStream & AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg_level_name()

const std::string & asg::AsgTool::msg_level_name ( ) const

inherited

A deprecated function for getting the message level's name.

Instead of using this, weirdly named function, user code should get the string name of the current minimum message level (in case they really need it...), with:

MSG::name( msg().level() )

This function's name doesn't follow the ATLAS coding rules, and as such will be removed in the not too distant future.

Returns

The string name of the current minimum message level that's printed

Definition at line 101 of file AsgTool.cxx.

                                                  {
 
      return MSG::name( msg().level() );
   }

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.

passesPreselectionEnergy()

bool PanTau::Tool_InputConverter::passesPreselectionEnergy ( double energy ) const

protectedvirtual

Definition at line 35 of file Tool_InputConverter.cxx.

                                                                            {
  return energy >= m_Config_TauConstituents_PreselectionMinEnergy;
}

print()

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

Reimplemented in AsgHelloTool, HI::HIPileupTool, JetBottomUpSoftDrop, JetConstituentsRetriever, JetDumper, JetFinder, JetFromPseudojet, JetModifiedMassDrop, JetPileupLabelingTool, JetPruner, JetPseudojetRetriever, JetReclusterer, JetReclusteringTool, JetRecTool, JetRecursiveSoftDrop, JetSoftDrop, JetSplitter, JetSubStructureMomentToolsBase, JetToolRunner, JetTrimmer, JetTruthLabelingTool, KtDeltaRTool, and LundVariablesTool.

Definition at line 131 of file AsgTool.cxx.

                             {
 
      ATH_MSG_INFO( "AsgTool " << name() << " @ " << this );
      return;
   }

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_Config_TauConstituents_PreselectionMinEnergy

double PanTau::Tool_InputConverter::m_Config_TauConstituents_PreselectionMinEnergy = 0.0

protected

Definition at line 60 of file Tool_InputConverter.h.

m_Config_TauConstituents_Types_DeltaRCore

double PanTau::Tool_InputConverter::m_Config_TauConstituents_Types_DeltaRCore = 0.0

protected

Definition at line 59 of file Tool_InputConverter.h.

m_Config_UsePionMass

int PanTau::Tool_InputConverter::m_Config_UsePionMass = 0

protected

Definition at line 57 of file Tool_InputConverter.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_init

bool PanTau::Tool_InputConverter::m_init =false

protected

Definition at line 62 of file Tool_InputConverter.h.

m_Tool_InformationStore

ToolHandle<PanTau::ITool_InformationStore> PanTau::Tool_InputConverter::m_Tool_InformationStore {this, "Tool_InformationStore", "PanTau::Tool_InformationStore/Tool_InformationStore","Link to tool with all information"}

protected

Definition at line 52 of file Tool_InputConverter.h.

{this, "Tool_InformationStore", "PanTau::Tool_InformationStore/Tool_InformationStore","Link to tool with all information"};

m_Tool_InformationStoreName

Gaudi::Property<std::string> PanTau::Tool_InputConverter::m_Tool_InformationStoreName {this, "Tool_InformationStoreName", "", "Optional Name for InformationStore instance in ABR"}

protected

Definition at line 53 of file Tool_InputConverter.h.

{this, "Tool_InformationStoreName", "", "Optional Name for InformationStore instance in ABR"};

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:

• Tool_InputConverter.h
• Tool_InputConverter.cxx