eflowRecCluster Class Reference

This class extends the information about a xAOD::CaloCluster. More...

#include <eflowRecCluster.h>

Collaboration diagram for eflowRecCluster:

Classes
class	SortDescendingPt

Public Member Functions
	eflowRecCluster (const ElementLink< xAOD::CaloClusterContainer > &clusElementLink, xAOD::CaloClusterContainer &newClusContainer)
	eflowRecCluster (const eflowRecCluster &originalEflowRecCluster)
eflowRecCluster &	operator= (const eflowRecCluster &originalEflowRecCluster)=delete
virtual	~eflowRecCluster ()
xAOD::CaloCluster *	getCluster ()
const xAOD::CaloCluster *	getCluster () const
ElementLink< xAOD::CaloClusterContainer >	getClusElementLink () const
ElementLink< xAOD::CaloClusterContainer >	getOriginalClusElementLink () const
eflowMatchCluster *	getMatchCluster () const
double	getSumExpectedEnergy ()
double	getVarianceOfSumExpectedEnergy ()
bool	isEOverPFail (bool consistencySigmaCut, bool useGoldenMode)
void	addTrackMatch (eflowTrackClusterLink *trackMatch)
const std::vector< eflowTrackClusterLink * > &	getTrackMatches () const
void	clearTrackMatches ()
int	getNTracks () const
int	getClusterId () const
void	setClusterId (int clusterId)
void	setCellsWeight (std::map< IdentifierHash, double > &&cellsWeight)
const std::map< IdentifierHash, double > &	getCellsWeight () const
int	getClusterType () const
	Specifies if we have a cluster mainly in ECAL, HCAL or FCAL More...
bool	isTouchable () const

Private Types
enum	CalorimeterType {   CALORIMETER_START = 0, UNASSIGNED = CALORIMETER_START, ECAL = 1, HCAL = 2,   FCAL = 3, UNKNOWN = 4, CALORIMETER_END = 5 }
	ENUM that defines calorimeter regions as ECAL, HCAL or FCAL More...

Private Member Functions
void	setClusterType ()

Private Attributes
int	m_clusterId
int	m_calorimeterType
xAOD::CaloCluster *	m_cluster
ElementLink< xAOD::CaloClusterContainer >	m_originalClusElementLink
ElementLink< xAOD::CaloClusterContainer >	m_clusElementLink
bool	m_isTouchable
std::map< IdentifierHash, double >	m_cellsWeightMap
std::unique_ptr< eflowMatchCluster >	m_matchCluster
std::vector< eflowTrackClusterLink * >	m_trackMatches

Detailed Description

This class extends the information about a xAOD::CaloCluster.

It includes an element link and raw pointer back to the CaloCluster, the index of the cluster in the CaloClusterContainer, a bool to determine if the CaloCluster is allowed to be modified or not (only if we have already copied the CaloCluster), the type (ECAL/HCAL), a map to store the LC weights for the calorimeter cluster cells, a pointer to an eflowMatchCluster and a vector of eflowTrackClusterLink

Definition at line 39 of file eflowRecCluster.h.

Member Enumeration Documentation

CalorimeterType

enum eflowRecCluster::CalorimeterType

private

ENUM that defines calorimeter regions as ECAL, HCAL or FCAL

Enumerator
CALORIMETER_START
UNASSIGNED
ECAL
HCAL
FCAL
UNKNOWN
CALORIMETER_END

Definition at line 96 of file eflowRecCluster.h.

  {
    CALORIMETER_START = 0,
    UNASSIGNED = CALORIMETER_START,
    ECAL = 1,
    HCAL = 2,
    FCAL = 3,
    UNKNOWN = 4,
    CALORIMETER_END = 5
  };

Constructor & Destructor Documentation

eflowRecCluster() [1/2]

eflowRecCluster::eflowRecCluster	(	const ElementLink< xAOD::CaloClusterContainer > &	clusElementLink,
		xAOD::CaloClusterContainer &	newClusContainer
	)

Definition at line 17 of file eflowRecCluster.cxx.

                                                                                                                                         :
  m_clusterId(-1), m_calorimeterType(UNASSIGNED) , m_originalClusElementLink(clusElementLink), m_isTouchable(false),  m_matchCluster(nullptr) {
  const xAOD::CaloCluster* originalCluster = *clusElementLink;
  m_cluster = new xAOD::CaloCluster();
  newClusContainer.push_back(m_cluster);
  m_clusElementLink = ElementLink<xAOD::CaloClusterContainer>(newClusContainer,newClusContainer.size()-1);
 
  const CaloClusterCellLink* theOldCellLinks = originalCluster->getCellLinks();
 
  CaloClusterCellLink *newLinks = new CaloClusterCellLink(*theOldCellLinks);
  m_cluster->addCellLink(newLinks);
  m_cluster->setClusterSize(xAOD::CaloCluster::Topo_420);
  CaloClusterKineHelper::calculateKine(m_cluster,true,true);
 
  m_cluster->setRawE(m_cluster->calE());
  m_cluster->setRawEta(m_cluster->calEta());
  m_cluster->setRawPhi(m_cluster->calPhi());
  m_cluster->setRawM(m_cluster->calM());
 
  m_matchCluster = std::make_unique<eflowMatchCluster>(this);
  setClusterType();
}

eflowRecCluster() [2/2]

eflowRecCluster::eflowRecCluster

(

const eflowRecCluster &

originalEflowRecCluster

)

Definition at line 40 of file eflowRecCluster.cxx.

  : m_clusterId (originalEflowRecCluster.m_clusterId),
    m_calorimeterType (originalEflowRecCluster.m_calorimeterType),
    m_cluster (originalEflowRecCluster.m_cluster),
    m_originalClusElementLink (originalEflowRecCluster.m_originalClusElementLink),
    m_clusElementLink (originalEflowRecCluster.m_clusElementLink),
    m_isTouchable (originalEflowRecCluster.m_isTouchable),
    m_matchCluster (std::make_unique<eflowMatchCluster>(this))
{
}

~eflowRecCluster()

eflowRecCluster::~eflowRecCluster ( )

virtualdefault

Member Function Documentation

addTrackMatch()

void eflowRecCluster::addTrackMatch ( eflowTrackClusterLink *  trackMatch )

inline

Definition at line 69 of file eflowRecCluster.h.

  {
    m_trackMatches.push_back(trackMatch);
  }

clearTrackMatches()

void eflowRecCluster::clearTrackMatches ( )

inline

Definition at line 77 of file eflowRecCluster.h.

{ m_trackMatches.clear(); }

getCellsWeight()

const std::map<IdentifierHash, double>& eflowRecCluster::getCellsWeight ( ) const

inline

Definition at line 85 of file eflowRecCluster.h.

  {
    return m_cellsWeightMap;
  }

getClusElementLink()

ElementLink<xAOD::CaloClusterContainer> eflowRecCluster::getClusElementLink ( ) const

inline

Definition at line 54 of file eflowRecCluster.h.

  {
    return m_clusElementLink;
  }

getCluster() [1/2]

xAOD::CaloCluster* eflowRecCluster::getCluster ( )

inline

Definition at line 49 of file eflowRecCluster.h.

{ return m_cluster; }

getCluster() [2/2]

const xAOD::CaloCluster* eflowRecCluster::getCluster ( ) const

inline

Definition at line 50 of file eflowRecCluster.h.

{ return m_cluster; }

getClusterId()

int eflowRecCluster::getClusterId ( ) const

inline

Definition at line 79 of file eflowRecCluster.h.

{ return m_clusterId; }

getClusterType()

int eflowRecCluster::getClusterType ( ) const

inline

Specifies if we have a cluster mainly in ECAL, HCAL or FCAL

Definition at line 90 of file eflowRecCluster.h.

{  return m_calorimeterType; }

getMatchCluster()

eflowMatchCluster* eflowRecCluster::getMatchCluster ( ) const

inline

Definition at line 63 of file eflowRecCluster.h.

{ return m_matchCluster.get(); }

getNTracks()

int eflowRecCluster::getNTracks ( ) const

inline

Definition at line 78 of file eflowRecCluster.h.

{ return m_trackMatches.size(); }

getOriginalClusElementLink()

ElementLink<xAOD::CaloClusterContainer> eflowRecCluster::getOriginalClusElementLink ( ) const

inline

Definition at line 58 of file eflowRecCluster.h.

  {
    return m_originalClusElementLink;
  }

getSumExpectedEnergy()

double eflowRecCluster::getSumExpectedEnergy

(

)

Definition at line 69 of file eflowRecCluster.cxx.

                                             {
  double expectedEnergy(0);
  int nTrk = getNTracks();
  for (int iTrk = 0; iTrk < nTrk; ++iTrk){
    expectedEnergy += m_trackMatches[iTrk]->getTrack()->getEExpect();
  }
  return expectedEnergy;
}

getTrackMatches()

const std::vector<eflowTrackClusterLink*>& eflowRecCluster::getTrackMatches ( ) const

inline

Definition at line 73 of file eflowRecCluster.h.

  {
    return m_trackMatches;
  }

getVarianceOfSumExpectedEnergy()

double eflowRecCluster::getVarianceOfSumExpectedEnergy

(

)

Definition at line 77 of file eflowRecCluster.cxx.

                                                       {
  double varianceExpectedEnergy(0);
  int nTrk = getNTracks();
  for (int iTrk = 0; iTrk < nTrk; ++iTrk){
    varianceExpectedEnergy += m_trackMatches[iTrk]->getTrack()->getVarEExpect();
  }
  return varianceExpectedEnergy;
}

isEOverPFail()

bool eflowRecCluster::isEOverPFail	(	bool	consistencySigmaCut,
		bool	useGoldenMode
	)

Definition at line 53 of file eflowRecCluster.cxx.

                                                                               {
 
  double expectedEnergy = getSumExpectedEnergy();
  double clusterEnergy = m_cluster->e();
 
  if ((expectedEnergy == 0) && (clusterEnergy > 0)) {
    return false;
  }
 
  double sigma = sqrt(getVarianceOfSumExpectedEnergy());
 
  bool result = useGoldenMode ? fabs(clusterEnergy - expectedEnergy) > consistencySigmaCut*sigma
                              : clusterEnergy < expectedEnergy - consistencySigmaCut*sigma;
  return result;
}

isTouchable()

bool eflowRecCluster::isTouchable ( ) const

inline

Definition at line 91 of file eflowRecCluster.h.

{ return m_isTouchable; }

operator=()

eflowRecCluster& eflowRecCluster::operator= ( const eflowRecCluster &  originalEflowRecCluster )

delete

setCellsWeight()

void eflowRecCluster::setCellsWeight ( std::map< IdentifierHash, double > &&  cellsWeight )

inline

Definition at line 81 of file eflowRecCluster.h.

  {
    m_cellsWeightMap = std::move(cellsWeight);
  }

setClusterId()

void eflowRecCluster::setClusterId ( int  clusterId )

inline

Definition at line 80 of file eflowRecCluster.h.

{ m_clusterId = clusterId; }

setClusterType()

void eflowRecCluster::setClusterType ( )

private

Definition at line 86 of file eflowRecCluster.cxx.

                                     {
 
  double EMB_E = m_cluster->eSample(xAOD::CaloCluster::CaloSample::PreSamplerB)
      + m_cluster->eSample(xAOD::CaloCluster::CaloSample::EMB1)
      + m_cluster->eSample(xAOD::CaloCluster::CaloSample::EMB2)
      + m_cluster->eSample(xAOD::CaloCluster::CaloSample::EMB3);
  double EME_E = m_cluster->eSample(xAOD::CaloCluster::CaloSample::PreSamplerE)
      + m_cluster->eSample(xAOD::CaloCluster::CaloSample::EME1)
      + m_cluster->eSample(xAOD::CaloCluster::CaloSample::EME2)
      + m_cluster->eSample(xAOD::CaloCluster::CaloSample::EME3);
  double HEC_E = m_cluster->eSample(xAOD::CaloCluster::CaloSample::HEC0)
      + m_cluster->eSample(xAOD::CaloCluster::CaloSample::HEC1)
      + m_cluster->eSample(xAOD::CaloCluster::CaloSample::HEC2)
      + m_cluster->eSample(xAOD::CaloCluster::CaloSample::HEC3);
  double Tile_E = m_cluster->eSample(xAOD::CaloCluster::CaloSample::TileBar0)
      + m_cluster->eSample(xAOD::CaloCluster::CaloSample::TileBar1)
      + m_cluster->eSample(xAOD::CaloCluster::CaloSample::TileBar2)
      + m_cluster->eSample(xAOD::CaloCluster::CaloSample::TileGap1)
      + m_cluster->eSample(xAOD::CaloCluster::CaloSample::TileGap2)
      + m_cluster->eSample(xAOD::CaloCluster::CaloSample::TileGap3)
      + m_cluster->eSample(xAOD::CaloCluster::CaloSample::TileExt0)
      + m_cluster->eSample(xAOD::CaloCluster::CaloSample::TileExt1)
      + m_cluster->eSample(xAOD::CaloCluster::CaloSample::TileExt2);
  double FCAL_E = m_cluster->eSample(xAOD::CaloCluster::CaloSample::FCAL0)
      + m_cluster->eSample(xAOD::CaloCluster::CaloSample::FCAL1)
      + m_cluster->eSample(xAOD::CaloCluster::CaloSample::FCAL2);
  double MiniFCAL_E = m_cluster->eSample(xAOD::CaloCluster::CaloSample::MINIFCAL0)
          + m_cluster->eSample(xAOD::CaloCluster::CaloSample::MINIFCAL1)
          + m_cluster->eSample(xAOD::CaloCluster::CaloSample::MINIFCAL2)
          + m_cluster->eSample(xAOD::CaloCluster::CaloSample::MINIFCAL3);
 
  double totalEnergy = EMB_E + EME_E + HEC_E + Tile_E + FCAL_E + MiniFCAL_E;
  if(std::abs(totalEnergy) < 1.0e-4){
     m_calorimeterType = UNASSIGNED;
     return;
  }
  double ratioEM = (EMB_E+EME_E)/totalEnergy;
  double ratioHCAL = (HEC_E+Tile_E)/totalEnergy;
  double ratioFCAL = (FCAL_E + MiniFCAL_E)/totalEnergy;
  m_calorimeterType = UNASSIGNED;
  if(ratioEM > 0.5) {
    m_calorimeterType = ECAL;
  } else if (ratioHCAL > 0.5) {
    m_calorimeterType = HCAL;
  } else if (ratioFCAL > 0.5) {
    m_calorimeterType = FCAL;
  } else {
    m_calorimeterType = UNKNOWN;
  }
  assert(m_calorimeterType!=UNASSIGNED);
}

Member Data Documentation

m_calorimeterType

int eflowRecCluster::m_calorimeterType

private

Definition at line 108 of file eflowRecCluster.h.

m_cellsWeightMap

std::map<IdentifierHash, double> eflowRecCluster::m_cellsWeightMap

private

Definition at line 117 of file eflowRecCluster.h.

m_clusElementLink

ElementLink<xAOD::CaloClusterContainer> eflowRecCluster::m_clusElementLink

private

Definition at line 111 of file eflowRecCluster.h.

m_cluster

xAOD::CaloCluster* eflowRecCluster::m_cluster

private

Definition at line 109 of file eflowRecCluster.h.

m_clusterId

int eflowRecCluster::m_clusterId

private

Definition at line 107 of file eflowRecCluster.h.

m_isTouchable

bool eflowRecCluster::m_isTouchable

private

Definition at line 112 of file eflowRecCluster.h.

m_matchCluster

std::unique_ptr<eflowMatchCluster> eflowRecCluster::m_matchCluster

private

Definition at line 119 of file eflowRecCluster.h.

m_originalClusElementLink

ElementLink<xAOD::CaloClusterContainer> eflowRecCluster::m_originalClusElementLink

private

Definition at line 110 of file eflowRecCluster.h.

m_trackMatches

std::vector<eflowTrackClusterLink*> eflowRecCluster::m_trackMatches

private

Definition at line 120 of file eflowRecCluster.h.

---

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

• eflowRecCluster.h
• eflowRecCluster.cxx