#include "CosmicRayRemovalTool.h"

Inheritance diagram for lar_content::CosmicRayRemovalTool:

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

typedef ThreeViewDeltaRayMatchingAlgorithm::MatchingType::TensorType	TensorType

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

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

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

Protected Member Functions
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...

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...

Private Member Functions
bool	Run (ThreeViewDeltaRayMatchingAlgorithm *const pAlgorithm, TensorType &overlapTensor)
	Run the algorithm tool. More...

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

bool	RemoveCosmicRayHits (const TensorType::ElementList &elementList) const
	Remove hits from delta ray clusters that belong to the parent muon. More...

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

bool	IsContaminated (const TensorType::Element &element, const pandora::HitType hitType) const
	Determine whether the cluster under investigation has muon contamination. More...

void	CreateSeed (const TensorType::Element &element, const pandora::HitType hitType, pandora::CaloHitList &collectedHits) const
	Collect hits in the delta ray cluster that lie close to calculated projected positions forming a seed to later grow. More...

pandora::StatusCode	GrowSeed (const TensorType::Element &element, const pandora::HitType hitType, pandora::CaloHitList &collectedHits, pandora::CaloHitList &deltaRayRemantHits) const
	Examine remaining hits in the delta ray cluster adding them to the delta ray seed or parent muon if appropriate and a separate list if not. More...

void	CollectHitsFromDeltaRay (const pandora::CartesianVector &positionOnMuon, const pandora::CartesianVector &muonDirection, const pandora::Cluster *const pDeltaRayCluster, const float &minDistanceFromMuon, const bool demandCloserToCollected, const pandora::CaloHitList &protectedHits, pandora::CaloHitList &collectedHits) const
	Collect hits from the delta ray cluster to either keep (demandCloserToCollected == true) or separate into a new shower (demandCloserToCollected == false) More...

void	SplitDeltaRayCluster (const TensorType::Element &element, const pandora::HitType hitType, pandora::CaloHitList &collectedHits, pandora::CaloHitList &deltaRayRemnantHits) const
	Fragment the delta ray cluster adding hits to the muon track and perhaps creating significant remnants in the process. More...

void	ReclusterRemnant (const pandora::HitType hitType, const pandora::Cluster const pMuonCluster, const pandora::Cluster const pDeltaRayRemnant, pandora::ClusterVector &clusterVector, pandora::PfoVector &pfoVector) const
	Reculster a given remnant cluster, merging insignificant created clusters into the parent muon (if proximity checks pass) More...

Private Attributes
unsigned int	m_slidingFitWindow
	The sliding fit window used in cosmic ray parameterisations. More...

float	m_minContaminationLength
	The minimum projected length of a delta ray cluster onto the muon track for it to be considered contaminated. More...

float	m_maxDistanceToHit
	The maximum distance of a hit from the cosmic ray track for it to be added into the CR. More...

unsigned int	m_minRemnantClusterSize
	The minimum hit number of a remnant cluster for it to be considered significant. More...

float	m_maxDistanceToTrack
	The minimum distance of an insignificant remnant cluster from the cosmic ray track for it to be merged into the CR. More...

Detailed Description

CosmicRayRemovalTool class.

Definition at line 20 of file CosmicRayRemovalTool.h.

Member Typedef Documentation

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

inherited

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::CosmicRayRemovalTool::CosmicRayRemovalTool ( )

Default constructor.

Definition at line 23 of file CosmicRayRemovalTool.cc.

                                            :
     m_slidingFitWindow(10000),
     m_minContaminationLength(3.f),
     m_maxDistanceToHit(1.f),
     m_minRemnantClusterSize(3),
     m_maxDistanceToTrack(2.f)
 {
 }

Member Function Documentation

void lar_content::CosmicRayRemovalTool::CollectHitsFromDeltaRay	(	const pandora::CartesianVector &	positionOnMuon,
		const pandora::CartesianVector &	muonDirection,
		const pandora::Cluster *const	pDeltaRayCluster,
		const float &	minDistanceFromMuon,
		const bool	demandCloserToCollected,
		const pandora::CaloHitList &	protectedHits,
		pandora::CaloHitList &	collectedHits
	)		const

private

Collect hits from the delta ray cluster to either keep (demandCloserToCollected == true) or separate into a new shower (demandCloserToCollected == false)

Parameters

positionOnMuon	the parameterised muon position
muonDirection	the parameterised muon direction
pDeltaRayCluster	the delta ray cluster under investigation
minDistanceFromMuon	the minimum distance of a hit from the muon track for it to not belong to the muon
demandCloserToCollected	whether to demand a hit be closer to the collected hits than to the muon hits for it to be collected
protectedHits	the hits that are protected from being collected
collectedHits	the output list of collected hits

Definition at line 262 of file CosmicRayRemovalTool.cc.

References lar_content::LArClusterHelper::GetClosestDistance().

Referenced by GrowSeed().

 {
     CaloHitList deltaRayHitList;
     pDeltaRayCluster->GetOrderedCaloHitList().FillCaloHitList(deltaRayHitList);
 
     bool hitsAdded(false);
 
     do
     {
         hitsAdded = false;
 
         for (const CaloHit *const pCaloHit : deltaRayHitList)
         {
             if (std::find(protectedHits.begin(), protectedHits.end(), pCaloHit) != protectedHits.end())
                 continue;
 
             if (std::find(collectedHits.begin(), collectedHits.end(), pCaloHit) != collectedHits.end())
                 continue;
 
             const float distanceToCollectedHits(collectedHits.empty()
                     ? std::numeric_limits<float>::max()
                     : LArClusterHelper::GetClosestDistance(pCaloHit->GetPositionVector(), collectedHits));
             const float distanceToMuonHits(muonDirection.GetCrossProduct(pCaloHit->GetPositionVector() - positionOnMuon).GetMagnitude());
 
             if ((distanceToMuonHits < minDistanceFromMuon) || (demandCloserToCollected && (distanceToCollectedHits > distanceToMuonHits)))
                 continue;
 
             collectedHits.push_back(pCaloHit);
             hitsAdded = true;
         }
     } while (hitsAdded);
 }

void lar_content::CosmicRayRemovalTool::CreateSeed	(	const TensorType::Element &	element,
		const pandora::HitType	hitType,
		pandora::CaloHitList &	collectedHits
	)		const

private

Collect hits in the delta ray cluster that lie close to calculated projected positions forming a seed to later grow.

Parameters

element	the tensor element
hitType	the hit type of the cluster under investigation
collectedHits	the output list of identified delta ray hits

Definition at line 191 of file CosmicRayRemovalTool.cc.

References f, lar_content::LArClusterHelper::GetClosestDistance(), m_maxDistanceToHit, lar_content::DeltaRayTensorTool::m_pParentAlgorithm, lar_content::NViewDeltaRayMatchingAlgorithm< T >::ParameteriseMuon(), lar_content::RemovalBaseTool::ProjectDeltaRayPositions(), and lar_content::LArClusterHelper::SortHitsByPosition().

Referenced by RemoveCosmicRayHits().

 {
     // To avoid fluctuations, parameterise the muon track
     CartesianVector positionOnMuon(0.f, 0.f, 0.f), muonDirection(0.f, 0.f, 0.f);
     if (m_pParentAlgorithm->ParameteriseMuon(element.GetOverlapResult().GetCommonMuonPfoList().front(), element.GetCluster(hitType),
             positionOnMuon, muonDirection) != STATUS_CODE_SUCCESS)
         return;
 
     CartesianPointVector deltaRayProjectedPositions;
     if (this->ProjectDeltaRayPositions(element, hitType, deltaRayProjectedPositions) != STATUS_CODE_SUCCESS)
         return;
 
     CaloHitList deltaRayHitList;
     element.GetCluster(hitType)->GetOrderedCaloHitList().FillCaloHitList(deltaRayHitList);
 
     CaloHitVector deltaRayHitVector(deltaRayHitList.begin(), deltaRayHitList.end());
     std::sort(deltaRayHitVector.begin(), deltaRayHitVector.end(), LArClusterHelper::SortHitsByPosition);
 
     for (const CaloHit *const pCaloHit : deltaRayHitVector)
     {
         const CartesianVector &position(pCaloHit->GetPositionVector());
 
         for (const CartesianVector &projectedPosition : deltaRayProjectedPositions)
         {
             const float distanceToProjectionSquared((position - projectedPosition).GetMagnitudeSquared());
 
             if (distanceToProjectionSquared < m_maxDistanceToHit * m_maxDistanceToHit)
             {
                 // To prevent gappy seeds
                 if ((!collectedHits.empty()) && (LArClusterHelper::GetClosestDistance(position, collectedHits) > m_maxDistanceToHit))
                     continue;
 
                 const float distanceToMuonHitsSquared(muonDirection.GetCrossProduct(position - positionOnMuon).GetMagnitudeSquared());
 
                 if (distanceToMuonHitsSquared < m_maxDistanceToHit * m_maxDistanceToHit)
                     continue;
 
                 collectedHits.push_back(pCaloHit);
 
                 break;
             }
         }
     }
 }

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

protectedinherited

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 lar_content::RemovalBaseTool::IsCloseToLine(), lar_content::RemovalBaseTool::IsInLineSegment(), and lar_content::RemovalBaseTool::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);
     }
 }

StatusCode lar_content::CosmicRayRemovalTool::GrowSeed	(	const TensorType::Element &	element,
		const pandora::HitType	hitType,
		pandora::CaloHitList &	collectedHits,
		pandora::CaloHitList &	deltaRayRemantHits
	)		const

private

Examine remaining hits in the delta ray cluster adding them to the delta ray seed or parent muon if appropriate and a separate list if not.

Parameters

element	the tensor element
hitType	the hit type of the cluster under investigation
collectedHits	the list of identified delta ray hits
deltaRayRemantHits	the list of remainder hits

Returns: whether the muon projection mechanics were successful - abort process if not

Definition at line 238 of file CosmicRayRemovalTool.cc.

References CollectHitsFromDeltaRay(), f, lar_content::NViewDeltaRayMatchingAlgorithm< T >::GetMuonCluster(), m_maxDistanceToHit, lar_content::DeltaRayTensorTool::m_pParentAlgorithm, and lar_content::NViewDeltaRayMatchingAlgorithm< T >::ParameteriseMuon().

Referenced by RemoveCosmicRayHits().

 {
     const Cluster *const pDeltaRayCluster(element.GetCluster(hitType)), *pMuonCluster(nullptr);
 
     if (m_pParentAlgorithm->GetMuonCluster(element.GetOverlapResult().GetCommonMuonPfoList(), hitType, pMuonCluster) != STATUS_CODE_SUCCESS)
         return STATUS_CODE_NOT_FOUND;
 
     // To avoid fluctuatuions, parameterise the muon track
     CartesianVector positionOnMuon(0.f, 0.f, 0.f), muonDirection(0.f, 0.f, 0.f);
     if (m_pParentAlgorithm->ParameteriseMuon(element.GetOverlapResult().GetCommonMuonPfoList().front(), pDeltaRayCluster, positionOnMuon,
             muonDirection) != STATUS_CODE_SUCCESS)
         return STATUS_CODE_NOT_FOUND;
 
     // Identify delta ray hits
     this->CollectHitsFromDeltaRay(positionOnMuon, muonDirection, pDeltaRayCluster, m_maxDistanceToHit, true, deltaRayHits, deltaRayHits);
 
     // Identify remnant hits
     this->CollectHitsFromDeltaRay(positionOnMuon, muonDirection, pDeltaRayCluster, m_maxDistanceToHit, false, deltaRayHits, remnantHits);
 
     return STATUS_CODE_SUCCESS;
 }

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

protectedinherited

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 lar_content::RemovalBaseTool::PassElementChecks().

Referenced by 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

protectedinherited

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 lar_content::RemovalBaseTool::FindExtrapolatedHits(), and 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::CosmicRayRemovalTool::IsContaminated	(	const TensorType::Element &	element,
		const pandora::HitType	hitType
	)		const

private

Determine whether the cluster under investigation has muon contamination.

Parameters

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

Returns: whether the cluster contains muon hits to remove

Definition at line 134 of file CosmicRayRemovalTool.cc.

References f, lar_content::LArClusterHelper::GetClosestPositions(), lar_content::TwoDSlidingFitResult::GetGlobalDirection(), lar_content::TwoDSlidingFitResult::GetLayerFitResultMap(), lar_content::NViewDeltaRayMatchingAlgorithm< T >::GetMuonCluster(), lar_content::LArGeometryHelper::GetWirePitch(), lar_content::RemovalBaseTool::IsCloseToLine(), lar_content::RemovalBaseTool::IsInLineSegment(), lar_content::RemovalBaseTool::m_distanceToLine, m_minContaminationLength, lar_content::DeltaRayTensorTool::m_pParentAlgorithm, and m_slidingFitWindow.

Referenced by RemoveCosmicRayHits().

 {
     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 slidingFitPitch(LArGeometryHelper::GetWirePitch(this->GetPandora(), hitType));
     const TwoDSlidingFitResult slidingFitResult(pMuonCluster, m_slidingFitWindow, slidingFitPitch);
 
     CartesianVector muonDirection(0.f, 0.f, 0.f);
     slidingFitResult.GetGlobalDirection(slidingFitResult.GetLayerFitResultMap().begin()->second.GetGradient(), muonDirection);
 
     CartesianVector deltaRayVertex(0.f, 0.f, 0.f), muonVertex(0.f, 0.f, 0.f);
     LArClusterHelper::GetClosestPositions(pDeltaRayCluster, pMuonCluster, deltaRayVertex, muonVertex);
 
     // Find furthest point in DR cluster that lies on the projected muon track
     float furthestSeparation(0.f);
     CartesianVector extendedPoint(0.f, 0.f, 0.f);
 
     CaloHitList deltaRayHitList;
     pDeltaRayCluster->GetOrderedCaloHitList().FillCaloHitList(deltaRayHitList);
 
     for (const CaloHit *const pCaloHit : deltaRayHitList)
     {
         const CartesianVector &position(pCaloHit->GetPositionVector());
         const float separation((position - muonVertex).GetMagnitude());
 
         if (separation > furthestSeparation)
         {
             if (this->IsCloseToLine(position, muonVertex, muonVertex + muonDirection, m_distanceToLine))
             {
                 furthestSeparation = separation;
                 extendedPoint = position;
             }
         }
     }
 
     // Check if delta ray has significant track contamination
     if (furthestSeparation < m_minContaminationLength)
         return false;
 
     // ATTN: Avoid cases where opening angle is small - it is easy to make mistakes in these instances
     CaloHitList muonHitList;
     pMuonCluster->GetOrderedCaloHitList().FillCaloHitList(muonHitList);
 
     for (const CaloHit *const pCaloHit : muonHitList)
     {
         if (this->IsInLineSegment(deltaRayVertex, extendedPoint, pCaloHit->GetPositionVector()))
             return false;
     }
 
     return true;
 }

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

protectedinherited

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 lar_content::RemovalBaseTool::FindExtrapolatedHits(), and 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

protectedinherited

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 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::CosmicRayRemovalTool::PassElementChecks	(	const TensorType::Element &	element,
		const pandora::HitType	hitType
	)		const

privatevirtual

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

Implements lar_content::RemovalBaseTool.

Definition at line 123 of file CosmicRayRemovalTool.cc.

References lar_content::RemovalBaseTool::IsMuonEndpoint(), and lar_content::RemovalBaseTool::PassElementChecks().

Referenced by RemoveCosmicRayHits().

 {
     // ATTN: Avoid endpoints, topological michel reconstruction is very ambiguous
     if (this->IsMuonEndpoint(element, true, hitType))
         return false;
 
     return RemovalBaseTool::PassElementChecks(element, hitType);
 }

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

protectedinherited

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 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::CosmicRayRemovalTool::ReadSettings ( const pandora::TiXmlHandle xmlHandle )

privatevirtual

Implements lar_content::RemovalBaseTool.

Definition at line 399 of file CosmicRayRemovalTool.cc.

References m_maxDistanceToHit, m_maxDistanceToTrack, m_minContaminationLength, m_minRemnantClusterSize, m_slidingFitWindow, and lar_content::RemovalBaseTool::ReadSettings().

 {
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "SlidingFitWindow", m_slidingFitWindow));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinContaminationLength", m_minContaminationLength));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MaxDistanceToHit", m_maxDistanceToHit));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinRemnantClusterSize", m_minRemnantClusterSize));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MaxDistanceToTrack", m_maxDistanceToTrack));
 
     return RemovalBaseTool::ReadSettings(xmlHandle);
 }

void lar_content::CosmicRayRemovalTool::ReclusterRemnant	(	const pandora::HitType	hitType,
		const pandora::Cluster *const	pMuonCluster,
		const pandora::Cluster *const	pDeltaRayRemnant,
		pandora::ClusterVector &	clusterVector,
		pandora::PfoVector &	pfoVector
	)		const

private

Reculster a given remnant cluster, merging insignificant created clusters into the parent muon (if proximity checks pass)

Parameters

hitType	the hit type of the cluster under investigation
pMuonCluster	the address of the parent muon cluster
pDeltaRayRemnant	the address of the delta ray remnant
clusterVector	a vector containing the address of created/modified clusters for bookeeping purposes
pfoVector	a vector containing the address of the pfo to which a modified muon cluster belongs for bookeeping purposes

Definition at line 359 of file CosmicRayRemovalTool.cc.

References lar_content::LArClusterHelper::GetClosestDistance(), lar_content::ThreeViewDeltaRayMatchingAlgorithm::GetClusteringAlgName(), lar_content::NViewMatchingAlgorithm< T >::GetClusterListName(), m_maxDistanceToTrack, m_minRemnantClusterSize, and lar_content::DeltaRayTensorTool::m_pParentAlgorithm.

Referenced by SplitDeltaRayCluster().

 {
     std::string caloHitListName(hitType == TPC_VIEW_U ? "CaloHitListU" : hitType == TPC_VIEW_V ? "CaloHitListV" : "CaloHitListW");
 
     PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::ReplaceCurrentList<CaloHit>(*m_pParentAlgorithm, caloHitListName));
     PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=,
         PandoraContentApi::ReplaceCurrentList<Cluster>(*m_pParentAlgorithm, m_pParentAlgorithm->GetClusterListName(hitType)));
     PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::Delete<Cluster>(*m_pParentAlgorithm, pDeltaRayRemnant));
 
     const ClusterList *pClusterList(nullptr);
     std::string newClusterListName;
     PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=,
         PandoraContentApi::RunClusteringAlgorithm(*m_pParentAlgorithm, m_pParentAlgorithm->GetClusteringAlgName(), pClusterList, newClusterListName));
 
     const ClusterList remnantClusters(pClusterList->begin(), pClusterList->end());
 
     PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=,
         PandoraContentApi::SaveList<Cluster>(*m_pParentAlgorithm, newClusterListName, m_pParentAlgorithm->GetClusterListName(hitType)));
     PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=,
         PandoraContentApi::ReplaceCurrentList<Cluster>(*m_pParentAlgorithm, m_pParentAlgorithm->GetClusterListName(hitType)));
 
     for (const Cluster *const pRemnant : remnantClusters)
     {
         if (pRemnant->GetNCaloHits() < m_minRemnantClusterSize)
         {
             if (LArClusterHelper::GetClosestDistance(pRemnant, pMuonCluster) < m_maxDistanceToTrack)
             {
                 PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::MergeAndDeleteClusters(*m_pParentAlgorithm, pMuonCluster, pRemnant));
                 continue;
             }
         }
 
         clusterVector.push_back(pRemnant);
         pfoVector.push_back(nullptr);
     }
 }

bool lar_content::CosmicRayRemovalTool::RemoveCosmicRayHits ( const TensorType::ElementList & elementList ) const

private

Remove hits from delta ray clusters that belong to the parent muon.

Parameters

elementList the tensor element list

Returns: whether any clusters have been modified

Definition at line 68 of file CosmicRayRemovalTool.cc.

References CreateSeed(), GrowSeed(), lar_content::RemovalBaseTool::IsBestElement(), IsContaminated(), PassElementChecks(), and SplitDeltaRayCluster().

Referenced by Run().

 {
     ClusterSet modifiedClusters, checkedClusters;
 
     for (const TensorType::Element &element : elementList)
     {
         for (const HitType hitType : {TPC_VIEW_U, TPC_VIEW_V, TPC_VIEW_W})
         {
             const Cluster *const pDeltaRayCluster(element.GetCluster(hitType));
 
             if (checkedClusters.count(pDeltaRayCluster))
                 continue;
 
             // ATTN: The underlying tensor will update during this loop, do not proceed if element has been modified
             if ((modifiedClusters.count(element.GetClusterU())) || (modifiedClusters.count(element.GetClusterV())) ||
                 (modifiedClusters.count(element.GetClusterW())))
                 continue;
 
             if (!this->PassElementChecks(element, hitType))
                 continue;
 
             if (!this->IsContaminated(element, hitType))
                 continue;
 
             if (!this->IsBestElement(element, hitType, elementList, modifiedClusters))
                 continue;
 
             checkedClusters.insert(pDeltaRayCluster);
 
             CaloHitList deltaRayHits;
             this->CreateSeed(element, hitType, deltaRayHits);
 
             if (deltaRayHits.empty())
                 continue;
 
             // ATTN: Abort if seed cannot be grown
             CaloHitList remnantHits;
             if (this->GrowSeed(element, hitType, deltaRayHits, remnantHits) != STATUS_CODE_SUCCESS)
                 continue;
 
             // ATTN: Abort if reformed DR cluster
             if (deltaRayHits.size() == pDeltaRayCluster->GetNCaloHits())
                 continue;
 
             modifiedClusters.insert(pDeltaRayCluster);
 
             this->SplitDeltaRayCluster(element, hitType, deltaRayHits, remnantHits);
         }
     }
 
     return !modifiedClusters.empty();
 }

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

privatevirtual

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::RemovalBaseTool.

Definition at line 34 of file CosmicRayRemovalTool.cc.

References lar_content::OverlapTensor< T >::GetConnectedElements(), lar_content::OverlapTensor< T >::GetSortedKeyClusters(), lar_content::DeltaRayTensorTool::m_pParentAlgorithm, and RemoveCosmicRayHits().

 {
     m_pParentAlgorithm = pAlgorithm;
 
     if (PandoraContentApi::GetSettings(*m_pParentAlgorithm)->ShouldDisplayAlgorithmInfo())
         std::cout << "----> Running Algorithm Tool: " << this->GetInstanceName() << ", " << this->GetType() << std::endl;
 
     bool changesMade(false);
 
     ClusterVector sortedKeyClusters;
     overlapTensor.GetSortedKeyClusters(sortedKeyClusters);
 
     ClusterSet usedKeyClusters;
     for (const Cluster *const pKeyCluster : sortedKeyClusters)
     {
         if (usedKeyClusters.count(pKeyCluster))
             continue;
 
         TensorType::ElementList elementList;
         overlapTensor.GetConnectedElements(pKeyCluster, true, elementList);
 
         for (const TensorType::Element &element : elementList)
             usedKeyClusters.insert(element.GetClusterU());
 
         const bool changesMadeInIteration = this->RemoveCosmicRayHits(elementList);
 
         changesMade = (changesMade ? changesMade : changesMadeInIteration);
     }
 
     return changesMade;
 }

void lar_content::CosmicRayRemovalTool::SplitDeltaRayCluster	(	const TensorType::Element &	element,
		const pandora::HitType	hitType,
		pandora::CaloHitList &	collectedHits,
		pandora::CaloHitList &	deltaRayRemnantHits
	)		const

private

Fragment the delta ray cluster adding hits to the muon track and perhaps creating significant remnants in the process.

Parameters

element	the tensor element
hitType	the hit type of the cluster under investigation
collectedHits	the list of identified delta ray hits
deltaRayRemantHits	the list of remainder hits

Definition at line 299 of file CosmicRayRemovalTool.cc.

References lar_content::NViewMatchingAlgorithm< T >::GetClusterListName(), lar_content::NViewDeltaRayMatchingAlgorithm< T >::GetMuonCluster(), lar_content::DeltaRayTensorTool::m_pParentAlgorithm, ReclusterRemnant(), lar_content::NViewDeltaRayMatchingAlgorithm< T >::UpdateForNewClusters(), and lar_content::NViewDeltaRayMatchingAlgorithm< T >::UpdateUponDeletion().

Referenced by RemoveCosmicRayHits().

 {
     const Cluster *const pDeltaRayCluster(element.GetCluster(hitType)), *pMuonCluster(nullptr);
 
     if (m_pParentAlgorithm->GetMuonCluster(element.GetOverlapResult().GetCommonMuonPfoList(), hitType, pMuonCluster) != STATUS_CODE_SUCCESS)
         return;
 
     m_pParentAlgorithm->UpdateUponDeletion(pMuonCluster);
     m_pParentAlgorithm->UpdateUponDeletion(pDeltaRayCluster);
 
     std::string originalListName, fragmentListName;
     ClusterList originalClusterList(1, pDeltaRayCluster);
 
     PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=,
         PandoraContentApi::ReplaceCurrentList<Cluster>(*m_pParentAlgorithm, m_pParentAlgorithm->GetClusterListName(hitType)));
     PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=,
         PandoraContentApi::InitializeFragmentation(*m_pParentAlgorithm, originalClusterList, originalListName, fragmentListName));
 
     CaloHitList deltaRayHitList;
     pDeltaRayCluster->GetOrderedCaloHitList().FillCaloHitList(deltaRayHitList);
 
     const Cluster *pDeltaRay(nullptr), *pDeltaRayRemnant(nullptr);
 
     for (const CaloHit *const pCaloHit : deltaRayHitList)
     {
         const bool isDeltaRay(std::find(collectedHits.begin(), collectedHits.end(), pCaloHit) != collectedHits.end());
         const bool isDeltaRayRemnant(
             !isDeltaRay && (std::find(deltaRayRemnantHits.begin(), deltaRayRemnantHits.end(), pCaloHit) != deltaRayRemnantHits.end()));
         const Cluster *&pCluster(isDeltaRay ? pDeltaRay : isDeltaRayRemnant ? pDeltaRayRemnant : pMuonCluster);
 
         if (!pCluster)
         {
             PandoraContentApi::Cluster::Parameters parameters;
             parameters.m_caloHitList.push_back(pCaloHit);
             PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::Cluster::Create(*m_pParentAlgorithm, parameters, pCluster));
         }
         else
         {
             PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::AddToCluster(*m_pParentAlgorithm, pCluster, pCaloHit));
         }
     }
 
     PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::EndFragmentation(*m_pParentAlgorithm, fragmentListName, originalListName));
 
     ClusterVector clusterVector;
     PfoVector pfoVector;
     if (pDeltaRayRemnant)
         this->ReclusterRemnant(hitType, pMuonCluster, pDeltaRayRemnant, clusterVector, pfoVector);
 
     clusterVector.push_back(pMuonCluster);
     pfoVector.push_back(element.GetOverlapResult().GetCommonMuonPfoList().front());
     clusterVector.push_back(pDeltaRay);
     pfoVector.push_back(nullptr);
 
     m_pParentAlgorithm->UpdateForNewClusters(clusterVector, pfoVector);
 }

Member Data Documentation

float lar_content::RemovalBaseTool::m_distanceToLine

protectedinherited

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 lar_content::RemovalBaseTool::FindExtrapolatedHits(), IsContaminated(), and lar_content::RemovalBaseTool::ReadSettings().

float lar_content::CosmicRayRemovalTool::m_maxDistanceToHit

private

The maximum distance of a hit from the cosmic ray track for it to be added into the CR.

Definition at line 123 of file CosmicRayRemovalTool.h.

Referenced by CreateSeed(), GrowSeed(), and ReadSettings().

float lar_content::CosmicRayRemovalTool::m_maxDistanceToTrack

private

The minimum distance of an insignificant remnant cluster from the cosmic ray track for it to be merged into the CR.

Definition at line 125 of file CosmicRayRemovalTool.h.

Referenced by ReadSettings(), and ReclusterRemnant().

float lar_content::CosmicRayRemovalTool::m_minContaminationLength

private

The minimum projected length of a delta ray cluster onto the muon track for it to be considered contaminated.

Definition at line 122 of file CosmicRayRemovalTool.h.

Referenced by IsContaminated(), and ReadSettings().

unsigned int lar_content::CosmicRayRemovalTool::m_minRemnantClusterSize

private

The minimum hit number of a remnant cluster for it to be considered significant.

Definition at line 124 of file CosmicRayRemovalTool.h.

Referenced by ReadSettings(), and ReclusterRemnant().

float lar_content::RemovalBaseTool::m_minSeparation

protectedinherited

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 lar_content::RemovalBaseTool::PassElementChecks(), and lar_content::RemovalBaseTool::ReadSettings().

ThreeViewDeltaRayMatchingAlgorithm* lar_content::DeltaRayTensorTool::m_pParentAlgorithm

inherited

Address of the parent matching algorithm.

Definition at line 114 of file ThreeViewDeltaRayMatchingAlgorithm.h.

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

unsigned int lar_content::CosmicRayRemovalTool::m_slidingFitWindow

private

The sliding fit window used in cosmic ray parameterisations.

Definition at line 121 of file CosmicRayRemovalTool.h.

Referenced by IsContaminated(), and ReadSettings().

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

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

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation