PFCellEOverPTool Class Reference

Class to store reference e/p mean and widths, as well as reference energy density radial profile fit parameters. More...

#include <PFCellEOverPTool.h>

Inheritance diagram for PFCellEOverPTool:

Collaboration diagram for PFCellEOverPTool:

Public Member Functions
	PFCellEOverPTool (const std::string &type, const std::string &name, const IInterface *parent)
	~PFCellEOverPTool ()
StatusCode	initialize ()
StatusCode	fillBinnedParameters (eflowEEtaBinnedParameters *binnedParameters) const
StatusCode	finalize ()
virtual StatusCode	intialize ()
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Static Public Member Functions
static const InterfaceID &	interfaceID ()

Protected Types
enum	E_BINS {   ENERGY_BIN_START = 0 , E001bin = ENERGY_BIN_START , E003point5bin = 1 , E010bin = 2 ,   E020bin = 3 , E032point5bin = 4 , E040bin = 5 , ENERGY_BIN_END = 6 }
enum	ETA_BINS {   ETA_BIN_START = 0 , eta050bin = ETA_BIN_START , eta100bin = 1 , eta150bin = 2 ,   eta250bin = 3 , eta350bin = 4 , eta450bin = 5 , ETA_BIN_END = 6 }
enum	SHAPE_PARAMS {   SHAPE_START = 0 , NORM1 = SHAPE_START , WIDTH1 = 1 , NORM2 = 2 ,   WIDTH2 = 3 , SHAPE_END = 4 }

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
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
std::vector< double >	m_energyBinLowerBoundaries
std::vector< double >	m_etaBinLowerBoundaries
std::vector< int >	m_firstIntBinLowerBoundaries
std::vector< int >	m_caloLayerBins
Gaudi::Property< std::string >	m_referenceFileLocation {this,"referenceFileLocation","","Location for e/p and cell ordering reference files"}
	Location for e/p and cell ordering reference files (set to null value so one cannot use a wrong reference silently)
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

Class to store reference e/p mean and widths, as well as reference energy density radial profile fit parameters.

The data is input to an eflowEEtaBinnedParameters object in the execute method. Stores data at the uncalibrated (EM) scale and is used by default. This inherits from IEFlowCellEOverPTool.

Definition at line 15 of file PFCellEOverPTool.h.

Member Typedef Documentation

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Enumeration Documentation

E_BINS

enum IEFlowCellEOverPTool::E_BINS

protectedinherited

Enumerator
ENERGY_BIN_START
E001bin
E003point5bin
E010bin
E020bin
E032point5bin
E040bin
ENERGY_BIN_END

Definition at line 45 of file IEFlowCellEOverPTool.h.

{ ENERGY_BIN_START = 0, E001bin = ENERGY_BIN_START, E003point5bin = 1, E010bin = 2, E020bin = 3, E032point5bin = 4, E040bin = 5, ENERGY_BIN_END = 6 };

ETA_BINS

enum IEFlowCellEOverPTool::ETA_BINS

protectedinherited

Enumerator
ETA_BIN_START
eta050bin
eta100bin
eta150bin
eta250bin
eta350bin
eta450bin
ETA_BIN_END

Definition at line 47 of file IEFlowCellEOverPTool.h.

{ ETA_BIN_START = 0, eta050bin = ETA_BIN_START, eta100bin = 1, eta150bin = 2, eta250bin = 3, eta350bin = 4, eta450bin = 5, ETA_BIN_END = 6};

SHAPE_PARAMS

enum IEFlowCellEOverPTool::SHAPE_PARAMS

protectedinherited

Enumerator
SHAPE_START
NORM1
WIDTH1
NORM2
WIDTH2
SHAPE_END

Definition at line 49 of file IEFlowCellEOverPTool.h.

{ SHAPE_START = 0, NORM1 = SHAPE_START, WIDTH1 = 1, NORM2 = 2, WIDTH2 = 3, SHAPE_END = 4 };

Constructor & Destructor Documentation

PFCellEOverPTool()

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

Definition at line 19 of file PFCellEOverPTool.cxx.

  : IEFlowCellEOverPTool(type, name, parent)
{
 
  declareInterface<IEFlowCellEOverPTool>(this);
 
}

~PFCellEOverPTool()

PFCellEOverPTool::~PFCellEOverPTool ( )

inline

Definition at line 21 of file PFCellEOverPTool.h.

{};

Member Function Documentation

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

fillBinnedParameters()

StatusCode PFCellEOverPTool::fillBinnedParameters ( eflowEEtaBinnedParameters * binnedParameters ) const

virtual

Implements IEFlowCellEOverPTool.

Definition at line 95 of file PFCellEOverPTool.cxx.

                                                                                                   {
 
  if (binnedParameters) {
 
    //The energy values in the json files are in GeV, but in athena we work in MeV
    //so the energy values used by binnedParameters are converted to MeV
    std::vector<double>  energyBinLowerBoundaries_GeV;
    for (auto energyBin : m_energyBinLowerBoundaries) energyBinLowerBoundaries_GeV.push_back(energyBin*Gaudi::Units::GeV);
    binnedParameters->initialise(energyBinLowerBoundaries_GeV, m_etaBinLowerBoundaries);
 
    std::string path;
    path = PathResolverFindCalibDirectory(m_referenceFileLocation);  
 
    std::ifstream inputFile_eoverp(path+"eOverP.json");
    nlohmann::json json_eoverp;
    inputFile_eoverp >> json_eoverp;  
 
    std::ifstream inputFile_cellOrdering(path+"cellOrdering.json");
    nlohmann::json json_cellOrdering;
    inputFile_cellOrdering >> json_cellOrdering;
 
    //Loop over energy, eta and first int bins
    //For each combination we set the e/p mean and width from the json file values
    int energyBinCounter = -1;
    for (auto thisEBin : m_energyBinLowerBoundaries){
      energyBinCounter++;
      std::stringstream currentEBinStream;
      currentEBinStream << std::fixed << std::setprecision(0) << thisEBin;
      std::string currentEBin = currentEBinStream.str();
      int etaBinCounter = -1;
      for (auto thisEtaBin : m_etaBinLowerBoundaries){
        etaBinCounter++;
        std::stringstream currentEtaBinStream;
        currentEtaBinStream << std::fixed << std::setprecision(1) << thisEtaBin;
        std::string currentEtaBin = currentEtaBinStream.str();
        for (auto thisFirstIntRegionBin_Int : m_firstIntBinLowerBoundaries){
          //enum version is used for the calls to binnedParameters APIs
          auto thisFirstIntRegionBin = static_cast<eflowFirstIntRegions::J1STLAYER>(thisFirstIntRegionBin_Int);
          //and string version is used to lookup values from the json file
          std::string currentFirstIntBin = std::to_string(thisFirstIntRegionBin_Int);
          std::string eOverPBin = "energyBinLowerBound_"+currentEBin+"_etaBinLowerBound_"+currentEtaBin+"_firstIntBinLowerBound_"+currentFirstIntBin;
          if (json_eoverp.contains(eOverPBin+"_mean")){     
            binnedParameters->setFudgeMean(energyBinCounter,etaBinCounter,thisFirstIntRegionBin,json_eoverp[eOverPBin+"_mean"]);
            ATH_MSG_DEBUG("Setting mean for bin " << eOverPBin << " to " << json_eoverp[eOverPBin+"_mean"]);
          }
          //DEBUG because this is expected to happen for some combinations (e.g HEC calo layers for tracks in the barrel)
          else ATH_MSG_DEBUG("No mean found for bin " << eOverPBin);
          if (json_eoverp.contains(eOverPBin+"_sigma")){
            binnedParameters->setFudgeStdDev(energyBinCounter,etaBinCounter,thisFirstIntRegionBin,json_eoverp[eOverPBin+"_sigma"]);
            ATH_MSG_DEBUG("Setting sigma for bin " << eOverPBin << " to " << json_eoverp[eOverPBin+"_sigma"]);
          }
          else ATH_MSG_DEBUG("No sigma found for bin " << eOverPBin);
          for (auto thisLayerBin : m_caloLayerBins){
            eflowCalo::LAYER thisLayerBinEnum = static_cast<eflowCalo::LAYER>(thisLayerBin);   
            std::string currentLayerBin = eflowCalo::name(thisLayerBinEnum);            
            std::string cellOrderingBin = eOverPBin + "_caloLayer_"+std::to_string(thisLayerBin);
            if (json_cellOrdering.contains(cellOrderingBin+"_norm1")){
              binnedParameters->setShapeParam(energyBinCounter,etaBinCounter,thisFirstIntRegionBin,thisLayerBinEnum,NORM1,json_cellOrdering[cellOrderingBin+"_norm1"]);
              ATH_MSG_DEBUG("Setting norm1 for bin " << cellOrderingBin << " to " << json_cellOrdering[cellOrderingBin+"_norm1"]);
            }
            else ATH_MSG_DEBUG("No norm1 found for bin " << cellOrderingBin);
            if (json_cellOrdering.contains(cellOrderingBin+"_sigma1")){
              binnedParameters->setShapeParam(energyBinCounter,etaBinCounter,thisFirstIntRegionBin,thisLayerBinEnum,WIDTH1,json_cellOrdering[cellOrderingBin+"_sigma1"]);
              ATH_MSG_DEBUG("Setting sigma1 for bin " << cellOrderingBin << " to " << json_cellOrdering[cellOrderingBin+"_sigma1"]);
            }
            else ATH_MSG_DEBUG("No sigma1 found for bin " << cellOrderingBin);
            if (json_cellOrdering.contains(cellOrderingBin+"_norm2")){
              binnedParameters->setShapeParam(energyBinCounter,etaBinCounter,thisFirstIntRegionBin,thisLayerBinEnum,NORM2,json_cellOrdering[cellOrderingBin+"_norm2"]);
              ATH_MSG_DEBUG("Setting norm2 for bin " << cellOrderingBin << " to " << json_cellOrdering[cellOrderingBin+"_norm2"]);
            }
            else ATH_MSG_DEBUG("No norm2 found for bin " << cellOrderingBin);
            if (json_cellOrdering.contains(cellOrderingBin+"_sigma2")){
              binnedParameters->setShapeParam(energyBinCounter,etaBinCounter,thisFirstIntRegionBin,thisLayerBinEnum,WIDTH2,json_cellOrdering[cellOrderingBin+"_sigma2"]);
              ATH_MSG_DEBUG("Setting sigma2 for bin " << cellOrderingBin << " to " << json_cellOrdering[cellOrderingBin+"_sigma2"]);
            }            
            else ATH_MSG_DEBUG("No sigma2 found for bin " << cellOrderingBin);
          }
        }
      }
    }    
  }
 
  return StatusCode::SUCCESS;
 
}

finalize()

StatusCode PFCellEOverPTool::finalize ( )

virtual

Reimplemented from IEFlowCellEOverPTool.

Definition at line 181 of file PFCellEOverPTool.cxx.

                                     {
  return StatusCode::SUCCESS;
}

initialize()

StatusCode PFCellEOverPTool::initialize

(

)

Definition at line 29 of file PFCellEOverPTool.cxx.

                                       {
 
  std::string path;
  path = PathResolverFindCalibDirectory(m_referenceFileLocation);
 
  ATH_MSG_INFO("Using reference file location " + path);
 
  std::ifstream binBoundariesFile(path+"binBoundaries.json");
  nlohmann::json json_binBoundaries;
  binBoundariesFile >> json_binBoundaries;
 
  //whilst for calo layers and first interaction regions we want to lookup the full set of bin values
  auto fillBinValues = [](auto && binBoundaries, const nlohmann::json &json_binBoundaries, const std::string &binName){
    if (json_binBoundaries.contains(binName)){
      for (auto binBoundary : json_binBoundaries[binName]) binBoundaries.push_back(binBoundary);
      return true;
    }
    else return false;
  };
  
  bool filledBins = false;
  std::string energyBinBoundaries = "energyBinBoundaries";
  std::string etaBinBoundaries = "etaBinBoundaries";
  std::string firstIntBinBoundaries = "firstIntBinBoundaries";
  std::string caloLayerBinBoundaries = "caloLayerBinBoundaries";
 
  //here we verify we can load in the bin boundaries - if not we return a FAILURE code
  //because particle flow cannot run correctly without these being loaded
  filledBins = fillBinValues(m_energyBinLowerBoundaries, json_binBoundaries, energyBinBoundaries);
  if (!filledBins) {
    ATH_MSG_ERROR("Could not bin boundaries in json file: " << energyBinBoundaries);
    return StatusCode::FAILURE;
  }
  //remove the last bin boundary - the e/p derivation code measures e/p in an energy range and our json
  //contains the bin boundaries as usded by the e/p derivation code:
  //https://gitlab.cern.ch/atlas-jetetmiss/pflow/commontools/EOverPTools/-/blob/0dee81d8823be1fd725af2cfe62391bcb904b683/EoverpNtupleAnalysis/Run_EoverP_Comparison.py#L100
  //But e.g if the last pair if boundaries are 40 and 100 GeV we measure e/p between those values, but we 
  //want to allow any track with e > 40 GeV to find an e/p reference value.
  //Note the same issue cannot occur for eta, calo layer or first interaction region bins
  //because there is a hard upper limit from the detector geometry - so a track can never
  //e.g have an eta above the final eta bin boundary
  m_energyBinLowerBoundaries.pop_back(); 
  filledBins = fillBinValues(m_etaBinLowerBoundaries, json_binBoundaries, etaBinBoundaries);
  if (!filledBins) {
    ATH_MSG_ERROR("Could not bin boundaries in json file: " << etaBinBoundaries);
    return StatusCode::FAILURE;
  }
  filledBins = fillBinValues(m_firstIntBinLowerBoundaries, json_binBoundaries, firstIntBinBoundaries);
  if (!filledBins) {
    ATH_MSG_ERROR("Could not bin boundaries in json file: " << firstIntBinBoundaries);
    return StatusCode::FAILURE;
  }
  filledBins = fillBinValues(m_caloLayerBins, json_binBoundaries, caloLayerBinBoundaries);
  if (!filledBins) {
    ATH_MSG_ERROR("Could not bin boundaries in json file: " << caloLayerBinBoundaries);
    return StatusCode::FAILURE;
  }
 
  ATH_MSG_DEBUG("Energy bin boundaries: " << m_energyBinLowerBoundaries);
  ATH_MSG_DEBUG("Eta bin boundaries: " << m_etaBinLowerBoundaries);
  ATH_MSG_DEBUG("First interaction region bin boundaries: " << m_firstIntBinLowerBoundaries);
  ATH_MSG_DEBUG("Calo layer bin boundaries: " << m_caloLayerBins);
 
  return StatusCode::SUCCESS;
}

inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

interfaceID()

const InterfaceID & IEFlowCellEOverPTool::interfaceID ( )

inlinestaticinherited

Definition at line 53 of file IEFlowCellEOverPTool.h.

{
  return IID_IEFlowCellEOverPTool;
}

intialize()

virtual StatusCode IEFlowCellEOverPTool::intialize ( )

inlinevirtualinherited

Definition at line 40 of file IEFlowCellEOverPTool.h.

{return StatusCode::SUCCESS;};

msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

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_caloLayerBins

std::vector<int> PFCellEOverPTool::m_caloLayerBins

private

Definition at line 32 of file PFCellEOverPTool.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_energyBinLowerBoundaries

std::vector<double> PFCellEOverPTool::m_energyBinLowerBoundaries

private

Definition at line 29 of file PFCellEOverPTool.h.

m_etaBinLowerBoundaries

std::vector<double> PFCellEOverPTool::m_etaBinLowerBoundaries

private

Definition at line 30 of file PFCellEOverPTool.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_firstIntBinLowerBoundaries

std::vector<int> PFCellEOverPTool::m_firstIntBinLowerBoundaries

private

Definition at line 31 of file PFCellEOverPTool.h.

m_referenceFileLocation

Gaudi::Property<std::string> PFCellEOverPTool::m_referenceFileLocation {this,"referenceFileLocation","","Location for e/p and cell ordering reference files"}

private

Location for e/p and cell ordering reference files (set to null value so one cannot use a wrong reference silently)

Definition at line 35 of file PFCellEOverPTool.h.

{this,"referenceFileLocation","","Location for e/p and cell ordering reference files"};

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:

• PFCellEOverPTool.h
• PFCellEOverPTool.cxx