CP::PhotonPointingTool Class Reference

Implementation for the photon pointing tool. More...

#include <PhotonPointingTool.h>

Inheritance diagram for CP::PhotonPointingTool:

Collaboration diagram for CP::PhotonPointingTool:

Public Types
Definition of the StoreGate-like object's definition
typedef ServiceHandle< StoreGateSvc >	MetaStore_t
	Type of the metadata store object in Athena.
typedef const ServiceHandle< StoreGateSvc > &	MetaStorePtr_t
	Type of the metadata store pointer in standalone mode.

Public Member Functions
	PhotonPointingTool (const std::string &name)
virtual	~PhotonPointingTool ()
virtual StatusCode	sysInitialize ()
	Function initialising the tool in the correct way in Athena.
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	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
Function(s) implementing the asg::IAsgTool interface
virtual StatusCode	initialize ()
	Function initialising the tool.
Function(s) implementing the IPhotonPointingTool interface
StatusCode	updatePointingAuxdata (const xAOD::EgammaContainer &egammas) const
	Add calo and conversion (HPV) pointing variables.
std::pair< float, float >	getCaloPointing (const xAOD::Egamma *egamma) const
	Return calo pointing variables.
std::pair< float, float >	getConvPointing (const xAOD::Photon *photon) const
	Return conversion (HPV) pointing variables.
Functions providing access to the input/output metadata
MetaStorePtr_t	inputMetaStore () const
	Accessor for the input metadata store.
MetaStorePtr_t	outputMetaStore () const
	Accessor for the output metadata store.
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
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.
Callback functions helping in metadata reading/writing
void	setUseIncidents (const bool flag)
virtual void	handle (const Incident &inc)
	Function receiving incidents from IncidentSvc/TEvent.
virtual StatusCode	beginInputFile ()
	Function called when a new input file is opened.
virtual StatusCode	endInputFile ()
	Function called when the currently open input file got completely processed.
virtual StatusCode	beginEvent ()
	Function called when a new events is loaded.
virtual StatusCode	metaDataStop ()
	Function called when the tool should write out its metadata.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
float	getCorrectedZ (float zPointing, float etas2) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
TH1F *	m_zCorrection
	Create a proper constructor for Athena.
SG::ReadHandleKey< xAOD::EventInfo >	m_evtInfo
SG::WriteDecorHandleKey< xAOD::EgammaContainer >	m_zvertex
SG::WriteDecorHandleKey< xAOD::EgammaContainer >	m_errz
SG::WriteDecorHandleKey< xAOD::EgammaContainer >	m_HPV_zvertex
SG::WriteDecorHandleKey< xAOD::EgammaContainer >	m_HPV_errz
bool	m_isMC {}
std::string	m_zOscFileMC
std::string	m_zOscFileData
std::string	m_zvertexDecorName
std::string	m_errzDecorName
std::string	m_HPV_zvertexDecorName
std::string	m_HPV_errzDecorName
std::string	m_ContainerName
MetaStore_t	m_inputMetaStore
	Object accessing the input metadata store.
MetaStore_t	m_outputMetaStore
	Object accessing the output metadata store.
bool	m_beginInputFileCalled
	Flag helping to discover when the tool misses the opening of the first input file.
bool	m_useIncidents
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

Implementation for the photon pointing tool.

Takes photon shower shape and/or conversion vertex and extrapolates back to beamline

Author

Christopher Meyer chris.nosp@m..mey.nosp@m.er@ce.nosp@m.rn.c.nosp@m.h

Definition at line 34 of file PhotonPointingTool.h.

Member Typedef Documentation

MetaStore_t

typedef ServiceHandle< StoreGateSvc > asg::AsgMetadataTool::MetaStore_t

inherited

Type of the metadata store object in Athena.

Definition at line 66 of file AsgMetadataTool.h.

MetaStorePtr_t

typedef const ServiceHandle< StoreGateSvc >& asg::AsgMetadataTool::MetaStorePtr_t

inherited

Type of the metadata store pointer in standalone mode.

Definition at line 68 of file AsgMetadataTool.h.

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

PhotonPointingTool()

CP::PhotonPointingTool::PhotonPointingTool

(

const std::string &

name

)

Definition at line 30 of file PhotonPointingTool.cxx.

  : asg::AsgMetadataTool(name)
    , m_zCorrection(nullptr)
{
  declareProperty("isSimulation", m_isMC);
  declareProperty("zOscillationFileMC", m_zOscFileMC = "PhotonVertexSelection/v1/pointing_correction_mc.root");
  declareProperty("zOscillationFileData", m_zOscFileData = "PhotonVertexSelection/v1/pointing_correction_data.root");
  declareProperty("zvertex", m_zvertexDecorName = "zvertex");
  declareProperty("errz", m_errzDecorName = "errz");
  declareProperty("HPV_zvertex", m_HPV_zvertexDecorName = "HPV_zvertex");
  declareProperty("HPV_errz", m_HPV_errzDecorName = "HPV_errz");
  declareProperty("ContainerName", m_ContainerName = "Photons");
}

~PhotonPointingTool()

CP::PhotonPointingTool::~PhotonPointingTool ( )

virtual

Definition at line 45 of file PhotonPointingTool.cxx.

{
  SafeDelete(m_zCorrection);
}

Member Function Documentation

beginEvent()

StatusCode asg::AsgMetadataTool::beginEvent ( )

protectedvirtualinherited

Function called when a new events is loaded.

Dummy implementation that can be overridden by the derived tool.

Reimplemented in AsgElectronEfficiencyCorrectionTool, TauAnalysisTools::CommonSmearingTool, TauAnalysisTools::DiTauEfficiencyCorrectionsTool, TauAnalysisTools::DiTauSelectionTool, TauAnalysisTools::TauEfficiencyCorrectionsTool, TauAnalysisTools::TauSelectionTool, Trig::TrigConfBunchCrossingTool, Trig::TrigDecisionTool, Trig::xAODBunchCrossingTool, TrigConf::xAODConfigTool, and xAODMaker::TriggerMenuMetaDataTool.

Definition at line 201 of file AsgMetadataTool.cxx.

                                          {
 
      // Return gracefully:
      return StatusCode::SUCCESS;
   }

beginInputFile()

StatusCode asg::AsgMetadataTool::beginInputFile ( )

protectedvirtualinherited

Function called when a new input file is opened.

Dummy implementation that can be overridden by the derived tool.

Reimplemented in AsgElectronEfficiencyCorrectionTool, BookkeeperDumperTool, BookkeeperTool, PMGTools::PMGTruthWeightTool, TauAnalysisTools::TauEfficiencyCorrectionsTool, TauAnalysisTools::TauSmearingTool, Trig::TrigDecisionTool, Trig::xAODBunchCrossingTool, TrigConf::xAODConfigTool, xAODMaker::TriggerMenuMetaDataTool, and xAODMaker::TruthMetaDataTool.

Definition at line 185 of file AsgMetadataTool.cxx.

                                              {
 
      // Return gracefully:
      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; }

endInputFile()

StatusCode asg::AsgMetadataTool::endInputFile ( )

protectedvirtualinherited

Function called when the currently open input file got completely processed.

Dummy implementation that can be overridden by the derived tool.

Reimplemented in BookkeeperDumperTool, BookkeeperTool, xAODMaker::TriggerMenuMetaDataTool, and xAODMaker::TruthMetaDataTool.

Definition at line 193 of file AsgMetadataTool.cxx.

                                            {
 
      // Return gracefully:
      return StatusCode::SUCCESS;
   }

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

getCaloPointing()

std::pair< float, float > CP::PhotonPointingTool::getCaloPointing ( const xAOD::Egamma * egamma ) const

virtual

Return calo pointing variables.

Implements CP::IPhotonPointingTool.

Definition at line 174 of file PhotonPointingTool.cxx.

  {
    if (egamma == nullptr) {
      ATH_MSG_WARNING("Passed Egamma was a nullptr, returning (0,0).");
      return std::make_pair(0,0);
    }
 
    // Get the EventInfo
    SG::ReadHandle<xAOD::EventInfo> eventInfo(m_evtInfo);
    if(!eventInfo.isValid()){
      ATH_MSG_WARNING("Couldn't retrieve EventInfo from TEvent, egamma won't be decorated.");
      return std::make_pair(0, 0);
    }
 
    // Beam parameters
    double d_beamSpot   = hypot(eventInfo->beamPosY(), eventInfo->beamPosX());
    double phi_beamSpot = atan2(eventInfo->beamPosY(), eventInfo->beamPosX());
 
    // Photon variables
    const xAOD::CaloCluster *cluster = egamma->caloCluster();
    if (cluster == nullptr) {
      ATH_MSG_WARNING("Couldn't retrieve CaloCluster from Photon, egammas won't be decorated.");
      return std::make_pair(0, 0);
    }
 
    float cl_e     = cluster->e();
    float etas1    = cluster->etaBE(1);
    float etas2    = cluster->etaBE(2);
    float phis2    = cluster->phiBE(2);
    float cl_theta = 2.0*atan(exp(-1.0*cluster->eta()));
 
    // Shower depths
    std::pair<float, float> RZ1 = CP::ShowerDepthUtil::getRZ(etas1, 1);
    std::pair<float, float> RZ2 = CP::ShowerDepthUtil::getRZ(etas2, 2);
 
    // Calo cluster pointing calculation
    double r0_with_beamSpot = d_beamSpot*cos(phis2 - phi_beamSpot);
 
    float s_zvertex = 0, s_errz = 0;
    s_zvertex = (RZ1.second * (RZ2.first - r0_with_beamSpot) -
                 RZ2.second * (RZ1.first - r0_with_beamSpot)) /
                (RZ2.first - RZ1.first);
    s_zvertex = getCorrectedZ(s_zvertex, etas2);
 
    s_errz = 0.5 * (RZ2.first + RZ1.first) * (0.060 / sqrt(cl_e * 0.001)) /
             (sin(cl_theta) * sin(cl_theta));
 
    return std::make_pair(s_zvertex, s_errz);
  }

getConvPointing()

std::pair< float, float > CP::PhotonPointingTool::getConvPointing ( const xAOD::Photon * photon ) const

virtual

Return conversion (HPV) pointing variables.

Implements CP::IPhotonPointingTool.

