An in-memory representation of a cluster being built during reconstruction. More...

#include <WorkingCluster.h>

Public Member Functions
	WorkingCluster ()=default
	Default constructor.

	WorkingCluster (const HitType *hit)
	Construct a cluster from a single hit.

	WorkingCluster (const HitType &hit)
	Construct a cluster from a single hit (reference version).

	~WorkingCluster ()=default
	Default destructor.

void	add (const HitType *hit)
	Add a hit to the cluster using its stored position.

void	add (const HitType &hit)
	Add a hit to the cluster using its stored position (reference version).

void	add (const HitType *hit, double x, double y, double z)
	Add a hit to the cluster with explicit position.

void	add (const WorkingCluster< HitType > &other)
	Merge another cluster into this one.

double	centroidX () const
	Get the centroid X position (energy-weighted).

double	centroidY () const
	Get the centroid Y position (energy-weighted).

double	centroidZ () const
	Get the centroid Z position (energy-weighted).

double	energy () const
	Get the total energy of the cluster.

double	time () const
	Get the time of the cluster (latest hit time).

const std::vector< const HitType * > &	hits () const
	Get the list of hits in this cluster.

bool	empty () const
	Check if the cluster is empty.

void	clear ()
	Clear all hits from the cluster.

void	setCentroid (double x, double y, double z, double e)
	Set the centroid position and energy explicitly.

void	setTime (double t)
	Set the time explicitly.

int	layer () const
	Get the layer of the cluster.

void	setLayer (int layer)
	Set the layer of the cluster.

Private Attributes
std::vector< const HitType * >	hits_
	The hits in this cluster.

double	centroid_x_ {0}
	Centroid X position (energy-weighted)

double	centroid_y_ {0}
	Centroid Y position (energy-weighted)

double	centroid_z_ {0}
	Centroid Z position (energy-weighted)

double	centroid_e_ {0}
	Total energy.

double	time_ {0}
	Time (latest hit time)

int	layer_ {-1}
	Layer number.

Detailed Description

template<class HitType>
class recon::WorkingCluster< HitType >

An in-memory representation of a cluster being built during reconstruction.

This class is a general-purpose tool for building clusters from calorimeter hits. It is templated on the hit type, which must inherit from CalorimeterHit. The cluster stores an energy-weighted centroid in (x,y,z,E) space.

Template Parameters

HitType The type of hit to cluster (must inherit from CalorimeterHit)

Definition at line 26 of file WorkingCluster.h.

Constructor & Destructor Documentation

◆ WorkingCluster() [1/2]

template<class HitType >

recon::WorkingCluster< HitType >::WorkingCluster ( const HitType * hit )

inline

Construct a cluster from a single hit.

Parameters

hit	Pointer to the hit to initialize the cluster with

Definition at line 38 of file WorkingCluster.h.

                                     {
    if (hit) {
      add(hit);
    }
  }

References recon::WorkingCluster< HitType >::add().

◆ WorkingCluster() [2/2]

template<class HitType >

recon::WorkingCluster< HitType >::WorkingCluster ( const HitType & hit )

inline

Construct a cluster from a single hit (reference version).

Parameters

hit	Reference to the hit to initialize the cluster with

Definition at line 49 of file WorkingCluster.h.

49{ add(hit); }

References recon::WorkingCluster< HitType >::add().

Member Function Documentation

◆ add() [1/4]

template<class HitType >

void recon::WorkingCluster< HitType >::add ( const HitType & hit )

inline

Add a hit to the cluster using its stored position (reference version).

Parameters

hit	Reference to the hit to add

Definition at line 93 of file WorkingCluster.h.

93{ add(&hit); }

References recon::WorkingCluster< HitType >::add().

Referenced by recon::WorkingCluster< HitType >::add().

◆ add() [2/4]

template<class HitType >

void recon::WorkingCluster< HitType >::add ( const HitType * hit )

inline

Add a hit to the cluster using its stored position.

The centroid is updated using energy-weighted averaging.

Parameters

hit	Pointer to the hit to add

Definition at line 63 of file WorkingCluster.h.

                               {
    if (!hit) return;
 
    double hit_e = hit->getEnergy();
    double hit_x = hit->getXPos();
    double hit_y = hit->getYPos();
    double hit_z = hit->getZPos();
    double hit_t = hit->getTime();
 
    double new_e = hit_e + centroid_e_;
    if (new_e > 0) {
      centroid_x_ = (centroid_x_ * centroid_e_ + hit_e * hit_x) / new_e;
      centroid_y_ = (centroid_y_ * centroid_e_ + hit_e * hit_y) / new_e;
      centroid_z_ = (centroid_z_ * centroid_e_ + hit_e * hit_z) / new_e;
    }
    centroid_e_ = new_e;
 
    // Track the latest time
    if (hit_t > time_) {
      time_ = hit_t;
    }
 
    hits_.push_back(hit);
  }

References recon::WorkingCluster< HitType >::centroid_e_, recon::WorkingCluster< HitType >::centroid_x_, recon::WorkingCluster< HitType >::centroid_y_, recon::WorkingCluster< HitType >::centroid_z_, recon::WorkingCluster< HitType >::hits_, and recon::WorkingCluster< HitType >::time_.

Referenced by recon::TemplatedClusterFinder< HitType, WeightClass >::add(), recon::WorkingCluster< HitType >::WorkingCluster(), and recon::WorkingCluster< HitType >::WorkingCluster().

◆ add() [3/4]

template<class HitType >

void recon::WorkingCluster< HitType >::add	(	const HitType *	hit,
		double	x,
		double	y,
		double	z )

inline

Add a hit to the cluster with explicit position.

This version allows providing the position externally (e.g., from geometry).

Parameters

hit	Pointer to the hit to add
x	X position of the hit
y	Y position of the hit
z	Z position of the hit

Definition at line 106 of file WorkingCluster.h.

                                                             {
    if (!hit) return;
 
    double hit_e = hit->getEnergy();
    double hit_t = hit->getTime();
 
    double new_e = hit_e + centroid_e_;
    if (new_e > 0) {
      centroid_x_ = (centroid_x_ * centroid_e_ + hit_e * x) / new_e;
      centroid_y_ = (centroid_y_ * centroid_e_ + hit_e * y) / new_e;
      centroid_z_ = (centroid_z_ * centroid_e_ + hit_e * z) / new_e;
    }
    centroid_e_ = new_e;
 
    if (hit_t > time_) {
      time_ = hit_t;
    }
 
    hits_.push_back(hit);
  }

References recon::WorkingCluster< HitType >::centroid_e_, recon::WorkingCluster< HitType >::centroid_x_, recon::WorkingCluster< HitType >::centroid_y_, recon::WorkingCluster< HitType >::centroid_z_, recon::WorkingCluster< HitType >::hits_, and recon::WorkingCluster< HitType >::time_.

◆ add() [4/4]

template<class HitType >

void recon::WorkingCluster< HitType >::add ( const WorkingCluster< HitType > & other )

inline

Merge another cluster into this one.

Parameters

other The cluster to merge into this one

Definition at line 132 of file WorkingCluster.h.

                                                 {
    double new_e = other.centroid_e_ + centroid_e_;
    if (new_e > 0) {
      centroid_x_ =
          (centroid_x_ * centroid_e_ + other.centroid_x_ * other.centroid_e_) /
          new_e;
      centroid_y_ =
          (centroid_y_ * centroid_e_ + other.centroid_y_ * other.centroid_e_) /
          new_e;
      centroid_z_ =
          (centroid_z_ * centroid_e_ + other.centroid_z_ * other.centroid_e_) /
          new_e;
    }
    centroid_e_ = new_e;
 
    if (other.time_ > time_) {
      time_ = other.time_;
    }
 
    for (const auto* hit : other.hits_) {
      hits_.push_back(hit);
    }
  }

References recon::WorkingCluster< HitType >::centroid_e_, recon::WorkingCluster< HitType >::centroid_x_, recon::WorkingCluster< HitType >::centroid_y_, recon::WorkingCluster< HitType >::centroid_z_, recon::WorkingCluster< HitType >::hits_, and recon::WorkingCluster< HitType >::time_.

◆ centroidX()

template<class HitType >

double recon::WorkingCluster< HitType >::centroidX ( ) const

inline

Get the centroid X position (energy-weighted).

Definition at line 159 of file WorkingCluster.h.

159{ return centroid_x_; }

References recon::WorkingCluster< HitType >::centroid_x_.

Referenced by ecal::MyClusterWeight::operator()(), and hcal::MyClusterWeight::operator()().

◆ centroidY()

template<class HitType >

double recon::WorkingCluster< HitType >::centroidY ( ) const

inline

Get the centroid Y position (energy-weighted).

Definition at line 164 of file WorkingCluster.h.

164{ return centroid_y_; }

References recon::WorkingCluster< HitType >::centroid_y_.

Referenced by ecal::MyClusterWeight::operator()(), and hcal::MyClusterWeight::operator()().

◆ centroidZ()

template<class HitType >

double recon::WorkingCluster< HitType >::centroidZ ( ) const

inline

Get the centroid Z position (energy-weighted).

Definition at line 169 of file WorkingCluster.h.

169{ return centroid_z_; }

References recon::WorkingCluster< HitType >::centroid_z_.

Referenced by ecal::MyClusterWeight::operator()(), and hcal::MyClusterWeight::operator()().

◆ clear()

template<class HitType >

void recon::WorkingCluster< HitType >::clear ( )

inline

Clear all hits from the cluster.

Definition at line 194 of file WorkingCluster.h.

               {
    hits_.clear();
    centroid_x_ = 0;
    centroid_y_ = 0;
    centroid_z_ = 0;
    centroid_e_ = 0;
    time_ = 0;
  }

References recon::WorkingCluster< HitType >::centroid_e_, recon::WorkingCluster< HitType >::centroid_x_, recon::WorkingCluster< HitType >::centroid_y_, recon::WorkingCluster< HitType >::centroid_z_, recon::WorkingCluster< HitType >::hits_, and recon::WorkingCluster< HitType >::time_.

◆ empty()

template<class HitType >

bool recon::WorkingCluster< HitType >::empty ( ) const

inline

Check if the cluster is empty.

Definition at line 189 of file WorkingCluster.h.

189{ return hits_.empty(); }

References recon::WorkingCluster< HitType >::hits_.

◆ energy()

template<class HitType >

double recon::WorkingCluster< HitType >::energy ( ) const

inline

Get the total energy of the cluster.

Definition at line 174 of file WorkingCluster.h.

174{ return centroid_e_; }

References recon::WorkingCluster< HitType >::centroid_e_.

Referenced by recon::TemplatedClusterFinder< HitType, WeightClass >::compClusters(), ecal::MyClusterWeight::operator()(), and hcal::MyClusterWeight::operator()().

◆ hits()

template<class HitType >

const std::vector< const HitType * > & recon::WorkingCluster< HitType >::hits ( ) const

inline

Get the list of hits in this cluster.

Definition at line 184 of file WorkingCluster.h.

184{ return hits_; }

References recon::WorkingCluster< HitType >::hits_.

◆ layer()

template<class HitType >

int recon::WorkingCluster< HitType >::layer ( ) const

inline

Get the layer of the cluster.

Definition at line 221 of file WorkingCluster.h.

221{ return layer_; }

recon::WorkingCluster::layer_

int layer_

Layer number.

Definition WorkingCluster.h:248

References recon::WorkingCluster< HitType >::layer_.

Referenced by recon::WorkingCluster< HitType >::setLayer().

◆ setCentroid()

template<class HitType >

void recon::WorkingCluster< HitType >::setCentroid	(	double	x,
		double	y,
		double	z,
		double	e )

inline

Set the centroid position and energy explicitly.

Definition at line 206 of file WorkingCluster.h.

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

References recon::WorkingCluster< HitType >::centroid_e_, recon::WorkingCluster< HitType >::centroid_x_, recon::WorkingCluster< HitType >::centroid_y_, and recon::WorkingCluster< HitType >::centroid_z_.

◆ setLayer()

template<class HitType >

void recon::WorkingCluster< HitType >::setLayer ( int layer )

inline

Set the layer of the cluster.

Definition at line 226 of file WorkingCluster.h.

226{ layer_ = layer; }

recon::WorkingCluster::layer

int layer() const

Get the layer of the cluster.

Definition WorkingCluster.h:221

References recon::WorkingCluster< HitType >::layer(), and recon::WorkingCluster< HitType >::layer_.

◆ setTime()

template<class HitType >

void recon::WorkingCluster< HitType >::setTime ( double t )

inline

Set the time explicitly.

Definition at line 216 of file WorkingCluster.h.

216{ time_ = t; }

References recon::WorkingCluster< HitType >::time_.

◆ time()

template<class HitType >

double recon::WorkingCluster< HitType >::time_ {0}

private

Time (latest hit time)

Definition at line 245 of file WorkingCluster.h.

245{0};

Referenced by recon::WorkingCluster< HitType >::add(), recon::WorkingCluster< HitType >::add(), recon::WorkingCluster< HitType >::add(), recon::WorkingCluster< HitType >::clear(), recon::WorkingCluster< HitType >::setTime(), and recon::WorkingCluster< HitType >::time().

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

Recon/include/Recon/WorkingCluster.h

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ WorkingCluster() [1/2]

◆ WorkingCluster() [2/2]

Member Function Documentation

◆ add() [1/4]

◆ add() [2/4]

◆ add() [3/4]

◆ add() [4/4]

◆ centroidX()

◆ centroidY()

◆ centroidZ()

◆ clear()

◆ empty()

◆ energy()

◆ hits()

◆ layer()

◆ setCentroid()

◆ setLayer()

◆ setTime()

◆ time()

Member Data Documentation

◆ centroid_e_

◆ centroid_x_

◆ centroid_y_

◆ centroid_z_

◆ hits_

◆ layer_

◆ time_