All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Attributes | List of all members
lar_content::LArHitWidthHelper::ClusterParameters Class Reference

ClusterParameters class. More...

#include <LArHitWidthHelper.h>

Public Member Functions

 ClusterParameters (const pandora::Cluster *const pCluster, const float maxConsituentHitWidth, const bool isUniformHits, const float hitWidthScalingFactor)
 Constructor. More...
 
 ClusterParameters (const pandora::Cluster *const pCluster, const unsigned int numCaloHits, const float totalWeight, const ConstituentHitVector &constituentHitVector, const pandora::CartesianVector &lowerXExtrema, const pandora::CartesianVector &higherXExtrema)
 Constructor. More...
 
const pandora::Cluster * GetClusterAddress () const
 Returns the address of the cluster. More...
 
unsigned int GetNumCaloHits () const
 Returns the number of calo hits within the cluster. More...
 
float GetTotalWeight () const
 Returns the total weight of the constituent hits. More...
 
const ConstituentHitVectorGetConstituentHitVector () const
 Returns the vector of constituent hits. More...
 
const pandora::CartesianVector & GetLowerXExtrema () const
 Returns the lower x extremal point of the constituent hits. More...
 
const pandora::CartesianVector & GetHigherXExtrema () const
 Returns the higher x extremal point of the constituent hits. More...
 

Private Attributes

const pandora::Cluster * m_pCluster
 The address of the cluster. More...
 
const unsigned int m_numCaloHits
 The number of calo hits within the cluster. More...
 
const ConstituentHitVector m_constituentHitVector
 The vector of constituent hits. More...
 
const float m_totalWeight
 The total hit weight of the contituent hits. More...
 
const pandora::CartesianVector m_lowerXExtrema
 The lower x extremal point of the constituent hits. More...
 
const pandora::CartesianVector m_higherXExtrema
 The higher x extremal point of the constituent hits. More...
 

Detailed Description

ClusterParameters class.

Definition at line 92 of file LArHitWidthHelper.h.

Constructor & Destructor Documentation

lar_content::LArHitWidthHelper::ClusterParameters::ClusterParameters ( const pandora::Cluster *const  pCluster,
const float  maxConsituentHitWidth,
const bool  isUniformHits,
const float  hitWidthScalingFactor 
)

Constructor.

Parameters
pClusterfrom which the parameters will be obtained
maxConstituentHitWidththe maximum width of a constituent hit
isUniformwhether to break up the hit into uniform constituent hits (and pad the hit) or not in the non-uniform case constituent hits from different hits may have different weights
hitWidthScalingFactorthe constituent hit width scaling factor
lar_content::LArHitWidthHelper::ClusterParameters::ClusterParameters ( const pandora::Cluster *const  pCluster,
const unsigned int  numCaloHits,
const float  totalWeight,
const ConstituentHitVector constituentHitVector,
const pandora::CartesianVector &  lowerXExtrema,
const pandora::CartesianVector &  higherXExtrema 
)

Constructor.

Parameters
pClusterfrom which the parameters will be obtained
numCaloHitsthe number of calo hits within the cluster
totalWeightthe total weight of the constituent hits
constituentHitVectorthe vector of constituent hits
lowerXExtremathe lower x extremal point of the constituent hits
higherXExtremathe higher x extremal point of the constituent hits

Member Function Documentation

const pandora::Cluster * lar_content::LArHitWidthHelper::ClusterParameters::GetClusterAddress ( ) const
inline

Returns the address of the cluster.

Definition at line 340 of file LArHitWidthHelper.h.

341 {
342  return m_pCluster;
343 }
const pandora::Cluster * m_pCluster
The address of the cluster.
const LArHitWidthHelper::ConstituentHitVector & lar_content::LArHitWidthHelper::ClusterParameters::GetConstituentHitVector ( ) const
inline

Returns the vector of constituent hits.

Definition at line 361 of file LArHitWidthHelper.h.

362 {
363  return m_constituentHitVector;
364 }
const ConstituentHitVector m_constituentHitVector
The vector of constituent hits.
const pandora::CartesianVector & lar_content::LArHitWidthHelper::ClusterParameters::GetHigherXExtrema ( ) const
inline

Returns the higher x extremal point of the constituent hits.

Definition at line 375 of file LArHitWidthHelper.h.

376 {
377  return m_higherXExtrema;
378 }
const pandora::CartesianVector m_higherXExtrema
The higher x extremal point of the constituent hits.
const pandora::CartesianVector & lar_content::LArHitWidthHelper::ClusterParameters::GetLowerXExtrema ( ) const
inline

Returns the lower x extremal point of the constituent hits.

Definition at line 368 of file LArHitWidthHelper.h.

369 {
370  return m_lowerXExtrema;
371 }
const pandora::CartesianVector m_lowerXExtrema
The lower x extremal point of the constituent hits.
unsigned int lar_content::LArHitWidthHelper::ClusterParameters::GetNumCaloHits ( ) const
inline

Returns the number of calo hits within the cluster.

Definition at line 347 of file LArHitWidthHelper.h.

348 {
349  return m_numCaloHits;
350 }
const unsigned int m_numCaloHits
The number of calo hits within the cluster.
float lar_content::LArHitWidthHelper::ClusterParameters::GetTotalWeight ( ) const
inline

Returns the total weight of the constituent hits.

Definition at line 354 of file LArHitWidthHelper.h.

355 {
356  return m_totalWeight;
357 }
const float m_totalWeight
The total hit weight of the contituent hits.

Member Data Documentation

const ConstituentHitVector lar_content::LArHitWidthHelper::ClusterParameters::m_constituentHitVector
private

The vector of constituent hits.

Definition at line 154 of file LArHitWidthHelper.h.

const pandora::CartesianVector lar_content::LArHitWidthHelper::ClusterParameters::m_higherXExtrema
private

The higher x extremal point of the constituent hits.

Definition at line 157 of file LArHitWidthHelper.h.

const pandora::CartesianVector lar_content::LArHitWidthHelper::ClusterParameters::m_lowerXExtrema
private

The lower x extremal point of the constituent hits.

Definition at line 156 of file LArHitWidthHelper.h.

const unsigned int lar_content::LArHitWidthHelper::ClusterParameters::m_numCaloHits
private

The number of calo hits within the cluster.

Definition at line 153 of file LArHitWidthHelper.h.

const pandora::Cluster* lar_content::LArHitWidthHelper::ClusterParameters::m_pCluster
private

The address of the cluster.

Definition at line 152 of file LArHitWidthHelper.h.

const float lar_content::LArHitWidthHelper::ClusterParameters::m_totalWeight
private

The total hit weight of the contituent hits.

Definition at line 155 of file LArHitWidthHelper.h.


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