Definition at line 225 of file PhotonPointingTool.cxx.

  {
    if (photon == nullptr) {
      ATH_MSG_WARNING("Passed Egamma was a nullptr, returning (0,0).");
      return std::make_pair(0,0);
    }
 
    // Get the EventInfo
    SG::ReadHandle<xAOD::EventInfo> eventInfo(m_evtInfo);
    if(!eventInfo.isValid()){
      ATH_MSG_WARNING("Couldn't retrieve EventInfo from TEvent, photons won't be decorated.");
      return std::make_pair(0, 0);
    }
 
    // Beam parameters
    double d_beamSpot   = hypot(eventInfo->beamPosY(), eventInfo->beamPosX());
    double phi_beamSpot = atan2(eventInfo->beamPosY(), eventInfo->beamPosX());
 
    // Photon variables
    const xAOD::CaloCluster *cluster = photon->caloCluster();
    if (cluster == nullptr) {
      ATH_MSG_WARNING("Couldn't retrieve CaloCluster from Photon, photons won't be decorated.");
      return std::make_pair(0, 0);
    }
 
    float etas1    = cluster->etaBE(1);
    float phis2    = cluster->phiBE(2);
 
    const xAOD::Vertex *conv = photon->vertex();
    if (cluster == nullptr) {
      ATH_MSG_WARNING("Couldn't retrieve conversion Vertex from Photon, photons won't be decorated.");
      return std::make_pair(0, 0);
    }
 
    float conv_x = conv->x();
    float conv_y = conv->y();
    float conv_z = conv->z();
 
    // Shower depths
    std::pair<float, float> RZ1 = CP::ShowerDepthUtil::getRZ(etas1, 1);
 
    // Photon conversion
    double conv_r = hypot(conv_x, conv_y);
 
    // HPV pointing calculation
    double phi_Calo         = atan2(sin(phis2), cos(phis2));
    double r0_with_beamSpot = d_beamSpot*cos(phi_Calo - phi_beamSpot);
 
    float s_zvertex = (RZ1.second*(conv_r - r0_with_beamSpot) - conv_z*(RZ1.first - r0_with_beamSpot)) / (conv_r - RZ1.first);
 
    float dist_vtx_to_conv = hypot(conv_r - r0_with_beamSpot, conv_z - s_zvertex);
    float dist_conv_to_s1 = hypot(RZ1.first - conv_r, RZ1.second - conv_z);
 
    float error_etaS1 = 0.001; // FIXME is there a tool which provides a better value?
    float s_errz = 0.0;
 
    if ((cluster->inBarrel() && !cluster->inEndcap()) ||
        (cluster->inBarrel() &&  cluster->inEndcap() && cluster->eSample(CaloSampling::EMB1) > cluster->eSample(CaloSampling::EME1))) {
      // Barrel case
      float error_Z_Calo_1st_Sampling_barrel = error_etaS1*RZ1.first*fabs(cosh(etas1));
      s_errz = error_Z_Calo_1st_Sampling_barrel*dist_vtx_to_conv/dist_conv_to_s1;
    } else {
      // Endcap case
      float error_R_Calo_1st_Sampling_endcap = error_etaS1*cosh(etas1)*RZ1.first*RZ1.first/fabs(RZ1.second);
      s_errz = error_R_Calo_1st_Sampling_endcap*fabs(sinh(etas1))*dist_vtx_to_conv/dist_conv_to_s1;
    }
 
    return std::make_pair(s_zvertex, s_errz);
  }

getCorrectedZ()

float CP::PhotonPointingTool::getCorrectedZ ( float zPointing, float etas2 ) const

private

Definition at line 167 of file PhotonPointingTool.cxx.

  {
    if (fabs(etas2) < 1.37) return zPointing;
    return zPointing - m_zCorrection->Interpolate(etas2);
  }

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.

handle()

void asg::AsgMetadataTool::handle ( const Incident & inc )

protectedvirtualinherited

Function receiving incidents from IncidentSvc/TEvent.

Reimplemented in Trig::TrigDecisionTool.

Definition at line 135 of file AsgMetadataTool.cxx.

                                                     {
 
      // Tell the user what's happening:
      ATH_MSG_VERBOSE( "Callback received with incident: " << inc.type() );
 
      // Call the appropriate member function:
      if( inc.type() == IncidentType::BeginInputFile ) {
        m_beginInputFileCalled = true;
        if( beginInputFile().isFailure() ) {
          ATH_MSG_FATAL( "Failed to call beginInputFile()" );
          throw std::runtime_error( "Couldn't call beginInputFile()" );
         }
      } else if( inc.type() == IncidentType::EndInputFile ) {
        if( endInputFile().isFailure() ) {
          ATH_MSG_FATAL( "Failed to call endInputFile()" );
          throw std::runtime_error( "Couldn't call endInputFile()" );
         }
      } else if( inc.type() == IncidentType::BeginEvent ) {
         // If the tool didn't catch the begin input file incident for the
         // first input file of the job, then call the appropriate function
         // now.
         if( ! m_beginInputFileCalled ) {
            m_beginInputFileCalled = true;
            if( beginInputFile().isFailure() ) {
               ATH_MSG_FATAL( "Failed to call beginInputFile()" );
               throw std::runtime_error( "Couldn't call beginInputFile()" );
            }
         }
         if( beginEvent().isFailure() ) {
            ATH_MSG_FATAL( "Failed to call beginEvent()" );
            throw std::runtime_error( "Couldn't call beginEvent()" );
         }
 
     #ifdef XAOD_STANDALONE
      } else if( inc.type() == IncidentType::MetaDataStop ) {
         if( metaDataStop().isFailure() ) {
            ATH_MSG_FATAL( "Failed to call metaDataStop()" );
            throw std::runtime_error( "Couldn't call metaDataStop()" );
         }
         
     #endif // XAOD_STANDALONE
      } else {
         ATH_MSG_WARNING( "Unknown incident type received in AsgMetaDataTool: " << inc.type() );
      }
 
      return;
   }

