LArPointingCluster class. More...

#include "LArPointingCluster.h"

Classes
class	Vertex
	Vertex class. More...

Public Member Functions
	LArPointingCluster (const pandora::Cluster *const pCluster, const unsigned int fitHalfLayerWindow=10, const float fitLayerPitch=0.3f)
	Constructor. More...

	LArPointingCluster (const TwoDSlidingFitResult &slidingFitResult)
	Constructor. More...

	LArPointingCluster (const ThreeDSlidingFitResult &slidingFitResult)
	Constructor. More...

const pandora::Cluster *	GetCluster () const
	Get the address of the cluster. More...

const Vertex &	GetInnerVertex () const
	Get the inner vertex. More...

const Vertex &	GetOuterVertex () const
	Get the outer vertex. More...

float	GetLengthSquared () const
	Get length squared of pointing cluster. More...

float	GetLength () const
	Get length of pointing cluster. More...

Private Member Functions
void	BuildPointingCluster (const TwoDSlidingFitResult &slidingFitResult)
	Build the pointing cluster object from the sliding fit result. More...

void	BuildPointingCluster (const ThreeDSlidingFitResult &slidingFitResult)
	Build the pointing cluster object from the sliding fit result. More...

Private Attributes
const pandora::Cluster *	m_pCluster
	The address of the cluster. More...

Vertex	m_innerVertex
	The inner vertex. More...

Vertex	m_outerVertex
	The outer vertex. More...

Detailed Description

LArPointingCluster class.

Definition at line 20 of file LArPointingCluster.h.

Constructor & Destructor Documentation

lar_content::LArPointingCluster::LArPointingCluster	(	const pandora::Cluster *const	pCluster,
		const unsigned int	fitHalfLayerWindow = `10`,
		const float	fitLayerPitch = `0.3f`
	)

Constructor.

Parameters

pCluster	address of the cluster
fitHalfLayerWindow	the fit layer half window
fitLayerPitch	the fit layer pitch, units cm

lar_content::LArPointingCluster::LArPointingCluster ( const TwoDSlidingFitResult & slidingFitResult )

Constructor.

Parameters

slidingFitResult the input sliding fit result

Definition at line 34 of file LArPointingCluster.cc.

 {
     this->BuildPointingCluster(slidingFitResult);
 }

lar_content::LArPointingCluster::LArPointingCluster ( const ThreeDSlidingFitResult & slidingFitResult )

Constructor.

Parameters

slidingFitResult the input sliding fit result

Definition at line 41 of file LArPointingCluster.cc.

 {
     this->BuildPointingCluster(slidingFitResult);
 }

Member Function Documentation

void lar_content::LArPointingCluster::BuildPointingCluster ( const TwoDSlidingFitResult & slidingFitResult )

private

Build the pointing cluster object from the sliding fit result.

Parameters

slidingFitResult the input sliding fit result

Definition at line 48 of file LArPointingCluster.cc.

 {
     const HitType hitType(LArClusterHelper::GetClusterHitType(slidingFitResult.GetCluster()));
 
     if (!((TPC_VIEW_U == hitType) || (TPC_VIEW_V == hitType) || (TPC_VIEW_W == hitType)))
         throw StatusCodeException(STATUS_CODE_INVALID_PARAMETER);
 
     if (slidingFitResult.GetMinLayer() >= slidingFitResult.GetMaxLayer())
         throw StatusCodeException(STATUS_CODE_INVALID_PARAMETER);
 
     const bool isInner((slidingFitResult.GetGlobalMinLayerPosition().GetZ() < slidingFitResult.GetGlobalMaxLayerPosition().GetZ()));
 
     m_pCluster = slidingFitResult.GetCluster();
 
     const Vertex minVertex(m_pCluster, slidingFitResult.GetGlobalMinLayerPosition(), slidingFitResult.GetGlobalMinLayerDirection(),
         slidingFitResult.GetMinLayerRms(), isInner);
     const Vertex maxVertex(m_pCluster, slidingFitResult.GetGlobalMaxLayerPosition(), slidingFitResult.GetGlobalMaxLayerDirection() * -1.f,
         slidingFitResult.GetMaxLayerRms(), !isInner);
 
     m_innerVertex = (isInner ? minVertex : maxVertex);
     m_outerVertex = (isInner ? maxVertex : minVertex);
 }

void lar_content::LArPointingCluster::BuildPointingCluster ( const ThreeDSlidingFitResult & slidingFitResult )

private

Build the pointing cluster object from the sliding fit result.

Parameters

slidingFitResult the input sliding fit result

Definition at line 73 of file LArPointingCluster.cc.

 {
     if (TPC_3D != LArClusterHelper::GetClusterHitType(slidingFitResult.GetCluster()))
         throw StatusCodeException(STATUS_CODE_INVALID_PARAMETER);
 
     if (slidingFitResult.GetMinLayer() >= slidingFitResult.GetMaxLayer())
         throw StatusCodeException(STATUS_CODE_INVALID_PARAMETER);
 
     const bool isInner((slidingFitResult.GetGlobalMinLayerPosition().GetZ() < slidingFitResult.GetGlobalMaxLayerPosition().GetZ()) &&
         (slidingFitResult.GetMinLayer() < slidingFitResult.GetMaxLayer()));
 
     m_pCluster = slidingFitResult.GetCluster();
 
     const Vertex minVertex(m_pCluster, slidingFitResult.GetGlobalMinLayerPosition(), slidingFitResult.GetGlobalMinLayerDirection(),
         slidingFitResult.GetMinLayerRms(), isInner);
     const Vertex maxVertex(m_pCluster, slidingFitResult.GetGlobalMaxLayerPosition(), slidingFitResult.GetGlobalMaxLayerDirection() * -1.f,
         slidingFitResult.GetMaxLayerRms(), !isInner);
 
     m_innerVertex = (isInner ? minVertex : maxVertex);
     m_outerVertex = (isInner ? maxVertex : minVertex);
 }

const pandora::Cluster * lar_content::LArPointingCluster::GetCluster ( ) const

inline

Get the address of the cluster.

Returns: the address of the cluster

Definition at line 201 of file LArPointingCluster.h.

References lar_content::LArPointingCluster::Vertex::m_pCluster.

Referenced by lar_content::LongitudinalExtensionAlgorithm::FillClusterAssociationMatrix(), lar_content::CosmicRayExtensionAlgorithm::FillClusterAssociationMatrix(), lar_content::LArPointingClusterHelper::GetClosestVertices(), lar_content::LongitudinalExtensionAlgorithm::GetListOfCleanClusters(), lar_content::CosmicRayExtensionAlgorithm::GetListOfCleanClusters(), lar_content::TransverseExtensionAlgorithm::GetListOfCleanClusters(), and lar_content::VertexBasedPfoRecoveryAlgorithm::MatchTwoViews().

 {
     return m_pCluster;
 }

const LArPointingCluster::Vertex & lar_content::LArPointingCluster::GetInnerVertex ( ) const

inline

Get the inner vertex.

Returns: the inner vertex

Definition at line 208 of file LArPointingCluster.h.

References m_innerVertex.

Referenced by lar_content::CosmicRayVertexBuildingAlgorithm::BuildCosmicRayParent(), lar_content::NeutrinoDaughterVerticesAlgorithm::BuildDaughterTrack(), lar_content::OvershootSplittingAlgorithm::BuildIntersectionMap(), lar_content::EventSlicingTool::CheckClosestApproach(), lar_content::LArPointingClusterHelper::CollectAssociatedClusters(), lar_content::CosmicRayExtensionAlgorithm::FillClusterAssociationMatrix(), lar_content::LArPointingClusterHelper::GetClosestVertices(), lar_content::LArStitchingHelper::GetClosestVertices(), lar_content::LArVertexHelper::GetClusterDirectionInZ(), lar_content::SlidingConePfoMopUpAlgorithm::GetClusterMergeMap(), lar_content::VertexBasedPfoRecoveryAlgorithm::GetInnerVertex(), lar_content::LArPointingClusterHelper::GetLengthSquared(), lar_content::TransverseExtensionAlgorithm::GetListOfCleanClusters(), lar_content::VertexBasedPfoRecoveryAlgorithm::GetOuterVertex(), lar_content::ThreeDKinkBaseTool::IsALowestInX(), lar_content::TwoViewThreeDKinkTool::IsALowestInX(), lar_content::EventSlicingTool::IsEmission(), lar_content::EventSlicingTool::IsNode(), lar_content::ShowerPfoMopUpAlgorithm::IsVertexAssociated(), lar_content::ShowerGrowingAlgorithm::IsVertexAssociated(), lar_content::NViewTrackMatchingAlgorithm< T >::MakeClusterSplit(), lar_content::CosmicRayTrackRecoveryAlgorithm::MatchClusters(), lar_content::StitchingCosmicRayMergingTool::OrderPfoMerges(), lar_content::TrackSplittingTool::PassesChecks(), lar_content::VertexAssociatedPfosTool::Run(), lar_content::VertexBasedPfoMopUpAlgorithm::Run(), lar_content::VertexBasedPfoRecoveryAlgorithm::SelectVertexClusters(), and lar_content::ParticleRecoveryAlgorithm::VertexClusterSelection().

 {
     return m_innerVertex;
 }

