PFUnifiedMomentCalculatorTool Class Reference

This tool uses a CaloClusterCollectionProcessor to calculate new moments for the modified calorimeter clusters (modified when we do the charged shower subtraction), and makes use of IPFClusterCollectionTool to generate a VIEW container of xAOD::CaloCluster to be used in the CaloClusterCollectionProcessor tool. More...

#include <PFUnifiedMomentCalculatorTool.h>

Inheritance diagram for PFUnifiedMomentCalculatorTool:

Collaboration diagram for PFUnifiedMomentCalculatorTool:

Public Member Functions
	PFUnifiedMomentCalculatorTool (const std::string &type, const std::string &name, const IInterface *parent)
	~PFUnifiedMomentCalculatorTool ()
virtual StatusCode	initialize () override
virtual StatusCode	processPFlowData (const EventContext &ctx, PFData &thePFData) const override

Private Attributes
ToolHandle< IPFClusterCollectionTool >	m_clusterCollectionTool {this,"PFClusterCollectionTool","eflowRecClusterCollectionTool","Tool to put all clusters into a temporary container - then we use this to calculate moments, some of which depend on configuration of nearby clusters"}
	Tool to put all clusters into a temporary container - then we use this to calculate moments, some of which depend on configuration of nearby clusters.
ToolHandle< CaloClusterCollectionProcessor >	m_clusterMomentsMaker {this,"CaloClusterMomentsMaker","CaloClusterMomentsMaker","Tool to calculate cluster moments"}
	Tool to calculate cluster moments.
ToolHandle< CaloClusterCollectionProcessor >	m_clusterCalibHitMomentsMaker2 {this,"CaloCalibClusterMomentsMaker2","CaloCalibClusterMomentsMaker2","Tool to calculate calibration hit cluster moments"}
	Tool to calculate calibration hit truth cluster moments.
Gaudi::Property< bool >	m_LCMode {this,"LCMode",false,"Toggle whether we are in LC mode - false by default"}
	Toggle whether we are in LC mode - false by default.
Gaudi::Property< bool >	m_useCalibHitTruth {this,"UseCalibHitTruth",false,"Toggle usage of calibration hit truth - false by default"}
	Toggle usage of calibration hit truth - false by default.

Detailed Description

This tool uses a CaloClusterCollectionProcessor to calculate new moments for the modified calorimeter clusters (modified when we do the charged shower subtraction), and makes use of IPFClusterCollectionTool to generate a VIEW container of xAOD::CaloCluster to be used in the CaloClusterCollectionProcessor tool.

Inherits from IPFBaseAlgTool.

Definition at line 19 of file PFUnifiedMomentCalculatorTool.h.

Constructor & Destructor Documentation

PFUnifiedMomentCalculatorTool()

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

Definition at line 12 of file PFUnifiedMomentCalculatorTool.cxx.

                                                                                                                                 :
  base_class( type, name, parent)
{
}

~PFUnifiedMomentCalculatorTool()

PFUnifiedMomentCalculatorTool::~PFUnifiedMomentCalculatorTool ( )

inline

Definition at line 25 of file PFUnifiedMomentCalculatorTool.h.

{}

Member Function Documentation

initialize()

StatusCode PFUnifiedMomentCalculatorTool::initialize ( )

overridevirtual

Definition at line 17 of file PFUnifiedMomentCalculatorTool.cxx.

                                                    {
 
  /* Retrieve the cluster collection tool */
  ATH_CHECK(m_clusterCollectionTool.retrieve());
 
  /* Retrieve the cluster moments maker */
  ATH_CHECK(m_clusterMomentsMaker.retrieve());
 
  /* Retrieve the cluster calib hit moments maker */
  if (m_useCalibHitTruth) ATH_CHECK(m_clusterCalibHitMomentsMaker2.retrieve());
  else m_clusterCalibHitMomentsMaker2.disable();
 
  return StatusCode::SUCCESS;
}

processPFlowData()

StatusCode PFUnifiedMomentCalculatorTool::processPFlowData ( const EventContext & ctx, PFData & thePFData ) const

overridevirtual

Definition at line 32 of file PFUnifiedMomentCalculatorTool.cxx.

                                                                                                           {
 
  if (!thePFData.caloObjects) {
    ATH_MSG_ERROR("PFData::caloObjects is null; caller must set it before invoking the moment calculator tool");
    return StatusCode::FAILURE;
  }
 
  eflowCaloObjectContainer *theEflowCaloObjectContainer = thePFData.caloObjects;
 
  /* Collect all the clusters in a temporary container (with VIEW_ELEMENTS!) */
  bool useNonModifiedClusters = true;
  if (true == m_LCMode) useNonModifiedClusters = false;
  std::unique_ptr<xAOD::CaloClusterContainer> tempClusterContainer = m_clusterCollectionTool->execute(*theEflowCaloObjectContainer, useNonModifiedClusters);
 
  /* Set the layer energies */
  /* This must be set before the cluster moment calculations, which use the layer energies */
  for (auto cluster : *tempClusterContainer) CaloClusterKineHelper::calculateKine(cluster, true, true);
 
  /* Remake the cluster moments */
  ATH_CHECK(m_clusterMomentsMaker->execute(ctx, tempClusterContainer.get()));
 
  if (m_useCalibHitTruth){
    ATH_CHECK(m_clusterCalibHitMomentsMaker2->execute(ctx, tempClusterContainer.get()));
  }
 
  return StatusCode::SUCCESS;
}

Member Data Documentation

m_clusterCalibHitMomentsMaker2

ToolHandle<CaloClusterCollectionProcessor> PFUnifiedMomentCalculatorTool::m_clusterCalibHitMomentsMaker2 {this,"CaloCalibClusterMomentsMaker2","CaloCalibClusterMomentsMaker2","Tool to calculate calibration hit cluster moments"}

private

Tool to calculate calibration hit truth cluster moments.

Definition at line 39 of file PFUnifiedMomentCalculatorTool.h.

{this,"CaloCalibClusterMomentsMaker2","CaloCalibClusterMomentsMaker2","Tool to calculate calibration hit cluster moments"};

m_clusterCollectionTool

ToolHandle<IPFClusterCollectionTool> PFUnifiedMomentCalculatorTool::m_clusterCollectionTool {this,"PFClusterCollectionTool","eflowRecClusterCollectionTool","Tool to put all clusters into a temporary container - then we use this to calculate moments, some of which depend on configuration of nearby clusters"}

private

Tool to put all clusters into a temporary container - then we use this to calculate moments, some of which depend on configuration of nearby clusters.

Definition at line 33 of file PFUnifiedMomentCalculatorTool.h.

{this,"PFClusterCollectionTool","eflowRecClusterCollectionTool","Tool to put all clusters into a temporary container - then we use this to calculate moments, some of which depend on configuration of nearby clusters"};

m_clusterMomentsMaker

ToolHandle<CaloClusterCollectionProcessor> PFUnifiedMomentCalculatorTool::m_clusterMomentsMaker {this,"CaloClusterMomentsMaker","CaloClusterMomentsMaker","Tool to calculate cluster moments"}

private

Tool to calculate cluster moments.

Definition at line 36 of file PFUnifiedMomentCalculatorTool.h.

{this,"CaloClusterMomentsMaker","CaloClusterMomentsMaker","Tool to calculate cluster moments"};

m_LCMode

Gaudi::Property<bool> PFUnifiedMomentCalculatorTool::m_LCMode {this,"LCMode",false,"Toggle whether we are in LC mode - false by default"}

private

Toggle whether we are in LC mode - false by default.

Definition at line 42 of file PFUnifiedMomentCalculatorTool.h.

{this,"LCMode",false,"Toggle whether we are in LC mode - false by default"};

m_useCalibHitTruth

Gaudi::Property<bool> PFUnifiedMomentCalculatorTool::m_useCalibHitTruth {this,"UseCalibHitTruth",false,"Toggle usage of calibration hit truth - false by default"}

private

Toggle usage of calibration hit truth - false by default.

Definition at line 45 of file PFUnifiedMomentCalculatorTool.h.

{this,"UseCalibHitTruth",false,"Toggle usage of calibration hit truth - false by default"};\

---

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

• PFUnifiedMomentCalculatorTool.h
• PFUnifiedMomentCalculatorTool.cxx