Cluster correction tool which applies local hadronic calibration w eights to the cells. More...

#include <CaloClusterLocalCalib.h>

Inheritance diagram for CaloClusterLocalCalib:

Collaboration diagram for CaloClusterLocalCalib:

Public Member Functions
virtual StatusCode	initialize () override
	Tool initialization: load calibration tools specified by jobOptions.
virtual StatusCode	execute (const EventContext &ctx, xAOD::CaloCluster *theCluster) const override
	Execute on a single cluster.
	CaloClusterLocalCalib (const std::string &type, const std::string &name, const IInterface *parent)
	Standard AlgTool constructor.
virtual StatusCode	execute (const EventContext &ctx, xAOD::CaloClusterContainer *collection) const
	Apply corrections to cluster.
virtual StatusCode	execute (xAOD::CaloClusterContainer *collection) final
	Execute on an entire collection of clusters.
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
	DeclareInterfaceID (CaloClusterCollectionProcessor, 1, 0)

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	Standard Gaudi interface ID method.

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
ToolHandleArray< IClusterClassificationTool >	m_classificationTool {this, "ClusterClassificationTool", {}}
	property: Classification tools
ToolHandleArray< IClusterCellWeightTool >	m_calibTools {this, "LocalCalibTools", {}}
	property: Array of IClusterCellWeightTool
Gaudi::Property< std::vector< int > >	m_recoStatus {this, "ClusterRecoStatus", {}}
	property: vector of valid Reco Statuses for the clusters in order to be calibrated
Gaudi::Property< bool >	m_absOpt {this, "WeightingOfNegClusters", false}
	if set to true, negative clusters are weighted as well
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

Cluster correction tool which applies local hadronic calibration w eights to the cells.

The weight are provided by ICellWeight tools

Definition at line 32 of file CaloClusterLocalCalib.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ CaloClusterLocalCalib()

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

Standard AlgTool constructor.

Definition at line 18 of file CaloClusterLocalCalib.cxx.

  : CaloClusterProcessor(type, name, parent)
{
}

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

◆ DeclareInterfaceID()

CaloClusterCollectionProcessor::DeclareInterfaceID	(	CaloClusterCollectionProcessor	,
		1	,
		0	)

inherited

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

◆ detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

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

Definition at line 85 of file AthCommonDataStore.h.

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute() [1/3]

StatusCode CaloClusterLocalCalib::execute	(	const EventContext &	ctx,
		xAOD::CaloCluster *	cluster ) const

overridevirtual

Execute on a single cluster.

Parameters

cluster	The cluster to process.
ctx	The event context.

Implements CaloClusterProcessor.

Definition at line 50 of file CaloClusterLocalCalib.cxx.

{
  CaloRecoStatus& recoStatus=theCluster->recoStatus();
  // call classification tool
  if (!m_classificationTool.empty()) {
    recoStatus=m_classificationTool[0]->classify(theCluster);
  }
  // check desired reco status
  bool isSelected (false);
  for (unsigned int i=0;!isSelected && i<m_recoStatus.size();i++ )
    isSelected = recoStatus.checkStatus(CaloRecoStatus::StatusIndicator(m_recoStatus[i]));
  if ( isSelected ) {    
    if( m_absOpt ){  
        
 
        //double dm_weight(0.);          
        //double had_weight(0.);
        double centLambd(0.);
        double engdens(0.);
        double emprobability(0.);
        double isolation(0.);
        // Store moments and energy of the old cluster
        //theCluster->retrieveMoment(xAOD::CaloCluster::DM_WEIGHT,  dm_weight); 
        //theCluster->retrieveMoment(xAOD::CaloCluster::HAD_WEIGHT,had_weight); 
        if (!theCluster->retrieveMoment(xAOD::CaloCluster::CENTER_LAMBDA,centLambd))
          centLambd = 0;
        if (!theCluster->retrieveMoment(xAOD::CaloCluster::FIRST_ENG_DENS,engdens))
          engdens = 0;
        if (!theCluster->retrieveMoment(xAOD::CaloCluster::EM_PROBABILITY,emprobability))
          emprobability = 0;
        if (!theCluster->retrieveMoment(xAOD::CaloCluster::ISOLATION,isolation))
          isolation = 0;
        
        double oldEnergy = theCluster->e();           
        
        const CaloCell_ID*               calo_id  = nullptr;
        ATH_CHECK(detStore()->retrieve(calo_id,"CaloCell_ID"));   
              
//         Make new Cluster and CellColl
        //std::unique_ptr<CaloCellContainer> myCellColl=std::make_unique<CaloCellContainer>(SG::OWN_ELEMENTS);
        CaloCellContainer myCellColl(SG::OWN_ELEMENTS);
        std::unique_ptr<xAOD::CaloCluster> myCluster  = CaloClusterStoreHelper::makeCluster(&myCellColl);
        int cellIndex = 0; 
//         Iterate over cells of old cluster and replicate them with energy weighted by -1 if negative and add it to the new cluster
        xAOD::CaloCluster::cell_iterator cellIter = theCluster->cell_begin();  
        for(;cellIter!=theCluster->cell_end();cellIter++) {
          const  CaloCell* pCell = *cellIter;  
          double CellEnergy = pCell->e();    
          //Identifier myId = pCell->ID();    
          //IdentifierHash myHashId = calo_id->calo_cell_hash(myId); 
          if( CellEnergy < 0. )   CellEnergy = -1 * pCell->e();
          myCellColl.push_back(new CaloCell(pCell->caloDDE(), pCell->ID(), CellEnergy, pCell->time(), pCell->quality(),  pCell->provenance(), pCell->gain() ));    
          double cellWeight = cellIter.weight();         
          myCluster->addCell(cellIndex,cellWeight);
          cellIndex++;
        }  
        
        CaloClusterKineHelper::calculateKine(myCluster.get(),false,false);
        myCluster->setRawE(myCluster->e());
        
// Set sample energy of the new cluster to the one of the old cluster, other wise it is zero, important for dm correction
        for(unsigned int i=0; i != CaloSampling::Unknown; ++ i) {
          const xAOD::CaloCluster::CaloSample s=(xAOD::CaloCluster::CaloSample)(i);
          if (myCluster->hasSampling(s)) myCluster->setEnergy((CaloSampling::CaloSample)i, theCluster->eSample((CaloSampling::CaloSample)i)); 
        }//end loop over samplings  
        
        CaloClusterKineHelper::calculateKine(myCluster.get(),true,false);
//           Give the new cluster the same moments as the old one
        myCluster->insertMoment(xAOD::CaloCluster::CENTER_LAMBDA,centLambd);
        myCluster->insertMoment(xAOD::CaloCluster::FIRST_ENG_DENS,engdens);
        myCluster->insertMoment(xAOD::CaloCluster::EM_PROBABILITY,emprobability);
        myCluster->insertMoment(xAOD::CaloCluster::ISOLATION,isolation);
        
//         Weight the new cluster
        for (const ToolHandle<IClusterCellWeightTool>& tool : m_calibTools) {
          if (tool->weight(myCluster.get(),ctx).isFailure())
            msg(MSG::ERROR) << " failed to weight cluster " << endmsg;
        }
 
//       Iterate over new, calibrated cluster and write out the weights of every cell into a map
         std::map<IdentifierHash,double> weightMap;
         xAOD::CaloCluster::cell_iterator mycellIter    = myCluster->cell_begin();
         xAOD::CaloCluster::cell_iterator mycellIterEnd = myCluster->cell_end();      
         for(;mycellIter!=mycellIterEnd;mycellIter++) {
           const CaloCell* pCell = *mycellIter;
           double cellWeight = mycellIter.weight();  
           Identifier myId = pCell->ID();    
           IdentifierHash myHashId = calo_id->calo_cell_hash(myId);
           weightMap[myHashId] = cellWeight;           
         }
 
        
//          Apply cellweight on the corresponding cell of the  original cluster
 
         cellIter    = theCluster->cell_begin();
         for(;cellIter!=theCluster->cell_end();cellIter++) {
           const CaloCell* pCell = *cellIter;
           IdentifierHash myHashId = calo_id->calo_cell_hash(pCell->ID()); 
           double weight = weightMap[myHashId];
           theCluster->reweightCell(cellIter,weight);  
         }           
 
//          Update kinematics of new cluster
         CaloClusterKineHelper::calculateKine(theCluster,true,false); 
  
 
        //Manually insert weight moments to the original cluster, in the OOC case this is a multiplicative weight from LCOut and LCOutPi0
         double newWeightMoment = theCluster->e()/oldEnergy;  
         if(m_calibTools[0].typeAndName() == "CaloLCWeightTool/LCWeight")             theCluster->insertMoment(xAOD::CaloCluster::HAD_WEIGHT,newWeightMoment);         
         if(m_calibTools[0].typeAndName() == "CaloLCDeadMaterialTool/LCDeadMaterial") theCluster->insertMoment(xAOD::CaloCluster::DM_WEIGHT, newWeightMoment);          
         if(m_calibTools[0].typeAndName() == "CaloLCOutOfClusterTool/LCOut")          theCluster->insertMoment(xAOD::CaloCluster::OOC_WEIGHT,newWeightMoment);         
         if(m_calibTools[0].typeAndName() == "CaloLCOutOfClusterTool/LCOutPi0") 
         {
           double ooc_weight;
           if (theCluster->retrieveMoment(xAOD::CaloCluster::OOC_WEIGHT,ooc_weight)) {
             newWeightMoment *= ooc_weight;
             theCluster->insertMoment(xAOD::CaloCluster::OOC_WEIGHT,newWeightMoment);
           }
         }
      }
//    else, what as was always done     
      else{ 
        
        for (const ToolHandle<IClusterCellWeightTool>& tool : m_calibTools) {
          if (tool->weight(theCluster,ctx).isFailure())
            msg(MSG::ERROR) << " failed to weight cluster " << endmsg;
        }       
 
      }
    //report <<MSG::DEBUG<<"new cluster energy="<<theCluster->e()<<endmsg;
  }//end of "has correct reco status" if statement
 
  // PL add calibration method bits to reco status
  recoStatus.setStatus(CaloRecoStatus::CALIBRATEDLHC);
 
  return StatusCode::SUCCESS;
}

◆ execute() [2/3]

StatusCode CaloClusterProcessor::execute	(	const EventContext &	ctx,
		xAOD::CaloClusterContainer *	collection ) const

virtual

Apply corrections to cluster.

Reimplemented from CaloClusterProcessor.

Definition at line 65 of file CaloClusterProcessor.cxx.

{
  for (xAOD::CaloCluster* clu : *collection) {
    ATH_CHECK( execute (ctx, clu) );
  }
  return StatusCode::SUCCESS;
}

◆ execute() [3/3]

virtual StatusCode CaloClusterCollectionProcessor::execute ( xAOD::CaloClusterContainer * collection )

inlinefinalvirtualinherited

Execute on an entire collection of clusters.

Parameters

collection The container of clusters. (deprecated)

Reimplemented from CaloClusterCollectionProcessor.

Definition at line 50 of file CaloClusterCollectionProcessor.h.

  {
    return execute (Gaudi::Hive::currentContext(), collection);
  }

◆ 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

◆ initialize()

StatusCode CaloClusterLocalCalib::initialize ( )

overridevirtual

Tool initialization: load calibration tools specified by jobOptions.

Definition at line 26 of file CaloClusterLocalCalib.cxx.

                                              {
 
  if (m_classificationTool.size()>1) {
    msg(MSG::ERROR) << "More than one classification tool specified!" << endmsg;
    return StatusCode::FAILURE;
  }
  //Retrieve classification tool (if necessary)
  if (!m_classificationTool.empty()) {
    ATH_CHECK(m_classificationTool.retrieve());
    msg(MSG::INFO) << "Found classification tool " << m_classificationTool[0] << endmsg;
  }
 
  //Retrieve calibration tools
  ATH_CHECK(m_calibTools.retrieve());
  msg(MSG::INFO) <<"Loaded "<< m_calibTools.size() <<" hadronic calibration tools"<<endmsg;
  
  // check that at least one reco status is defined
  if ( m_recoStatus.empty() ) {
    msg(MSG::ERROR) << "Please specify at least one valid reco status with ClusterRecoStatus = [...] for this calib tool " << endmsg;
    return StatusCode::FAILURE;
  }
  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 & CaloClusterProcessor::interfaceID ( )

inlinestaticinherited

Standard Gaudi interface ID method.

Definition at line 72 of file CaloClusterProcessor.h.

72{return IID_CaloClusterProcessor;}

IID_CaloClusterProcessor

static const InterfaceID IID_CaloClusterProcessor("CaloClusterProcessor", 1, 0)

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

Gaudi::Property<bool> CaloClusterLocalCalib::m_absOpt {this, "WeightingOfNegClusters", false}

private

if set to true, negative clusters are weighted as well

Definition at line 65 of file CaloClusterLocalCalib.h.

65{this, "WeightingOfNegClusters", false};

◆ m_calibTools

ToolHandleArray<IClusterCellWeightTool> CaloClusterLocalCalib::m_calibTools {this, "LocalCalibTools", {}}

private

property: Array of IClusterCellWeightTool

Definition at line 57 of file CaloClusterLocalCalib.h.

57{this, "LocalCalibTools", {}};

◆ m_classificationTool

ToolHandleArray<IClusterClassificationTool> CaloClusterLocalCalib::m_classificationTool {this, "ClusterClassificationTool", {}}

private

property: Classification tools

Definition at line 52 of file CaloClusterLocalCalib.h.

52{this, "ClusterClassificationTool", {}};

◆ 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_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_recoStatus

Gaudi::Property<std::vector<int> > CaloClusterLocalCalib::m_recoStatus {this, "ClusterRecoStatus", {}}

private

property: vector of valid Reco Statuses for the clusters in order to be calibrated

Definition at line 62 of file CaloClusterLocalCalib.h.

62{this, "ClusterRecoStatus", {}};

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ CaloClusterLocalCalib()

Member Function Documentation

◆ declareGaudiProperty()

◆ DeclareInterfaceID()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute() [1/3]

◆ execute() [2/3]

◆ execute() [3/3]

◆ extraDeps_update_handler()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_absOpt

◆ m_calibTools

◆ m_classificationTool

◆ m_detStore

◆ m_evtStore

◆ m_recoStatus

◆ m_varHandleArraysDeclared

◆ m_vhka