float lar_content::LArPointingCluster::GetLength ( ) const

inline

Get length of pointing cluster.

Returns: the length

Definition at line 229 of file LArPointingCluster.h.

References GetLengthSquared().

 {
     return std::sqrt(this->GetLengthSquared());
 }

float lar_content::LArPointingCluster::GetLengthSquared ( ) const

inline

Get length squared of pointing cluster.

Returns: the length squared

Definition at line 222 of file LArPointingCluster.h.

References lar_content::LArPointingCluster::Vertex::GetPosition(), m_innerVertex, and m_outerVertex.

Referenced by lar_content::VertexBasedPfoRecoveryAlgorithm::BuildSlidingFitResultMap(), lar_content::StitchingCosmicRayMergingTool::CreatePfoMatches(), and GetLength().

 {
     return (m_outerVertex.GetPosition() - m_innerVertex.GetPosition()).GetMagnitudeSquared();
 }

const LArPointingCluster::Vertex & lar_content::LArPointingCluster::GetOuterVertex ( ) const

inline

Get the outer vertex.

Returns: the outer vertex

Definition at line 215 of file LArPointingCluster.h.

References m_outerVertex.

Referenced by lar_content::CosmicRayVertexBuildingAlgorithm::BuildCosmicRayParent(), lar_content::NeutrinoDaughterVerticesAlgorithm::BuildDaughterTrack(), lar_content::OvershootSplittingAlgorithm::BuildIntersectionMap(), lar_content::EventSlicingTool::CheckClosestApproach(), lar_content::LArPointingClusterHelper::CollectAssociatedClusters(), lar_content::CosmicRayExtensionAlgorithm::FillClusterAssociationMatrix(), lar_content::LArPointingClusterHelper::GetClosestVertices(), lar_content::LArStitchingHelper::GetClosestVertices(), lar_content::LArVertexHelper::GetClusterDirectionInZ(), lar_content::SlidingConePfoMopUpAlgorithm::GetClusterMergeMap(), lar_content::VertexBasedPfoRecoveryAlgorithm::GetInnerVertex(), lar_content::LArPointingClusterHelper::GetLengthSquared(), lar_content::TransverseExtensionAlgorithm::GetListOfCleanClusters(), lar_content::VertexBasedPfoRecoveryAlgorithm::GetOuterVertex(), lar_content::ThreeDKinkBaseTool::IsALowestInX(), lar_content::TwoViewThreeDKinkTool::IsALowestInX(), lar_content::EventSlicingTool::IsEmission(), lar_content::EventSlicingTool::IsNode(), lar_content::ShowerPfoMopUpAlgorithm::IsVertexAssociated(), lar_content::ShowerGrowingAlgorithm::IsVertexAssociated(), lar_content::NViewTrackMatchingAlgorithm< T >::MakeClusterSplit(), lar_content::CosmicRayTrackRecoveryAlgorithm::MatchClusters(), lar_content::StitchingCosmicRayMergingTool::OrderPfoMerges(), lar_content::VertexAssociatedPfosTool::Run(), lar_content::VertexBasedPfoMopUpAlgorithm::Run(), lar_content::VertexBasedPfoRecoveryAlgorithm::SelectVertexClusters(), and lar_content::ParticleRecoveryAlgorithm::VertexClusterSelection().

 {
     return m_outerVertex;
 }

Member Data Documentation

Vertex lar_content::LArPointingCluster::m_innerVertex

private

The inner vertex.

Definition at line 191 of file LArPointingCluster.h.

Referenced by GetInnerVertex(), and GetLengthSquared().

Vertex lar_content::LArPointingCluster::m_outerVertex

private

The outer vertex.

Definition at line 192 of file LArPointingCluster.h.

Referenced by GetLengthSquared(), and GetOuterVertex().

const pandora::Cluster* lar_content::LArPointingCluster::m_pCluster

private

The address of the cluster.

Definition at line 190 of file LArPointingCluster.h.

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

larpandoracontent/v04_08_01/source/larpandoracontent/LArObjects/LArPointingCluster.h
larpandoracontent/v04_08_01/source/larpandoracontent/LArObjects/LArPointingCluster.cc

Classes

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation