LArSoft  v06_85_00
Liquid Argon Software toolkit - http://larsoft.org/
LArClusterHelper.h
Go to the documentation of this file.
1 
8 #ifndef LAR_CLUSTER_HELPER_H
9 #define LAR_CLUSTER_HELPER_H 1
10 
11 #include "Objects/Cluster.h"
12 
13 namespace lar_content
14 {
15 
19 class LArClusterHelper
20 {
21 public:
29  static pandora::HitType GetClusterHitType(const pandora::Cluster *const pCluster);
30 
39  static void GetClustersUVW(const pandora::ClusterList &inputClusters, pandora::ClusterList &clusterListU,
40  pandora::ClusterList &clusterListV, pandora::ClusterList &clusterListW);
41 
49  static void GetClustersByHitType(const pandora::ClusterList &inputClusters, const pandora::HitType hitType,
50  pandora::ClusterList &clusterList);
51 
59  static float GetLengthSquared(const pandora::Cluster *const pCluster);
60 
68  static float GetLength(const pandora::Cluster *const pCluster);
69 
77  static float GetEnergyFromLength(const pandora::Cluster *const pCluster);
78 
86  static unsigned int GetLayerSpan(const pandora::Cluster *const pCluster);
87 
95  static float GetLayerOccupancy(const pandora::Cluster *const pCluster);
96 
105  static float GetLayerOccupancy(const pandora::Cluster *const pCluster1, const pandora::Cluster *const pCluster2);
106 
115  static float GetClosestDistance(const pandora::ClusterList &clusterList1, const pandora::ClusterList &clusterList2);
116 
125  static float GetClosestDistance(const pandora::Cluster *const pCluster, const pandora::ClusterList &clusterList);
126 
135  static float GetClosestDistance(const pandora::Cluster *const pCluster1, const pandora::Cluster *const pCluster2);
136 
145  static float GetClosestDistance(const pandora::CartesianVector &position, const pandora::ClusterList &clusterList);
146 
155  static float GetClosestDistance(const pandora::CartesianVector &position, const pandora::Cluster *const pCluster);
156 
165  static pandora::CartesianVector GetClosestPosition(const pandora::CartesianVector &position, const pandora::ClusterList &clusterList);
166 
175  static pandora::CartesianVector GetClosestPosition(const pandora::CartesianVector &position, const pandora::Cluster *const pCluster);
176 
185  static void GetClosestPositions(const pandora::Cluster *const pCluster1, const pandora::Cluster *const pCluster2,
186  pandora::CartesianVector &position1, pandora::CartesianVector &position2);
187 
195  static void GetExtremalCoordinates(const pandora::ClusterList &clusterList, pandora::CartesianVector &innerCoordinate,
196  pandora::CartesianVector &outerCoordinate);
197 
205  static void GetExtremalCoordinates(const pandora::Cluster *const pCluster, pandora::CartesianVector &innerCoordinate,
206  pandora::CartesianVector &outerCoordinate);
207 
215  static void GetExtremalCoordinates(const pandora::OrderedCaloHitList &orderedCaloHitList, pandora::CartesianVector &innerCoordinate,
216  pandora::CartesianVector &outerCoordinate);
217 
225  static void GetExtremalCoordinates(const pandora::CartesianPointVector &coordinateVector, pandora::CartesianVector &innerCoordinate,
226  pandora::CartesianVector &outerCoordinate);
227 
235  static void GetClusterBoundingBox(const pandora::Cluster *const pCluster, pandora::CartesianVector &minimumCoordinate,
236  pandora::CartesianVector &maximumCoordinate);
237 
245  static void GetClusterSpanX(const pandora::Cluster *const pCluster, float &xmin, float &xmax);
246 
256  static void GetClusterSpanZ(const pandora::Cluster *const pCluster, const float xmin, const float xmax, float &zmin, float &zmax);
257 
264  static void GetCoordinateVector(const pandora::Cluster *const pCluster, pandora::CartesianPointVector &coordinateVector);
265 
276  static pandora::StatusCode GetAverageZ(const pandora::Cluster *const pCluster, const float xmin, const float xmax, float &averageZ);
277 
284  static bool SortByNOccupiedLayers(const pandora::Cluster *const pLhs, const pandora::Cluster *const pRhs);
285 
292  static bool SortByNHits(const pandora::Cluster *const pLhs, const pandora::Cluster *const pRhs);
293 
300  static bool SortByLayerSpan(const pandora::Cluster *const pLhs, const pandora::Cluster *const pRhs);
301 
308  static bool SortByInnerLayer(const pandora::Cluster *const pLhs, const pandora::Cluster *const pRhs);
309 
316  static bool SortByPosition(const pandora::Cluster *const pLhs, const pandora::Cluster *const pRhs);
317 
324  static bool SortByPulseHeight(const pandora::Cluster *const pLhs, const pandora::Cluster *const pRhs);
325 
332  static bool SortHitsByPosition(const pandora::CaloHit *const pLhs, const pandora::CaloHit *const pRhs);
333 
340  static bool SortHitsByPulseHeight(const pandora::CaloHit *const pLhs, const pandora::CaloHit *const pRhs);
341 
348  static bool SortCoordinatesByPosition(const pandora::CartesianVector &lhs, const pandora::CartesianVector &rhs);
349 };
350 
351 } // namespace lar_content
352 
353 #endif // #ifndef LAR_CLUSTER_HELPER_H
lar_content::LArClusterHelper::SortByNHits
static bool SortByNHits(const pandora::Cluster *const pLhs, const pandora::Cluster *const pRhs)
Sort clusters by number of hits, then layer span, then inner layer, then position, then pulse-height.
Definition: LArClusterHelper.cc:616
lar_content
Definition: CheatingBeamParticleIdTool.cc:18
lar_content::LArClusterHelper::GetLayerSpan
static unsigned int GetLayerSpan(const pandora::Cluster *const pCluster)
Get number of layers spanned by cluster (1+Last-First)
Definition: LArClusterHelper.cc:107
lar_content::LArClusterHelper::SortHitsByPulseHeight
static bool SortHitsByPulseHeight(const pandora::CaloHit *const pLhs, const pandora::CaloHit *const pRhs)
Sort calo hits by their pulse height.
Definition: LArClusterHelper.cc:711
lar_content::LArClusterHelper::GetClusterSpanZ
static void GetClusterSpanZ(const pandora::Cluster *const pCluster, const float xmin, const float xmax, float &zmin, float &zmax)
Get upper and lower Z positions of the calo hits in a cluster in range xmin to xmax.
Definition: LArClusterHelper.cc:368
lar_content::LArClusterHelper::GetClustersByHitType
static void GetClustersByHitType(const pandora::ClusterList &inputClusters, const pandora::HitType hitType, pandora::ClusterList &clusterList)
Get the subset of clusters, from a provided list, that match the specified hit type.
Definition: LArClusterHelper.cc:49
lar_content::LArClusterHelper::GetClusterHitType
static pandora::HitType GetClusterHitType(const pandora::Cluster *const pCluster)
Get the hit type associated with a two dimensional cluster.
Definition: LArClusterHelper.cc:20
lar_content::LArClusterHelper::GetClosestPositions
static void GetClosestPositions(const pandora::Cluster *const pCluster1, const pandora::Cluster *const pCluster2, pandora::CartesianVector &position1, pandora::CartesianVector &position2)
Get pair of closest positions for a pair of clusters.
Definition: LArClusterHelper.cc:267
lar_content::LArClusterHelper::GetAverageZ
static pandora::StatusCode GetAverageZ(const pandora::Cluster *const pCluster, const float xmin, const float xmax, float &averageZ)
Get average Z positions of the calo hits in a cluster in range xmin to xmax.
Definition: LArClusterHelper.cc:403
lar_content::LArClusterHelper::SortByPulseHeight
static bool SortByPulseHeight(const pandora::Cluster *const pLhs, const pandora::Cluster *const pRhs)
Sort clusters by pulse-height.
Definition: LArClusterHelper.cc:685
lar_content::LArClusterHelper::GetClustersUVW
static void GetClustersUVW(const pandora::ClusterList &inputClusters, pandora::ClusterList &clusterListU, pandora::ClusterList &clusterListV, pandora::ClusterList &clusterListW)
Divide an input cluster list into separate u, v and w lists (exception raised if alternative hit type...
Definition: LArClusterHelper.cc:34
lar_content::LArClusterHelper::SortCoordinatesByPosition
static bool SortCoordinatesByPosition(const pandora::CartesianVector &lhs, const pandora::CartesianVector &rhs)
Sort cartesian vectors by their position (use Z, followed by X, followed by Y)
Definition: LArClusterHelper.cc:719
lar_content::LArClusterHelper::SortByPosition
static bool SortByPosition(const pandora::Cluster *const pLhs, const pandora::Cluster *const pRhs)
Sort clusters by position, then pulse-height.
Definition: LArClusterHelper.cc:655
lar_content::LArClusterHelper::GetClusterBoundingBox
static void GetClusterBoundingBox(const pandora::Cluster *const pCluster, pandora::CartesianVector &minimumCoordinate, pandora::CartesianVector &maximumCoordinate)
Get minimum and maximum X, Y and Z positions of the calo hits in a cluster.
Definition: LArClusterHelper.cc:316
lar_content::LArClusterHelper::GetEnergyFromLength
static float GetEnergyFromLength(const pandora::Cluster *const pCluster)
Get energy of cluster, based on length.
Definition: LArClusterHelper.cc:99
lar_content::LArClusterHelper::SortHitsByPosition
static bool SortHitsByPosition(const pandora::CaloHit *const pLhs, const pandora::CaloHit *const pRhs)
Sort calo hits by their position (use Z, followed by X, followed by Y)
Definition: LArClusterHelper.cc:692
lar_content::LArClusterHelper::GetLength
static float GetLength(const pandora::Cluster *const pCluster)
Get length of cluster.
Definition: LArClusterHelper.cc:92
lar_content::LArClusterHelper::SortByLayerSpan
static bool SortByLayerSpan(const pandora::Cluster *const pLhs, const pandora::Cluster *const pRhs)
Sort clusters by layer span, then inner layer, then position, then pulse-height.
Definition: LArClusterHelper.cc:629
lar_content::LArClusterHelper::GetLayerOccupancy
static float GetLayerOccupancy(const pandora::Cluster *const pCluster)
Fraction of occupied layers in cluster.
lar_content::LArClusterHelper::GetExtremalCoordinates
static void GetExtremalCoordinates(const pandora::ClusterList &clusterList, pandora::CartesianVector &innerCoordinate, pandora::CartesianVector &outerCoordinate)
Get positions of the two most distant calo hits in a list of cluster (ordered by Z) ...
lar_content::LArClusterHelper::GetClusterSpanX
static void GetClusterSpanX(const pandora::Cluster *const pCluster, float &xmin, float &xmax)
Get minimum and maximum X positions of the calo hits in a cluster.
Definition: LArClusterHelper.cc:348
lar_content::LArClusterHelper::GetLengthSquared
static float GetLengthSquared(const pandora::Cluster *const pCluster)
Get length squared of cluster.
Definition: LArClusterHelper.cc:60
lar_content::LArClusterHelper::GetCoordinateVector
static void GetCoordinateVector(const pandora::Cluster *const pCluster, pandora::CartesianPointVector &coordinateVector)
Get vector of hit coordinates from an input cluster.
Definition: LArClusterHelper.cc:590
lar_content::LArClusterHelper::GetClosestPosition
static pandora::CartesianVector GetClosestPosition(const pandora::CartesianVector &position, const pandora::ClusterList &clusterList)
Get closest position in a list of clusters to a specified input position vector.
lar_content::LArClusterHelper
LArClusterHelper class.
Definition: LArClusterHelper.h:19
lar_content::LArClusterHelper::GetClosestDistance
static float GetClosestDistance(const pandora::ClusterList &clusterList1, const pandora::ClusterList &clusterList2)
Get closest distance between clusters in a pair of cluster lists.
lar_content::LArClusterHelper::SortByNOccupiedLayers
static bool SortByNOccupiedLayers(const pandora::Cluster *const pLhs, const pandora::Cluster *const pRhs)
Sort clusters by number of occupied layers, and by inner layer, then energy in event of a tie...
Definition: LArClusterHelper.cc:603
lar_content::LArClusterHelper::SortByInnerLayer
static bool SortByInnerLayer(const pandora::Cluster *const pLhs, const pandora::Cluster *const pRhs)
Sort clusters by inner layer, then position, then pulse-height.
Definition: LArClusterHelper.cc:642