ThreeViewShowersAlgorithm class. More...

#include "ThreeViewShowersAlgorithm.h"

Inheritance diagram for lar_content::ThreeViewShowersAlgorithm:

Classes
class	XSampling
	XSampling class. More...

Public Types
typedef NViewMatchingAlgorithm< ThreeViewMatchingControl< ShowerOverlapResult > >	BaseAlgorithm

typedef ThreeViewMatchingControl< ShowerOverlapResult >	MatchingType

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

const TwoDSlidingShowerFitResult &	GetCachedSlidingFitResult (const pandora::Cluster *const pCluster) const
	Get a sliding shower fit result from the algorithm cache. More...

void	UpdateForNewCluster (const pandora::Cluster *const pNewCluster)
	Update to reflect addition of a new cluster to the problem space. More...

void	UpdateUponDeletion (const pandora::Cluster *const pDeletedCluster)
	Update to reflect cluster deletion. More...

void	SelectInputClusters (const pandora::ClusterList *const pInputClusterList, pandora::ClusterList &selectedClusterList) const
	Select a subset of input clusters for processing in this algorithm. More...

void	PrepareInputClusters (pandora::ClusterList &preparedClusterList)
	Perform any preparatory steps required on the input clusters, e.g. caching expensive fit results. More...

const std::string &	GetClusterListName (const pandora::HitType hitType) const
	Get the cluster list name corresponding to a specified hit type. More...

const pandora::ClusterList &	GetInputClusterList (const pandora::HitType hitType) const
	Get the input cluster list corresponding to a specified hit type. More...

const pandora::ClusterList &	GetSelectedClusterList (const pandora::HitType hitType) const
	Get the selected cluster list corresponding to a specified hit type. More...

virtual bool	MakeClusterMerges (const ClusterMergeMap &clusterMergeMap)
	Merge clusters together. More...

virtual bool	CreateThreeDParticles (const ProtoParticleVector &protoParticleVector)
	Create particles using findings from recent algorithm processing. More...

virtual void	SetPfoParameters (const ProtoParticle &protoParticle, PandoraContentApi::ParticleFlowObject::Parameters &pfoParameters) const
	Set Pfo properties. More...

virtual void	SetPfoParticleId (PandoraContentApi::ParticleFlowObject::Parameters &pfoParameters) const
	Set pfo particle id. More...

Protected Member Functions
MatchingType &	GetMatchingControl ()
	Get the matching control. More...

virtual void	SelectAllInputClusters ()
	Select a subset of input clusters for processing in this algorithm. More...

virtual void	PrepareAllInputClusters ()
	Perform any preparatory steps required, e.g. caching expensive fit results for clusters. More...

virtual void	PerformMainLoop ()
	Main loop over cluster combinations in order to populate the overlap container. Responsible for calling CalculateOverlapResult. More...

Protected Attributes
MatchingType	m_matchingControl
	The matching control. More...

Private Types
typedef std::pair< ShowerPositionMap, ShowerPositionMap >	ShowerPositionMapPair

typedef std::vector< ShowerTensorTool * >	TensorToolVector

Private Member Functions
void	TidyUp ()
	Tidy member variables in derived class. More...

void	AddToSlidingFitCache (const pandora::Cluster *const pCluster)
	Add a new sliding fit result, for the specified cluster, to the algorithm cache. More...

void	RemoveFromSlidingFitCache (const pandora::Cluster *const pCluster)
	Remova an existing sliding fit result, for the specified cluster, from the algorithm cache. More...

void	CalculateOverlapResult (const pandora::Cluster const pClusterU, const pandora::Cluster const pClusterV, const pandora::Cluster *const pClusterW)
	Calculate cluster overlap result and store in container. More...

pandora::StatusCode	CalculateOverlapResult (const pandora::Cluster const pClusterU, const pandora::Cluster const pClusterV, const pandora::Cluster *const pClusterW, ShowerOverlapResult &overlapResult)
	Calculate the overlap result for given group of clusters. More...

void	GetShowerPositionMaps (const TwoDSlidingShowerFitResult &fitResultU, const TwoDSlidingShowerFitResult &fitResultV, const TwoDSlidingShowerFitResult &fitResultW, const XSampling &xSampling, ShowerPositionMapPair &positionMapsU, ShowerPositionMapPair &positionMapsV, ShowerPositionMapPair &positionMapsW) const
	Get the shower position maps. More...

void	GetBestHitOverlapFraction (const pandora::Cluster *const pCluster, const XSampling &xSampling, const ShowerPositionMapPair &positionMaps, unsigned int &nSampledHits, unsigned int &nMatchedHits) const
	Get the best fraction of hits, in the common x-overlap range, contained within the provided pair of shower boundaries. More...

void	ExamineOverlapContainer ()
	Examine contents of overlap container, collect together best-matching 2D particles and modify clusters as required. More...

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

Private Attributes
TensorToolVector	m_algorithmToolVector
	The algorithm tool vector. More...

unsigned int	m_nMaxTensorToolRepeats
	The maximum number of repeat loops over tensor tools. More...

unsigned int	m_slidingFitWindow
	The layer window for the sliding linear fits. More...

TwoDSlidingShowerFitResultMap	m_slidingFitResultMap
	The sliding shower fit result map. More...

bool	m_ignoreUnavailableClusters
	Whether to ignore (skip-over) unavailable clusters. More...

unsigned int	m_minClusterCaloHits
	The min number of hits in base cluster selection method. More...

float	m_minClusterLengthSquared
	The min length (squared) in base cluster selection method. More...

float	m_minShowerMatchedFraction
	The minimum shower matched sampling fraction to allow shower grouping. More...

unsigned int	m_minShowerMatchedPoints
	The minimum number of matched shower sampling points to allow shower grouping. More...

bool	m_visualize
	Visualize cluster matching procedure. More...

Detailed Description

ThreeViewShowersAlgorithm class.

Definition at line 29 of file ThreeViewShowersAlgorithm.h.

Member Typedef Documentation

typedef NViewMatchingAlgorithm<ThreeViewMatchingControl<ShowerOverlapResult> > lar_content::ThreeViewShowersAlgorithm::BaseAlgorithm

Definition at line 32 of file ThreeViewShowersAlgorithm.h.

typedef ThreeViewMatchingControl< ShowerOverlapResult > lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< ShowerOverlapResult > >::MatchingType

inherited

Definition at line 23 of file NViewMatchingAlgorithm.h.

typedef std::pair<ShowerPositionMap, ShowerPositionMap> lar_content::ThreeViewShowersAlgorithm::ShowerPositionMapPair

private

Definition at line 118 of file ThreeViewShowersAlgorithm.h.

typedef std::vector<ShowerTensorTool *> lar_content::ThreeViewShowersAlgorithm::TensorToolVector

private

Definition at line 150 of file ThreeViewShowersAlgorithm.h.

Constructor & Destructor Documentation

lar_content::ThreeViewShowersAlgorithm::ThreeViewShowersAlgorithm ( )

Default constructor.

Definition at line 21 of file ThreeViewShowersAlgorithm.cc.

                                                      :
     m_nMaxTensorToolRepeats(1000),
     m_slidingFitWindow(20),
     m_ignoreUnavailableClusters(true),
     m_minClusterCaloHits(5),
     m_minClusterLengthSquared(3.f * 3.f),
     m_minShowerMatchedFraction(0.2f),
     m_minShowerMatchedPoints(20),
     m_visualize(false)
 {
 }

Member Function Documentation

void lar_content::ThreeViewShowersAlgorithm::AddToSlidingFitCache ( const pandora::Cluster *const pCluster )

private

Add a new sliding fit result, for the specified cluster, to the algorithm cache.

Parameters

pCluster address of the relevant cluster

Definition at line 136 of file ThreeViewShowersAlgorithm.cc.

References lar_content::LArClusterHelper::GetClusterHitType(), lar_content::LArGeometryHelper::GetWirePitch(), m_slidingFitResultMap, and m_slidingFitWindow.

Referenced by PrepareInputClusters(), and UpdateForNewCluster().

 {
     const float slidingFitPitch(LArGeometryHelper::GetWirePitch(this->GetPandora(), LArClusterHelper::GetClusterHitType(pCluster)));
     const TwoDSlidingShowerFitResult slidingShowerFitResult(pCluster, m_slidingFitWindow, slidingFitPitch);
 
     if (!m_slidingFitResultMap.insert(TwoDSlidingShowerFitResultMap::value_type(pCluster, slidingShowerFitResult)).second)
         throw StatusCodeException(STATUS_CODE_FAILURE);
 }

void lar_content::ThreeViewShowersAlgorithm::CalculateOverlapResult	(	const pandora::Cluster *const	pCluster1,
		const pandora::Cluster *const	pCluster2,
		const pandora::Cluster *const	pCluster3
	)

privatevirtual

Calculate cluster overlap result and store in container.

Parameters

pCluster1	address of cluster1
pCluster2	address of cluster2
pCluster3	address of cluster3

Implements lar_content::MatchingBaseAlgorithm.

Referenced by RemoveFromSlidingFitCache().

pandora::StatusCode lar_content::ThreeViewShowersAlgorithm::CalculateOverlapResult	(	const pandora::Cluster *const	pClusterU,
		const pandora::Cluster *const	pClusterV,
		const pandora::Cluster *const	pClusterW,
		ShowerOverlapResult &	overlapResult
	)

private

Calculate the overlap result for given group of clusters.

Parameters

pClusterU	the cluster from the U view
pClusterV	the cluster from the V view
pClusterW	the cluster from the W view
overlapResult	to receive the overlap result

bool lar_content::MatchingBaseAlgorithm::CreateThreeDParticles ( const ProtoParticleVector & protoParticleVector )

virtualinherited

Create particles using findings from recent algorithm processing.

Parameters

protoParticleVector	the proto particle vector
whether	particles were created

Definition at line 88 of file MatchingBaseAlgorithm.cc.

 {
     bool particlesMade(false);
     const PfoList *pPfoList(nullptr);
     std::string pfoListName;
     PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::CreateTemporaryListAndSetCurrent(*this, pPfoList, pfoListName));
 
     for (const ProtoParticle &protoParticle : protoParticleVector)
     {
         PandoraContentApi::ParticleFlowObject::Parameters pfoParameters;
         this->SetPfoParameters(protoParticle, pfoParameters);
 
         const ParticleFlowObject *pPfo(nullptr);
         PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::ParticleFlowObject::Create(*this, pfoParameters, pPfo));
         particlesMade = true;
     }
 
     if (!pPfoList->empty())
     {
         PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::SaveList<Pfo>(*this, m_outputPfoListName));
         PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::ReplaceCurrentList<Pfo>(*this, m_outputPfoListName));
     }
 
     return particlesMade;
 }

void lar_content::ThreeViewShowersAlgorithm::ExamineOverlapContainer ( )

privatevirtual

Examine contents of overlap container, collect together best-matching 2D particles and modify clusters as required.

Implements lar_content::MatchingBaseAlgorithm.

Definition at line 323 of file ThreeViewShowersAlgorithm.cc.

References m_algorithmToolVector, and m_nMaxTensorToolRepeats.

 {
     unsigned int repeatCounter(0);
 
     for (TensorToolVector::const_iterator iter = m_algorithmToolVector.begin(), iterEnd = m_algorithmToolVector.end(); iter != iterEnd;)
     {
         if ((*iter)->Run(this, this->GetMatchingControl().GetOverlapTensor()))
         {
             iter = m_algorithmToolVector.begin();
 
             if (++repeatCounter > m_nMaxTensorToolRepeats)
                 break;
         }
         else
         {
             ++iter;
         }
     }
 }

void lar_content::ThreeViewShowersAlgorithm::GetBestHitOverlapFraction	(	const pandora::Cluster *const	pCluster,
		const XSampling &	xSampling,
		const ShowerPositionMapPair &	positionMaps,
		unsigned int &	nSampledHits,
		unsigned int &	nMatchedHits
	)		const

private

Get the best fraction of hits, in the common x-overlap range, contained within the provided pair of shower boundaries.

Parameters

pCluster	the address of the candidate cluster
xSampling	the x sampling details
positionMaps	the shower edge position maps
nSampledHits	to receive the number of hits in the common x-overlap range
nMatchedHits	to receive the number of sampled hits contained within the shower edges

Definition at line 282 of file ThreeViewShowersAlgorithm.cc.

References lar_content::ThreeViewShowersAlgorithm::XSampling::GetBin(), lar_content::ThreeViewShowersAlgorithm::XSampling::m_maxX, lar_content::ThreeViewShowersAlgorithm::XSampling::m_minX, x, and z.

Referenced by RemoveFromSlidingFitCache().

 {
     if ((xSampling.m_maxX - xSampling.m_minX) < std::numeric_limits<float>::epsilon())
         throw StatusCodeException(STATUS_CODE_INVALID_PARAMETER);
 
     nSampledHits = 0;
     nMatchedHits = 0;
     unsigned int nMatchedHits1(0), nMatchedHits2(0);
     const OrderedCaloHitList &orderedCaloHitList(pCluster->GetOrderedCaloHitList());
 
     for (OrderedCaloHitList::const_iterator iter = orderedCaloHitList.begin(), iterEnd = orderedCaloHitList.end(); iter != iterEnd; ++iter)
     {
         for (CaloHitList::const_iterator hIter = iter->second->begin(), hIterEnd = iter->second->end(); hIter != hIterEnd; ++hIter)
         {
             const CaloHit *const pCaloHit = *hIter;
             const float x(pCaloHit->GetPositionVector().GetX());
             const float z(pCaloHit->GetPositionVector().GetZ());
 
             int xBin(-1);
             if (STATUS_CODE_SUCCESS != xSampling.GetBin(x, xBin))
                 continue;
 
             ++nSampledHits;
 
             ShowerPositionMap::const_iterator positionIter1 = positionMaps.first.find(xBin);
             ShowerPositionMap::const_iterator positionIter2 = positionMaps.second.find(xBin);
 
             if ((positionMaps.first.end() != positionIter1) && (z > positionIter1->second.GetLowEdgeZ()) && (z < positionIter1->second.GetHighEdgeZ()))
                 ++nMatchedHits1;
 
             if ((positionMaps.second.end() != positionIter2) && (z > positionIter2->second.GetLowEdgeZ()) && (z < positionIter2->second.GetHighEdgeZ()))
                 ++nMatchedHits2;
         }
     }
 
     nMatchedHits = std::max(nMatchedHits1, nMatchedHits2);
 }

const TwoDSlidingShowerFitResult & lar_content::ThreeViewShowersAlgorithm::GetCachedSlidingFitResult ( const pandora::Cluster *const pCluster ) const

Get a sliding shower fit result from the algorithm cache.

Parameters

pCluster address of the relevant cluster

Definition at line 35 of file ThreeViewShowersAlgorithm.cc.

References m_slidingFitResultMap.

Referenced by lar_content::SplitShowersTool::CheckClusterVertexRelations(), lar_content::SplitShowersTool::GetSplitXDetails(), RemoveFromSlidingFitCache(), and lar_content::SplitShowersTool::SpecifyClusterMerges().

 {
     TwoDSlidingShowerFitResultMap::const_iterator iter = m_slidingFitResultMap.find(pCluster);
 
     if (m_slidingFitResultMap.end() == iter)
         throw StatusCodeException(STATUS_CODE_NOT_FOUND);
 
     return iter->second;
 }

const std::string& lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< ShowerOverlapResult > >::GetClusterListName ( const pandora::HitType hitType ) const

virtualinherited

Get the cluster list name corresponding to a specified hit type.

Parameters

hitType the hit type

Returns: the cluster list name

Implements lar_content::MatchingBaseAlgorithm.

const pandora::ClusterList& lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< ShowerOverlapResult > >::GetInputClusterList ( const pandora::HitType hitType ) const

virtualinherited

Get the input cluster list corresponding to a specified hit type.

Parameters

hitType the hit type

Returns: the input cluster list

Implements lar_content::MatchingBaseAlgorithm.

MatchingType& lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< ShowerOverlapResult > >::GetMatchingControl ( )

protectedinherited

Get the matching control.

Referenced by RemoveFromSlidingFitCache().

const pandora::ClusterList& lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< ShowerOverlapResult > >::GetSelectedClusterList ( const pandora::HitType hitType ) const

virtualinherited

Get the selected cluster list corresponding to a specified hit type.

Parameters

hitType the hit type

Returns: the selected cluster list

Implements lar_content::MatchingBaseAlgorithm.

void lar_content::ThreeViewShowersAlgorithm::GetShowerPositionMaps	(	const TwoDSlidingShowerFitResult &	fitResultU,
		const TwoDSlidingShowerFitResult &	fitResultV,
		const TwoDSlidingShowerFitResult &	fitResultW,
		const XSampling &	xSampling,
		ShowerPositionMapPair &	positionMapsU,
		ShowerPositionMapPair &	positionMapsV,
		ShowerPositionMapPair &	positionMapsW
	)		const

private

Get the shower position maps.

Parameters

fitResultU	the sliding shower fit result for the u view
fitResultV	the sliding shower fit result for the v view
fitResultW	the sliding shower fit result for the w view
xSampling	the x sampling details
positionMapsU	to receive the shower position maps for the u view
positionMapsV	to receive the shower position maps for the v view
positionMapsW	to receive the shower position maps for the w view

Definition at line 219 of file ThreeViewShowersAlgorithm.cc.

References lar_content::ThreeViewShowersAlgorithm::XSampling::GetBin(), lar_content::TwoDSlidingShowerFitResult::GetShowerEdges(), lar_content::ThreeViewShowersAlgorithm::XSampling::m_maxX, lar_content::ThreeViewShowersAlgorithm::XSampling::m_minX, lar_content::ThreeViewShowersAlgorithm::XSampling::m_nPoints, lar_content::LArGeometryHelper::MergeTwoPositions(), n, and x.

Referenced by RemoveFromSlidingFitCache().

 {
     const unsigned int nPoints(static_cast<unsigned int>(xSampling.m_nPoints));
 
     for (unsigned n = 0; n <= nPoints; ++n)
     {
         const float x(xSampling.m_minX + (xSampling.m_maxX - xSampling.m_minX) * static_cast<float>(n) / static_cast<float>(nPoints));
 
         int xBin(-1);
         if (STATUS_CODE_SUCCESS != xSampling.GetBin(x, xBin))
             continue;
 
         FloatVector uValues, vValues, wValues;
         fitResultU.GetShowerEdges(x, true, uValues);
         fitResultV.GetShowerEdges(x, true, vValues);
         fitResultW.GetShowerEdges(x, true, wValues);
 
         std::sort(uValues.begin(), uValues.end());
         std::sort(vValues.begin(), vValues.end());
         std::sort(wValues.begin(), wValues.end());
 
         if ((uValues.size() > 1) && (vValues.size() > 1))
         {
             const float uMin(uValues.front()), uMax(uValues.back());
             const float vMin(vValues.front()), vMax(vValues.back());
             const float uv2wMinMin(LArGeometryHelper::MergeTwoPositions(this->GetPandora(), TPC_VIEW_U, TPC_VIEW_V, uMin, vMin));
             const float uv2wMaxMax(LArGeometryHelper::MergeTwoPositions(this->GetPandora(), TPC_VIEW_U, TPC_VIEW_V, uMax, vMax));
             const float uv2wMinMax(LArGeometryHelper::MergeTwoPositions(this->GetPandora(), TPC_VIEW_U, TPC_VIEW_V, uMin, vMax));
             const float uv2wMaxMin(LArGeometryHelper::MergeTwoPositions(this->GetPandora(), TPC_VIEW_U, TPC_VIEW_V, uMax, vMin));
             positionMapsW.first.insert(ShowerPositionMap::value_type(xBin, ShowerExtent(x, uv2wMinMin, uv2wMaxMax)));
             positionMapsW.second.insert(ShowerPositionMap::value_type(xBin, ShowerExtent(x, uv2wMinMax, uv2wMaxMin)));
         }
 
         if ((uValues.size() > 1) && (wValues.size() > 1))
         {
             const float uMin(uValues.front()), uMax(uValues.back());
             const float wMin(wValues.front()), wMax(wValues.back());
             const float uw2vMinMin(LArGeometryHelper::MergeTwoPositions(this->GetPandora(), TPC_VIEW_U, TPC_VIEW_W, uMin, wMin));
             const float uw2vMaxMax(LArGeometryHelper::MergeTwoPositions(this->GetPandora(), TPC_VIEW_U, TPC_VIEW_W, uMax, wMax));
             const float uw2vMinMax(LArGeometryHelper::MergeTwoPositions(this->GetPandora(), TPC_VIEW_U, TPC_VIEW_W, uMin, wMax));
             const float uw2vMaxMin(LArGeometryHelper::MergeTwoPositions(this->GetPandora(), TPC_VIEW_U, TPC_VIEW_W, uMax, wMin));
             positionMapsV.first.insert(ShowerPositionMap::value_type(xBin, ShowerExtent(x, uw2vMinMin, uw2vMaxMax)));
             positionMapsV.second.insert(ShowerPositionMap::value_type(xBin, ShowerExtent(x, uw2vMinMax, uw2vMaxMin)));
         }
 
         if ((vValues.size() > 1) && (wValues.size() > 1))
         {
             const float vMin(vValues.front()), vMax(vValues.back());
             const float wMin(wValues.front()), wMax(wValues.back());
             const float vw2uMinMin(LArGeometryHelper::MergeTwoPositions(this->GetPandora(), TPC_VIEW_V, TPC_VIEW_W, vMin, wMin));
             const float vw2uMaxMax(LArGeometryHelper::MergeTwoPositions(this->GetPandora(), TPC_VIEW_V, TPC_VIEW_W, vMax, wMax));
             const float vw2uMinMax(LArGeometryHelper::MergeTwoPositions(this->GetPandora(), TPC_VIEW_V, TPC_VIEW_W, vMin, wMax));
             const float vw2uMaxMin(LArGeometryHelper::MergeTwoPositions(this->GetPandora(), TPC_VIEW_V, TPC_VIEW_W, vMax, wMin));
             positionMapsU.first.insert(ShowerPositionMap::value_type(xBin, ShowerExtent(x, vw2uMinMin, vw2uMaxMax)));
             positionMapsU.second.insert(ShowerPositionMap::value_type(xBin, ShowerExtent(x, vw2uMinMax, vw2uMaxMin)));
         }
     }
 }

bool lar_content::MatchingBaseAlgorithm::MakeClusterMerges ( const ClusterMergeMap & clusterMergeMap )

virtualinherited

Merge clusters together.

Parameters

clusterMergeMap the cluster merge map

Returns: whether changes to the overlap container have been made

Definition at line 48 of file MatchingBaseAlgorithm.cc.

Referenced by lar_content::SplitShowersTool::ApplyChanges(), lar_content::ThreeDKinkBaseTool::ApplyChanges(), lar_content::TwoViewThreeDKinkTool::ApplyChanges(), lar_content::ConnectedRemnantsTool::Run(), and lar_content::MissingTrackSegmentTool::Run().

 {
     ClusterSet deletedClusters;
 
     ClusterList parentClusters;
     for (const auto &mapEntry : clusterMergeMap)
         parentClusters.push_back(mapEntry.first);
     parentClusters.sort(LArClusterHelper::SortByNHits);
 
     for (const Cluster *const pParentCluster : parentClusters)
     {
         const HitType hitType(LArClusterHelper::GetClusterHitType(pParentCluster));
         const std::string &clusterListName(this->GetClusterListName(hitType));
 
         if (!((TPC_VIEW_U == hitType) || (TPC_VIEW_V == hitType) || (TPC_VIEW_W == hitType)))
             throw StatusCodeException(STATUS_CODE_FAILURE);
 
         ClusterList daughterClusters(clusterMergeMap.at(pParentCluster));
         daughterClusters.sort(LArClusterHelper::SortByNHits);
 
         for (const Cluster *const pDaughterCluster : daughterClusters)
         {
             if (deletedClusters.count(pParentCluster) || deletedClusters.count(pDaughterCluster))
                 throw StatusCodeException(STATUS_CODE_FAILURE);
 
             this->UpdateUponDeletion(pDaughterCluster);
             this->UpdateUponDeletion(pParentCluster);
             PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=,
                 PandoraContentApi::MergeAndDeleteClusters(*this, pParentCluster, pDaughterCluster, clusterListName, clusterListName));
 
             this->UpdateForNewCluster(pParentCluster);
             deletedClusters.insert(pDaughterCluster);
         }
     }
 
     return !(deletedClusters.empty());
 }

virtual void lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< ShowerOverlapResult > >::PerformMainLoop ( )

protectedvirtualinherited

Main loop over cluster combinations in order to populate the overlap container. Responsible for calling CalculateOverlapResult.

Implements lar_content::MatchingBaseAlgorithm.

virtual void lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< ShowerOverlapResult > >::PrepareAllInputClusters ( )

protectedvirtualinherited

Perform any preparatory steps required, e.g. caching expensive fit results for clusters.

Implements lar_content::MatchingBaseAlgorithm.

void lar_content::ThreeViewShowersAlgorithm::PrepareInputClusters ( pandora::ClusterList & preparedClusterList )

virtual

Perform any preparatory steps required on the input clusters, e.g. caching expensive fit results.

Parameters

preparedClusterList to receive the prepared cluster list, non const so as to be able to modify input selected list

Reimplemented from lar_content::MatchingBaseAlgorithm.

Definition at line 100 of file ThreeViewShowersAlgorithm.cc.

References AddToSlidingFitCache(), and m_visualize.

 {
     for (ClusterList::iterator iter = preparedClusterList.begin(), iterEnd = preparedClusterList.end(); iter != iterEnd;)
     {
         const Cluster *const pCluster(*iter);
 
         try
         {
             this->AddToSlidingFitCache(pCluster);
             ++iter;
         }
         catch (StatusCodeException &statusCodeException)
         {
             preparedClusterList.erase(iter++);
 
             if (STATUS_CODE_FAILURE == statusCodeException.GetStatusCode())
                 throw statusCodeException;
         }
     }
     if (m_visualize)
     {
         PANDORA_MONITORING_API(VisualizeClusters(this->GetPandora(), &preparedClusterList, "Prepared Clusters", GREEN));
         PANDORA_MONITORING_API(ViewEvent(this->GetPandora()));
     }
 }

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

privatevirtual

Reimplemented from lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< ShowerOverlapResult > >.

Definition at line 383 of file ThreeViewShowersAlgorithm.cc.

References m_algorithmToolVector, m_ignoreUnavailableClusters, m_minClusterCaloHits, m_minClusterLengthSquared, m_minShowerMatchedFraction, m_minShowerMatchedPoints, m_nMaxTensorToolRepeats, m_slidingFitWindow, m_visualize, and lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< ShowerOverlapResult > >::ReadSettings().

 {
     AlgorithmToolVector algorithmToolVector;
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ProcessAlgorithmToolList(*this, xmlHandle, "ShowerTools", algorithmToolVector));
 
     for (AlgorithmToolVector::const_iterator iter = algorithmToolVector.begin(), iterEnd = algorithmToolVector.end(); iter != iterEnd; ++iter)
     {
         ShowerTensorTool *const pShowerTensorTool(dynamic_cast<ShowerTensorTool *>(*iter));
 
         if (!pShowerTensorTool)
             return STATUS_CODE_INVALID_PARAMETER;
 
         m_algorithmToolVector.push_back(pShowerTensorTool);
     }
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "NMaxTensorToolRepeats", m_nMaxTensorToolRepeats));
 
     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, "IgnoreUnavailableClusters", m_ignoreUnavailableClusters));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinClusterCaloHits", m_minClusterCaloHits));
 
     float minClusterLength = std::sqrt(m_minClusterLengthSquared);
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinClusterLength", minClusterLength));
     m_minClusterLengthSquared = minClusterLength * minClusterLength;
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
         XmlHelper::ReadValue(xmlHandle, "MinShowerMatchedFraction", m_minShowerMatchedFraction));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinShowerMatchedPoints", m_minShowerMatchedPoints));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "Visualize", m_visualize));
 
     return BaseAlgorithm::ReadSettings(xmlHandle);
 }

void lar_content::ThreeViewShowersAlgorithm::RemoveFromSlidingFitCache ( const pandora::Cluster *const pCluster )

private

Remova an existing sliding fit result, for the specified cluster, from the algorithm cache.

Parameters

pCluster address of the relevant cluster

Definition at line 147 of file ThreeViewShowersAlgorithm.cc.

References CalculateOverlapResult(), GetBestHitOverlapFraction(), GetCachedSlidingFitResult(), lar_content::ShowerOverlapResult::GetMatchedFraction(), lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< ShowerOverlapResult > >::GetMatchingControl(), lar_content::ShowerOverlapResult::GetNMatchedSamplingPoints(), lar_content::ThreeViewMatchingControl< T >::GetOverlapTensor(), lar_content::TwoDSlidingShowerFitResult::GetShowerFitResult(), GetShowerPositionMaps(), lar_content::ShowerOverlapResult::IsInitialized(), m_minShowerMatchedFraction, m_minShowerMatchedPoints, m_slidingFitResultMap, m_visualize, and lar_content::OverlapTensor< T >::SetOverlapResult().

Referenced by UpdateUponDeletion().

 {
     TwoDSlidingShowerFitResultMap::iterator iter = m_slidingFitResultMap.find(pCluster);
 
     if (m_slidingFitResultMap.end() != iter)
         m_slidingFitResultMap.erase(iter);
 }

virtual void lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< ShowerOverlapResult > >::SelectAllInputClusters ( )

protectedvirtualinherited

Select a subset of input clusters for processing in this algorithm.

Implements lar_content::MatchingBaseAlgorithm.

void lar_content::ThreeViewShowersAlgorithm::SelectInputClusters	(	const pandora::ClusterList *const	pInputClusterList,
		pandora::ClusterList &	selectedClusterList
	)		const

virtual

Select a subset of input clusters for processing in this algorithm.

Parameters

pInputClusterList	address of an input cluster list
selectedClusterList	to receive the selected cluster list

Reimplemented from lar_content::MatchingBaseAlgorithm.

Definition at line 74 of file ThreeViewShowersAlgorithm.cc.

References lar_content::LArClusterHelper::GetLengthSquared(), m_ignoreUnavailableClusters, m_minClusterCaloHits, m_minClusterLengthSquared, and m_visualize.

 {
     for (ClusterList::const_iterator iter = pInputClusterList->begin(), iterEnd = pInputClusterList->end(); iter != iterEnd; ++iter)
     {
         const Cluster *const pCluster = *iter;
 
         if (m_ignoreUnavailableClusters && !pCluster->IsAvailable())
             continue;
 
         if (pCluster->GetNCaloHits() < m_minClusterCaloHits)
             continue;
 
         if (LArClusterHelper::GetLengthSquared(pCluster) < m_minClusterLengthSquared)
             continue;
 
         selectedClusterList.push_back(pCluster);
     }
     if (m_visualize)
     {
         PANDORA_MONITORING_API(VisualizeClusters(this->GetPandora(), &selectedClusterList, "Selected Clusters", RED));
         PANDORA_MONITORING_API(ViewEvent(this->GetPandora()));
     }
 }

void lar_content::MatchingBaseAlgorithm::SetPfoParameters	(	const ProtoParticle &	protoParticle,
		PandoraContentApi::ParticleFlowObject::Parameters &	pfoParameters
	)		const

virtualinherited

Set Pfo properties.

Parameters

protoParticle	the input proto particle
pfoParameters	the output pfo parameters

Definition at line 116 of file MatchingBaseAlgorithm.cc.

References f, and lar_content::ProtoParticle::m_clusterList.

 {
     this->SetPfoParticleId(pfoParameters);
     pfoParameters.m_charge = PdgTable::GetParticleCharge(pfoParameters.m_particleId.Get());
     pfoParameters.m_mass = PdgTable::GetParticleMass(pfoParameters.m_particleId.Get());
     pfoParameters.m_energy = 0.f;
     pfoParameters.m_momentum = CartesianVector(0.f, 0.f, 0.f);
     pfoParameters.m_clusterList = protoParticle.m_clusterList;
 }

void lar_content::MatchingBaseAlgorithm::SetPfoParticleId ( PandoraContentApi::ParticleFlowObject::Parameters & pfoParameters ) const

virtualinherited

Set pfo particle id.

Parameters

pfoParameters the output pfo parameters

Reimplemented in lar_content::NViewTrackMatchingAlgorithm< T >, lar_content::NViewTrackMatchingAlgorithm< TwoViewMatchingControl< TwoViewTransverseOverlapResult > >, lar_content::NViewTrackMatchingAlgorithm< ThreeViewMatchingControl< FragmentOverlapResult > >, lar_content::NViewTrackMatchingAlgorithm< ThreeViewMatchingControl< TransverseOverlapResult > >, and lar_content::NViewTrackMatchingAlgorithm< ThreeViewMatchingControl< LongitudinalOverlapResult > >.

Definition at line 128 of file MatchingBaseAlgorithm.cc.

 {
     pfoParameters.m_particleId = E_MINUS; // Shower
 }

void lar_content::ThreeViewShowersAlgorithm::TidyUp ( )

privatevirtual

Tidy member variables in derived class.

Reimplemented from lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< ShowerOverlapResult > >.

Definition at line 128 of file ThreeViewShowersAlgorithm.cc.

References m_slidingFitResultMap, and lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< ShowerOverlapResult > >::TidyUp().

 {
     m_slidingFitResultMap.clear();
     return BaseAlgorithm::TidyUp();
 }

void lar_content::ThreeViewShowersAlgorithm::UpdateForNewCluster ( const pandora::Cluster *const pNewCluster )

virtual

Update to reflect addition of a new cluster to the problem space.

Parameters

pNewCluster address of the new cluster

Implements lar_content::MatchingBaseAlgorithm.

Definition at line 47 of file ThreeViewShowersAlgorithm.cc.

References AddToSlidingFitCache(), and lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< ShowerOverlapResult > >::UpdateForNewCluster().

 {
     try
     {
         this->AddToSlidingFitCache(pNewCluster);
     }
     catch (StatusCodeException &statusCodeException)
     {
         if (STATUS_CODE_FAILURE == statusCodeException.GetStatusCode())
             throw statusCodeException;
 
         return;
     }
 
     BaseAlgorithm::UpdateForNewCluster(pNewCluster);
 }

void lar_content::ThreeViewShowersAlgorithm::UpdateUponDeletion ( const pandora::Cluster *const pDeletedCluster )

virtual

Update to reflect cluster deletion.

Parameters

pDeletedCluster address of the deleted cluster

Implements lar_content::MatchingBaseAlgorithm.

Definition at line 66 of file ThreeViewShowersAlgorithm.cc.

References RemoveFromSlidingFitCache(), and lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< ShowerOverlapResult > >::UpdateUponDeletion().

 {
     this->RemoveFromSlidingFitCache(pDeletedCluster);
     BaseAlgorithm::UpdateUponDeletion(pDeletedCluster);
 }

Member Data Documentation

TensorToolVector lar_content::ThreeViewShowersAlgorithm::m_algorithmToolVector

private

The algorithm tool vector.

Definition at line 151 of file ThreeViewShowersAlgorithm.h.

Referenced by ExamineOverlapContainer(), and ReadSettings().

bool lar_content::ThreeViewShowersAlgorithm::m_ignoreUnavailableClusters

private

Whether to ignore (skip-over) unavailable clusters.

Definition at line 157 of file ThreeViewShowersAlgorithm.h.

Referenced by ReadSettings(), and SelectInputClusters().

MatchingType lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< ShowerOverlapResult > >::m_matchingControl

protectedinherited

The matching control.

Definition at line 53 of file NViewMatchingAlgorithm.h.

unsigned int lar_content::ThreeViewShowersAlgorithm::m_minClusterCaloHits

private

The min number of hits in base cluster selection method.

Definition at line 158 of file ThreeViewShowersAlgorithm.h.

Referenced by ReadSettings(), and SelectInputClusters().

float lar_content::ThreeViewShowersAlgorithm::m_minClusterLengthSquared

private

The min length (squared) in base cluster selection method.

Definition at line 159 of file ThreeViewShowersAlgorithm.h.

Referenced by ReadSettings(), and SelectInputClusters().

float lar_content::ThreeViewShowersAlgorithm::m_minShowerMatchedFraction

private

The minimum shower matched sampling fraction to allow shower grouping.

Definition at line 161 of file ThreeViewShowersAlgorithm.h.

Referenced by ReadSettings(), and RemoveFromSlidingFitCache().

unsigned int lar_content::ThreeViewShowersAlgorithm::m_minShowerMatchedPoints

private

The minimum number of matched shower sampling points to allow shower grouping.

Definition at line 162 of file ThreeViewShowersAlgorithm.h.

Referenced by ReadSettings(), and RemoveFromSlidingFitCache().

unsigned int lar_content::ThreeViewShowersAlgorithm::m_nMaxTensorToolRepeats

private

The maximum number of repeat loops over tensor tools.

Definition at line 152 of file ThreeViewShowersAlgorithm.h.

Referenced by ExamineOverlapContainer(), and ReadSettings().

TwoDSlidingShowerFitResultMap lar_content::ThreeViewShowersAlgorithm::m_slidingFitResultMap

private

The sliding shower fit result map.

Definition at line 155 of file ThreeViewShowersAlgorithm.h.

Referenced by AddToSlidingFitCache(), GetCachedSlidingFitResult(), RemoveFromSlidingFitCache(), and TidyUp().

unsigned int lar_content::ThreeViewShowersAlgorithm::m_slidingFitWindow

private

The layer window for the sliding linear fits.

Definition at line 154 of file ThreeViewShowersAlgorithm.h.

Referenced by AddToSlidingFitCache(), and ReadSettings().

bool lar_content::ThreeViewShowersAlgorithm::m_visualize

private

Visualize cluster matching procedure.

Definition at line 163 of file ThreeViewShowersAlgorithm.h.

Referenced by PrepareInputClusters(), ReadSettings(), RemoveFromSlidingFitCache(), and SelectInputClusters().

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

larpandoracontent/v04_08_01/source/larpandoracontent/LArThreeDReco/LArShowerMatching/ThreeViewShowersAlgorithm.h
larpandoracontent/v04_08_01/source/larpandoracontent/LArThreeDReco/LArShowerMatching/ThreeViewShowersAlgorithm.cc

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation