#include "RemovalBaseTool.h"

Inheritance diagram for lar_content::RemovalBaseTool:

Public Types
typedef std::vector< pandora::HitType >	HitTypeVector

typedef ThreeViewDeltaRayMatchingAlgorithm::MatchingType::TensorType	TensorType

typedef std::vector< TensorType::ElementList::const_iterator >	IteratorList

Public Member Functions
	RemovalBaseTool ()
	Default constructor. More...

Public Attributes
ThreeViewDeltaRayMatchingAlgorithm *	m_pParentAlgorithm
	Address of the parent matching algorithm. More...

Protected Member Functions
virtual bool	Run (ThreeViewDeltaRayMatchingAlgorithm *const pAlgorithm, TensorType &overlapTensor)=0
	Run the algorithm tool. More...

virtual pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)=0

bool	IsMuonEndpoint (const TensorType::Element &element, const bool ignoreHitType, const pandora::HitType hitTypeToIgnore=pandora::TPC_VIEW_U) const
	Determine whether the matched clusters suggest that the delta ray is at the endpoint of the cosmic ray (and is likely to be a michel) More...

bool	IsBestElement (const TensorType::Element &element, const pandora::HitType hitType, const TensorType::ElementList &elementList, const pandora::ClusterSet &modifiedClusters) const
	Determine whether the input element is the best to use to modify the contaminated cluster (best is defined by the total hit count) More...

virtual bool	PassElementChecks (const TensorType::Element &element, const pandora::HitType hitType) const =0
	Determine whether element satifies simple checks. More...

bool	IsCloseToLine (const pandora::CartesianVector &hitPosition, const pandora::CartesianVector &lineStart, const pandora::CartesianVector &lineEnd, const float distanceToLine) const
	Whether a given position is close to a defined line. More...

bool	IsInLineSegment (const pandora::CartesianVector &lowerBoundary, const pandora::CartesianVector &upperBoundary, const pandora::CartesianVector &point) const
	Whether the projection of a given position lies on a defined line. More...

void	FindExtrapolatedHits (const pandora::Cluster *const pCluster, const pandora::CartesianVector &lowerBoundary, const pandora::CartesianVector &upperBoundary, pandora::CaloHitList &collectedHits) const
	Collect the hits that are closest to and can be projected onto a defined line. More...

pandora::StatusCode	ProjectDeltaRayPositions (const TensorType::Element &element, const pandora::HitType hitType, pandora::CartesianPointVector &projectedPositions) const
	Use two views of a delta ray pfo to calculate projected positions in a given third view. More...

Protected Attributes
float	m_minSeparation
	The minimum delta ray - parent muon cluster separation required to investigate a delta/cosmic ray cluster. More...

float	m_distanceToLine
	The maximum perpendicular distance of a position to a line for it to be considered close. More...

Detailed Description

RemovalBaseTool class.

Definition at line 18 of file RemovalBaseTool.h.

Member Typedef Documentation

typedef std::vector<pandora::HitType> lar_content::RemovalBaseTool::HitTypeVector

Definition at line 21 of file RemovalBaseTool.h.

typedef std::vector<TensorType::ElementList::const_iterator> lar_content::DeltaRayTensorTool::IteratorList

inherited

Definition at line 102 of file ThreeViewDeltaRayMatchingAlgorithm.h.

typedef ThreeViewDeltaRayMatchingAlgorithm::MatchingType::TensorType lar_content::DeltaRayTensorTool::TensorType

inherited

Definition at line 101 of file ThreeViewDeltaRayMatchingAlgorithm.h.

Constructor & Destructor Documentation

lar_content::RemovalBaseTool::RemovalBaseTool ( )

Default constructor.

Definition at line 20 of file RemovalBaseTool.cc.

                                  :
     m_minSeparation(1.f),
     m_distanceToLine(0.5f)
 {
 }

Member Function Documentation

void lar_content::RemovalBaseTool::FindExtrapolatedHits	(	const pandora::Cluster *const	pCluster,
		const pandora::CartesianVector &	lowerBoundary,
		const pandora::CartesianVector &	upperBoundary,
		pandora::CaloHitList &	collectedHits
	)		const

protected

Collect the hits that are closest to and can be projected onto a defined line.

Parameters

pCluster	the address of the input cluster containing the hits to be investigated
lowerBoundary	the start position of the line
upperBoundary	the end position of the line
collectedHits	the collected hits

Definition at line 152 of file RemovalBaseTool.cc.

References IsCloseToLine(), IsInLineSegment(), and m_distanceToLine.

Referenced by lar_content::DeltaRayRemovalTool::IsContaminated().

 {
     CaloHitList caloHitList;
     pCluster->GetOrderedCaloHitList().FillCaloHitList(caloHitList);
 
     for (const CaloHit *const pCaloHit : caloHitList)
     {
         if (!this->IsInLineSegment(lowerBoundary, upperBoundary, pCaloHit->GetPositionVector()))
             continue;
 
         if (!this->IsCloseToLine(pCaloHit->GetPositionVector(), lowerBoundary, upperBoundary, m_distanceToLine))
             continue;
 
         collectedHits.push_back(pCaloHit);
     }
 }

bool lar_content::RemovalBaseTool::IsBestElement	(	const TensorType::Element &	element,
		const pandora::HitType	hitType,
		const TensorType::ElementList &	elementList,
		const pandora::ClusterSet &	modifiedClusters
	)		const

protected

Determine whether the input element is the best to use to modify the contaminated cluster (best is defined by the total hit count)

Parameters

element	the tensor element
hitType	the hit type of the cluster under investigation
elementList	the tensor element list
modifiedClusters	the set of modified clusters

Returns: whether the input element is the best element

Definition at line 78 of file RemovalBaseTool.cc.

References PassElementChecks().

Referenced by lar_content::CosmicRayRemovalTool::RemoveCosmicRayHits(), and lar_content::DeltaRayRemovalTool::RemoveDeltaRayHits().

 {
     const float chiSquared(element.GetOverlapResult().GetReducedChi2());
     const unsigned int hitSum(element.GetClusterU()->GetNCaloHits() + element.GetClusterV()->GetNCaloHits() + element.GetClusterW()->GetNCaloHits());
 
     for (const TensorType::Element &testElement : elementList)
     {
         if (modifiedClusters.count(testElement.GetClusterU()) || modifiedClusters.count(testElement.GetClusterV()) ||
             modifiedClusters.count(testElement.GetClusterW()))
             continue;
 
         if (testElement.GetCluster(hitType) != element.GetCluster(hitType))
             continue;
 
         if ((testElement.GetClusterU() == element.GetClusterU()) && (testElement.GetClusterV() == element.GetClusterV()) &&
             (testElement.GetClusterW() == element.GetClusterW()))
             continue;
 
         const unsigned int testHitSum(
             testElement.GetClusterU()->GetNCaloHits() + testElement.GetClusterV()->GetNCaloHits() + testElement.GetClusterW()->GetNCaloHits());
         const float testChiSquared(testElement.GetOverlapResult().GetReducedChi2());
 
         if ((testHitSum < hitSum) || ((testHitSum == hitSum) && (testChiSquared > chiSquared)))
             continue;
 
         if (this->PassElementChecks(testElement, hitType))
             return false;
     }
 
     return true;
 }

bool lar_content::RemovalBaseTool::IsCloseToLine	(	const pandora::CartesianVector &	hitPosition,
		const pandora::CartesianVector &	lineStart,
		const pandora::CartesianVector &	lineEnd,
		const float	distanceToLine
	)		const

protected

Whether a given position is close to a defined line.

Parameters

hitPosition	the input position
lineStart	the start position of the line
lineEnd	the end position of the line
distanceToLine	the definition of close

Returns: whether the position is close to the definied line

Definition at line 113 of file RemovalBaseTool.cc.

Referenced by FindExtrapolatedHits(), and lar_content::CosmicRayRemovalTool::IsContaminated().

 {
     CartesianVector lineDirection(lineStart - lineEnd);
     lineDirection = lineDirection.GetUnitVector();
 
     const float transverseDistanceFromLine(lineDirection.GetCrossProduct(hitPosition - lineStart).GetMagnitude());
 
     if (transverseDistanceFromLine > distanceToLine)
         return false;
 
     return true;
 }

bool lar_content::RemovalBaseTool::IsInLineSegment	(	const pandora::CartesianVector &	lowerBoundary,
		const pandora::CartesianVector &	upperBoundary,
		const pandora::CartesianVector &	point
	)		const

protected

Whether the projection of a given position lies on a defined line.

Parameters

lowerBoundary	the start position of the line
upperBoundary	the end position of the line
point	the input position

Returns: whether the position lies between the two points

Definition at line 129 of file RemovalBaseTool.cc.

Referenced by FindExtrapolatedHits(), and lar_content::CosmicRayRemovalTool::IsContaminated().

 {
     const float segmentBoundaryGradient = (-1.f) * (upperBoundary.GetX() - lowerBoundary.GetX()) / (upperBoundary.GetZ() - lowerBoundary.GetZ());
     const float xPointOnUpperLine((point.GetZ() - upperBoundary.GetZ()) / segmentBoundaryGradient + upperBoundary.GetX());
     const float xPointOnLowerLine((point.GetZ() - lowerBoundary.GetZ()) / segmentBoundaryGradient + lowerBoundary.GetX());
 
     if (std::fabs(xPointOnUpperLine - point.GetX()) < std::numeric_limits<float>::epsilon())
         return true;
 
     if (std::fabs(xPointOnLowerLine - point.GetX()) < std::numeric_limits<float>::epsilon())
         return true;
 
     if ((point.GetX() > xPointOnUpperLine) && (point.GetX() > xPointOnLowerLine))
         return false;
 
     if ((point.GetX() < xPointOnUpperLine) && (point.GetX() < xPointOnLowerLine))
         return false;
 
     return true;
 }

bool lar_content::RemovalBaseTool::IsMuonEndpoint	(	const TensorType::Element &	element,
		const bool	ignoreHitType,
		const pandora::HitType	hitTypeToIgnore = `pandora::TPC_VIEW_U`
	)		const

protected

Determine whether the matched clusters suggest that the delta ray is at the endpoint of the cosmic ray (and is likely to be a michel)

Parameters

element	the tensor element
ignoreHitType	whether to ignore the cluster under investigation
hitTypeToIgnore	the hit type to ignore

Returns: whether the delta ray is at the endpoint of the cosmic ray

Definition at line 42 of file RemovalBaseTool.cc.

References lar_content::NViewDeltaRayMatchingAlgorithm< T >::GetMuonCluster(), and lar_content::DeltaRayTensorTool::m_pParentAlgorithm.

Referenced by lar_content::DeltaRayRemovalTool::PassElementChecks(), and lar_content::CosmicRayRemovalTool::PassElementChecks().

 {
     for (const HitType hitType : {TPC_VIEW_U, TPC_VIEW_V, TPC_VIEW_W})
     {
         if (ignoreHitType && (hitType == hitTypeToIgnore))
             continue;
 
         const Cluster *pMuonCluster(nullptr), *const pDeltaRayCluster(element.GetCluster(hitType));
 
         if (m_pParentAlgorithm->GetMuonCluster(element.GetOverlapResult().GetCommonMuonPfoList(), hitType, pMuonCluster) != STATUS_CODE_SUCCESS)
             return true;
 
         float xMinDR(-std::numeric_limits<float>::max()), xMaxDR(+std::numeric_limits<float>::max());
         pDeltaRayCluster->GetClusterSpanX(xMinDR, xMaxDR);
 
         float xMinCR(-std::numeric_limits<float>::max()), xMaxCR(+std::numeric_limits<float>::max());
         pMuonCluster->GetClusterSpanX(xMinCR, xMaxCR);
 
         if ((xMinDR < xMinCR) || (xMaxDR > xMaxCR))
             return true;
 
         float zMinDR(-std::numeric_limits<float>::max()), zMaxDR(+std::numeric_limits<float>::max());
         pDeltaRayCluster->GetClusterSpanZ(xMinDR, xMaxDR, zMinDR, zMaxDR);
 
         float zMinCR(-std::numeric_limits<float>::max()), zMaxCR(+std::numeric_limits<float>::max());
         pMuonCluster->GetClusterSpanZ(xMinCR, xMaxCR, zMinCR, zMaxCR);
 
         if ((zMinDR < zMinCR) || (zMaxDR > zMaxCR))
             return true;
     }
 
     return false;
 }

bool lar_content::RemovalBaseTool::PassElementChecks	(	const TensorType::Element &	element,
		const pandora::HitType	hitType
	)		const

protectedpure virtual

Determine whether element satifies simple checks.

Parameters

element	the tensor element
hitType	the hit type of the cluster under investigation

Returns: whether the checks pass

Implemented in lar_content::CosmicRayRemovalTool, and lar_content::DeltaRayRemovalTool.

Definition at line 28 of file RemovalBaseTool.cc.

References lar_content::LArClusterHelper::GetClosestDistance(), lar_content::NViewDeltaRayMatchingAlgorithm< T >::GetMuonCluster(), m_minSeparation, and lar_content::DeltaRayTensorTool::m_pParentAlgorithm.

Referenced by IsBestElement(), lar_content::DeltaRayRemovalTool::PassElementChecks(), and lar_content::CosmicRayRemovalTool::PassElementChecks().

 {
     const Cluster *pMuonCluster(nullptr), *const pDeltaRayCluster(element.GetCluster(hitType));
 
     if (m_pParentAlgorithm->GetMuonCluster(element.GetOverlapResult().GetCommonMuonPfoList(), hitType, pMuonCluster) != STATUS_CODE_SUCCESS)
         return false;
 
     const float separation(LArClusterHelper::GetClosestDistance(pDeltaRayCluster, pMuonCluster));
 
     return separation <= m_minSeparation;
 }

StatusCode lar_content::RemovalBaseTool::ProjectDeltaRayPositions	(	const TensorType::Element &	element,
		const pandora::HitType	hitType,
		pandora::CartesianPointVector &	projectedPositions
	)		const

protected

Use two views of a delta ray pfo to calculate projected positions in a given third view.

Parameters

element	the tensor element
hitType	the view to be projected into
projectedPositions	the output list of projected positions

Returns: a status code reflecting whether the procedure ran smoothly and if the outcome is good

Definition at line 172 of file RemovalBaseTool.cc.

References lar_content::NViewDeltaRayMatchingAlgorithm< T >::GetProjectedPositions(), and lar_content::DeltaRayTensorTool::m_pParentAlgorithm.

Referenced by lar_content::CosmicRayRemovalTool::CreateSeed().

 {
     HitTypeVector hitTypes({TPC_VIEW_U, TPC_VIEW_V, TPC_VIEW_W});
 
     hitTypes.erase(std::find(hitTypes.begin(), hitTypes.end(), hitType));
 
     const Cluster *const pCluster1(element.GetCluster(hitTypes[0]));
     const Cluster *const pCluster2(element.GetCluster(hitTypes[1]));
 
     return m_pParentAlgorithm->GetProjectedPositions(pCluster1, pCluster2, projectedPositions);
 }

StatusCode lar_content::RemovalBaseTool::ReadSettings ( const pandora::TiXmlHandle xmlHandle )

protectedpure virtual

Implemented in lar_content::CosmicRayRemovalTool, and lar_content::DeltaRayRemovalTool.

Definition at line 186 of file RemovalBaseTool.cc.

References m_distanceToLine, and m_minSeparation.

Referenced by lar_content::CosmicRayRemovalTool::ReadSettings().

 {
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinSeparation", m_minSeparation));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "DistanceToLine", m_distanceToLine));
 
     return STATUS_CODE_SUCCESS;
 }

virtual bool lar_content::RemovalBaseTool::Run	(	ThreeViewDeltaRayMatchingAlgorithm *const	pAlgorithm,
		TensorType &	overlapTensor
	)

protectedpure virtual

Run the algorithm tool.

Parameters

pAlgorithm	address of the calling algorithm
overlapTensor	the overlap tensor

Returns: whether changes have been made by the tool

Implements lar_content::DeltaRayTensorTool.

Implemented in lar_content::CosmicRayRemovalTool, and lar_content::DeltaRayRemovalTool.

Member Data Documentation

float lar_content::RemovalBaseTool::m_distanceToLine

protected

The maximum perpendicular distance of a position to a line for it to be considered close.

Definition at line 115 of file RemovalBaseTool.h.

Referenced by FindExtrapolatedHits(), lar_content::CosmicRayRemovalTool::IsContaminated(), and ReadSettings().

float lar_content::RemovalBaseTool::m_minSeparation

protected

The minimum delta ray - parent muon cluster separation required to investigate a delta/cosmic ray cluster.

Definition at line 114 of file RemovalBaseTool.h.

Referenced by PassElementChecks(), and ReadSettings().

ThreeViewDeltaRayMatchingAlgorithm* lar_content::DeltaRayTensorTool::m_pParentAlgorithm

inherited

Address of the parent matching algorithm.

Definition at line 114 of file ThreeViewDeltaRayMatchingAlgorithm.h.

Referenced by lar_content::CosmicRayRemovalTool::CreateSeed(), lar_content::AmbiguousDeltaRayTool::ExamineConnectedElements(), lar_content::UnambiguousDeltaRayTool::ExamineUnambiguousElements(), lar_content::CosmicRayRemovalTool::GrowSeed(), lar_content::DeltaRayRemovalTool::IsContaminated(), lar_content::CosmicRayRemovalTool::IsContaminated(), IsMuonEndpoint(), lar_content::DeltaRayMergeTool::MakeOneCommonViewMerges(), lar_content::DeltaRayMergeTool::MakeTwoCommonViewMerges(), PassElementChecks(), ProjectDeltaRayPositions(), lar_content::CosmicRayRemovalTool::ReclusterRemnant(), lar_content::DeltaRayRemovalTool::RemoveDeltaRayHits(), lar_content::DeltaRayMergeTool::Run(), lar_content::UnambiguousDeltaRayTool::Run(), lar_content::AmbiguousDeltaRayTool::Run(), lar_content::DeltaRayRemovalTool::Run(), lar_content::CosmicRayRemovalTool::Run(), lar_content::CosmicRayRemovalTool::SplitDeltaRayCluster(), and lar_content::DeltaRayRemovalTool::SplitMuonCluster().

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

larpandoracontent/v04_08_01/source/larpandoracontent/LArThreeDReco/LArCosmicRay/RemovalBaseTool.h
larpandoracontent/v04_08_01/source/larpandoracontent/LArThreeDReco/LArCosmicRay/RemovalBaseTool.cc

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation