Top algorithm to generate OutOfCluster histograms for Local Hadron Calibration. More...

#include <GetLCOutOfCluster.h>

Inheritance diagram for GetLCOutOfCluster:

Collaboration diagram for GetLCOutOfCluster:

Public Member Functions
	GetLCOutOfCluster (const std::string &name, ISvcLocator *pSvcLocator)

virtual	~GetLCOutOfCluster ()

virtual StatusCode	initialize ()

virtual StatusCode	execute ()

virtual StatusCode	finalize ()

virtual StatusCode	sysInitialize () override
	Override sysInitialize. More...

virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies. More...

ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`. More...

virtual StatusCode	sysStart () override
	Handle START transition. More...

virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...

virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &t)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...

void	updateVHKA (Gaudi::Details::PropertyBase &)

MsgStream &	msg () const

MsgStream &	msg (const MSG::Level lvl) const

bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...

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

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
void	mapinsert (const std::vector< Gaudi::Histo1DDef > &dims)

void	mapparse ()

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
std::vector< Gaudi::Histo1DDef >	m_dimensions
	definition of all dimensions used for out-of-cluster corrections More...

std::map< std::string, Gaudi::Histo1DDef >	m_dimensionsmap
	property to set all dimensions introduced above More...

std::vector< int >	m_isampmap
	Vector of indices in m_dimensions. More...

std::vector< TProfile2D * >	m_ooc
	Vector of actual histograms. More...

std::string	m_outputFileName
	Name of the output file to save histograms in. More...

std::unique_ptr< TFile >	m_outputFile
	Output file to save histograms in. More...

SG::ReadHandleKey< xAOD::CaloClusterContainer >	m_clusterCollName
	Name of the CaloClusterContainer to use. More...

std::vector< std::string >	m_invalidSamplingNames
	vector of names of the calorimeter samplings not to use when applying the out-of-cluster weights. More...

std::set< int >	m_invalidSamplings
	actual set of samplings to be ignored for out-of-cluster weights More...

std::string	m_NormalizationType
	string to choose different normalization types More...

int	m_NormalizationTypeNumber

std::string	m_ClassificationType
	string to choose different classification types More...

int	m_ClassificationTypeNumber

DataObjIDColl	m_extendedExtraObjects

StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...

StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...

std::vector< SG::VarHandleKeyArray * >	m_vhka

bool	m_varHandleArraysDeclared

Detailed Description

Top algorithm to generate OutOfCluster histograms for Local Hadron Calibration.

Version: $Id: GetLCOutOfCluster.h,v 1.2 2008-11-04 14:33:37 menke Exp $

Author: Sven Menke menke.nosp@m.@mpp.nosp@m.mu.mp.nosp@m.g.de

Date: 3-October-2008 This class is an Algorithm to generate the 2D histograms from single pion simulations to correct for out-of-cluster energy deposits.

Definition at line 31 of file GetLCOutOfCluster.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ GetLCOutOfCluster()

GetLCOutOfCluster::GetLCOutOfCluster	(	const std::string &	name,
		ISvcLocator *	pSvcLocator
	)

Definition at line 41 of file GetLCOutOfCluster.cxx.

   : AthAlgorithm(name, pSvcLocator),
     m_outputFile(nullptr),
     m_clusterCollName("CaloTopoClusters"),
     m_NormalizationType("Lin"),
     m_NormalizationTypeNumber(0),
     m_ClassificationType("None"),
     m_ClassificationTypeNumber(0)
 {
  
   std::vector<Gaudi::Histo1DDef> dims(6);
   dims[0] = Gaudi::Histo1DDef("side",-1.5,1.5,1);
   dims[1] = Gaudi::Histo1DDef("|eta|",0.,5.,50);
   dims[2] = Gaudi::Histo1DDef("phi",-M_PI,M_PI,1);
   dims[3] = Gaudi::Histo1DDef("log10(E_clus (MeV))",log10(200),log10(1e6),14);
   dims[4] = Gaudi::Histo1DDef("log10(lambda_clus (mm))",0.0,4.0,14);
   dims[5] = Gaudi::Histo1DDef("weight",0.,3.0,1);
  
   mapinsert(dims);
  
   // Dimensions to use for classification
   declareProperty("OutOfClusterDimensions",m_dimensionsmap);
  
   // Name of output file to save histograms in
   declareProperty("OutputFileName",m_outputFileName);  
   
   // Name of ClusterContainer to use
   declareProperty("ClusterCollectionName",m_clusterCollName);  
  
   // Name of Samplings to ignore 
   m_invalidSamplingNames.resize(3);
  
   m_invalidSamplingNames[0] = "PreSamplerB";
   m_invalidSamplingNames[1] = "PreSamplerE";
   m_invalidSamplingNames[2] = "TileGap3";
  
   declareProperty("InvalidSamplings",m_invalidSamplingNames);
  
   // Normalization type "Const", "Lin", "Log", "NClus"
   declareProperty("NormalizationType",m_NormalizationType); 
  
   // Classification type "None" for single pion MC or 
   //                     "ParticleID_EM" for ParticleID based em-type clusters  
   //                     "ParticleID_HAD" for ParticleID based had-type clusters  
   declareProperty("ClassificationType", m_ClassificationType);
 }

◆ ~GetLCOutOfCluster()

GetLCOutOfCluster::~GetLCOutOfCluster ( )

virtual

Definition at line 91 of file GetLCOutOfCluster.cxx.

92 { }

Member Function Documentation

◆ declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleKeyArrayType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKeyArray>

Definition at line 170 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
  
   }

◆ declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T > &	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());
  
   }

◆ declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleBase>

Definition at line 184 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
   }

◆ declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T > &	t,
		const SG::NotHandleType &
	)

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(t);
   }

◆ declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty	(	const std::string &	name,
		SG::VarHandleBase &	hndl,
		const std::string &	doc,
		const SG::VarHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

   {
     this->declare(hndl.vhKey());
     hndl.vhKey().setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKey &	hndl,
		const std::string &	doc,
		const SG::VarHandleKeyType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

   {
     this->declare(hndl);
     hndl.setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKeyArray &	hndArr,
		const std::string &	doc,
		const SG::VarHandleKeyArrayType &
	)

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

   {
  
     // std::ostringstream ost;
     // ost << Algorithm::name() << " VHKA declareProp: " << name 
     //     << " size: " << hndArr.keys().size() 
     //     << " mode: " << hndArr.mode() 
     //     << "  vhka size: " << m_vhka.size()
     //     << "\n";
     // debug() << ost.str() << endmsg;
  
     hndArr.setOwner(this);
     m_vhka.push_back(&hndArr);
  
     Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
     if (p != 0) {
       p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
     } else {
       ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                     << name);
     }
  
     return p;
  
   }

◆ declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc,
		const SG::NotHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(name, property, doc);
   }

◆ declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc = `"none"`
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

   {
     typedef typename SG::HandleClassifier<T>::type htype;
     return declareProperty (name, property, doc, htype());
   }

◆ declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty ( Gaudi::Property< T > & 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< Algorithm > >::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; }

◆ evtStore() [1/2]

ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< Algorithm > >::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; }

◆ evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< Algorithm > >::evtStore ( ) const

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 90 of file AthCommonDataStore.h.

90 { return m_evtStore; }

◆ execute()

StatusCode GetLCOutOfCluster::execute ( )

virtual

Definition at line 276 of file GetLCOutOfCluster.cxx.

 {
   SG::ReadHandle<xAOD::CaloClusterContainer> cc (m_clusterCollName);
  
   // total calib hit energy of all clusters 
   double eCalibTot(0.); 
   double nClusECalibGt0 = 0.0;
  
   for (const xAOD::CaloCluster* theCluster : *cc) {
     double eC=999; 
     if (!theCluster->retrieveMoment(xAOD::CaloCluster::ENG_CALIB_TOT,eC)) {
       ATH_MSG_ERROR( "Failed to retrieve cluster moment ENG_CALIB_TOT" );
       return StatusCode::FAILURE;      
     }
     if ( m_ClassificationTypeNumber != GetLCDefs::NONE ) {
       double emFrac=-999; 
       if (!theCluster->retrieveMoment(xAOD::CaloCluster::ENG_CALIB_FRAC_EM,emFrac)){
     ATH_MSG_ERROR( "Failed to retrieve cluster moment ENG_CALIB_FAC_EM" );
     return StatusCode::FAILURE;
       }
       if (m_ClassificationTypeNumber == GetLCDefs::PARTICLEID_EM && emFrac < 0.5 )
     eC = 0;
       if (m_ClassificationTypeNumber == GetLCDefs::PARTICLEID_HAD && emFrac > 0.5 )
     eC = 0;
     }
     eCalibTot += eC;
     if ( eC > 0 ) {
       nClusECalibGt0++;
     }
   }
  
   if ( eCalibTot > 0 ) {
     const double inv_eCalibTot = 1. / eCalibTot;
     const double inv_nClusECalibGt0 = 1. / nClusECalibGt0;
     for (const xAOD::CaloCluster* pClus : *cc) {
       double eng = pClus->e();
  
       if ( m_ClassificationTypeNumber != GetLCDefs::NONE ) {
     double emFrac=-999; 
     if (!pClus->retrieveMoment(xAOD::CaloCluster::ENG_CALIB_FRAC_EM,emFrac)){
       ATH_MSG_ERROR( "Failed to retrieve cluster moment ENG_CALIB_FAC_EM");
       return StatusCode::FAILURE;
     }
     if (m_ClassificationTypeNumber == GetLCDefs::PARTICLEID_EM && emFrac < 0.5 )
       continue;
     if (m_ClassificationTypeNumber == GetLCDefs::PARTICLEID_HAD && emFrac > 0.5 )
       continue;
       }
  
       // subtract the samplings to ignore from eng
       for (int sampling : m_invalidSamplings) {
     eng -= pClus->eSample((CaloSampling::CaloSample)(sampling));
       }
       
       if ( eng > 0 ) { 
  
     int iside = 0;
     int iphi = 0;
     int ilogE = 0;
     int nside = 1;
     int nphi = 1;
     int nlogE = 1;
     
     if ( m_isampmap[0] >= 0 ) {
       const Gaudi::Histo1DDef & hd = m_dimensions[m_isampmap[0]];
       nside = hd.bins();
       iside = (int)(nside*(((pClus->eta()<0?-1.0:1.0) - hd.lowEdge())
                    /(hd.highEdge()-hd.lowEdge())));
       if ( iside < 0 || iside > nside-1 ) {
         ATH_MSG_WARNING( " Side index out of bounds " <<
           iside << " not in [0," << nside-1 << "]" ); 
         iside = -1;
       }
     }
     
     if ( m_isampmap[1] >= 0 ) {
       const Gaudi::Histo1DDef & hd = m_dimensions[m_isampmap[1]];
       nphi = hd.bins();
       iphi = (int)(nphi*((pClus->phi() - hd.lowEdge())
                  /(hd.highEdge()-hd.lowEdge())));
       if ( iphi < 0 || iphi > nphi-1 ) {
         ATH_MSG_WARNING( " Phi index out of bounds " <<
           iphi << " not in [0," << nphi-1 << "]" ); 
         iphi = -1;
       }
     }
     
     const Gaudi::Histo1DDef & hd = m_dimensions[m_isampmap[2]];
     nlogE = hd.bins();
     ilogE = (int)(nlogE*((log10(eng) - hd.lowEdge())
                  /(hd.highEdge()-hd.lowEdge())));
     if ( ilogE >= 0 && ilogE < nlogE ) {
       double lamb,eout,etot,isol;
       if (!pClus->retrieveMoment(xAOD::CaloCluster::CENTER_LAMBDA,lamb) ||
           !pClus->retrieveMoment(xAOD::CaloCluster::ENG_CALIB_OUT_L,eout) ||
           !pClus->retrieveMoment(xAOD::CaloCluster::ENG_CALIB_TOT,etot) ||
           !pClus->retrieveMoment(xAOD::CaloCluster::ISOLATION,isol)) {
         ATH_MSG_ERROR( "Failed to retrieve a cluster moment (CENTER_LAMBDA,ENG_CALIB_OUT,ENG_CALIB_TOT,ISOLATION)" );
         return StatusCode::FAILURE;
       }
     
       if ( lamb > 0 &&
            etot > 0 &&
            isol > 0.5 )
           {
         int iO = ilogE*nphi*nside+iphi*nside+iside;
         if (m_ooc[iO]) {
           double norm = 0.0;
           if ( m_NormalizationTypeNumber == GetLCDefs::LIN ) {
         norm = etot*inv_eCalibTot;
           }
           else if ( m_NormalizationTypeNumber == GetLCDefs::LOG ) {
                 // cluster has to have at least 1% of the calib hit E
                 norm = log10(etot*inv_eCalibTot)+2.0;
           }
           else if ( m_NormalizationTypeNumber == GetLCDefs::NCLUS ) {
                 norm = inv_nClusECalibGt0;
           }
           else {
         norm = 1.0;
           }
           if ( norm > 0 ) {
         m_ooc[iO]->Fill(fabs(pClus->eta()),log10(lamb),eout/eng/isol,norm);
           }
         }
       }
     }
       }
     }
   }
  
   return StatusCode::SUCCESS;
 }

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::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

◆ extraOutputDeps()

const DataObjIDColl & AthAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 50 of file AthAlgorithm.cxx.

 {
   // If we didn't find any symlinks to add, just return the collection
   // from the base class.  Otherwise, return the extended collection.
   if (!m_extendedExtraObjects.empty()) {
     return m_extendedExtraObjects;
   }
   return Algorithm::extraOutputDeps();
 }

◆ finalize()

StatusCode GetLCOutOfCluster::finalize ( )

virtual

Definition at line 262 of file GetLCOutOfCluster.cxx.

 {
   ATH_MSG_INFO( "Writing out histograms" );
   m_outputFile->cd();
   for(unsigned int i=0;i<m_ooc.size();i++) {
     m_ooc[i]->Write();
   }
   m_outputFile->Close();
   
   return StatusCode::SUCCESS;
 }

◆ initialize()

StatusCode GetLCOutOfCluster::initialize ( )

virtual

Definition at line 96 of file GetLCOutOfCluster.cxx.

                                          {
  
   m_outputFile = std::make_unique<TFile>(m_outputFileName.c_str(),"RECREATE");
   m_outputFile->cd();
   m_ooc.resize(0);
  
   mapparse();
  
   if ( m_NormalizationType == "Lin" ) {
     ATH_MSG_INFO( "Using weighting proportional to E_calib" );
     m_NormalizationTypeNumber = GetLCDefs::LIN;
   }
   else if ( m_NormalizationType == "Log" ) {
     ATH_MSG_INFO( "Using weighting proportional to log(E_calib)" );
     m_NormalizationTypeNumber = GetLCDefs::LOG;
   }
   else if ( m_NormalizationType == "NClus" ) {
     ATH_MSG_INFO( "Using weighting proportional to 1/N_Clus_E_calib>0" );
     m_NormalizationTypeNumber = GetLCDefs::NCLUS;
   }
   else {
     ATH_MSG_INFO( "Using constant weighting" );
     m_NormalizationTypeNumber = GetLCDefs::CONST;
   }
  
   if ( m_ClassificationType == "None" ) {
     ATH_MSG_INFO( "Expecting single particle input" );
     m_ClassificationTypeNumber = GetLCDefs::NONE;
   }
   else if ( m_ClassificationType == "ParticleID_EM" ) {
     ATH_MSG_INFO( "Expecting ParticleID simulation as input -- use EM type clusters only" );
     m_ClassificationTypeNumber = GetLCDefs::PARTICLEID_EM;
   }
   else if ( m_ClassificationType == "ParticleID_HAD" ) {
     ATH_MSG_INFO( "Expecting ParticleID simulation as input -- use HAD type clusters only" );
     m_ClassificationTypeNumber = GetLCDefs::PARTICLEID_HAD;
   }
   else {
     ATH_MSG_WARNING( " unknown classification type " << m_ClassificationType << " given! Using None instead" );
     m_ClassificationTypeNumber = GetLCDefs::NONE;
   }
  
   int iside(-1);
   int ieta(-1);
   int iphi(-1);
   int ilogE(-1);
   int iloglambda(-1);
   int iweight(-1);
   
   m_isampmap.resize(3,-1);
   for(unsigned int idim=0;idim<m_dimensions.size();idim++) {
     if (      m_dimensions[idim].title() == "side" ) {
       iside = idim;
       m_isampmap[0] = iside;
     }
     else if ( m_dimensions[idim].title() == "|eta|" ) 
       ieta = idim;
     else if ( m_dimensions[idim].title() == "phi" ) {
       iphi = idim;
       m_isampmap[1] = iphi;
     }
     else if ( m_dimensions[idim].title() == "log10(E_clus (MeV))" ) {
       ilogE = idim;
       m_isampmap[2] = ilogE;
     }
     else if ( m_dimensions[idim].title() == "log10(lambda_clus (mm))" )
       iloglambda = idim;
     else if ( m_dimensions[idim].title() == "weight" )
       iweight = idim;
   }
   if ( ilogE < 0 || ieta < 0 || iloglambda < 0 || iweight < 0 || iside < 0 ) {
     ATH_MSG_FATAL(" Mandatory dimension log10E, |eta|, log10lambda or weight missing ...");
     return StatusCode::FAILURE;
   }
   int nside = m_dimensions[iside].bins();
   int nphi=1;
   if (iphi>=0) nphi = m_dimensions[iphi].bins();
   int nlogE = m_dimensions[ilogE].bins();
   m_ooc.resize(nside*nphi*nlogE,nullptr);
   for ( int jside=0;jside<nside;jside++) {
     for ( int jphi=0;jphi<nphi;jphi++) {
       for(int jlogE=0;jlogE<nlogE;jlogE++) {
     TString oname("ooc");
       oname += "_iside_";
       oname += jside;
       oname += "_[";
       oname += m_dimensions[iside].lowEdge();
       oname += ",";
       oname += m_dimensions[iside].highEdge();
       oname += ",";
       oname += nside;
       oname += "]";
       oname += "_iphi_";
       oname += jphi;
       oname += "_[";
       oname += (iphi>=0?m_dimensions[iphi].lowEdge():-1);
       oname += ",";
       oname += (iphi>=0?m_dimensions[iphi].highEdge():-1);
       oname += ",";
       oname += nphi;
       oname += "]";
       oname += "_ilogE_";
       oname += jlogE;
       oname += "_[";
       oname += m_dimensions[ilogE].lowEdge();
       oname += ",";
       oname += m_dimensions[ilogE].highEdge();
       oname += ",";
       oname += nlogE;
       oname += "]";
       int iO = jlogE*nphi*nside+jphi*nside+jside;
       m_ooc[iO] = new TProfile2D(oname,oname,
                      m_dimensions[ieta].bins(),
                      m_dimensions[ieta].lowEdge(),
                      m_dimensions[ieta].highEdge(),
                      m_dimensions[iloglambda].bins(),
                      m_dimensions[iloglambda].lowEdge(),
                      m_dimensions[iloglambda].highEdge(),
                      m_dimensions[iweight].lowEdge(),
                      m_dimensions[iweight].highEdge());
       m_ooc[iO]->SetXTitle("|#eta_{clus}|");
       m_ooc[iO]->SetYTitle("log_{10}(#lambda_{clus} (mm))");
       m_ooc[iO]->SetZTitle("E_{out of cluster} / E_{clus}^{EM-no-PS/Gap3} / Isolation");
       }
     }
   }
   //--- check sampling names to use exclude in correction
   for (const std::string& name : m_invalidSamplingNames) {
     int theSampling(CaloSampling::Unknown);
     for (unsigned int jsamp = 0;jsamp< CaloSampling::Unknown; jsamp++) {
       if ( name == CaloSamplingHelper::getSamplingName((CaloSampling::CaloSample)jsamp)) {
     theSampling = jsamp;
     break;
       }
     }
     if ( theSampling == CaloSampling::Unknown ) {
       msg(MSG::ERROR)  << "Calorimeter sampling " 
       << name
           << " is not a valid Calorimeter sampling name and will be ignored! "
           << "Valid names are: ";
       for (unsigned int jsamp = 0;jsamp< CaloSampling::Unknown; jsamp++) {
     msg() << CaloSamplingHelper::getSamplingName((CaloSampling::CaloSample)jsamp);
     if ( jsamp < CaloSampling::Unknown-1) 
       msg() << ", ";
     else 
       msg() << ".";
       }
       msg() << endmsg;
     }
     else {
       m_invalidSamplings.insert(theSampling);
     }
   }
  
   msg(MSG::INFO) << "Samplings to exclude from the out-of-cluster weighting:";
   for (const std::string& name : m_invalidSamplingNames)
     msg() << " " << name;
   msg() << endmsg;
  
   ATH_CHECK( m_clusterCollName.initialize() );
  
   return StatusCode::SUCCESS;
 }

◆ inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< Algorithm > >::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.

◆ mapinsert()

void GetLCOutOfCluster::mapinsert ( const std::vector< Gaudi::Histo1DDef > & dims )

private

Definition at line 410 of file GetLCOutOfCluster.cxx.

                                                                          {
   for (unsigned int i=0;i<dims.size();i++) {
     m_dimensionsmap[dims[i].title()] = dims[i];
   }
 }

◆ mapparse()

void GetLCOutOfCluster::mapparse ( )

private

Definition at line 416 of file GetLCOutOfCluster.cxx.

                                  {
  
   for (std::pair<const std::string, Gaudi::Histo1DDef>& p : m_dimensionsmap) {
     m_dimensions.push_back(p.second);
     ATH_MSG_DEBUG(" New Dimension: " 
           << p.second.title() << ", [" << p.second.lowEdge()
           << ", " << p.second.highEdge() 
           << ", " << p.second.bins()
           << "]");
   }
 }

◆ msg() [1/2]

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

MsgStream& AthCommonMsg< Algorithm >::msg ( const MSG::Level lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

◆ msgLvl()

bool AthCommonMsg< Algorithm >::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< Algorithm > >::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< Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

◆ renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                           {
     handlesArray.renounce();
   }

◆ sysInitialize()

StatusCode AthAlgorithm::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Algorithm > >.

Reimplemented in AthAnalysisAlgorithm, AthFilterAlgorithm, PyAthena::Alg, and AthHistogramAlgorithm.

Definition at line 66 of file AthAlgorithm.cxx.

                                        {
   StatusCode sc=AthCommonDataStore<AthCommonMsg<Algorithm>>::sysInitialize();
  
   if (sc.isFailure()) {
     return sc;
   }
   ServiceHandle<ICondSvc> cs("CondSvc",name());
   for (auto h : outputHandles()) {
     if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
       // do this inside the loop so we don't create the CondSvc until needed
       if ( cs.retrieve().isFailure() ) {
         ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
         return StatusCode::SUCCESS;
       }
       if (cs->regHandle(this,*h).isFailure()) {
         sc = StatusCode::FAILURE;
         ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                       << " with CondSvc");
       }
     }
   }
   return sc;
 }

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::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_ClassificationType

std::string GetLCOutOfCluster::m_ClassificationType

private

string to choose different classification types

Available options are "None": the input MC is expected to be just a single pion MC with one sort of particles; "ParticleID_EM" Gena's ParticleID classification (EM type objects) for the use of QCD MC; "ParticleID_HAD" Gena's ParticleID classification (HAD type objects) for the use of QCD MC;

Definition at line 154 of file GetLCOutOfCluster.h.

◆ m_ClassificationTypeNumber

int GetLCOutOfCluster::m_ClassificationTypeNumber

private

Definition at line 156 of file GetLCOutOfCluster.h.

◆ m_clusterCollName

SG::ReadHandleKey<xAOD::CaloClusterContainer> GetLCOutOfCluster::m_clusterCollName

private

Name of the CaloClusterContainer to use.

Definition at line 113 of file GetLCOutOfCluster.h.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_dimensions

std::vector<Gaudi::Histo1DDef> GetLCOutOfCluster::m_dimensions

private

definition of all dimensions used for out-of-cluster corrections

The currently defined dimensions are:

side: negative values for eta < 0 and positive for eta > 0; 1 bin from -1.5 to 1.5 for no side dependency

|eta|: the absolute value of eta; normally in ATLAS the bounds are within [0,5], smaller ones are useful for test beam setups.

phi: the phi range; 1 bin from -pi to pi for no phi dependency

log10(E_clus^EMnoPSnoGap3): the log10 of the cluster energy on EM scale without pre-samplers and gap scintillators; typical range should be within the generated energy range of single pions with about 50% room to the maximum created energy - i.e. use log10(1 TeV) as max value if you generated up tp 2 TeV pions

log10(lambda_clus): the log10 of the cluster depth in the calorimeter; typical ranges are from 0 to 4

weight: the ratio E_outOfCluster/E_clus^EMnoPSnoGap3/Isolation; the bounds define the level of truncation for the weights to suppress noise and bad sampling ratios. Typical bounds are 0. to 5.

Definition at line 76 of file GetLCOutOfCluster.h.

◆ m_dimensionsmap

std::map<std::string,Gaudi::Histo1DDef> GetLCOutOfCluster::m_dimensionsmap

private

property to set all dimensions introduced above

Gaudi has only a map<string,Histo1DDef> to use as property. So the syntax for all dimensions introduced above is {'Title': ('Title',Low,High,Bins), ... }.

Definition at line 84 of file GetLCOutOfCluster.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects

privateinherited

Definition at line 79 of file AthAlgorithm.h.

◆ m_invalidSamplingNames

std::vector<std::string> GetLCOutOfCluster::m_invalidSamplingNames

private

vector of names of the calorimeter samplings not to use when applying the out-of-cluster weights.

The pre-sampler layers (barrel and endcap) and the gap-scintillators should not receive out-of-cluster weights as they mainly deal with dead-material corrections.

Definition at line 122 of file GetLCOutOfCluster.h.

◆ m_invalidSamplings

std::set<int> GetLCOutOfCluster::m_invalidSamplings

private

actual set of samplings to be ignored for out-of-cluster weights

This set is created according to the names given in the property m_invalidSamplingNames.

Definition at line 129 of file GetLCOutOfCluster.h.

◆ m_isampmap

std::vector<int> GetLCOutOfCluster::m_isampmap

private

Vector of indices in m_dimensions.

Internal list of indices in m_dimensions object.

Definition at line 90 of file GetLCOutOfCluster.h.

◆ m_NormalizationType

std::string GetLCOutOfCluster::m_NormalizationType

private

string to choose different normalization types

Available options are "Const": every cluster counts with weight 1; "Lin": Each cluster is weighted with E_calib_clus/E_calib_tot; "Log": Each cluster is weighted with log10(E_calib_clus/E_calib_tot)+2; "NClus": Each cluster is weighted with 1/TotalNumberOfClustersWithE_calib>0.

Definition at line 141 of file GetLCOutOfCluster.h.

◆ m_NormalizationTypeNumber

int GetLCOutOfCluster::m_NormalizationTypeNumber

private

Definition at line 143 of file GetLCOutOfCluster.h.

◆ m_ooc

std::vector<TProfile2D *> GetLCOutOfCluster::m_ooc

private

Vector of actual histograms.

Internal list of histograms to fill and save.

Definition at line 96 of file GetLCOutOfCluster.h.

◆ m_outputFile

std::unique_ptr<TFile> GetLCOutOfCluster::m_outputFile

private

Output file to save histograms in.

Internal variable pointing to the output file.

Definition at line 109 of file GetLCOutOfCluster.h.

◆ m_outputFileName

std::string GetLCOutOfCluster::m_outputFileName

private

Name of the output file to save histograms in.

Use this property to set the name of the output file containing the OutOfCluster histograms.

Definition at line 103 of file GetLCOutOfCluster.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

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

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ GetLCOutOfCluster()

◆ ~GetLCOutOfCluster()

Member Function Documentation

◆ declareGaudiProperty() [1/4]

◆ declareGaudiProperty() [2/4]

◆ declareGaudiProperty() [3/4]

◆ declareGaudiProperty() [4/4]

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ detStore()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ mapinsert()

◆ mapparse()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_ClassificationType

◆ m_ClassificationTypeNumber

◆ m_clusterCollName

◆ m_detStore

◆ m_dimensions

◆ m_dimensionsmap

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_invalidSamplingNames

◆ m_invalidSamplings

◆ m_isampmap

◆ m_NormalizationType

◆ m_NormalizationTypeNumber

◆ m_ooc

◆ m_outputFile

◆ m_outputFileName

◆ m_varHandleArraysDeclared

◆ m_vhka