#include "ThreeDKinkBaseTool.h"

Inheritance diagram for lar_content::ThreeDKinkBaseTool:

Classes
class	Modification
	Modification class. More...

Public Types
typedef ThreeDTransverseTracksAlgorithm::TensorType	TensorType

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

Public Member Functions
	ThreeDKinkBaseTool (const unsigned int nCommonClusters)
	Constructor. More...

virtual	~ThreeDKinkBaseTool ()
	Destructor. More...

bool	Run (ThreeDTransverseTracksAlgorithm *const pAlgorithm, TensorType &overlapTensor)
	Run the algorithm tool. More...

Protected Types
typedef std::vector< Modification >	ModificationList

Protected Member Functions
virtual bool	PassesElementCuts (TensorType::ElementList::const_iterator eIter, const pandora::ClusterSet &usedClusters) const
	Whether a provided (iterator to a) tensor element passes the selection cuts for overshoot identification. More...

virtual void	GetIteratorListModifications (ThreeDTransverseTracksAlgorithm *const pAlgorithm, const IteratorList &iteratorList, ModificationList &modificationList) const =0
	Get modification objects for a specific elements of the tensor, identifying required splits and merges for clusters. More...

float	GetXSamplingPoint (const pandora::CartesianVector &splitPosition1, const bool isForwardInX, const TwoDSlidingFitResult &fitResult1, const TwoDSlidingFitResult &fitResult2, const TwoDSlidingFitResult &fitResult3) const
	Get a sampling point in x that is common to sliding linear fit objects in three views. More...

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

Static Protected Member Functions
static bool	IsALowestInX (const LArPointingCluster &pointingClusterA, const LArPointingCluster &pointingClusterB)
	Whether pointing cluster labelled A extends to lowest x positions (as opposed to that labelled B) More...

Protected Attributes
unsigned int	m_nCommonClusters
	The number of common clusters. More...

bool	m_majorityRulesMode
	Whether to run in majority rules mode (always split overshoots, always merge undershoots) More...

float	m_minMatchedFraction
	The min matched sampling point fraction for use as a key tensor element. More...

unsigned int	m_minMatchedSamplingPoints
	The min number of matched sampling points for use as a key tensor element. More...

float	m_minLongitudinalImpactParameter
	The min longitudinal impact parameter for connecting accompanying clusters. More...

int	m_nLayersForKinkSearch
	The number of sliding fit layers to step in the kink search. More...

float	m_additionalXStepForKinkSearch
	An additional (safety) step to tack-on when choosing x sampling points. More...

Private Member Functions
void	GetModifications (ThreeDTransverseTracksAlgorithm *const pAlgorithm, const TensorType &overlapTensor, ModificationList &modificationList) const
	Get modification objects, identifying required splits and merges for clusters. More...

void	SelectTensorElements (TensorType::ElementList::const_iterator eIter, const TensorType::ElementList &elementList, const pandora::ClusterSet &usedClusters, IteratorList &iteratorList) const
	Select elements representing possible components of interest due to overshoots or undershoots in clustering. More...

bool	ApplyChanges (ThreeDTransverseTracksAlgorithm *const pAlgorithm, const ModificationList &modificationList) const
	Apply the changes cached in a modification list and update the tensor accordingly. More...

Detailed Description

ThreeDKinkBaseTool class.

Definition at line 21 of file ThreeDKinkBaseTool.h.

Member Typedef Documentation

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

inherited

Definition at line 128 of file ThreeDTransverseTracksAlgorithm.h.

typedef std::vector<Modification> lar_content::ThreeDKinkBaseTool::ModificationList

protected

Definition at line 50 of file ThreeDKinkBaseTool.h.

typedef ThreeDTransverseTracksAlgorithm::TensorType lar_content::TransverseTensorTool::TensorType

inherited

Definition at line 127 of file ThreeDTransverseTracksAlgorithm.h.

Constructor & Destructor Documentation

lar_content::ThreeDKinkBaseTool::ThreeDKinkBaseTool ( const unsigned int nCommonClusters )

Constructor.

Parameters

nCommonClusters the number of common clusters to select

Definition at line 22 of file ThreeDKinkBaseTool.cc.

References m_nCommonClusters.

                                                                          :
     m_nCommonClusters(nCommonClusters),
     m_majorityRulesMode(false),
     m_minMatchedFraction(0.75f),
     m_minMatchedSamplingPoints(10),
     m_minLongitudinalImpactParameter(-1.f),
     m_nLayersForKinkSearch(10),
     m_additionalXStepForKinkSearch(0.01f)
 {
     if (!((1 == m_nCommonClusters) || (2 == m_nCommonClusters)))
         throw StatusCodeException(STATUS_CODE_INVALID_PARAMETER);
 }

lar_content::ThreeDKinkBaseTool::~ThreeDKinkBaseTool ( )

virtual

Destructor.

Definition at line 37 of file ThreeDKinkBaseTool.cc.

38 {

39 }

Member Function Documentation

bool lar_content::ThreeDKinkBaseTool::ApplyChanges	(	ThreeDTransverseTracksAlgorithm *const	pAlgorithm,
		const ModificationList &	modificationList
	)		const

private

Apply the changes cached in a modification list and update the tensor accordingly.

Parameters

pAlgorithm	address of the calling algorithm
modificationList	the modification list

Returns: whether changes to the tensor have been made

Definition at line 187 of file ThreeDKinkBaseTool.cc.

References lar_content::ThreeDBaseAlgorithm< T >::MakeClusterMerges(), lar_content::ThreeDTracksBaseAlgorithm< T >::MakeClusterSplits(), and lar_content::LArClusterHelper::SortByNHits().

Referenced by Run().

 {
     ClusterMergeMap consolidatedMergeMap;
     SplitPositionMap consolidatedSplitMap;
 
     for (const Modification &modification : modificationList)
     {
         ClusterList parentClusters;
         for (const auto &mapEntry : modification.m_clusterMergeMap) parentClusters.push_back(mapEntry.first);
         parentClusters.sort(LArClusterHelper::SortByNHits);
 
         for (const Cluster *const pParentCluster : parentClusters)
         {
             const ClusterList &daughterClusters(modification.m_clusterMergeMap.at(pParentCluster));
 
             for (const Cluster *const pDaughterCluster : daughterClusters)
             {
                 if (consolidatedMergeMap.count(pDaughterCluster))
                     throw StatusCodeException(STATUS_CODE_FAILURE);
             }
 
             ClusterList &targetClusterList(consolidatedMergeMap[pParentCluster]);
             targetClusterList.insert(targetClusterList.end(), daughterClusters.begin(), daughterClusters.end());
         }
 
         ClusterList splitClusters;
         for (const auto &mapEntry : modification.m_splitPositionMap) splitClusters.push_back(mapEntry.first);
         splitClusters.sort(LArClusterHelper::SortByNHits);
 
         for (const Cluster *const pSplitCluster : splitClusters)
         {
             const CartesianPointVector &splitPositions(modification.m_splitPositionMap.at(pSplitCluster));
 
             CartesianPointVector &cartesianPointVector(consolidatedSplitMap[pSplitCluster]);
             cartesianPointVector.insert(cartesianPointVector.end(), splitPositions.begin(), splitPositions.end());
         }
     }
 
     bool changesMade(false);
     changesMade |= pAlgorithm->MakeClusterMerges(consolidatedMergeMap);
     changesMade |= pAlgorithm->MakeClusterSplits(consolidatedSplitMap);
 
     return changesMade;
 }

virtual void lar_content::ThreeDKinkBaseTool::GetIteratorListModifications	(	ThreeDTransverseTracksAlgorithm *const	pAlgorithm,
		const IteratorList &	iteratorList,
		ModificationList &	modificationList
	)		const

protectedpure virtual

Get modification objects for a specific elements of the tensor, identifying required splits and merges for clusters.

Parameters

pAlgorithm	address of the calling algorithm
iteratorList	list of iterators to relevant tensor elements
modificationList	to be populated with modifications

Implemented in lar_content::OvershootTracksTool, and lar_content::UndershootTracksTool.

Referenced by GetModifications().

void lar_content::ThreeDKinkBaseTool::GetModifications	(	ThreeDTransverseTracksAlgorithm *const	pAlgorithm,
		const TensorType &	overlapTensor,
		ModificationList &	modificationList
	)		const

private

Get modification objects, identifying required splits and merges for clusters.

Parameters

pAlgorithm	address of the calling algorithm
overlapTensor	the overlap tensor
modificationList	to be populated with modifications

Definition at line 140 of file ThreeDKinkBaseTool.cc.

References lar_content::OverlapTensor< T >::GetConnectedElements(), GetIteratorListModifications(), lar_content::OverlapTensor< T >::GetSortedKeyClusters(), PassesElementCuts(), and SelectTensorElements().

Referenced by Run().

 {
     ClusterSet usedClusters;
     ClusterVector sortedKeyClusters;
     overlapTensor.GetSortedKeyClusters(sortedKeyClusters);
 
     for (const Cluster *const pKeyCluster : sortedKeyClusters)
     {
         if (!pKeyCluster->IsAvailable())
             continue;
 
         unsigned int nU(0), nV(0), nW(0);
         TensorType::ElementList elementList;
         overlapTensor.GetConnectedElements(pKeyCluster, true, elementList, nU, nV, nW);
 
         if (nU * nV * nW < 2)
             continue;
 
         for (TensorType::ElementList::const_iterator eIter = elementList.begin(); eIter != elementList.end(); ++eIter)
         {
             if (!this->PassesElementCuts(eIter, usedClusters))
                 continue;
 
             IteratorList iteratorList;
             this->SelectTensorElements(eIter, elementList, usedClusters, iteratorList);
 
             if (iteratorList.size() < 2)
                 continue;
 
             ModificationList localModificationList;
             this->GetIteratorListModifications(pAlgorithm, iteratorList, localModificationList);
 
             if (localModificationList.empty())
                 continue;
 
             for (ModificationList::const_iterator mIter = localModificationList.begin(), mIterEnd = localModificationList.end(); mIter != mIterEnd; ++mIter)
             {
                 usedClusters.insert(mIter->m_affectedClusters.begin(), mIter->m_affectedClusters.end());
             }
 
             modificationList.insert(modificationList.end(), localModificationList.begin(), localModificationList.end());
         }
     }
 }

float lar_content::ThreeDKinkBaseTool::GetXSamplingPoint	(	const pandora::CartesianVector &	splitPosition1,
		const bool	isForwardInX,
		const TwoDSlidingFitResult &	fitResult1,
		const TwoDSlidingFitResult &	fitResult2,
		const TwoDSlidingFitResult &	fitResult3
	)		const

protected

Get a sampling point in x that is common to sliding linear fit objects in three views.

Parameters

splitPosition1	the split position in view 1
isForwardInX	whether to work forwards (or backwards) in x
fitResult1	the sliding fit result in view 1
fitResult2	the sliding fit result in view 2
fitResult3	the sliding fit result in view 3

Returns: the sampling point

Definition at line 59 of file ThreeDKinkBaseTool.cc.

References f, lar_content::TwoDSlidingFitResult::GetGlobalFitPosition(), lar_content::TwoDSlidingFitResult::GetL(), lar_content::TwoDSlidingFitResult::GetLayer(), lar_content::TwoDSlidingFitResult::GetLocalPosition(), lar_content::TwoDSlidingFitResult::GetMaxLayer(), lar_content::TwoDSlidingFitResult::GetMinAndMaxX(), lar_content::TwoDSlidingFitResult::GetMinLayer(), m_additionalXStepForKinkSearch, m_nLayersForKinkSearch, max, and min.

