Stores cluster information from the trigger scintillator pads. More...

#include <TrigScintCluster.h>

Public Member Functions
	TrigScintCluster ()=default
	Class constructor.

virtual	~TrigScintCluster ()
	Class destructor.

void	clear (Option_t *option="")
	Reset the TrigScintCluster object.

void	addHit (uint idx, const ldmx::TrigScintHit *hit)
	Take in the hits that make up the cluster.

void	setSeed (int idx)

void	setEnergy (double energy)
	Set the cluster energy.

void	setPE (float PE)
	Set the cluster photoelectron count (PE)

void	setNHits (int nHits)
	The number of hits forming the cluster.

void	setIDs (std::vector< unsigned int > &hitIDs)
	The channel numbers of hits forming the cluster.

void	setCentroidXYZ (double x, double y, double z)
	The cluster centroid in x,y,z.

void	setCentroid (double centroid)

void	setTime (float t)
	Set time of hit.

float	getTime () const
	Get time of hit.

void	setBeamEfrac (float e)
	Set beam energy fraction of hit.

float	getBeamEfrac () const
	Get beam energy fraction of hit.

int	getSeed () const
	Get cluster seed channel nb.

double	getEnergy () const
	Get cluster total energy deposition.

double	getPE () const
	Get cluster total photoelectron count.

int	getNHits () const
	Get the number of hits constituting the cluster.

double	getCentroidX () const
	Get cluster centroid in x [mm] (not implmented)

double	getCentroidY () const
	Get cluster centroid in y [mm] (not implmented)

double	getCentroidZ () const
	Get cluster centroid in z [mm] (not implmented)

const std::vector< unsigned int > &	getHitIDs () const
	Get vector of channel IDs of hits forming the cluster.

double	getCentroid () const
	Get the cluster centroid in units of channel nb.

bool	operator< (const TrigScintCluster &rhs) const

Private Member Functions
	ClassDef (TrigScintCluster, 3)
	The ROOT class definition.

Private Attributes
std::vector< unsigned int >	hit_ids_

double	energy_ {0}

int	n_hits_ {0}

float	pe_ {0}

int	seed_ {-1}

double	centroid_ {-1}

double	centroid_x_ {0}

double	centroid_y_ {0}

double	centroid_z_ {0}

float	beam_efrac_ {0.}

float	time_ {0.}

Friends
std::ostream &	operator<< (std::ostream &o, const TrigScintCluster &d)
	Print a description of this object.

Detailed Description

Stores cluster information from the trigger scintillator pads.

Adds on the ECal cluster functionality

Definition at line 21 of file TrigScintCluster.h.

Constructor & Destructor Documentation

◆ ~TrigScintCluster()

ldmx::TrigScintCluster::~TrigScintCluster ( )

virtual

Class destructor.

Definition at line 6 of file TrigScintCluster.cxx.

6{ clear(); }

ldmx::TrigScintCluster::clear

void clear(Option_t *option="")

Reset the TrigScintCluster object.

Definition TrigScintCluster.cxx:21

References clear().

Member Function Documentation

◆ addHit()

void ldmx::TrigScintCluster::addHit	(	uint	idx,
		const ldmx::TrigScintHit *	hit )

Take in the hits that make up the cluster.

Parameters

idx	The digi hit's entry number in the event's digi collection.
hit	The digi hit

◆ clear()

void ldmx::TrigScintCluster::clear ( Option_t * option = "" )

Reset the TrigScintCluster object.

Definition at line 21 of file TrigScintCluster.cxx.

                                      {
  hit_ids_.clear();
 
  centroid_x_ = 0;
  centroid_y_ = 0;
  centroid_z_ = 0;
  setEnergy(0);
  setNHits(0);
  setCentroid(0);
  setSeed(-1);
}

References setCentroid(), setEnergy(), setNHits(), and setSeed().

Referenced by ~TrigScintCluster().

◆ getBeamEfrac()

float ldmx::TrigScintCluster::getBeamEfrac ( ) const

inline

Get beam energy fraction of hit.

Definition at line 108 of file TrigScintCluster.h.

108{ return beam_efrac_; }

◆ getCentroid()

double ldmx::TrigScintCluster::getCentroid ( ) const

inline

Get the cluster centroid in units of channel nb.

Definition at line 135 of file TrigScintCluster.h.

135{ return centroid_; }

◆ getCentroidX()

double ldmx::TrigScintCluster::getCentroidX ( ) const

inline

Get cluster centroid in x [mm] (not implmented)

Definition at line 123 of file TrigScintCluster.h.

123{ return centroid_x_; }

◆ getCentroidY()

double ldmx::TrigScintCluster::getCentroidY ( ) const

inline

Get cluster centroid in y [mm] (not implmented)

Definition at line 126 of file TrigScintCluster.h.

126{ return centroid_y_; }

◆ getCentroidZ()

double ldmx::TrigScintCluster::getCentroidZ ( ) const

inline

Get cluster centroid in z [mm] (not implmented)

Definition at line 129 of file TrigScintCluster.h.

129{ return centroid_z_; }

◆ getEnergy()

double ldmx::TrigScintCluster::getEnergy ( ) const

inline

Get cluster total energy deposition.

Definition at line 114 of file TrigScintCluster.h.

114{ return energy_; }

◆ getHitIDs()

const std::vector< unsigned int > & ldmx::TrigScintCluster::getHitIDs ( ) const

inline

Get vector of channel IDs of hits forming the cluster.

Definition at line 132 of file TrigScintCluster.h.

132{ return hit_ids_; }

◆ getNHits()

int ldmx::TrigScintCluster::getNHits ( ) const

inline

Get the number of hits constituting the cluster.

Definition at line 120 of file TrigScintCluster.h.

120{ return n_hits_; }

◆ getPE()

double ldmx::TrigScintCluster::getPE ( ) const

inline

Get cluster total photoelectron count.

Definition at line 117 of file TrigScintCluster.h.

117{ return pe_; }

◆ getSeed()

int ldmx::TrigScintCluster::getSeed ( ) const

inline

Get cluster seed channel nb.

Definition at line 111 of file TrigScintCluster.h.

111{ return seed_; }

◆ getTime()

float ldmx::TrigScintCluster::getTime ( ) const

inline

Get time of hit.

Definition at line 102 of file TrigScintCluster.h.

102{ return time_; }

◆ operator<()

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

inline

Definition at line 137 of file TrigScintCluster.h.

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

◆ setBeamEfrac()

void ldmx::TrigScintCluster::setBeamEfrac ( float e )

inline

Set beam energy fraction of hit.

Definition at line 105 of file TrigScintCluster.h.

105{ beam_efrac_ = e; }

Referenced by trigscint::TestBeamClusterProducer::produce(), and trigscint::TrigScintClusterProducer::produce().

◆ setCentroid()

void ldmx::TrigScintCluster::setCentroid ( double centroid )

inline

Parameters

centroid The channel ID centroid

Definition at line 96 of file TrigScintCluster.h.

96{ centroid_ = centroid; }

Referenced by clear(), trigscint::TestBeamClusterProducer::produce(), and trigscint::TrigScintClusterProducer::produce().

◆ setCentroidXYZ()

void ldmx::TrigScintCluster::setCentroidXYZ	(	double	x,
		double	y,
		double	z )

inline

The cluster centroid in x,y,z.

Parameters

x	Cluster x coordinate
y	Cluster y coordinate
z	Cluster z coordinate (not implemented)

Definition at line 87 of file TrigScintCluster.h.

                                                    {
    centroid_x_ = x;
    centroid_y_ = y;
    centroid_z_ = z;
  }

Referenced by trigscint::TrigScintClusterProducer::produce().

◆ setEnergy()

void ldmx::TrigScintCluster::setEnergy ( double energy )

inline

Set the cluster energy.

Parameters

energy The cluster energy deposition (in units given by hit)

Definition at line 61 of file TrigScintCluster.h.

61{ energy_ = energy; }

Referenced by clear(), trigscint::TestBeamClusterProducer::produce(), and trigscint::TrigScintClusterProducer::produce().

◆ setIDs()

void ldmx::TrigScintCluster::setIDs ( std::vector< unsigned int > & hitIDs )

inline

The channel numbers of hits forming the cluster.

Parameters

hitIDs vector of channel numbers of hits forming the cluster

Definition at line 79 of file TrigScintCluster.h.

79{ hit_ids_ = hitIDs; }

Referenced by trigscint::TestBeamClusterProducer::produce(), and trigscint::TrigScintClusterProducer::produce().

◆ setNHits()

void ldmx::TrigScintCluster::setNHits ( int nHits )

inline

The number of hits forming the cluster.

Parameters

nHits Number of hits forming the cluster

Definition at line 73 of file TrigScintCluster.h.

73{ n_hits_ = nHits; }

Referenced by clear(), trigscint::TestBeamClusterProducer::produce(), and trigscint::TrigScintClusterProducer::produce().

◆ setPE()

void ldmx::TrigScintCluster::setPE ( float PE )

inline

Set the cluster photoelectron count (PE)

Parameters

PE	The cluster photoelectron count

Definition at line 67 of file TrigScintCluster.h.

67{ pe_ = PE; }

Referenced by trigscint::TestBeamClusterProducer::produce(), and trigscint::TrigScintClusterProducer::produce().

◆ setSeed()

void ldmx::TrigScintCluster::setSeed ( int idx )

inline

Parameters

idx	The digi collection index of the hit seeding the cluster

Definition at line 55 of file TrigScintCluster.h.

55{ seed_ = idx; }

Referenced by clear(), trigscint::TestBeamClusterProducer::produce(), and trigscint::TrigScintClusterProducer::produce().

◆ setTime()

void ldmx::TrigScintCluster::setTime ( float t )

inline

Set time of hit.

Definition at line 99 of file TrigScintCluster.h.

99{ time_ = t; }

Referenced by trigscint::TestBeamClusterProducer::produce(), and trigscint::TrigScintClusterProducer::produce().

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<<	(	std::ostream &	o,
		const TrigScintCluster &	d )

friend

Print a description of this object.

Definition at line 8 of file TrigScintCluster.cxx.

                                                                 {
  o << "TrigScintCluster { " << "Energy: " << c.energy_ << ", "
    << "Number of hits: " << c.n_hits_ << ", " << "Seed channel " << c.seed_
    << ", Channel centroid: " << c.centroid_ << " }";
  o << "  --  Constituent hit channel ids: {  ";
  for (const auto& idx : c.getHitIDs()) {
    o << idx << "  ";
 
    o << "}";
  }
  return o;
};

Member Data Documentation

◆ beam_efrac_

float ldmx::TrigScintCluster::beam_efrac_ {0.}

private

Definition at line 172 of file TrigScintCluster.h.

172{0.};

◆ centroid_

double ldmx::TrigScintCluster::centroid_ {-1}

private

Definition at line 159 of file TrigScintCluster.h.

159{-1};

◆ centroid_x_

double ldmx::TrigScintCluster::centroid_x_ {0}

private

Definition at line 162 of file TrigScintCluster.h.

162{0};

◆ centroid_y_

double ldmx::TrigScintCluster::centroid_y_ {0}

private

Definition at line 165 of file TrigScintCluster.h.

165{0};

◆ centroid_z_

double ldmx::TrigScintCluster::centroid_z_ {0}

private

Definition at line 168 of file TrigScintCluster.h.

168{0};

◆ energy_

double ldmx::TrigScintCluster::energy_ {0}

private

Definition at line 146 of file TrigScintCluster.h.

146{0};

◆ hit_ids_

std::vector<unsigned int> ldmx::TrigScintCluster::hit_ids_

private

Definition at line 143 of file TrigScintCluster.h.

◆ n_hits_

int ldmx::TrigScintCluster::n_hits_ {0}

private

Definition at line 149 of file TrigScintCluster.h.

149{0};

◆ pe_

float ldmx::TrigScintCluster::pe_ {0}

private

Definition at line 152 of file TrigScintCluster.h.

152{0};

◆ seed_

int ldmx::TrigScintCluster::seed_ {-1}

private

Definition at line 155 of file TrigScintCluster.h.

155{-1};

◆ time_

float ldmx::TrigScintCluster::time_ {0.}

private

Definition at line 176 of file TrigScintCluster.h.

176{0.};

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

TrigScint/include/TrigScint/Event/TrigScintCluster.h
TrigScint/src/TrigScint/Event/TrigScintCluster.cxx

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ~TrigScintCluster()

Member Function Documentation

◆ addHit()

◆ clear()

◆ getBeamEfrac()

◆ getCentroid()

◆ getCentroidX()

◆ getCentroidY()

◆ getCentroidZ()

◆ getEnergy()

◆ getHitIDs()

◆ getNHits()

◆ getPE()

◆ getSeed()

◆ getTime()

◆ operator<()

◆ setBeamEfrac()

◆ setCentroid()

◆ setCentroidXYZ()

◆ setEnergy()

◆ setIDs()

◆ setNHits()

◆ setPE()

◆ setSeed()

◆ setTime()

Friends And Related Symbol Documentation

◆ operator<<

Member Data Documentation

◆ beam_efrac_

◆ centroid_

◆ centroid_x_

◆ centroid_y_

◆ centroid_z_

◆ energy_

◆ hit_ids_

◆ n_hits_

◆ pe_

◆ seed_

◆ time_