ldmx::HcalCluster Class Reference

Stores cluster information from the HCal. More...

#include <HcalCluster.h>

Public Member Functions
	HcalCluster ()=default
	Class constructor.
virtual	~HcalCluster ()
	Class destructor.
void	clear ()
	Reset the HcalCluster object.
void	addHits (const std::vector< const ldmx::HcalHit * > hitsVec)
	Take in the hits that make up the cluster.
void	setTime (double time)
double	getTime () const
bool	operator< (const HcalCluster &rhs) const
Public Member Functions inherited from ldmx::CaloCluster
	CaloCluster ()=default
	Class constructor.
virtual	~CaloCluster ()
	Class destructor.
void	clear ()
	Reset the CaloCluster object.
void	addHits (const std::vector< const ldmx::CalorimeterHit * > hitsVec)
	Take in the hits that make up the cluster.
void	setEnergy (double energy)
	Sets total energy for the cluster.
void	setNHits (int nHits)
	Sets total number of hits in the cluster.
void	setIDs (std::vector< unsigned int > &hitIDs)
	Sets a sorted vector for the IDs of the hits_ that make up the cluster.
void	setHitValsX (std::vector< float > &x_)
void	setHitValsY (std::vector< float > &x_)
void	setHitValsZ (std::vector< float > &x_)
void	setHitValsE (std::vector< float > &x_)
void	setCentroidXYZ (double centroid_x, double centroid_y, double centroid_z)
	Sets the three coordinates of the cluster centroid.
void	setLayer (int layer)
void	setRMSXYZ (double rms_x, double rms_y, double rms_z)
void	setDXDZ (double dxdz)
void	setDYDZ (double dydz)
void	setEDXDZ (double err_dxdz)
void	setEDYDZ (double err_dydz)
double	getEnergy () const
int	getNHits () const
double	getCentroidX () const
	centroid x-location
double	getCentroidY () const
	centroid y-location
double	getCentroidZ () const
	centroid z-location
int	getLayer () const
	layer of the cluster centroid
double	getRMSX () const
	rms in x
double	getRMSY () const
	rms in y
double	getRMSZ () const
	rms in z
double	getDXDZ () const
	Delta in x-z plane.
double	getDYDZ () const
	Delta in y-z plane.
double	getEDXDZ () const
	Delta unc on unc in x-z plane.
double	getEDYDZ () const
	Delta unc on unc in y-z plane.
const std::vector< unsigned int > &	getHitIDs () const
const std::vector< float > &	getHitX () const
const std::vector< float > &	getHitY () const
const std::vector< float > &	getHitZ () const
const std::vector< float > &	getHitE () const
bool	operator< (const CaloCluster &rhs) const

Private Member Functions
	ClassDef (HcalCluster, 1)

Private Attributes
double	time_ {0}

Additional Inherited Members
Protected Attributes inherited from ldmx::CaloCluster
std::vector< unsigned int >	hit_ids_
double	energy_ {0}
int	n_hits_ {0}
double	centroid_x_ {0}
double	centroid_y_ {0}
double	centroid_z_ {0}
int	layer_ {-1}
double	rms_x_ {0}
double	rms_y_ {0}
double	rms_z_ {0}
double	dxdz_ {0}
double	dydz_ {0}
double	err_dxdz_ {0}
double	err_dydz_ {0}
std::vector< float >	hit_x_
std::vector< float >	hit_y_
std::vector< float >	hit_z_
std::vector< float >	hit_e_

Detailed Description

Stores cluster information from the HCal.

Definition at line 21 of file HcalCluster.h.

Constructor & Destructor Documentation

~HcalCluster()

ldmx::HcalCluster::~HcalCluster ( )

virtual

Class destructor.

Definition at line 6 of file HcalCluster.cxx.

{ clear(); }

References clear().

Member Function Documentation

addHits()

void ldmx::HcalCluster::addHits

(

const std::vector< const ldmx::HcalHit * >

hitsVec

)

Take in the hits that make up the cluster.

Parameters

hit	The digi hit's entry number in the events digi collection.

Definition at line 13 of file HcalCluster.cxx.

                                                                  {
  std::vector<unsigned int> vec_i_ds;
  for (unsigned int i_hit = 0; i_hit < hitsVec.size(); i_hit++) {
    vec_i_ds.push_back(hitsVec[i_hit]->getID());
  }
  setIDs(vec_i_ds);
}

References ldmx::CaloCluster::setIDs().

Referenced by hcal::HcalClusterProducer::produce().

clear()

void ldmx::HcalCluster::clear

(

)

Reset the HcalCluster object.

Definition at line 8 of file HcalCluster.cxx.

                        {
  ldmx::CaloCluster::clear();
  time_ = 0;
}

References ldmx::CaloCluster::clear().

Referenced by ~HcalCluster().

getTime()

double ldmx::HcalCluster::getTime ( ) const

inline

Definition at line 47 of file HcalCluster.h.

{ return time_; }

operator<()

bool ldmx::HcalCluster::operator< ( const HcalCluster & rhs ) const

inline

Definition at line 49 of file HcalCluster.h.

                                               {
    return this->getEnergy() < rhs.getEnergy();
  }

setTime()

void ldmx::HcalCluster::setTime ( double time )

inline

Definition at line 45 of file HcalCluster.h.

{ time_ = time; }

Member Data Documentation

time_

double ldmx::HcalCluster::time_ {0}

private

Definition at line 54 of file HcalCluster.h.

{0};

---

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

• Hcal/include/Hcal/Event/HcalCluster.h
• Hcal/src/Hcal/Event/HcalCluster.cxx