#include <DeltaRayRemovalTool.h>

Inheritance diagram for lar_content::DeltaRayRemovalTool:

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

Public Member Functions inherited from lar_content::RemovalBaseTool
	RemovalBaseTool ()
	Default constructor. More...

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

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

bool	RemoveDeltaRayHits (const TensorType::ElementList &elementList) const
	Remove hits from cosmic ray clusters that belong to a child delta ray. 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 cosmic ray cluster under investigation has delta ray contamination. More...

void	SplitMuonCluster (const TensorType::Element &element, const pandora::HitType hitType, const pandora::CaloHitList &deltaRayHits) const
	Remove collected delta ray hits from the cosmic ray pfo. More...

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

float	m_minDeviationFromTransverse
	The minimum deviation from transverse required to avoid mistakes. More...

float	m_contaminationWindow
	The distance in which to search for delta ray contamination in the cosmic ray track. More...

unsigned int	m_significantHitThreshold
	The threshold number of hits which define significant contimination. More...

float	m_minDistanceFromMuon
	The minimum distance of a hit from the cosmic ray track required for removal. More...

float	m_maxDistanceToCollected
	The maximim distance of a hit from the projected delta ray hits required for removal. More...

Additional Inherited Members
Public Types inherited from lar_content::RemovalBaseTool
typedef std::vector< pandora::HitType >	HitTypeVector

Public Types inherited from lar_content::DeltaRayTensorTool
typedef ThreeViewDeltaRayMatchingAlgorithm::MatchingType::TensorType	TensorType

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

Public Attributes inherited from lar_content::DeltaRayTensorTool
ThreeViewDeltaRayMatchingAlgorithm *	m_pParentAlgorithm
	Address of the parent matching algorithm. More...

Protected Member Functions inherited from lar_content::RemovalBaseTool
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 inherited from lar_content::RemovalBaseTool
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

DeltaRayRemovalTool class.

Definition at line 19 of file DeltaRayRemovalTool.h.

Constructor & Destructor Documentation

lar_content::DeltaRayRemovalTool::DeltaRayRemovalTool ( )

Default constructor.

Definition at line 23 of file DeltaRayRemovalTool.cc.

                                          :
     m_slidingFitWindow(10000),
     m_minDeviationFromTransverse(0.35f),
     m_contaminationWindow(5.f),
     m_significantHitThreshold(3),
     m_minDistanceFromMuon(1.f),
     m_maxDistanceToCollected(1.f)
 {
 }

Member Function Documentation

bool lar_content::DeltaRayRemovalTool::IsContaminated	(	const TensorType::Element &	element,
		const pandora::HitType	hitType
	)		const

private

Determine whether the cosmic ray cluster under investigation has delta ray contamination.

Parameters

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

Returns: whether the cosmic ray cluster is likely to contain delta ray hits that can be removed

Definition at line 126 of file DeltaRayRemovalTool.cc.

 {
     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::GetWireZPitch(this->GetPandora()));
     const TwoDSlidingFitResult slidingFitResult(pMuonCluster, m_slidingFitWindow, slidingFitPitch);
 
     CartesianVector muonDirection(0.f, 0.f, 0.f);
     slidingFitResult.GetGlobalDirection(slidingFitResult.GetLayerFitResultMap().begin()->second.GetGradient(), muonDirection);
 
     const CartesianVector xAxis(1.f, 0.f, 0.f);
     const bool isTransverse((muonDirection.GetOpeningAngle(xAxis) < m_minDeviationFromTransverse) ||
                             ((M_PI - muonDirection.GetOpeningAngle(xAxis)) < m_minDeviationFromTransverse));
 
     if (isTransverse)
         return false;
 
     CartesianVector deltaRayVertex(0.f, 0.f, 0.f), muonVertex(0.f, 0.f, 0.f);
     LArClusterHelper::GetClosestPositions(pDeltaRayCluster, pMuonCluster, deltaRayVertex, muonVertex);
 
     CaloHitList minusMuonHits, minusDeltaRayHits, plusMuonHits, plusDeltaRayHits;
     const CartesianVector minusPosition(muonVertex - (muonDirection * m_contaminationWindow));
     const CartesianVector plusPosition(muonVertex + (muonDirection * m_contaminationWindow));
 
     this->FindExtrapolatedHits(pMuonCluster, muonVertex, minusPosition, minusMuonHits);
     this->FindExtrapolatedHits(pMuonCluster, muonVertex, plusPosition, plusMuonHits);
     this->FindExtrapolatedHits(pDeltaRayCluster, muonVertex, minusPosition, minusDeltaRayHits);
     this->FindExtrapolatedHits(pDeltaRayCluster, muonVertex, plusPosition, plusDeltaRayHits);
 
     if ((minusMuonHits.size() < m_significantHitThreshold) && (plusMuonHits.size() < m_significantHitThreshold))
         return true;
 
     if ((minusMuonHits.size() < m_significantHitThreshold) && (minusDeltaRayHits.size() >= m_significantHitThreshold) &&
         (plusDeltaRayHits.size() < m_significantHitThreshold) && (plusMuonHits.size() >= m_significantHitThreshold))
     {
         return true;
     }
 
     if ((plusMuonHits.size() < m_significantHitThreshold) && (plusDeltaRayHits.size() >= m_significantHitThreshold) &&
         (minusDeltaRayHits.size() < m_significantHitThreshold) && (minusMuonHits.size() >= m_significantHitThreshold))
     {
         return true;
     }
 
     return false;
 }

bool lar_content::DeltaRayRemovalTool::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 115 of file DeltaRayRemovalTool.cc.

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

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

privatevirtual

Implements lar_content::RemovalBaseTool.

Definition at line 201 of file DeltaRayRemovalTool.cc.

 {
     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, "MinDeviationFromTransverse", m_minDeviationFromTransverse));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "ContaminationWindow", m_contaminationWindow));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadValue(xmlHandle, "SignificantHitThreshold", m_significantHitThreshold));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinDistanceFromMuon", m_minDistanceFromMuon));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MaxDistanceToCollected", m_maxDistanceToCollected));
 
     return STATUS_CODE_SUCCESS;
 }

bool lar_content::DeltaRayRemovalTool::RemoveDeltaRayHits ( const TensorType::ElementList & elementList ) const

private

Remove hits from cosmic ray clusters that belong to a child delta ray.

Parameters

elementList the tensor element list

Returns: changesMade whether clusters in element have been modified

Definition at line 69 of file DeltaRayRemovalTool.cc.

 {
     ClusterSet modifiedClusters, checkedClusters;
 
     for (const TensorType::Element &element : elementList)
     {
         for (const HitType hitType : {TPC_VIEW_U, TPC_VIEW_V, TPC_VIEW_W})
         {
             const Cluster *pDeltaRayCluster(element.GetCluster(hitType));
             const ParticleFlowObject *const pMuonPfo(element.GetOverlapResult().GetCommonMuonPfoList().front());
 
             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;
             if (m_pParentAlgorithm->CollectHitsFromMuon(nullptr, nullptr, pDeltaRayCluster, pMuonPfo, m_minDistanceFromMuon,
                     m_maxDistanceToCollected, deltaRayHits) != STATUS_CODE_SUCCESS)
                 continue;
 
             modifiedClusters.insert(pDeltaRayCluster);
 
             this->SplitMuonCluster(element, hitType, deltaRayHits);
         }
     }
 
     return !modifiedClusters.empty();
 }

bool lar_content::DeltaRayRemovalTool::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 35 of file DeltaRayRemovalTool.cc.

 {
     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->RemoveDeltaRayHits(elementList);
 
         changesMade = (changesMade ? changesMade : changesMadeInIteration);
     }
 
     return changesMade;
 }

void lar_content::DeltaRayRemovalTool::SplitMuonCluster	(	const TensorType::Element &	element,
		const pandora::HitType	hitType,
		const pandora::CaloHitList &	deltaRayHits
	)		const

private

Remove collected delta ray hits from the cosmic ray pfo.

Parameters

element	the tensor element
hitType	the hit type of the cluster under investigation
deltaRayHits	the list of delta ray hits to remove

Definition at line 178 of file DeltaRayRemovalTool.cc.

 {
     const Cluster *pDeltaRayCluster(element.GetCluster(hitType)), *pMuonCluster(nullptr);
 
     if (m_pParentAlgorithm->GetMuonCluster(element.GetOverlapResult().GetCommonMuonPfoList(), hitType, pMuonCluster) != STATUS_CODE_SUCCESS)
         throw StatusCodeException(STATUS_CODE_FAILURE);
 
     m_pParentAlgorithm->UpdateUponDeletion(pMuonCluster);
     m_pParentAlgorithm->UpdateUponDeletion(pDeltaRayCluster);
 
     m_pParentAlgorithm->SplitMuonCluster(m_pParentAlgorithm->GetClusterListName(hitType), pMuonCluster, deltaRayHits, pDeltaRayCluster);
 
     ClusterVector clusterVector;
     PfoVector pfoVector;
     clusterVector.push_back(pMuonCluster);
     pfoVector.push_back(element.GetOverlapResult().GetCommonMuonPfoList().front());
     clusterVector.push_back(pDeltaRayCluster);
     pfoVector.push_back(nullptr);
     m_pParentAlgorithm->UpdateForNewClusters(clusterVector, pfoVector);
 }

Member Data Documentation

float lar_content::DeltaRayRemovalTool::m_contaminationWindow

private

The distance in which to search for delta ray contamination in the cosmic ray track.

Definition at line 71 of file DeltaRayRemovalTool.h.

float lar_content::DeltaRayRemovalTool::m_maxDistanceToCollected

private

The maximim distance of a hit from the projected delta ray hits required for removal.

Definition at line 74 of file DeltaRayRemovalTool.h.

float lar_content::DeltaRayRemovalTool::m_minDeviationFromTransverse

private

The minimum deviation from transverse required to avoid mistakes.

Definition at line 70 of file DeltaRayRemovalTool.h.

float lar_content::DeltaRayRemovalTool::m_minDistanceFromMuon

private

The minimum distance of a hit from the cosmic ray track required for removal.

Definition at line 73 of file DeltaRayRemovalTool.h.

unsigned int lar_content::DeltaRayRemovalTool::m_significantHitThreshold

private

The threshold number of hits which define significant contimination.

Definition at line 72 of file DeltaRayRemovalTool.h.

unsigned int lar_content::DeltaRayRemovalTool::m_slidingFitWindow

private

The sliding fit window used in cosmic ray parameterisations.

Definition at line 69 of file DeltaRayRemovalTool.h.

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

larpandoracontent/larpandoracontent/LArThreeDReco/LArCosmicRay/DeltaRayRemovalTool.h
larpandoracontent/larpandoracontent/LArThreeDReco/LArCosmicRay/DeltaRayRemovalTool.cc

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation