LArHitWidthHelper class. More...

#include "LArHitWidthHelper.h"

Classes
class	ClusterParameters
	ClusterParameters class. More...

class	ConstituentHit
	ConstituentHit class. More...

class	SortByHigherXExtrema
	SortByHigherExtrema class. More...

Public Types
typedef std::vector< ConstituentHit >	ConstituentHitVector

typedef std::unordered_map< const pandora::Cluster *, const ClusterParameters >	ClusterToParametersMap

Static Public Member Functions
static const ClusterParameters &	GetClusterParameters (const pandora::Cluster *const pCluster, const ClusterToParametersMap &clusterToParametersMap)
	Return the cluster parameters of a given cluster, exception thrown if not found in map [cluster -> cluster parameter] or if map is empty.

static unsigned int	GetNProposedConstituentHits (const pandora::Cluster *const pCluster, const float maxConstituentHitWidth, const float hitWidthScalingFactor)
	Return the number of constituent hits that a given cluster would be broken into.

static ConstituentHitVector	GetConstituentHits (const pandora::Cluster *const pCluster, const float maxConstituentHitWidth, const float hitWidthScalingFactor, const bool isUniform)
	Break up the cluster hits into constituent hits.

static void	SplitHitIntoConstituents (const pandora::CaloHit const pCaloHit, const pandora::Cluster const pCluster, const unsigned int numberOfConstituentHits, const float constituentHitWidth, ConstituentHitVector &constituentHitVector)
	Break up the calo hit into constituent hits.

static pandora::CartesianPointVector	GetConstituentHitPositionVector (const ConstituentHitVector &constituentHitVector)
	Obtain a vector of the contituent hit central positions.

static float	GetTotalClusterWeight (const ConstituentHitVector &constituentHitVector)
	Sum the widths of constituent hits.

static float	GetOriginalTotalClusterWeight (const pandora::Cluster *const pCluster)
	Sum the widths of the original, unscaled hits contained within a cluster.

static pandora::CartesianVector	GetExtremalCoordinatesLowerX (const ConstituentHitVector &constituentHitVector)
	Return the lower x extremal point of the constituent hits.

static pandora::CartesianVector	GetExtremalCoordinatesHigherX (const ConstituentHitVector &constituentHitVector)
	Return the higher x extremal point of the constituent hits.

static void	GetExtremalCoordinatesX (const ConstituentHitVector &constituentHitVector, pandora::CartesianVector &lowerXCoordinate, pandora::CartesianVector &higherXCoordinate)
	Calculate the higher and lower x extremal points of the constituent hits.

static pandora::CartesianVector	GetClosestPointToLine2D (const pandora::CartesianVector &lineStart, const pandora::CartesianVector &lineDirection, const pandora::CaloHit *const pCaloHit)
	Consider the hit width to find the closest position of a calo hit to a specified line.

static float	GetClosestDistanceToPoint2D (const pandora::CaloHit *const pCaloHit, const pandora::CartesianVector &point2D)
	Consider the hit width to find the smallest distance between a calo hit and a given point.

static float	GetClosestDistance (const pandora::CaloHit *const pThisCaloHit, const pandora::CaloHitList &caloHitList)
	Find the smallest separation between a hit and a list of hits, with the consideration of their hit widths.

static float	GetClosestDistance (const pandora::CaloHit const pCaloHit1, const pandora::CaloHit const pCaloHit2)
	Find the smallest separation between two hits, with the consideration of their hit widths.

Detailed Description

LArHitWidthHelper class.

Definition at line 19 of file LArHitWidthHelper.h.

Member Typedef Documentation

◆ ClusterToParametersMap

typedef std::unordered_map<const pandora::Cluster *, const ClusterParameters> lar_content::LArHitWidthHelper::ClusterToParametersMap

Definition at line 160 of file LArHitWidthHelper.h.

◆ ConstituentHitVector

typedef std::vector<ConstituentHit> lar_content::LArHitWidthHelper::ConstituentHitVector

Definition at line 87 of file LArHitWidthHelper.h.

Member Function Documentation

◆ GetClosestDistance() [1/2]

float lar_content::LArHitWidthHelper::GetClosestDistance	(	const pandora::CaloHit *const	pCaloHit1,
		const pandora::CaloHit *const	pCaloHit2
	)

static

Find the smallest separation between two hits, with the consideration of their hit widths.

Parameters

pCaloHit1	the first calo hit
pCaloHit2	the second calo hit

Returns: the smallest separation

Definition at line 341 of file LArHitWidthHelper.cc.

Here is the call graph for this function:

◆ GetClosestDistance() [2/2]

float lar_content::LArHitWidthHelper::GetClosestDistance	(	const pandora::CaloHit *const	pThisCaloHit,
		const pandora::CaloHitList &	caloHitList
	)

static

Find the smallest separation between a hit and a list of hits, with the consideration of their hit widths.

Parameters

pThisCaloHit	the input calo hit
caloHitList	the input calo hit list

Returns: the smallest separation

Definition at line 324 of file LArHitWidthHelper.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetClosestDistanceToPoint2D()

float lar_content::LArHitWidthHelper::GetClosestDistanceToPoint2D	(	const pandora::CaloHit *const	pCaloHit,
		const pandora::CartesianVector &	point2D
	)

static

Consider the hit width to find the smallest distance between a calo hit and a given point.

Parameters

pCaloHit	the input calo hit
point2D	the position

Returns: the smallest distance

Definition at line 306 of file LArHitWidthHelper.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetClosestPointToLine2D()

CartesianVector lar_content::LArHitWidthHelper::GetClosestPointToLine2D	(	const pandora::CartesianVector &	lineStart,
		const pandora::CartesianVector &	lineDirection,
		const pandora::CaloHit *const	pCaloHit
	)

static

Consider the hit width to find the closest position of a calo hit to a specified line.

Parameters

lineStart	the start position of the line
lineDirection	the direction of the line
pCaloHit	the input calo hit

Returns: the closest position

Definition at line 281 of file LArHitWidthHelper.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetClusterParameters()

const LArHitWidthHelper::ClusterParameters & lar_content::LArHitWidthHelper::GetClusterParameters	(	const pandora::Cluster *const	pCluster,
		const ClusterToParametersMap &	clusterToParametersMap
	)

static

Return the cluster parameters of a given cluster, exception thrown if not found in map [cluster -> cluster parameter] or if map is empty.

Parameters

pCluster	the input cluster
clusterToParametersMap	the map [cluster -> cluster parameter]

Returns: the cluster parameters of the input cluster

Definition at line 74 of file LArHitWidthHelper.cc.

Here is the caller graph for this function:

◆ GetConstituentHitPositionVector()

CartesianPointVector lar_content::LArHitWidthHelper::GetConstituentHitPositionVector ( const ConstituentHitVector & constituentHitVector )

static

Obtain a vector of the contituent hit central positions.

Parameters

constituentHitVector the input vector of contituent hits

Returns: a vector of constituent hit central positions

Definition at line 223 of file LArHitWidthHelper.cc.

Here is the caller graph for this function:

◆ GetConstituentHits()

LArHitWidthHelper::ConstituentHitVector lar_content::LArHitWidthHelper::GetConstituentHits	(	const pandora::Cluster *const	pCluster,
		const float	maxConstituentHitWidth,
		const float	hitWidthScalingFactor,
		const bool	isUniform
	)

static

Break up the cluster hits into constituent hits.

Parameters

pCluster	the input cluster
maxConstituentHitWidth	the maximum width of a constituent hit
hitWidthScalingFactor	the constituent hit width scaling factor
isUniform	whether 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

Returns: the vector of constituent hits

Definition at line 120 of file LArHitWidthHelper.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetExtremalCoordinatesHigherX()

CartesianVector lar_content::LArHitWidthHelper::GetExtremalCoordinatesHigherX ( const ConstituentHitVector & constituentHitVector )

static

Return the higher x extremal point of the constituent hits.

Parameters

constituentHitVector the input vector of contituent hits

Returns: the higher x extremal point of the constituent hits

Definition at line 245 of file LArHitWidthHelper.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetExtremalCoordinatesLowerX()

CartesianVector lar_content::LArHitWidthHelper::GetExtremalCoordinatesLowerX ( const ConstituentHitVector & constituentHitVector )

static

Return the lower x extremal point of the constituent hits.

Parameters

constituentHitVector the input vector of contituent hits

Returns: the lower x extremal point of the constituent hits

Definition at line 235 of file LArHitWidthHelper.cc.

Here is the call graph for this function:

◆ GetExtremalCoordinatesX()

void lar_content::LArHitWidthHelper::GetExtremalCoordinatesX	(	const ConstituentHitVector &	constituentHitVector,
		pandora::CartesianVector &	lowerXCoordinate,
		pandora::CartesianVector &	higherXCoordinate
	)

static

Calculate the higher and lower x extremal points of the constituent hits.

Parameters

constituentHitVector	the input vector of contituent hits
lowerXCoordinate	the lower x extremal point
higherXCoordinate	the higher x extremal point

Definition at line 255 of file LArHitWidthHelper.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetNProposedConstituentHits()

unsigned int lar_content::LArHitWidthHelper::GetNProposedConstituentHits	(	const pandora::Cluster *const	pCluster,
		const float	maxConstituentHitWidth,
		const float	hitWidthScalingFactor
	)

static

Return the number of constituent hits that a given cluster would be broken into.

Parameters

pCluster	the input cluster
maxConstituentHitWidth	the maximum width of a constituent hit
hitWidthScalingFactor	the constituent hit width scaling factor

Returns: the number of constituent hits the cluster would be broken into

Definition at line 90 of file LArHitWidthHelper.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetOriginalTotalClusterWeight()

float lar_content::LArHitWidthHelper::GetOriginalTotalClusterWeight ( const pandora::Cluster *const pCluster )

static

Sum the widths of the original, unscaled hits contained within a cluster.

Parameters

pCluster the input cluster

Returns: the total weight sum

Definition at line 207 of file LArHitWidthHelper.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetTotalClusterWeight()

float lar_content::LArHitWidthHelper::GetTotalClusterWeight ( const ConstituentHitVector & constituentHitVector )

static

Sum the widths of constituent hits.

Parameters

constituentHitVector the input vector of contituent hits

Returns: the total weight sum

Definition at line 196 of file LArHitWidthHelper.cc.

◆ SplitHitIntoConstituents()

void lar_content::LArHitWidthHelper::SplitHitIntoConstituents	(	const pandora::CaloHit *const	pCaloHit,
		const pandora::Cluster *const	pCluster,
		const unsigned int	numberOfConstituentHits,
		const float	constituentHitWidth,
		LArHitWidthHelper::ConstituentHitVector &	constituentHitVector
	)

static

Break up the calo hit into constituent hits.

Parameters

pCaloHit	the input calo hit
pCluster	the parent cluster
numberOfConstituentHits	the number of constituent hits the hit will be broken into
constituentHitWidth	the hit width of the constituent hits
constituentHitVector	the input vector to which to add the contituent hits

Definition at line 158 of file LArHitWidthHelper.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

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

LArContent/larpandoracontent/LArHelpers/LArHitWidthHelper.h
LArContent/larpandoracontent/LArHelpers/LArHitWidthHelper.cc

Classes

Public Types

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ ClusterToParametersMap

◆ ConstituentHitVector

Member Function Documentation

◆ GetClosestDistance() [1/2]

◆ GetClosestDistance() [2/2]

◆ GetClosestDistanceToPoint2D()

◆ GetClosestPointToLine2D()

◆ GetClusterParameters()

◆ GetConstituentHitPositionVector()

◆ GetConstituentHits()

◆ GetExtremalCoordinatesHigherX()

◆ GetExtremalCoordinatesLowerX()

◆ GetExtremalCoordinatesX()

◆ GetNProposedConstituentHits()

◆ GetOriginalTotalClusterWeight()

◆ GetTotalClusterWeight()

◆ SplitHitIntoConstituents()