Referenced by lar_content::UndershootTracksTool::IsThreeDKink(), and lar_content::OvershootTracksTool::IsThreeDKink().

 {
     // Nearest common x position
     float xMin1(std::numeric_limits<float>::max()), xMax1(-std::numeric_limits<float>::max());
     float xMin2(std::numeric_limits<float>::max()), xMax2(-std::numeric_limits<float>::max());
     float xMin3(std::numeric_limits<float>::max()), xMax3(-std::numeric_limits<float>::max());
     fitResult1.GetMinAndMaxX(xMin1, xMax1);
     fitResult2.GetMinAndMaxX(xMin2, xMax2);
     fitResult3.GetMinAndMaxX(xMin3, xMax3);
 
     const float commonX(isForwardInX ? std::max(xMin1, std::max(xMin2, xMin3)) : std::min(xMax1, std::min(xMax2, xMax3)));
 
     if (isForwardInX && ((commonX > xMax1) || (commonX > xMax2) || (commonX > xMax3)))
         throw StatusCodeException(STATUS_CODE_NOT_FOUND);
 
     if (!isForwardInX && ((commonX < xMin1) || (commonX < xMin2) || (commonX < xMin3)))
         throw StatusCodeException(STATUS_CODE_NOT_FOUND);
 
     // Layer step x position
     float rL1(0.f), rT1(0.f);
     fitResult1.GetLocalPosition(splitPosition1, rL1, rT1);
     const int splitLayer(fitResult1.GetLayer(rL1));
 
     const int lowLayer(std::max(fitResult1.GetMinLayer(), std::min(fitResult1.GetMaxLayer(), splitLayer - m_nLayersForKinkSearch)));
     const int highLayer(std::max(fitResult1.GetMinLayer(), std::min(fitResult1.GetMaxLayer(), splitLayer + m_nLayersForKinkSearch)));
 
     CartesianVector minus(0.f, 0.f, 0.f), plus(0.f, 0.f, 0.f);
     PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, fitResult1.GetGlobalFitPosition(fitResult1.GetL(lowLayer), minus));
     PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, fitResult1.GetGlobalFitPosition(fitResult1.GetL(highLayer), plus));
 
     if (minus.GetX() > plus.GetX()) 
     {
         CartesianVector temporary(minus);
         minus = plus;
         plus = temporary;
     }
 
     const float layerStepX(isForwardInX ? plus.GetX() : minus.GetX());
 
     // Final x position selection
     const float chosenX(isForwardInX ? std::max(layerStepX, commonX) : std::min(layerStepX, commonX));
     const float finalX(isForwardInX ? chosenX + m_additionalXStepForKinkSearch : chosenX - m_additionalXStepForKinkSearch);
     return finalX;
 }

bool lar_content::ThreeDKinkBaseTool::IsALowestInX	(	const LArPointingCluster &	pointingClusterA,
		const LArPointingCluster &	pointingClusterB
	)

staticprotected

Whether pointing cluster labelled A extends to lowest x positions (as opposed to that labelled B)

Parameters

pointingClusterA	pointing cluster A
pointingClusterB	pointing cluster B

Definition at line 107 of file ThreeDKinkBaseTool.cc.

References lar_content::LArPointingCluster::GetInnerVertex(), lar_content::LArPointingCluster::GetOuterVertex(), and lar_content::LArPointingCluster::Vertex::GetPosition().

Referenced by lar_content::UndershootTracksTool::GetIteratorListModifications(), and lar_content::OvershootTracksTool::GetIteratorListModifications().

 {
     if ((pointingClusterA.GetInnerVertex().GetPosition().GetX() < pointingClusterB.GetInnerVertex().GetPosition().GetX()) &&
         (pointingClusterA.GetInnerVertex().GetPosition().GetX() < pointingClusterB.GetOuterVertex().GetPosition().GetX()) )
     {
         return true;
     }
 
     if ((pointingClusterA.GetOuterVertex().GetPosition().GetX() < pointingClusterB.GetInnerVertex().GetPosition().GetX()) &&
         (pointingClusterA.GetOuterVertex().GetPosition().GetX() < pointingClusterB.GetOuterVertex().GetPosition().GetX()) )
     {
         return true;
     }
 
     return false;
 }

bool lar_content::ThreeDKinkBaseTool::PassesElementCuts	(	TensorType::ElementList::const_iterator	eIter,
		const pandora::ClusterSet &	usedClusters
	)		const

protectedvirtual

Whether a provided (iterator to a) tensor element passes the selection cuts for overshoot identification.

Parameters

eIter	the iterator to the tensor element
usedClusters	the list of used clusters

Definition at line 43 of file ThreeDKinkBaseTool.cc.

References m_minMatchedFraction, and m_minMatchedSamplingPoints.

Referenced by GetModifications(), and SelectTensorElements().

 {
     if (usedClusters.count(eIter->GetClusterU()) || usedClusters.count(eIter->GetClusterV()) || usedClusters.count(eIter->GetClusterW()))
         return false;
 
     if (eIter->GetOverlapResult().GetMatchedFraction() < m_minMatchedFraction)
         return false;
 
     if (eIter->GetOverlapResult().GetNMatchedSamplingPoints() < m_minMatchedSamplingPoints)
         return false;
 
     return true;
 }

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

protected

Definition at line 274 of file ThreeDKinkBaseTool.cc.

References m_additionalXStepForKinkSearch, m_majorityRulesMode, m_minLongitudinalImpactParameter, m_minMatchedFraction, m_minMatchedSamplingPoints, and m_nLayersForKinkSearch.

Referenced by lar_content::UndershootTracksTool::ReadSettings(), and lar_content::OvershootTracksTool::ReadSettings().

 {
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "MajorityRulesMode", m_majorityRulesMode));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "MinMatchedFraction", m_minMatchedFraction));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "MinMatchedSamplingPoints", m_minMatchedSamplingPoints));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "MinLongitudinalImpactParameter", m_minLongitudinalImpactParameter));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "NLayersForKinkSearch", m_nLayersForKinkSearch));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "AdditionalXStepForKinkSearch", m_additionalXStepForKinkSearch));
 
     return STATUS_CODE_SUCCESS;
 }

bool lar_content::ThreeDKinkBaseTool::Run	(	ThreeDTransverseTracksAlgorithm *const	pAlgorithm,
		TensorType &	overlapTensor
	)

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

Definition at line 126 of file ThreeDKinkBaseTool.cc.

References ApplyChanges(), and GetModifications().

 {
     if (PandoraContentApi::GetSettings(*pAlgorithm)->ShouldDisplayAlgorithmInfo())
        std::cout << "----> Running Algorithm Tool: " << this->GetInstanceName() << ", " << this->GetType() << std::endl;
 
     ModificationList modificationList;
     this->GetModifications(pAlgorithm, overlapTensor, modificationList);
     const bool changesMade(this->ApplyChanges(pAlgorithm, modificationList));
 
     return changesMade;
 }

void lar_content::ThreeDKinkBaseTool::SelectTensorElements	(	TensorType::ElementList::const_iterator	eIter,
		const TensorType::ElementList &	elementList,
		const pandora::ClusterSet &	usedClusters,
		IteratorList &	iteratorList
	)		const

private

Select elements representing possible components of interest due to overshoots or undershoots in clustering.

Parameters

eIter	iterator to a candidate element
elementList	the provided element list
usedClusters	the list of used clusters
iteratorList	to receive a list of iterators to relevant elements

Definition at line 234 of file ThreeDKinkBaseTool.cc.

References m_nCommonClusters, and PassesElementCuts().

Referenced by GetModifications().

 {
     iteratorList.push_back(eIter);
 
     for (TensorType::ElementList::const_iterator eIter2 = elementList.begin(); eIter2 != elementList.end(); ++eIter2)
     {
         if (eIter == eIter2)
             continue;
 
         if (!this->PassesElementCuts(eIter2, usedClusters))
             continue;
 
         for (IteratorList::const_iterator iIter = iteratorList.begin(); iIter != iteratorList.end(); ++iIter)
         {
             if ((*iIter) == eIter2)
                 continue;
 
             unsigned int nMatchedClusters(0);
 
             if ((*iIter)->GetClusterU() == eIter2->GetClusterU())
                 ++nMatchedClusters;
 
             if ((*iIter)->GetClusterV() == eIter2->GetClusterV())
                 ++nMatchedClusters;
 
             if ((*iIter)->GetClusterW() == eIter2->GetClusterW())
                 ++nMatchedClusters;
 
             if (m_nCommonClusters == nMatchedClusters)
             {
                 iteratorList.push_back(eIter2);
                 return;
             }
         }
     }
 }

Member Data Documentation

float lar_content::ThreeDKinkBaseTool::m_additionalXStepForKinkSearch

protected

An additional (safety) step to tack-on when choosing x sampling points.

Definition at line 100 of file ThreeDKinkBaseTool.h.

Referenced by GetXSamplingPoint(), and ReadSettings().

bool lar_content::ThreeDKinkBaseTool::m_majorityRulesMode

protected

Whether to run in majority rules mode (always split overshoots, always merge undershoots)

Definition at line 95 of file ThreeDKinkBaseTool.h.

Referenced by lar_content::UndershootTracksTool::GetIteratorListModifications(), lar_content::OvershootTracksTool::GetIteratorListModifications(), and ReadSettings().

float lar_content::ThreeDKinkBaseTool::m_minLongitudinalImpactParameter

protected

The min longitudinal impact parameter for connecting accompanying clusters.

Definition at line 98 of file ThreeDKinkBaseTool.h.

Referenced by lar_content::UndershootTracksTool::GetIteratorListModifications(), lar_content::OvershootTracksTool::PassesVertexCuts(), and ReadSettings().

float lar_content::ThreeDKinkBaseTool::m_minMatchedFraction

protected

The min matched sampling point fraction for use as a key tensor element.

Definition at line 96 of file ThreeDKinkBaseTool.h.

Referenced by PassesElementCuts(), and ReadSettings().

unsigned int lar_content::ThreeDKinkBaseTool::m_minMatchedSamplingPoints

protected

The min number of matched sampling points for use as a key tensor element.

Definition at line 97 of file ThreeDKinkBaseTool.h.

Referenced by PassesElementCuts(), and ReadSettings().

unsigned int lar_content::ThreeDKinkBaseTool::m_nCommonClusters

protected

The number of common clusters.

Definition at line 94 of file ThreeDKinkBaseTool.h.

Referenced by SelectTensorElements(), and ThreeDKinkBaseTool().

int lar_content::ThreeDKinkBaseTool::m_nLayersForKinkSearch

protected

The number of sliding fit layers to step in the kink search.

Definition at line 99 of file ThreeDKinkBaseTool.h.

Referenced by GetXSamplingPoint(), and ReadSettings().

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

/cvmfs/larsoft.opensciencegrid.org/products/larpandoracontent/v03_14_03/source/larpandoracontent/LArThreeDReco/LArTransverseTrackMatching/ThreeDKinkBaseTool.h
/cvmfs/larsoft.opensciencegrid.org/products/larpandoracontent/v03_14_03/source/larpandoracontent/LArThreeDReco/LArTransverseTrackMatching/ThreeDKinkBaseTool.cc

Classes

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation