Normalizing Flows-based correction tool for photon MC shower shape variables. More...

#include <ElectronPhotonVariableNFCorrectionTool.h>

Inheritance diagram for ElectronPhotonVariableNFCorrectionTool:

Collaboration diagram for ElectronPhotonVariableNFCorrectionTool:

Classes
struct	SSAccessors
	Accessor used to decorate photons per shower shape variable. More...

Public Member Functions
	ElectronPhotonVariableNFCorrectionTool (const std::string &name)
	Standard constructor.
	~ElectronPhotonVariableNFCorrectionTool ()
	Standard destructor.
virtual StatusCode	initialize () override
	Initialize the class instance.
virtual const CP::CorrectionCode	applyCorrection (xAOD::Photon &photon) const override
	Apply the Normalizing Flow correction to the passed photon.
virtual const CP::CorrectionCode	applyCorrection (xAOD::Electron &electron) const override
	Not supported, so electrons cannot be corrected by this tool.
virtual const CP::CorrectionCode	correctedCopy (const xAOD::Photon &in_photon, xAOD::Photon *&out_photon) const override
	Make a corrected copy of the passed photon.
virtual const CP::CorrectionCode	correctedCopy (const xAOD::Electron &in_electron, xAOD::Electron *&out_electron) const override
	Not supported, so electrons cannot be corrected by this tool.
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
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Private Types
enum class	ApplyToMode { TruthPhotons , All }
	NF will be applied only for TruthPhotons, or for All photons. More...
enum class	FoldStrategy { Unknown , EventNumber , EventNumberPhi }
	Fold selection strategy. More...
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
bool	passPhotonSelection (const xAOD::Photon &photon) const
	Returns true if the photon passes the pT and truthType selection.
bool	passShowerShapeCuts (const std::vector< float > &ss) const
	Returns true if the shower shapes pass the cuts removing default values.
CP::CorrectionCode	applyFallbackFudge (xAOD::Photon &photon, const std::vector< float > &ss) const
	Apply the fallback fudge tool to a photon failing only the shower shape cuts.
int	selectFold (unsigned long long eventNumber, float phi) const
	Select fold index for the current event/photon.
FoldStrategy	parseFoldStrategy (const std::string &s) const
	Parse fold strategy string from config.
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
Gaudi::Property< std::string >	m_configFile {this, "ConfigFile", "", "The configuration file for Normalizing Flows to use"}
	The configuration file for the tool, application mode and minimum photon pT cut in MeV.
Gaudi::Property< int >	m_nFoldsOverride {this, "NFoldsOverride", -1, "If > 0, override the number of folds to use instead of the value from the config file (must not exceed NFolds in the config)"}
Gaudi::Property< std::string >	m_applyToStr {this, "ApplyTo", "TruthPhotons", "TruthPhotons or All"}
Gaudi::Property< float >	m_pTcutMeV {this, "pTcut", 10000.f, "Min photon pT in MeV"}
int	m_nFolds {0}
	Number of model folds configured (must match tool handle array sizes).
std::string	m_onnxPattern
	Models path pattern string from config.
SG::ReadHandleKey< xAOD::EventInfo >	m_eventInfoKey {this, "EventInfoKey", "EventInfo", "EventInfo key"}
	ReadHandleKey for EventInfo used for fold selection.
ApplyToMode	m_applyToMode {ApplyToMode::TruthPhotons}
bool	m_applyShowerShapeCuts {true}
	Cuts applied to remove default values of shower shapes.
ToolHandle< IElectronPhotonShowerShapeFudgeTool >	m_fallbackFudgeTool {this, "FallbackFudgeTool", "", "Fudge tool applied to photons which fail the shower shape cuts"}
	Fudge tool used for photons failing the shower shape cuts, empty = no fallback.
FoldStrategy	m_foldStrategy {FoldStrategy::EventNumber}
	Selected fold strategy (configured via FoldStrategy in the config).
ToolHandleArray< AthOnnx::IOnnxRuntimeInferenceTool >	m_onnxToolsForward {this, "OnnxInferenceToolsForward", {}, "Forward ONNX tools per fold"}
	ToolHandleArray for forward ONNX models (one tool per fold).
ToolHandleArray< AthOnnx::IOnnxRuntimeInferenceTool >	m_onnxToolsBackward {this, "OnnxInferenceToolsBackward", {}, "Backward ONNX tools per fold"}
	ToolHandleArray for backward ONNX models (one tool per fold).
std::vector< SSAccessors >	m_accessors
	Per-variable accessors aligned with s_ssVarNames.
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

Static Private Attributes
static constexpr float	s_defaultValueThreshold = -100.f
	Original values of weta1 and wtots1 below this threshold are default values and are not fudged.
static const std::vector< std::string >	s_ssVarNames
	List of shower shape variable names (order must match model I/O).
static const std::vector< xAOD::EgammaParameters::ShowerShapeType >	s_ssEnums
	Egamma shower shape enum mapping for reading/writing values (order matches s_ssVarNames).

Detailed Description

Normalizing Flows-based correction tool for photon MC shower shape variables.

The tool applies a two-step NF mapping using ONNX Runtime inference:

Forward model: maps shower shape tenzor -> latent representation (z)
Backward model: maps latent representation (z) -> corrected shower shape tenzor

The correction is applied to the photon shower shape variables listed in s_ssVarNames (the order should correspond to order in a model).

The ONNX models are provided per-fold via ToolHandleArray, and the fold is selected event-by-event using EventInfo::eventNumber() (optionally including phi).

Author: Katerina Kazakova kater.nosp@m.ina..nosp@m.kazak.nosp@m.ova@.nosp@m.cern..nosp@m.ch

Date: February 2026

Definition at line 53 of file ElectronPhotonVariableNFCorrectionTool.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 376 of file AthCommonDataStore.h.

Member Enumeration Documentation

◆ ApplyToMode

enum class ElectronPhotonVariableNFCorrectionTool::ApplyToMode

strongprivate

NF will be applied only for TruthPhotons, or for All photons.

Enumerator
TruthPhotons
All

Definition at line 120 of file ElectronPhotonVariableNFCorrectionTool.h.

120{ TruthPhotons, All };

PUClassification.All

int All

Definition PUClassification.py:17

◆ FoldStrategy

enum class ElectronPhotonVariableNFCorrectionTool::FoldStrategy

strongprivate

Fold selection strategy.

EventNumber : fold = eventNumber % NFolds
EventNumberPhi : fold = (eventNumber + floor((phi + pi)*100)) % NFolds

Enumerator
Unknown
EventNumber
EventNumberPhi

Definition at line 148 of file ElectronPhotonVariableNFCorrectionTool.h.

148{ Unknown, EventNumber, EventNumberPhi };

Unknown

struct TBPatternUnitContext Unknown

sct_calib_tf.EventNumber

int EventNumber

Definition sct_calib_tf.py:29

Constructor & Destructor Documentation

◆ ElectronPhotonVariableNFCorrectionTool()

ElectronPhotonVariableNFCorrectionTool::ElectronPhotonVariableNFCorrectionTool ( const std::string & name )

Standard constructor.

Parameters

name	Internal name of the tool instance

Definition at line 43 of file ElectronPhotonVariableNFCorrectionTool.cxx.

                                                                                                    :
    AsgTool(name)
{}

◆ ~ElectronPhotonVariableNFCorrectionTool()

ElectronPhotonVariableNFCorrectionTool::~ElectronPhotonVariableNFCorrectionTool ( )

inline

Standard destructor.

Definition at line 65 of file ElectronPhotonVariableNFCorrectionTool.h.

65{};

Member Function Documentation

◆ applyCorrection() [1/2]

const CP::CorrectionCode ElectronPhotonVariableNFCorrectionTool::applyCorrection ( xAOD::Electron & electron ) const

overridevirtual

Not supported, so electrons cannot be corrected by this tool.

Implements IElectronPhotonShowerShapeFudgeTool.

Definition at line 419 of file ElectronPhotonVariableNFCorrectionTool.cxx.

{
    ATH_MSG_ERROR("ElectronPhotonVariableNFCorrectionTool does not support electrons.");
    return CP::CorrectionCode::Error;
}

◆ applyCorrection() [2/2]

const CP::CorrectionCode ElectronPhotonVariableNFCorrectionTool::applyCorrection ( xAOD::Photon & photon ) const

overridevirtual

Apply the Normalizing Flow correction to the passed photon.

Parameters

photon The photon to be corrected

Reads the configured shower-shape variables from the photon, runs forward and backward ONNX inference for the selected fold, and overwrites the photon shower-shape values with the corrected outputs.

Implements IElectronPhotonShowerShapeFudgeTool.

Definition at line 255 of file ElectronPhotonVariableNFCorrectionTool.cxx.

{
 
    const size_t nSS = s_ssEnums.size();
    std::vector<float> ss(nSS);
 
    // Read shower shapes, then store original values
    for (size_t i = 0; i < nSS; ++i) {
        ss[i] = photon.showerShapeValue(s_ssEnums[i]);
        (*m_accessors[i].original)(photon) = ss[i];
    }
 
 
    static const SG::Decorator<char> dec_pass("NFCorrectedShowerShapes");
    static const SG::Decorator<char> dec_fudged("FallbackFudgedShowerShapes");
 
    // Photon selection
    const bool passPhoton = passPhotonSelection(photon);
    const bool passSS = passPhoton && passShowerShapeCuts(ss);
    const bool fallback = passPhoton && !passSS && !m_fallbackFudgeTool.empty();
 
    dec_pass(photon) = passSS ? 1 : 0;
    dec_fudged(photon) = fallback ? 1 : 0;
 
    if (fallback) {
        // NF is not applied because of the shower shape cuts, so use fudging instead
        return applyFallbackFudge(photon, ss);
    }
 
    if (!passSS) {
        // If selection is not passed, then SS value will be same to original
        return CP::CorrectionCode::Ok;
    }
 
    
    // Get event info and select fold
    SG::ReadHandle<xAOD::EventInfo> h(m_eventInfoKey);
    if (!h.isValid()) {
        ATH_MSG_ERROR("Failed to read EventInfo via key " << m_eventInfoKey.key());
        return CP::CorrectionCode::Error;
    }
 
    const unsigned long long eventNumber = h->eventNumber();
    float ptGeV = photon.pt() / 1000.0f;
    const float phi = static_cast<float>(photon.phi());
    const int fold = selectFold(eventNumber, phi);
 
 
    if (fold < 0 || fold >= m_nFolds) {
        ATH_MSG_ERROR("Selected fold " << fold << " out of range [0," << (m_nFolds-1) << "]");
        return CP::CorrectionCode::Error;
    }
 
 
    // Kinematic inputs
    const bool isConv = photon.conversionType() != xAOD::EgammaParameters::unconverted;
    std::vector<float> kinematic = {
        ptGeV,
        static_cast<float>(photon.eta()),
        static_cast<float>(photon.phi()),
        static_cast<float>(isConv)
    };
 
    // Forward inference
    std::vector<Ort::Value> inputTensors;
 
    const auto& onnxToolForward = m_onnxToolsForward[fold];
 
    // index 0 is for kinematics
    int64_t batchSizeKin = onnxToolForward->getBatchSize(
        static_cast<int64_t>(kinematic.size()), 0);
    if (onnxToolForward->addInput(inputTensors, kinematic, 0, batchSizeKin).isFailure()) {
        ATH_MSG_ERROR("Fold " << fold << ": failed to add kinematic input tensor");
        return CP::CorrectionCode::Error;
    }
 
    // index 1 is for shower shape varibales
    int64_t batchSizeSS = onnxToolForward->getBatchSize(
        static_cast<int64_t>(ss.size()), 1);
    if (onnxToolForward->addInput(inputTensors, ss, 1, batchSizeSS).isFailure()) {
        ATH_MSG_ERROR("Fold " << fold << ": failed to add shower shape input tensor");
        return CP::CorrectionCode::Error;
    }
 
    std::vector<Ort::Value> outputTensors;
    std::vector<float> outputData;
    if (onnxToolForward->addOutput(outputTensors, outputData, 0, batchSizeKin).isFailure()) {
        ATH_MSG_ERROR("Fold " << fold << ": failed to add forward output tensor");
        return CP::CorrectionCode::Error;
    }
 
    if (onnxToolForward->inference(inputTensors, outputTensors).isFailure()) {
        ATH_MSG_ERROR("Fold " << fold << ": forward inference failed");
        return CP::CorrectionCode::Error;
    }
 
    float* zPtr = outputTensors[0].GetTensorMutableData<float>();
    std::vector<float> zVec(zPtr, zPtr + nSS);
 
 
    // Backward inference
    std::vector<Ort::Value> inputTensorsBack;
    std::vector<Ort::Value> outputTensorsBack;
    std::vector<float> outputDataBack;
 
    const auto& onnxToolBackward = m_onnxToolsBackward[fold];
 
    // index 0 is for kinematics
    int64_t batchSizeKinBack = onnxToolBackward->getBatchSize(
        static_cast<int64_t>(kinematic.size()), 0);
    if (onnxToolBackward->addInput(inputTensorsBack, kinematic, 0, batchSizeKinBack).isFailure()) {
        ATH_MSG_ERROR("Fold " << fold << ": failed to add kinematic input tensor for backward model");
        return CP::CorrectionCode::Error;
    }
 
    // index 1 is for shower shapes in latent space
    int64_t batchSizeZBack = onnxToolBackward->getBatchSize(static_cast<int64_t>(zVec.size()), 1);
 
    if (onnxToolBackward->addInput(inputTensorsBack, zVec, 1, batchSizeZBack).isFailure()) {
        ATH_MSG_ERROR("Fold " << fold << ": failed to add z input tensor for backward model");
        return CP::CorrectionCode::Error;
    }
 
    // index 2 is for original shower shapes (models use them to cut on std values [-5, 5])
    if (onnxToolBackward->addInput(inputTensorsBack, ss, 2, batchSizeKinBack).isFailure()) {
        ATH_MSG_ERROR("Fold " << fold << ": failed to add original SS input tensor for backward model");
        return CP::CorrectionCode::Error;
    }
 
    if (onnxToolBackward->addOutput(outputTensorsBack, outputDataBack, 0, batchSizeZBack).isFailure()) {
        ATH_MSG_ERROR("Fold " << fold << ": failed to add backward output tensor");
        return CP::CorrectionCode::Error;
    }
 
    if (onnxToolBackward->inference(inputTensorsBack, outputTensorsBack).isFailure()) {
        ATH_MSG_ERROR("Fold " << fold << ": backward inference failed");
        return CP::CorrectionCode::Error;
    }
 
    const auto infoB  = outputTensorsBack[0].GetTensorTypeAndShapeInfo();
    const auto nElB = infoB.GetElementCount();
    if (nElB != nSS) {
        ATH_MSG_ERROR("Fold "<<fold <<": backward output has " <<nElB<< " elements, expected "<<nSS);
        return CP::CorrectionCode::Error;
    }
 
    // Write corrected shower shapes
    float* corrPtr = outputTensorsBack[0].GetTensorMutableData<float>();
    for (size_t i = 0; i < nSS; ++i) {
        photon.setShowerShapeValue(corrPtr[i], s_ssEnums[i]);
    }
 
    // Keep fracs1 (index 8) = 0 untouched (NF smears it)
    if (ss[8] == 0.f) {
        photon.setShowerShapeValue(0.f, s_ssEnums[8]);
    }
 
    ATH_MSG_DEBUG("NF correction applied successfully");
 
 
    return CP::CorrectionCode::Ok;
}

◆ applyFallbackFudge()

CP::CorrectionCode ElectronPhotonVariableNFCorrectionTool::applyFallbackFudge	(	xAOD::Photon &	photon,
		const std::vector< float > &	ss ) const

private

Apply the fallback fudge tool to a photon failing only the shower shape cuts.

weta1 and wtots1 are kept at their original values if these are below s_defaultValueThreshold

Definition at line 121 of file ElectronPhotonVariableNFCorrectionTool.cxx.

{
    if (m_fallbackFudgeTool->applyCorrection(photon) != CP::CorrectionCode::Ok) {
        ATH_MSG_ERROR("Fallback fudge tool failed to correct photon");
        return CP::CorrectionCode::Error;
    }
 
    // Keep default values of weta1 (index 1) and wtots1 (index 4) untouched
    for (size_t i : {size_t(1), size_t(4)}) {
        if (ss[i] < s_defaultValueThreshold) {
            photon.setShowerShapeValue(ss[i], s_ssEnums[i]);
        }
    }
    // Keep fracs1 (index 8) = 0 untouched (fudging smears it)
    if (ss[8] == 0.f) {
        photon.setShowerShapeValue(0.f, s_ssEnums[8]);
    }
 
    ATH_MSG_DEBUG("Photon failed shower shape cuts: fallback fudge correction applied");
    return CP::CorrectionCode::Ok;
}

◆ correctedCopy() [1/2]

const CP::CorrectionCode ElectronPhotonVariableNFCorrectionTool::correctedCopy	(	const xAOD::Electron &	in_electron,
		xAOD::Electron *&	out_electron ) const

overridevirtual

Not supported, so electrons cannot be corrected by this tool.

Implements IElectronPhotonShowerShapeFudgeTool.

Definition at line 435 of file ElectronPhotonVariableNFCorrectionTool.cxx.

{
    ATH_MSG_ERROR("ElectronPhotonVariableNFCorrectionTool cannot correct electrons.");
    out_electron = new xAOD::Electron(in_electron);
    return CP::CorrectionCode::Error;
}

◆ correctedCopy() [2/2]

const CP::CorrectionCode ElectronPhotonVariableNFCorrectionTool::correctedCopy	(	const xAOD::Photon &	in_photon,
		xAOD::Photon *&	out_photon ) const

overridevirtual

Make a corrected copy of the passed photon.

Parameters

in_photon	The original photon to copy
out_photon	The corrected copy

Implements IElectronPhotonShowerShapeFudgeTool.

Definition at line 426 of file ElectronPhotonVariableNFCorrectionTool.cxx.

{
 
    out_photon = new xAOD::Photon(in_photon);
    return applyCorrection(*out_photon);
}

◆ 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:381

◆ 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:378

◆ 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::Event 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::Event, 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::Event 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::Event, 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 ElectronPhotonVariableNFCorrectionTool::initialize ( void )

overridevirtual

Initialize the class instance.

Reads the configuration file set via setProperty("ConfigFile", ...) function and sets up the class instance accordingly.

The configuration provides:

SimulationType: FS/AF3
NFolds: number of folds (must match number of ONNX tools configured)
ONNXnamePattern: pattern string (informational; tool arrays are configured externally)
FoldStrategy: eventNumber or eventNumber_phi
ApplyTo: TruthPhotons/All

Reimplemented from asg::AsgTool.

Definition at line 147 of file ElectronPhotonVariableNFCorrectionTool.cxx.

{
    if (m_configFile.empty()) {
        ATH_MSG_ERROR("ConfigFile property is empty. Please provide a config file to the tool.");
        return StatusCode::FAILURE;
    }
 
    std::string resolvedConfig = PathResolverFindCalibFile(m_configFile);
    if (resolvedConfig.empty()) {
        ATH_MSG_ERROR("Failed to resolve config file \"" << m_configFile << "\"");
        return StatusCode::FAILURE;
    }
    ATH_MSG_DEBUG("Use configuration file " << m_configFile);
 
    TEnv env;
    env.ReadFile(resolvedConfig.c_str(), kEnvLocal);
    env.IgnoreDuplicates(false);
 
    const int nFoldsConfig = env.GetValue("NFolds", 0);
    if (nFoldsConfig <= 0) {
        ATH_MSG_ERROR("NFolds not set or invalid in config: " << resolvedConfig);
        return StatusCode::FAILURE;
    }
 
    if (m_nFoldsOverride > 0) {
        if (m_nFoldsOverride > nFoldsConfig) {
            ATH_MSG_ERROR("NFoldsOverride (" << m_nFoldsOverride.value() << ") exceeds NFolds in config (" << nFoldsConfig << ")");
            return StatusCode::FAILURE;
        }
        m_nFolds = m_nFoldsOverride;
    } else {
        m_nFolds = nFoldsConfig;
    }
 
    TString pattern = env.GetValue("ONNXnamePattern", "");
    if (pattern.IsNull()) {
        ATH_MSG_ERROR("ONNXnamePattern not set in config: " << resolvedConfig);
        return StatusCode::FAILURE;
    }
    m_onnxPattern = pattern.Data();
 
 
    TString fs = env.GetValue("FoldStrategy", "eventNumber");
    std::string fsStr = fs.Data();
 
    m_foldStrategy = parseFoldStrategy(fsStr);
 
    if (m_foldStrategy == FoldStrategy::Unknown) {
        ATH_MSG_ERROR("FoldStrategy must be 'eventNumber' or 'eventNumber_phi', but got '" << fsStr << "' in config: " << resolvedConfig);
        return StatusCode::FAILURE;
    }
 
 
    ATH_MSG_VERBOSE("NFolds = " << m_nFolds << ", pattern = " << m_onnxPattern << ", FoldStrategy = " << fsStr);
 
    if (static_cast<int>(m_onnxToolsForward.size()) != m_nFolds ||
        static_cast<int>(m_onnxToolsBackward.size()) != m_nFolds) {
        ATH_MSG_ERROR("Expected "<<m_nFolds<<" forward/backward tools, "<< "but got "<<m_onnxToolsForward.size()<<" / "<< m_onnxToolsBackward.size());
        return StatusCode::FAILURE;
    }
 
 
    if (m_applyToStr == "TruthPhotons") m_applyToMode = ApplyToMode::TruthPhotons;
    else if (m_applyToStr == "All") m_applyToMode = ApplyToMode::All;
    else {
        ATH_MSG_ERROR("ApplyTo must be TruthPhotons or All, but got '" << m_applyToStr << "'");
        return StatusCode::FAILURE;
    }
 
    // Cuts on SS vars to remove default values
    m_applyShowerShapeCuts = (env.GetValue("ApplyShowerShapeCuts", 1) == 1);
 
    ATH_MSG_INFO("ApplyTo = " << m_applyToStr << ", pTcut=" << m_pTcutMeV << " MeV, ApplyShowerShapeCuts=" << m_applyShowerShapeCuts);
 
 
    ATH_CHECK(m_onnxToolsForward.retrieve());
    ATH_CHECK(m_onnxToolsBackward.retrieve());
 
    if (!m_fallbackFudgeTool.empty()) {
        ATH_CHECK(m_fallbackFudgeTool.retrieve());
        ATH_MSG_INFO("Photons failing shower shape cuts will be corrected with fallback fudge tool " << m_fallbackFudgeTool.name());
    }
 
    if (msgLvl(MSG::DEBUG)) {
        for (int i = 0; i < m_nFolds; ++i) {
            ATH_MSG_VERBOSE("Fold " << i << " forward model info:");
            m_onnxToolsForward[i]->printModelInfo();
            ATH_MSG_VERBOSE("Fold " << i << " backward model info:");
            m_onnxToolsBackward[i]->printModelInfo();
        }
    }
 
    // Prepare decorations for each shower shape
    m_accessors.resize(s_ssVarNames.size());
    for (size_t i = 0; i < s_ssVarNames.size(); ++i) {
        const std::string& var = s_ssVarNames[i];
            m_accessors[i].original = std::make_unique<SG::Accessor<float>>(var + "_original");
    }
 
    ATH_CHECK(m_eventInfoKey.initialize());
 
    ATH_MSG_INFO("NF correction tool initialized with " << m_nFolds << " folds. ");
 
    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.

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

◆ parseFoldStrategy()

ElectronPhotonVariableNFCorrectionTool::FoldStrategy ElectronPhotonVariableNFCorrectionTool::parseFoldStrategy ( const std::string & s ) const

private

Parse fold strategy string from config.

Definition at line 64 of file ElectronPhotonVariableNFCorrectionTool.cxx.

{
    if (s == "eventNumber") return FoldStrategy::EventNumber;
    if (s == "eventNumber_phi") return FoldStrategy::EventNumberPhi;
    ATH_MSG_WARNING("Unknown FoldStrategy '" << s << "'");
    return FoldStrategy::Unknown;
}

◆ passPhotonSelection()

bool ElectronPhotonVariableNFCorrectionTool::passPhotonSelection ( const xAOD::Photon & photon ) const

private

Returns true if the photon passes the pT and truthType selection.

Definition at line 72 of file ElectronPhotonVariableNFCorrectionTool.cxx.

{
    // pT cut
    if (photon.pt() < m_pTcutMeV) return false;
 
    // TruthType cut
    if (m_applyToMode == ApplyToMode::TruthPhotons) {
        static const SG::Accessor<int> acc_truthType("truthType");
        if (!acc_truthType.isAvailable(photon)) {
            ATH_MSG_WARNING("ApplyTo = TruthPhotons but truthType not available — skipping photon");
            return false;
        }
        int truthType = acc_truthType(photon);
        if (truthType < 13 || truthType > 15) return false;
    }
 
    return true;
}

◆ passShowerShapeCuts()

bool ElectronPhotonVariableNFCorrectionTool::passShowerShapeCuts ( const std::vector< float > & ss ) const

private

Returns true if the shower shapes pass the cuts removing default values.

Definition at line 91 of file ElectronPhotonVariableNFCorrectionTool.cxx.

{
    if (!m_applyShowerShapeCuts) return true;
 
    // weta2
    if (ss[0] <= -10.f || ss[0] >= 10.f) return false;
    // weta1
    if (ss[1] <= -10.f || ss[1] >= 10.f) return false;
    // Rphi
    if (ss[2] <= -10.f || ss[2] >= 10.f) return false;
    // Reta
    if (ss[3] <= -10.f || ss[3] >= 10.f) return false;
    // wtots1
    if (ss[4] < -2.f || ss[4] >= 10.f) return false;
    // Rhad
    if (ss[5] < -2.f || ss[5] > 2.f) return false;
    // Rhad1
    if (ss[6] < -2.f || ss[6] > 2.f) return false;
    // f1
    if (ss[7] <= -2.f || ss[7] >= 2.f) return false;
    // fracs1
    if (ss[8] <= -2.f || ss[8] >= 5.f) return false;
    // DeltaE
    if (ss[9] < 0.f || ss[9] >= 5000.f) return false;
    // Eratio
    if (ss[10] < 0.f || ss[10] > 1.f) return false;
 
    return true;
}

◆ 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, and KtDeltaRTool.

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 368 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 352 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ selectFold()

int ElectronPhotonVariableNFCorrectionTool::selectFold	(	unsigned long long	eventNumber,
		float	phi ) const

private

Select fold index for the current event/photon.

Parameters

eventNumber	EventInfo::eventNumber()
phi	Photon phi in radians

Returns: Fold index in [0, NFolds-1]

Definition at line 48 of file ElectronPhotonVariableNFCorrectionTool.cxx.

{
    if (m_nFolds <= 1) return 0;
 
    unsigned long long key = eventNumber;
 
    if (m_foldStrategy == FoldStrategy::EventNumberPhi) {
        const long long phiBin = static_cast<long long>(std::floor((phi + static_cast<float>(M_PI)) * 100.0f));
        key = eventNumber + static_cast<unsigned long long>(phiBin);
    }
 
    return static_cast<int>(key % m_nFolds);
}

◆ 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 298 of file AthCommonDataStore.h.

                                               {
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

◆ m_accessors

std::vector<SSAccessors> ElectronPhotonVariableNFCorrectionTool::m_accessors

private

Per-variable accessors aligned with s_ssVarNames.

Definition at line 180 of file ElectronPhotonVariableNFCorrectionTool.h.

◆ m_applyShowerShapeCuts

bool ElectronPhotonVariableNFCorrectionTool::m_applyShowerShapeCuts {true}

private

Cuts applied to remove default values of shower shapes.

Definition at line 124 of file ElectronPhotonVariableNFCorrectionTool.h.

124{true};

◆ m_applyToMode

ApplyToMode ElectronPhotonVariableNFCorrectionTool::m_applyToMode {ApplyToMode::TruthPhotons}

private

Definition at line 121 of file ElectronPhotonVariableNFCorrectionTool.h.

121{ApplyToMode::TruthPhotons};

◆ m_applyToStr

Gaudi::Property<std::string> ElectronPhotonVariableNFCorrectionTool::m_applyToStr {this, "ApplyTo", "TruthPhotons", "TruthPhotons or All"}

private

Definition at line 107 of file ElectronPhotonVariableNFCorrectionTool.h.

107{this, "ApplyTo", "TruthPhotons", "TruthPhotons or All"};

◆ m_configFile

Gaudi::Property<std::string> ElectronPhotonVariableNFCorrectionTool::m_configFile {this, "ConfigFile", "", "The configuration file for Normalizing Flows to use"}

private

The configuration file for the tool, application mode and minimum photon pT cut in MeV.

Definition at line 105 of file ElectronPhotonVariableNFCorrectionTool.h.

105{this, "ConfigFile", "", "The configuration file for Normalizing Flows to use"};

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default).

Definition at line 381 of file AthCommonDataStore.h.

◆ m_eventInfoKey

SG::ReadHandleKey<xAOD::EventInfo> ElectronPhotonVariableNFCorrectionTool::m_eventInfoKey {this, "EventInfoKey", "EventInfo", "EventInfo key"}

private

ReadHandleKey for EventInfo used for fold selection.

Definition at line 117 of file ElectronPhotonVariableNFCorrectionTool.h.

117{this, "EventInfoKey", "EventInfo", "EventInfo key"};

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default).

Definition at line 378 of file AthCommonDataStore.h.

◆ m_fallbackFudgeTool

ToolHandle<IElectronPhotonShowerShapeFudgeTool> ElectronPhotonVariableNFCorrectionTool::m_fallbackFudgeTool {this, "FallbackFudgeTool", "", "Fudge tool applied to photons which fail the shower shape cuts"}

private

Fudge tool used for photons failing the shower shape cuts, empty = no fallback.

Definition at line 138 of file ElectronPhotonVariableNFCorrectionTool.h.

138{this, "FallbackFudgeTool", "", "Fudge tool applied to photons which fail the shower shape cuts"};

◆ m_foldStrategy

FoldStrategy ElectronPhotonVariableNFCorrectionTool::m_foldStrategy {FoldStrategy::EventNumber}

private

Selected fold strategy (configured via FoldStrategy in the config).

Definition at line 151 of file ElectronPhotonVariableNFCorrectionTool.h.

151{FoldStrategy::EventNumber};

◆ m_nFolds

int ElectronPhotonVariableNFCorrectionTool::m_nFolds {0}

private

Number of model folds configured (must match tool handle array sizes).

Definition at line 111 of file ElectronPhotonVariableNFCorrectionTool.h.

111{0};

◆ m_nFoldsOverride

Gaudi::Property<int> ElectronPhotonVariableNFCorrectionTool::m_nFoldsOverride {this, "NFoldsOverride", -1, "If > 0, override the number of folds to use instead of the value from the config file (must not exceed NFolds in the config)"}

private

Definition at line 106 of file ElectronPhotonVariableNFCorrectionTool.h.

106{this, "NFoldsOverride", -1, "If > 0, override the number of folds to use instead of the value from the config file (must not exceed NFolds in the config)"};

◆ m_onnxPattern

std::string ElectronPhotonVariableNFCorrectionTool::m_onnxPattern

private

Models path pattern string from config.

Definition at line 114 of file ElectronPhotonVariableNFCorrectionTool.h.

◆ m_onnxToolsBackward

ToolHandleArray<AthOnnx::IOnnxRuntimeInferenceTool> ElectronPhotonVariableNFCorrectionTool::m_onnxToolsBackward {this, "OnnxInferenceToolsBackward", {}, "Backward ONNX tools per fold"}

private

ToolHandleArray for backward ONNX models (one tool per fold).

Definition at line 166 of file ElectronPhotonVariableNFCorrectionTool.h.

166{this, "OnnxInferenceToolsBackward", {}, "Backward ONNX tools per fold"};

◆ m_onnxToolsForward

ToolHandleArray<AthOnnx::IOnnxRuntimeInferenceTool> ElectronPhotonVariableNFCorrectionTool::m_onnxToolsForward {this, "OnnxInferenceToolsForward", {}, "Forward ONNX tools per fold"}

private

ToolHandleArray for forward ONNX models (one tool per fold).

Definition at line 164 of file ElectronPhotonVariableNFCorrectionTool.h.

164{this, "OnnxInferenceToolsForward", {}, "Forward ONNX tools per fold"};

◆ m_pTcutMeV

Gaudi::Property<float> ElectronPhotonVariableNFCorrectionTool::m_pTcutMeV {this, "pTcut", 10000.f, "Min photon pT in MeV"}

private

Definition at line 108 of file ElectronPhotonVariableNFCorrectionTool.h.

108{this, "pTcut", 10000.f, "Min photon pT in MeV"};

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 387 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 386 of file AthCommonDataStore.h.

◆ s_defaultValueThreshold

float ElectronPhotonVariableNFCorrectionTool::s_defaultValueThreshold = -100.f

staticconstexprprivate

Original values of weta1 and wtots1 below this threshold are default values and are not fudged.

Definition at line 141 of file ElectronPhotonVariableNFCorrectionTool.h.

◆ s_ssEnums

const std::vector< xAOD::EgammaParameters::ShowerShapeType > ElectronPhotonVariableNFCorrectionTool::s_ssEnums

staticprivate

Initial value:

                                                                    = {
    xAOD::EgammaParameters::weta2,
    xAOD::EgammaParameters::weta1,
    xAOD::EgammaParameters::Rphi,
    xAOD::EgammaParameters::Reta,
    xAOD::EgammaParameters::wtots1,
    xAOD::EgammaParameters::Rhad,
    xAOD::EgammaParameters::Rhad1,
    xAOD::EgammaParameters::f1,
    xAOD::EgammaParameters::fracs1,
    xAOD::EgammaParameters::DeltaE,
    xAOD::EgammaParameters::Eratio
}

Egamma shower shape enum mapping for reading/writing values (order matches s_ssVarNames).

Definition at line 27 of file ElectronPhotonVariableNFCorrectionTool.h.

◆ s_ssVarNames

const std::vector< std::string > ElectronPhotonVariableNFCorrectionTool::s_ssVarNames

staticprivate

Initial value:

                                                                       = {
    "weta2", "weta1", "Rphi", "Reta", "wtots1", "Rhad",  "Rhad1", "f1", "fracs1", "DeltaE", "Eratio"
}

List of shower shape variable names (order must match model I/O).

Definition at line 22 of file ElectronPhotonVariableNFCorrectionTool.h.

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

Classes

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Member Enumeration Documentation

◆ ApplyToMode

◆ FoldStrategy

Constructor & Destructor Documentation

◆ ElectronPhotonVariableNFCorrectionTool()

◆ ~ElectronPhotonVariableNFCorrectionTool()

Member Function Documentation

◆ applyCorrection() [1/2]

◆ applyCorrection() [2/2]

◆ applyFallbackFudge()

◆ correctedCopy() [1/2]

◆ correctedCopy() [2/2]

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ getKey()

◆ getName()

◆ getProperty()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ parseFoldStrategy()

◆ passPhotonSelection()

◆ passShowerShapeCuts()

◆ print()

◆ renounce()

◆ renounceArray()

◆ selectFold()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_accessors

◆ m_applyShowerShapeCuts

◆ m_applyToMode

◆ m_applyToStr

◆ m_configFile

◆ m_detStore

◆ m_eventInfoKey

◆ m_evtStore

◆ m_fallbackFudgeTool

◆ m_foldStrategy

◆ m_nFolds

◆ m_nFoldsOverride

◆ m_onnxPattern

◆ m_onnxToolsBackward

◆ m_onnxToolsForward

◆ m_pTcutMeV

◆ m_varHandleArraysDeclared

◆ m_vhka

◆ s_defaultValueThreshold

◆ s_ssEnums

◆ s_ssVarNames