GetLCWeights Class Reference

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

#include <GetLCWeights.h>

Inheritance diagram for GetLCWeights:

Collaboration diagram for GetLCWeights:

Public Member Functions
	GetLCWeights (const std::string &name, ISvcLocator *pSvcLocator)
virtual	~GetLCWeights ()
virtual StatusCode	initialize ()
virtual StatusCode	execute ()
virtual StatusCode	finalize ()
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

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
void	mapinsert (const std::vector< Gaudi::Histo1DDef > &dims)
void	mapparse ()
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
std::vector< std::vector< Gaudi::Histo1DDef > >	m_dimensions
	definition of all dimensions used for each sampling
std::map< std::string, Gaudi::Histo1DDef >	m_dimensionsmap
	property to set all dimensions introduced above
std::vector< std::vector< int > >	m_isampmap
	Vector of indices in m_dimensions for each sampling.
std::vector< std::vector< TProfile2D * > >	m_weight
	Vector of vector of actual histograms.
std::string	m_outputFileName
	Name of the output file to save histograms in.
std::unique_ptr< TFile >	m_outputFile
	Output file to save histograms in.
SG::ReadHandleKey< xAOD::CaloClusterContainer >	m_clusterCollName
	Name of the CaloClusterContainer to use.
SG::ReadHandleKeyArray< CaloCalibrationHitContainer >	m_CalibrationHitContainerNames
	vector of calibration hit container names to use.
bool	m_useInversionMethod
	flag to switch on/off the use of the inversion method
std::string	m_NormalizationType
	string to choose different normalization types
int	m_NormalizationTypeNumber
std::string	m_ClassificationType
	string to choose different classification types
int	m_ClassificationTypeNumber
DataObjIDColl	m_extendedExtraObjects
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

Top algorithm to generate Weight histograms for Local Hadron Calibration.

Version

$Id: GetLCWeights.h,v 1.2 2008-12-08 16:57:41 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 cell-weight the hadronic classified clusters.

Definition at line 41 of file GetLCWeights.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

GetLCWeights()

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

Definition at line 45 of file GetLCWeights.cxx.

  : AthAlgorithm(name, pSvcLocator),
    m_outputFile(nullptr),
    m_clusterCollName("CaloTopoClusters"),
    m_useInversionMethod(true),
    m_NormalizationType("Lin"),
    m_NormalizationTypeNumber(0),
    m_ClassificationType("None"),
    m_ClassificationTypeNumber(0)
{
 
  std::vector<Gaudi::Histo1DDef> dims(7);
  dims[1] = Gaudi::Histo1DDef("side",-1.5,1.5,1);
  dims[2] = Gaudi::Histo1DDef("|eta|",0.,1.6,16);
  dims[3] = Gaudi::Histo1DDef("phi",-M_PI,M_PI,1);
  dims[4] = Gaudi::Histo1DDef("log10(E_clus (MeV))",log10(200),log10(1e6),14);
  dims[5] = Gaudi::Histo1DDef("log10(rho_cell (MeV/mm^3))",-4.6,1.1,14);
  dims[6] = Gaudi::Histo1DDef("weight",-2,3,1);
 
  dims[0] = Gaudi::Histo1DDef("EMB1",0.5,1.5,1);
  mapinsert(dims);
  dims[0] = Gaudi::Histo1DDef("EMB2",1.5,2.5,1);
  dims[5] = Gaudi::Histo1DDef("log10(rho_cell (MeV/mm^3))",-4.8,0.5,14);
  mapinsert(dims);
  dims[0] = Gaudi::Histo1DDef("EMB3",2.5,3.5,1);
  dims[5] = Gaudi::Histo1DDef("log10(rho_cell (MeV/mm^3))",-4.9,0.6,14);
  mapinsert(dims);
  dims[0] = Gaudi::Histo1DDef("EME1",4.5,5.5,1);
  dims[2] = Gaudi::Histo1DDef("|eta|",1.2,3.2,20);
  dims[5] = Gaudi::Histo1DDef("log10(rho_cell (MeV/mm^3))",-4.5,1.7,14);
  mapinsert(dims);
  dims[0] = Gaudi::Histo1DDef("EME2",5.5,6.5,1);
  dims[5] = Gaudi::Histo1DDef("log10(rho_cell (MeV/mm^3))",-4.8,1.2,14);
  mapinsert(dims);
  dims[0] = Gaudi::Histo1DDef("EME3",6.5,7.5,1);
  dims[5] = Gaudi::Histo1DDef("log10(rho_cell (MeV/mm^3))",-4.5,1.0,14);
  mapinsert(dims);
  dims[0] = Gaudi::Histo1DDef("HEC0",7.5,8.5,1);
  dims[2] = Gaudi::Histo1DDef("|eta|",1.4,3.4,20);
  dims[5] = Gaudi::Histo1DDef("log10(rho_cell (MeV/mm^3))",-4.8,0.6,14);
  mapinsert(dims);
  dims[0] = Gaudi::Histo1DDef("HEC1",8.5,9.5,1);
  dims[5] = Gaudi::Histo1DDef("log10(rho_cell (MeV/mm^3))",-4.9,-0.2,14);
  mapinsert(dims);
  dims[0] = Gaudi::Histo1DDef("HEC2",9.5,10.5,1);
  dims[5] = Gaudi::Histo1DDef("log10(rho_cell (MeV/mm^3))",-4.8,-0.2,14);
  mapinsert(dims);
  dims[0] = Gaudi::Histo1DDef("HEC3",10.5,11.5,1);
  dims[5] = Gaudi::Histo1DDef("log10(rho_cell (MeV/mm^3))",-4.7,-0.2,14);
  mapinsert(dims);
  dims[0] = Gaudi::Histo1DDef("TileBar0",11.5,12.5,1);
  dims[2] = Gaudi::Histo1DDef("|eta|",0.,1.2,12);
  dims[5] = Gaudi::Histo1DDef("log10(rho_cell (MeV/mm^3))",-6,-1,14);
  mapinsert(dims);
  dims[0] = Gaudi::Histo1DDef("TileBar1",12.5,13.5,1);
  dims[5] = Gaudi::Histo1DDef("log10(rho_cell (MeV/mm^3))",-6.7,-1.2,14);
  mapinsert(dims);
  dims[0] = Gaudi::Histo1DDef("TileBar2",13.5,14.5,1);
  dims[5] = Gaudi::Histo1DDef("log10(rho_cell (MeV/mm^3))",-7,-1.9,14);
  mapinsert(dims);
  dims[0] = Gaudi::Histo1DDef("TileGap1",14.5,15.5,1);
  dims[2] = Gaudi::Histo1DDef("|eta|",0.8,1.8,10);
  dims[5] = Gaudi::Histo1DDef("log10(rho_cell (MeV/mm^3))",-6,-1,14);
  mapinsert(dims);
  dims[0] = Gaudi::Histo1DDef("TileGap2",15.5,16.5,1);
  dims[5] = Gaudi::Histo1DDef("log10(rho_cell (MeV/mm^3))",-6.5,-1.5,14);
  mapinsert(dims);
  dims[0] = Gaudi::Histo1DDef("TileExt0",17.5,18.5,1);
  dims[5] = Gaudi::Histo1DDef("log10(rho_cell (MeV/mm^3))",-6.5,-1,14);
  mapinsert(dims);
  dims[0] = Gaudi::Histo1DDef("TileExt1",18.5,19.5,1);
  dims[5] = Gaudi::Histo1DDef("log10(rho_cell (MeV/mm^3))",-6.6,-1.5,14);
  mapinsert(dims);
  dims[0] = Gaudi::Histo1DDef("TileExt2",19.5,20.5,1);
  dims[5] = Gaudi::Histo1DDef("log10(rho_cell (MeV/mm^3))",-7.2,-2.4,14);
  mapinsert(dims);
  dims[0] = Gaudi::Histo1DDef("FCal1",20.5,21.5,1);
  dims[2] = Gaudi::Histo1DDef("|eta|",2.8,5.0,22);
  dims[5] = Gaudi::Histo1DDef("log10(rho_cell (MeV/mm^3))",-3.5,2,14);
  mapinsert(dims);
  dims[0] = Gaudi::Histo1DDef("FCal2",21.5,22.5,1);
  dims[5] = Gaudi::Histo1DDef("log10(rho_cell (MeV/mm^3))",-3.5,1.5,14);
  mapinsert(dims);
  dims[0] = Gaudi::Histo1DDef("FCal3",22.5,23.5,1);
  dims[5] = Gaudi::Histo1DDef("log10(rho_cell (MeV/mm^3))",-3.8,1,14);
  mapinsert(dims);
 
  // Dimensions to use for all samplings
  declareProperty("SamplingDimensions",m_dimensionsmap);
 
  // Name of output file to save histograms in
  declareProperty("OutputFileName",m_outputFileName);  
  
  // Name of ClusterContainer to use
  declareProperty("ClusterCollectionName",m_clusterCollName); 
 
  // Names of CalibrationHitContainers to use
  declareProperty("CalibrationHitContainerNames",m_CalibrationHitContainerNames); 
  // Use Inversion Method
  declareProperty("UseInversionMethod",m_useInversionMethod); 
  // 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);
}

~GetLCWeights()

GetLCWeights::~GetLCWeights ( )

virtual

Definition at line 156 of file GetLCWeights.cxx.

{ }

Member Function Documentation

declareGaudiProperty()

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

execute()

StatusCode GetLCWeights::execute ( )

virtual

Definition at line 355 of file GetLCWeights.cxx.

{
  const EventContext& ctx = getContext();
  SG::ReadHandle<xAOD::CaloClusterContainer> cc (m_clusterCollName, ctx);
 
  std::vector<const CaloCalibrationHitContainer *> v_cchc;
  for (const SG::ReadHandleKey<CaloCalibrationHitContainer>& k : m_CalibrationHitContainerNames) {
    SG::ReadHandle<CaloCalibrationHitContainer> cchc (k, ctx);
    v_cchc.push_back(cchc.cptr());
  }
 
  std::vector<ClusWeight *> cellVector[CaloCell_ID::NSUBCALO];
 
  const CaloCell_ID*               calo_id  = nullptr;
  ATH_CHECK(detStore()->retrieve(calo_id,"CaloCell_ID"));   
 
  for(int ic=0;ic<CaloCell_ID::NSUBCALO; ic++) {
    unsigned int maxHashSize(0);
    IdentifierHash myHashMin,myHashMax;
    calo_id->calo_cell_hash_range (ic,myHashMin,myHashMax);
    maxHashSize = myHashMax-myHashMin;
    cellVector[ic].resize(maxHashSize,nullptr);
  }
 
  // loop over all cell members of all clusters and fill cell vector
  // for used cells
    
  // total calib hit energy of all clusters 
  double eCalibTot(0.); 
 
  unsigned int iClus = 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++;
    }
    xAOD::CaloCluster::const_cell_iterator cellIter    = theCluster->cell_begin();
    xAOD::CaloCluster::const_cell_iterator cellIterEnd = theCluster->cell_end();
    for(; cellIter != cellIterEnd; cellIter++ ){
      const CaloCell* pCell = (*cellIter);
      Identifier myId = pCell->ID();
      IdentifierHash myHashId;
      int otherSubDet(0);
      myHashId = calo_id->subcalo_cell_hash(myId,otherSubDet);
      ClusWeight * myClus = new ClusWeight();
      myClus->iClus = iClus;
      myClus->weight = cellIter.weight();
      myClus->next = nullptr;
      myClus->eCalibTot = 0;
      ClusWeight * theList = cellVector[otherSubDet][(unsigned int)myHashId];
      if ( theList ) {
    while ( theList->next ) 
      theList = theList->next;
    theList->next = myClus;
      }
      else {
    cellVector[otherSubDet][(unsigned int)myHashId] = myClus;
      }
    }
  }
 
  // calculate total calib energy of each cell in each cluster
 
  for (const CaloCalibrationHitContainer* cchc : v_cchc) {
    for (const CaloCalibrationHit* hit : *cchc) {
      Identifier myId = hit->cellID();
      int otherSubDet;
      IdentifierHash myHashId = calo_id->subcalo_cell_hash(myId,otherSubDet);
      if ( myHashId != CaloCell_ID::NOT_VALID ) {
    ClusWeight * theList = cellVector[otherSubDet][(unsigned int)myHashId];
    while ( theList ) {
     theList->eCalibTot += hit->energyTotal();
     theList = theList->next;
    }
      }
    }
  }
    
  // fill weight histos for all cells in all clusters
  // since pions can be split in several clusters the weights are 
  // calculated by importance of the cluster for the current pion - i.e.
  // the weights get a weight itself proportinal to the calib hit energy 
  // sum of the cluster over the total calib hit energy
 
  if ( eCalibTot > 0 && nClusECalibGt0 > 0 ) {
    const double inv_eCalibTot = 1. / eCalibTot;
    const double inv_nClusECalibGt0 = 1. / nClusECalibGt0;
    for (unsigned int j=0;j<cc->size();j++) {
      const xAOD::CaloCluster * pClus = cc->at(j);
      double eng = pClus->e();
      double eCalib=-999;  
      if (!pClus->retrieveMoment(xAOD::CaloCluster::ENG_CALIB_TOT,eCalib)) {
    ATH_MSG_ERROR( "Failed to retrieve cluster moment ENG_CALIB_TOT");
    return StatusCode::FAILURE;
      }
      if ( eng > 0 && eCalib > 0 ) {
    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;
    }
    xAOD::CaloCluster::const_cell_iterator cellIter    = pClus->cell_begin();
    xAOD::CaloCluster::const_cell_iterator cellIterEnd = pClus->cell_end();
    for(; cellIter != cellIterEnd; cellIter++ ){
      const CaloCell* pCell = (*cellIter);
      const Identifier myId = pCell->ID();
      const CaloDetDescrElement* myCDDE=pCell->caloDDE();
      const int caloSample = myCDDE->getSampling();//m_calo_id->calo_sample(myId);
      if ( !m_isampmap[caloSample].empty() && 
           !m_weight[caloSample].empty() ) {
        int isideCell = 0;
        int ietaCell = 0;
        int iphiCell = 0;
        int nside = 1;
        int neta = 1;
        int nphi = 1;
        if ( m_isampmap[caloSample][1] >= 0 ) {
          const Gaudi::Histo1DDef & hd = m_dimensions[m_isampmap[caloSample][0]][m_isampmap[caloSample][1]];
          nside = hd.bins();
          isideCell = (int)(nside*(((pCell->eta()<0?-1.0:1.0) - hd.lowEdge())
                       /(hd.highEdge()-hd.lowEdge())));
          if ( isideCell < 0 || isideCell > nside-1 ) {
        ATH_MSG_WARNING( " Side index out of bounds " <<
          isideCell << " not in [0," << nside-1 << "] for "
            << "Sampl=" << caloSample ); 
        isideCell = -1;
          }
        }
        if ( m_isampmap[caloSample][2] >= 0 ) {
          const Gaudi::Histo1DDef & hd = m_dimensions[m_isampmap[caloSample][0]][m_isampmap[caloSample][2]];
          neta = hd.bins();
          ietaCell = (int)(neta*((fabs(pCell->eta()) - hd.lowEdge())
                     /(hd.highEdge()-hd.lowEdge())));
          if ( ietaCell < 0 || ietaCell > neta-1 ) {
        ATH_MSG_WARNING( " Eta index out of bounds " <<
          ietaCell << " not in [0," << neta-1 << "] for "
            << "Sampl=" << caloSample ); 
        ietaCell = -1;
          }
        }
        if ( m_isampmap[caloSample][3] >= 0 ) {
          const Gaudi::Histo1DDef & hd = m_dimensions[m_isampmap[caloSample][0]][m_isampmap[caloSample][3]];
          nphi = hd.bins();
          iphiCell = (int)(nphi*((pCell->phi() - hd.lowEdge())
                     /(hd.highEdge()-hd.lowEdge())));
          if ( iphiCell < 0 || iphiCell > nphi-1 ) {
        ATH_MSG_WARNING( " Phi index out of bounds " <<
          iphiCell << " not in [0," << nphi-1 << "] for "
            << "Sampl=" << caloSample ); 
        iphiCell = -1;
          }
        }
        if ( isideCell >=0 && ietaCell >=0 && iphiCell >= 0 ) {
          if ( myCDDE->volume() > 0 ) {
        IdentifierHash myHashId;
        int otherSubDet(0);
        myHashId = calo_id->subcalo_cell_hash(myId,otherSubDet);
        unsigned int iW = iphiCell*neta*nside+ietaCell*nside+isideCell;
        if ( iW >= m_weight[caloSample].size() ) {
          ATH_MSG_WARNING( " Index out of bounds " <<
            iW << " > " << m_weight[caloSample].size()-1 << " for "
              << "Sampl=" << caloSample
              << ", iphi=" << iphiCell 
              << ", ieta=" << ietaCell 
              << ", iside=" << isideCell );
        }
        else {
          ClusWeight * theList = cellVector[otherSubDet][(unsigned int)myHashId];
          while ( theList && theList->iClus != j ) 
            theList = theList->next;
          
          if (m_weight[caloSample][iW] && theList && eCalibTot > 0) {
            double norm = 0.0;
            if ( m_NormalizationTypeNumber == GetLCDefs::LIN ) {
              norm = eCalib * inv_eCalibTot;
            }
            else if ( m_NormalizationTypeNumber == GetLCDefs::LOG ) {
              if ( eCalib > 0 ) {
            // cluster has to have at least 1% of the calib hit E
            norm = log10(eCalib * inv_eCalibTot)+2.0;
              }
            }
            else if ( m_NormalizationTypeNumber == GetLCDefs::NCLUS ) {
              if ( eCalib > 0 ) {
            norm = inv_nClusECalibGt0;
              }
            }
            else {
              norm = 1.0;
            }
            if ( norm > 0 ) {
              if ( !m_useInversionMethod && pCell->e()>0 ) {
            m_weight[caloSample][iW]->Fill(log10(eng),
                               log10(pCell->e()/myCDDE->volume()),
                               theList->eCalibTot/pCell->e(),norm);
 
              }
              else if (m_useInversionMethod && theList->eCalibTot>0 ) {
            m_weight[caloSample][iW]->Fill(log10(eng),
                               log10(theList->eCalibTot/myCDDE->volume()),
                               pCell->e()/theList->eCalibTot,
                               norm);
              }
            }
          }
        }
          }
        }
      }
    }
      }
    }
  }
  
  for(unsigned int ic=0;ic<CaloCell_ID::NSUBCALO; ic++) {
    for (unsigned int ii = 0;ii<cellVector[ic].size();ii++ ) {
      ClusWeight * theList = cellVector[ic][ii];
      ClusWeight * prev = nullptr;
      while ( theList) {
    while ( theList->next ) {
      prev = theList;
      theList = theList->next;
    }
    delete theList;
    if ( prev ) 
      prev->next = nullptr;
    else 
      cellVector[ic][ii] = nullptr;
    theList = cellVector[ic][ii];
    prev = nullptr;
      }
    }
  }
  
  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 GetLCWeights::finalize ( )

virtual

Definition at line 338 of file GetLCWeights.cxx.

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

initialize()

StatusCode GetLCWeights::initialize ( )

virtual

Definition at line 161 of file GetLCWeights.cxx.

{
 
  m_outputFile = std::make_unique<TFile>(m_outputFileName.c_str(),"RECREATE");
  m_outputFile->cd();
 
  m_weight.resize(CaloSampling::Unknown);
  m_isampmap.resize(CaloSampling::Unknown);
  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;
  }
 
  for(unsigned int isamp=0;isamp<m_dimensions.size();isamp++) {
    int theSampling(CaloSampling::Unknown);
    for (unsigned int jsamp = 0;jsamp< CaloSampling::Unknown; jsamp++) {
      if ( m_dimensions[isamp][0].title() == CaloSamplingHelper::getSamplingName((CaloSampling::CaloSample)jsamp)) {
    theSampling = jsamp;
    break;
      }
    }
    if ( theSampling == CaloSampling::Unknown ) {
      ATH_MSG_ERROR( "Calorimeter sampling " 
      << m_dimensions[isamp][0].title() 
          << " 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() );
    }
    else {
      m_isampmap[theSampling].resize(4,-1);
      m_isampmap[theSampling][0] = isamp;
      int iside(-1);
      int ieta(-1);
      int iphi(-1);
      int ilogE(-1);
      int ilogrho(-1);
      int iweight(-1);
      
      for(unsigned int idim=1;idim<m_dimensions[isamp].size();idim++) {
    if (      m_dimensions[isamp][idim].title() == "side" ) {
      iside = idim;
      m_isampmap[theSampling][1] = iside;
    }
    else if ( m_dimensions[isamp][idim].title() == "|eta|" ) {
      ieta = idim;
      m_isampmap[theSampling][2] = ieta;
    }
    else if ( m_dimensions[isamp][idim].title() == "phi" ) {
      iphi = idim;
      m_isampmap[theSampling][3] = iphi;
    }
    else if ( m_dimensions[isamp][idim].title() == "log10(E_clus (MeV))" )
      ilogE = idim;
    else if ( m_dimensions[isamp][idim].title() == "log10(rho_cell (MeV/mm^3))" )
      ilogrho = idim;
    else if ( m_dimensions[isamp][idim].title() == "weight" )
      iweight = idim;
      }
      if ( ilogE < 0 || ilogrho < 0 || iweight < 0 ) {
    ATH_MSG_FATAL( " Mandatory dimension log10E, log10rho or weight missing ..." );
    return StatusCode::FAILURE;
      }
      int nside = (iside>=0?m_dimensions[isamp][iside].bins():1);
      int neta = (ieta>=0?m_dimensions[isamp][ieta].bins():1);
      int nphi = (iphi>=0?m_dimensions[isamp][iphi].bins():1);
      m_weight[theSampling].resize(nside*neta*nphi,nullptr);
      for ( int jside=0;jside<nside;jside++) {
    for ( int jeta=0;jeta<neta;jeta++) {
      for ( int jphi=0;jphi<nphi;jphi++) {
        TString wname("");
        if ( m_useInversionMethod ) 
          wname += "inv_weight";
        else
          wname += "weight";
        wname += "_isamp_";
        wname += theSampling;
        wname += "_iside_";
        wname += jside;
        wname += "_[";
        wname += (iside>=0?m_dimensions[isamp][iside].lowEdge():-1);
        wname += ",";
        wname += (iside>=0?m_dimensions[isamp][iside].highEdge():-1);
        wname += ",";
        wname += nside;
        wname += "]";
        wname += "_ieta_";
        wname += jeta;
        wname += "_[";
        wname += (ieta>=0?m_dimensions[isamp][ieta].lowEdge():-1);
        wname += ",";
        wname += (ieta>=0?m_dimensions[isamp][ieta].highEdge():-1);
        wname += ",";
        wname += neta;
        wname += "]";
        wname += "_iphi_";
        wname += jphi;
        wname += "_[";
        wname += (iphi>=0?m_dimensions[isamp][iphi].lowEdge():-1);
        wname += ",";
        wname += (iphi>=0?m_dimensions[isamp][iphi].highEdge():-1);
        wname += ",";
        wname += nphi;
        wname += "]";
        int iW = jphi*neta*nside+jeta*nside+jside;
        m_weight[theSampling][iW]=
          new TProfile2D(wname,wname,
                 m_dimensions[isamp][ilogE].bins(),
                 m_dimensions[isamp][ilogE].lowEdge(),
                 m_dimensions[isamp][ilogE].highEdge(),
                 m_dimensions[isamp][ilogrho].bins(),
                 m_dimensions[isamp][ilogrho].lowEdge(),
                 m_dimensions[isamp][ilogrho].highEdge(),
                 m_dimensions[isamp][iweight].lowEdge(),
                 m_dimensions[isamp][iweight].highEdge(),
                 "spread");
        if ( m_useInversionMethod ) {
          m_weight[theSampling][iW]->SetYTitle("log10(#rho_{cell}^{true} (MeV/mm^{3}))");
          m_weight[theSampling][iW]->SetZTitle("E_{reco}/E_{tot}");
        }
        else {
          m_weight[theSampling][iW]->SetYTitle("log10(#rho_{cell} (MeV/mm^{3}))");
          m_weight[theSampling][iW]->SetZTitle("E_{tot}/E_{reco}");
        }
        m_weight[theSampling][iW]->SetXTitle("log10(E_{clus} (MeV))");
      }
    }
      }
    }
  }
 
  ATH_CHECK( m_clusterCollName.initialize() );
  ATH_CHECK( m_CalibrationHitContainerNames.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 GetLCWeights::mapinsert ( const std::vector< Gaudi::Histo1DDef > & dims )

private

Definition at line 615 of file GetLCWeights.cxx.

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

mapparse()

void GetLCWeights::mapparse ( )

private

Definition at line 621 of file GetLCWeights.cxx.

                            {
 
  std::vector<int> theUsedSamplings(CaloSampling::Unknown,-1);
 
  int nsamp(-1);
 
  for (const std::pair<const std::string, Gaudi::Histo1DDef>& p : m_dimensionsmap) {
    std::string_view dimname = std::string_view(p.first).substr(0,p.first.find(':'));
    int theSampling(CaloSampling::Unknown);
    for (unsigned int jsamp = 0;jsamp< CaloSampling::Unknown; jsamp++) {
      if ( dimname == CaloSamplingHelper::getSamplingName((CaloSampling::CaloSample)jsamp)) {
    theSampling = jsamp;
    break;
      }
    }
    if ( theSampling == CaloSampling::Unknown ) {
      msg(MSG::ERROR) << "Calorimeter sampling " << dimname
          << " 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 {
      if ( theUsedSamplings[theSampling] == -1 ) {
    nsamp++;
    theUsedSamplings[theSampling] = nsamp;
    m_dimensions.resize(nsamp+1);
    m_dimensions[nsamp].resize(0);
      }
      m_dimensions[theUsedSamplings[theSampling]].push_back(p.second);
      ATH_MSG_DEBUG(" New Dimension for " << dimname << ": " 
            << p.second.title() << ", [" << p.second.lowEdge()
            << ", " << p.second.highEdge() 
            << ", " << p.second.bins()
            << "]");
    }
  }
}

msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

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, AthHistogramAlgorithm, and PyAthena::Alg.

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_CalibrationHitContainerNames

SG::ReadHandleKeyArray<CaloCalibrationHitContainer> GetLCWeights::m_CalibrationHitContainerNames

private

vector of calibration hit container names to use.

The containers specified in this property should hold calibration hits inside the calorimeter systems.

Definition at line 138 of file GetLCWeights.h.

m_ClassificationType

std::string GetLCWeights::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 175 of file GetLCWeights.h.

m_ClassificationTypeNumber

int GetLCWeights::m_ClassificationTypeNumber

private

Definition at line 176 of file GetLCWeights.h.

m_clusterCollName

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

private

Name of the CaloClusterContainer to use.

Definition at line 131 of file GetLCWeights.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<std::vector<Gaudi::Histo1DDef> > GetLCWeights::m_dimensions

private

definition of all dimensions used for each sampling

Since samplings can be present or not, the samplings itself are defined via the special first dimension which has to be exactly 1 bin with the title of the sampling and the bounds of the CaloSample enum.

The remaining 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], most samplings need smaller ranges and even smaller ones for test beam setups.

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

log10(E_clus): the log10 of the cluster energy; 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(rho_cell): the cell energy density (either truth or reco); typical ranges are from -7 to 1

weight: the ratio E_true/E_rec (or E_rec/E_true for inversion method; the bounds define the level of truncation for the weights to suppress noise and bad sampling ratios. Typical bounds are 0.5 to 3,5, or 10 without inversion method, where 5 and 10 are used for HEC and Tile, respectively. With inversion mewthod the bounds are -2 to 3.

Definition at line 92 of file GetLCWeights.h.

m_dimensionsmap

std::map<std::string,Gaudi::Histo1DDef> GetLCWeights::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 {'Sampling:Title': ('Title',Low,High,Bins), ... }.

Definition at line 100 of file GetLCWeights.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_isampmap

std::vector<std::vector<int> > GetLCWeights::m_isampmap

private

Vector of indices in m_dimensions for each sampling.

Internal list of indices in m_dimensions object.

Definition at line 106 of file GetLCWeights.h.

m_NormalizationType

std::string GetLCWeights::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 162 of file GetLCWeights.h.

m_NormalizationTypeNumber

int GetLCWeights::m_NormalizationTypeNumber

private

Definition at line 164 of file GetLCWeights.h.

m_outputFile

std::unique_ptr<TFile> GetLCWeights::m_outputFile

private

Output file to save histograms in.

Internal variable pointing to the output file.

Definition at line 126 of file GetLCWeights.h.

m_outputFileName

std::string GetLCWeights::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 Weights histograms.

Definition at line 120 of file GetLCWeights.h.

m_useInversionMethod

bool GetLCWeights::m_useInversionMethod

private

flag to switch on/off the use of the inversion method

If true the inversion method is used - i.e. the weights are calculated as E_rec/E_true vs. E_true and not as E_true/E_rec vs. E_rec. If the inversion method is used the actual correction histogram has to be created in a final step after all histograms have been added by looping over the possible E_true values, calculating E_rec from the histogram and then filling E_true/E_rec vs. E_rec in the new weighting histogram.

Definition at line 150 of file GetLCWeights.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.

m_weight

std::vector<std::vector<TProfile2D *> > GetLCWeights::m_weight

private

Vector of vector of actual histograms.

Internal lists of histograms for each possible sampling to fill and save.

Definition at line 113 of file GetLCWeights.h.

---

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

• GetLCWeights.h
• GetLCWeights.cxx