initialize()

StatusCode CP::PhotonPointingTool::initialize ( void )

virtual

Function initialising the tool.

Reimplemented from asg::AsgTool.

Definition at line 51 of file PhotonPointingTool.cxx.

{
  ATH_MSG_INFO("Initializing PhotonVertexSelectionTool..." << name());
 
  ATH_CHECK( m_evtInfo.initialize() );
 
  if(m_ContainerName.empty()) m_ContainerName = "Photons";
 
  m_zvertex = m_ContainerName + "." + m_zvertexDecorName;
  m_errz = m_ContainerName + "." + m_errzDecorName;
  m_HPV_zvertex = m_ContainerName + "." + m_HPV_zvertexDecorName;
  m_HPV_errz = m_ContainerName + "." + m_HPV_errzDecorName;
 
  ATH_CHECK(m_zvertex.initialize());
  ATH_CHECK(m_errz.initialize());
  ATH_CHECK(m_HPV_zvertex.initialize());
  ATH_CHECK(m_HPV_errz.initialize());
 
  // Determine if this is MC or data
  std::string dataType("");
  m_isMC = true;
  if (inputMetaStore()->contains<xAOD::FileMetaData>("FileMetaData")) {
    const xAOD::FileMetaData* fmd = nullptr;
    ATH_CHECK(inputMetaStore()->retrieve(fmd, "FileMetaData"));
    std::string simType("");
    const bool s = fmd->value(xAOD::FileMetaData::simFlavour, simType);
    if (!s) {
      ATH_MSG_DEBUG("no sim flavour from metadata: must be data");
      m_isMC = false;
    }
  } else {
    ATH_MSG_WARNING("Failed to retrieve FileMetaData : assuming to be MC");
  }
 
 
  std::string filepath = PathResolverFindCalibFile(m_isMC ? m_zOscFileMC :
                                                   m_zOscFileData);
  TFile *file = TFile::Open(filepath.c_str(), "READ");
 
  if (file == nullptr) {
    ATH_MSG_WARNING("Couldn't find file for z-correction: " << filepath.c_str());
    ATH_MSG_WARNING("Failed to initialize.");
    return StatusCode::FAILURE;
  }
 
  TH1F *temp = nullptr;
  file->GetObject("dz_trk_pointing_vs_etas2", temp);
 
  if (temp == nullptr) {
    ATH_MSG_WARNING("Couldn't find 'dz_trk_pointing_vs_etas2' histogram in file: " << filepath.c_str());
    ATH_MSG_WARNING("Failed to initialize.");
    return StatusCode::FAILURE;
  }
 
  bool status = TH1::AddDirectoryStatus();
  TH1::AddDirectory(false);
  m_zCorrection = dynamic_cast<TH1F*>(temp->Clone("zCorrection"));
  SafeDelete(file);
  TH1::AddDirectory(status);
 
  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.

inputMetaStore()

AsgMetadataTool::MetaStorePtr_t asg::AsgMetadataTool::inputMetaStore ( ) const

inherited

Accessor for the input metadata store.

Definition at line 93 of file AsgMetadataTool.cxx.

                                                                       {
 
#ifdef XAOD_STANDALONE
      return &m_inputMetaStore;
#else // XAOD_STANDALONE
      return m_inputMetaStore;
#endif // XAOD_STANDALONE
   }

metaDataStop()

StatusCode asg::AsgMetadataTool::metaDataStop ( )

protectedvirtualinherited

Function called when the tool should write out its metadata.

Dummy implementation that can be overridden by the derived tool.

Reimplemented in BookkeeperDumperTool, BookkeeperTool, xAODMaker::TriggerMenuMetaDataTool, and xAODMaker::TruthMetaDataTool.

Definition at line 209 of file AsgMetadataTool.cxx.

                                            {
 
      // Return gracefully:
      return StatusCode::SUCCESS;
   }

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.

outputMetaStore()

AsgMetadataTool::MetaStorePtr_t asg::AsgMetadataTool::outputMetaStore ( ) const

inherited

Accessor for the output metadata store.

Definition at line 102 of file AsgMetadataTool.cxx.

                                                                        {
 
#ifdef XAOD_STANDALONE
      return &m_outputMetaStore;
#else // XAOD_STANDALONE
      return m_outputMetaStore;
#endif // XAOD_STANDALONE
   }

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

setUseIncidents()

void asg::AsgMetadataTool::setUseIncidents ( const bool flag )

inlineprotectedinherited

Definition at line 132 of file AsgMetadataTool.h.

   {
      m_useIncidents = flag;
   }

sysInitialize()

StatusCode asg::AsgMetadataTool::sysInitialize ( )

virtualinherited

Function initialising the tool in the correct way in Athena.

This function is used to set up the callbacks from IncidentSvc in Athena at the right time during initialisation, without the user having to do anything special in his/her code.

Reimplemented from AthCommonDataStore< AthCommonMsg< AlgTool > >.

Definition at line 115 of file AsgMetadataTool.cxx.

                                             {
 
#ifndef XAOD_STANDALONE
      if (m_useIncidents) {
         // Connect to the IncidentSvc:
         ServiceHandle< IIncidentSvc > incSvc( "IncidentSvc", name() );
         ATH_CHECK( incSvc.retrieve() );
 
         // Set up the right callbacks: don't rethrow exceptions, any failure and we should end
         incSvc->addListener( this, IncidentType::BeginEvent, 0, false );
      }
      // Let the base class do its thing:
      ATH_CHECK( AlgTool::sysInitialize() );
 
#endif // not XAOD_STANDALONE
 
      // Return gracefully:
      return StatusCode::SUCCESS;
   }

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.

updatePointingAuxdata()

StatusCode CP::PhotonPointingTool::updatePointingAuxdata ( const xAOD::EgammaContainer & egammas ) const

virtual

Add calo and conversion (HPV) pointing variables.

Implements CP::IPhotonPointingTool.

Definition at line 115 of file PhotonPointingTool.cxx.

{
  const EventContext& ctx = Gaudi::Hive::currentContext();
 
  // create the decorators
  SG::WriteDecorHandle<xAOD::EgammaContainer, float> s_zvertex(m_zvertex, ctx);
  SG::WriteDecorHandle<xAOD::EgammaContainer, float> s_errz(m_errz, ctx);
  SG::WriteDecorHandle<xAOD::EgammaContainer, float> s_HPV_zvertex(m_HPV_zvertex, ctx);
  SG::WriteDecorHandle<xAOD::EgammaContainer, float> s_HPV_errz(m_HPV_errz, ctx);
 
  bool isDecorAvailable = s_zvertex.isAvailable();
 
  // Loop over photons and add calo pointing auxdata
  std::pair<float, float> result;
  for (const auto *egamma: egammas) {
    if(egamma==nullptr){
      ATH_MSG_DEBUG("Passed Egamma was a nullptr  -- skipping");
      continue;
    }
    // Get calo pointing variables
    result = getCaloPointing(egamma);
 
    // Set photon auxdata with new value
    if(isDecorAvailable){
      ATH_MSG_DEBUG("Called updatePointingAuxdata but decoration is already available");
    }
    else{
      s_zvertex(*egamma) = result.first;
      s_errz(*egamma)    = result.second;
    }
 
    // Get conv pointing variables
    if (egamma->type() == xAOD::Type::Photon) {
      const xAOD::Egamma *eg     = static_cast<const xAOD::Egamma*>(egamma);
      const xAOD::Photon *photon = dynamic_cast<const xAOD::Photon*>(eg);
 
      if (photon && xAOD::EgammaHelpers::numberOfSiTracks(photon))
        result = getConvPointing(photon);
    }
 
    // Set photon auxdata with new value
    if(!isDecorAvailable){
      s_HPV_zvertex(*egamma) = result.first;
      s_HPV_errz(*egamma)    = result.second;
    }
 
  }
 
  return StatusCode::SUCCESS;
}

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_beginInputFileCalled

bool asg::AsgMetadataTool::m_beginInputFileCalled

privateinherited

Flag helping to discover when the tool misses the opening of the first input file.

Definition at line 126 of file AsgMetadataTool.h.

m_ContainerName

std::string CP::PhotonPointingTool::m_ContainerName

private

Definition at line 67 of file PhotonPointingTool.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_errz

SG::WriteDecorHandleKey<xAOD::EgammaContainer> CP::PhotonPointingTool::m_errz

private

Definition at line 53 of file PhotonPointingTool.h.

m_errzDecorName

std::string CP::PhotonPointingTool::m_errzDecorName

private

Definition at line 64 of file PhotonPointingTool.h.

m_evtInfo

SG::ReadHandleKey<xAOD::EventInfo> CP::PhotonPointingTool::m_evtInfo

private

Initial value:

{
      this,
      "EventInfo",
      "EventInfo",
      "SG key of xAOD::EventInfo"
    }

Definition at line 44 of file PhotonPointingTool.h.

                                            {
      this,
      "EventInfo",
      "EventInfo",
      "SG key of xAOD::EventInfo"
    };

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_HPV_errz

SG::WriteDecorHandleKey<xAOD::EgammaContainer> CP::PhotonPointingTool::m_HPV_errz

private

Definition at line 55 of file PhotonPointingTool.h.

m_HPV_errzDecorName

std::string CP::PhotonPointingTool::m_HPV_errzDecorName

private

Definition at line 66 of file PhotonPointingTool.h.

m_HPV_zvertex

SG::WriteDecorHandleKey<xAOD::EgammaContainer> CP::PhotonPointingTool::m_HPV_zvertex

private

Definition at line 54 of file PhotonPointingTool.h.

m_HPV_zvertexDecorName

std::string CP::PhotonPointingTool::m_HPV_zvertexDecorName

private

Definition at line 65 of file PhotonPointingTool.h.

m_inputMetaStore

MetaStore_t asg::AsgMetadataTool::m_inputMetaStore

privateinherited

Object accessing the input metadata store.

Definition at line 119 of file AsgMetadataTool.h.

m_isMC

bool CP::PhotonPointingTool::m_isMC {}

private

Definition at line 61 of file PhotonPointingTool.h.

{};

m_outputMetaStore

MetaStore_t asg::AsgMetadataTool::m_outputMetaStore

privateinherited

Object accessing the output metadata store.

Definition at line 121 of file AsgMetadataTool.h.

m_useIncidents

bool asg::AsgMetadataTool::m_useIncidents

privateinherited

Definition at line 128 of file AsgMetadataTool.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.

m_zCorrection

TH1F* CP::PhotonPointingTool::m_zCorrection

private

Create a proper constructor for Athena.

Correction histogram

Definition at line 42 of file PhotonPointingTool.h.

m_zOscFileData

std::string CP::PhotonPointingTool::m_zOscFileData

private

Definition at line 62 of file PhotonPointingTool.h.

m_zOscFileMC

std::string CP::PhotonPointingTool::m_zOscFileMC

private

Definition at line 62 of file PhotonPointingTool.h.

m_zvertex

SG::WriteDecorHandleKey<xAOD::EgammaContainer> CP::PhotonPointingTool::m_zvertex

private

Definition at line 52 of file PhotonPointingTool.h.

m_zvertexDecorName

std::string CP::PhotonPointingTool::m_zvertexDecorName

private

Definition at line 63 of file PhotonPointingTool.h.

---

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

• PhotonPointingTool.h
• PhotonPointingTool.cxx