#include "ThreeDShowersAlgorithm.h"

Inheritance diagram for lar_content::ThreeDShowersAlgorithm:

Classes
class	XSampling
	XSampling class. More...

Public Types
typedef OverlapTensor< ShowerOverlapResult >	TensorType

Public Member Functions
	ThreeDShowersAlgorithm ()
	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	SetPfoParameters (const ProtoParticle &protoParticle, PandoraContentApi::ParticleFlowObject::Parameters &pfoParameters) const
	Calculate Pfo properties from proto particle. More...

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

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

virtual void	RemoveUnavailableTensorElements ()
	Update tensor to remove all elements that have been added to pfos and so are unavailable. More...

const pandora::ClusterList &	GetInputClusterListU () const
	Get the input u cluster list. More...

const pandora::ClusterList &	GetInputClusterListV () const
	Get the input v cluster list. More...

const pandora::ClusterList &	GetInputClusterListW () const
	Get the input w cluster list. More...

const pandora::ClusterList &	GetSelectedClusterListU () const
	Get the selected u cluster list. More...

const pandora::ClusterList &	GetSelectedClusterListV () const
	Get the selected v cluster list. More...

const pandora::ClusterList &	GetSelectedClusterListW () const
	Get the selected w cluster list. More...

const std::string &	GetClusterListNameU () const
	Get the name of the u cluster list. More...

const std::string &	GetClusterListNameV () const
	Get the name of the v cluster list. More...

const std::string &	GetClusterListNameW () const
	Get the name of the w cluster list. More...

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

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

Protected Attributes
const pandora::ClusterList *	m_pInputClusterListU
	Address of the input cluster list U. More...

const pandora::ClusterList *	m_pInputClusterListV
	Address of the input cluster list V. More...

const pandora::ClusterList *	m_pInputClusterListW
	Address of the input cluster list W. More...

pandora::ClusterList	m_clusterListU
	The selected modified cluster list U. More...

pandora::ClusterList	m_clusterListV
	The selected modified cluster list V. More...

pandora::ClusterList	m_clusterListW
	The selected modified cluster list W. More...

TensorType	m_overlapTensor
	The overlap tensor. More...

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

typedef std::vector< ShowerTensorTool * >	TensorToolVector

Private Member Functions
void	PreparationStep ()
	Perform any preparatory steps required, e.g. caching expensive fit results for clusters. More...

void	PreparationStep (pandora::ClusterList &clusterList)
	Preparation step for a specific cluster list. More...

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 tensor. 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	ExamineTensor ()
	Examine contents of tensor, 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...

Detailed Description

ThreeDShowersAlgorithm class.

Definition at line 28 of file ThreeDShowersAlgorithm.h.

Member Typedef Documentation

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

private

Definition at line 124 of file ThreeDShowersAlgorithm.h.

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

private

Definition at line 155 of file ThreeDShowersAlgorithm.h.

typedef OverlapTensor<ShowerOverlapResult > lar_content::ThreeDBaseAlgorithm< ShowerOverlapResult >::TensorType

inherited

Definition at line 45 of file ThreeDBaseAlgorithm.h.

Constructor & Destructor Documentation

lar_content::ThreeDShowersAlgorithm::ThreeDShowersAlgorithm ( )

Default constructor.

Definition at line 21 of file ThreeDShowersAlgorithm.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)
 {
 }

Member Function Documentation

void lar_content::ThreeDShowersAlgorithm::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 149 of file ThreeDShowersAlgorithm.cc.

References lar_content::LArGeometryHelper::GetWireZPitch(), m_slidingFitResultMap, and m_slidingFitWindow.

Referenced by PreparationStep(), and UpdateForNewCluster().

 {
     const float slidingFitPitch(LArGeometryHelper::GetWireZPitch(this->GetPandora()));
     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::ThreeDShowersAlgorithm::CalculateOverlapResult	(	const pandora::Cluster *const	pClusterU,
		const pandora::Cluster *const	pClusterV,
		const pandora::Cluster *const	pClusterW
	)

privatevirtual

Calculate cluster overlap result and store in tensor.

Parameters

pClusterU	address of U view cluster
pClusterV	address of V view cluster
pClusterW	address of W view cluster

Implements lar_content::ThreeDBaseAlgorithm< ShowerOverlapResult >.

Referenced by RemoveFromSlidingFitCache().

pandora::StatusCode lar_content::ThreeDShowersAlgorithm::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

virtual bool lar_content::ThreeDBaseAlgorithm< ShowerOverlapResult >::CreateThreeDParticles ( const ProtoParticleVector & protoParticleVector )

virtualinherited

Create particles using findings from recent algorithm processing.

Parameters

protoParticleVector	the proto particle vector
whether	particles were created

void lar_content::ThreeDShowersAlgorithm::ExamineTensor ( )

privatevirtual

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

Implements lar_content::ThreeDBaseAlgorithm< ShowerOverlapResult >.

Definition at line 325 of file ThreeDShowersAlgorithm.cc.

References m_algorithmToolVector, m_nMaxTensorToolRepeats, and lar_content::ThreeDBaseAlgorithm< ShowerOverlapResult >::m_overlapTensor.

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

void lar_content::ThreeDShowersAlgorithm::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 285 of file ThreeDShowersAlgorithm.cc.

References lar_content::ThreeDShowersAlgorithm::XSampling::GetBin(), lar_content::ThreeDShowersAlgorithm::XSampling::m_maxX, lar_content::ThreeDShowersAlgorithm::XSampling::m_minX, max, 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::ThreeDShowersAlgorithm::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 34 of file ThreeDShowersAlgorithm.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::ThreeDBaseAlgorithm< ShowerOverlapResult >::GetClusterListNameU ( ) const

inherited

Get the name of the u cluster list.

const std::string& lar_content::ThreeDBaseAlgorithm< ShowerOverlapResult >::GetClusterListNameV ( ) const

inherited

Get the name of the v cluster list.

const std::string& lar_content::ThreeDBaseAlgorithm< ShowerOverlapResult >::GetClusterListNameW ( ) const

inherited

Get the name of the w cluster list.

const pandora::ClusterList& lar_content::ThreeDBaseAlgorithm< ShowerOverlapResult >::GetInputClusterListU ( ) const

inherited

Get the input u cluster list.

const pandora::ClusterList& lar_content::ThreeDBaseAlgorithm< ShowerOverlapResult >::GetInputClusterListV ( ) const

inherited

Get the input v cluster list.

const pandora::ClusterList& lar_content::ThreeDBaseAlgorithm< ShowerOverlapResult >::GetInputClusterListW ( ) const

inherited

Get the input w cluster list.

const pandora::ClusterList& lar_content::ThreeDBaseAlgorithm< ShowerOverlapResult >::GetSelectedClusterListU ( ) const

inherited

Get the selected u cluster list.

const pandora::ClusterList& lar_content::ThreeDBaseAlgorithm< ShowerOverlapResult >::GetSelectedClusterListV ( ) const

inherited

Get the selected v cluster list.

const pandora::ClusterList& lar_content::ThreeDBaseAlgorithm< ShowerOverlapResult >::GetSelectedClusterListW ( ) const

inherited

Get the selected w cluster list.

void lar_content::ThreeDShowersAlgorithm::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 222 of file ThreeDShowersAlgorithm.cc.

References lar_content::ThreeDShowersAlgorithm::XSampling::GetBin(), lar_content::TwoDSlidingShowerFitResult::GetShowerEdges(), lar_content::ThreeDShowersAlgorithm::XSampling::m_maxX, lar_content::ThreeDShowersAlgorithm::XSampling::m_minX, lar_content::ThreeDShowersAlgorithm::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)));
         }
     }
 }

virtual bool lar_content::ThreeDBaseAlgorithm< ShowerOverlapResult >::MakeClusterMerges ( const ClusterMergeMap & clusterMergeMap )

virtualinherited

Merge clusters together.

Parameters

clusterMergeMap the cluster merge map

Returns: whether changes to the tensor have been made

virtual void lar_content::ThreeDBaseAlgorithm< ShowerOverlapResult >::PerformMainLoop ( )

protectedvirtualinherited

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

void lar_content::ThreeDShowersAlgorithm::PreparationStep ( )

privatevirtual

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

Reimplemented from lar_content::ThreeDBaseAlgorithm< ShowerOverlapResult >.

Definition at line 109 of file ThreeDShowersAlgorithm.cc.

References AddToSlidingFitCache(), lar_content::ThreeDBaseAlgorithm< ShowerOverlapResult >::m_clusterListU, lar_content::ThreeDBaseAlgorithm< ShowerOverlapResult >::m_clusterListV, and lar_content::ThreeDBaseAlgorithm< ShowerOverlapResult >::m_clusterListW.

 {
     this->PreparationStep(this->m_clusterListU);
     this->PreparationStep(this->m_clusterListV);
     this->PreparationStep(this->m_clusterListW);
 }

void lar_content::ThreeDShowersAlgorithm::PreparationStep ( pandora::ClusterList & clusterList )

private

Preparation step for a specific cluster list.

Parameters

clusterList the cluster list

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

privatevirtual

Reimplemented from lar_content::ThreeDBaseAlgorithm< ShowerOverlapResult >.

Definition at line 382 of file ThreeDShowersAlgorithm.cc.

References m_algorithmToolVector, m_ignoreUnavailableClusters, m_minClusterCaloHits, m_minClusterLengthSquared, m_minShowerMatchedFraction, m_minShowerMatchedPoints, m_nMaxTensorToolRepeats, m_slidingFitWindow, and lar_content::ThreeDBaseAlgorithm< T >::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 (NULL == 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));
 
     return ThreeDBaseAlgorithm<ShowerOverlapResult>::ReadSettings(xmlHandle);
 }

void lar_content::ThreeDShowersAlgorithm::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 160 of file ThreeDShowersAlgorithm.cc.

References CalculateOverlapResult(), GetBestHitOverlapFraction(), GetCachedSlidingFitResult(), lar_content::ShowerOverlapResult::GetMatchedFraction(), lar_content::ShowerOverlapResult::GetNMatchedSamplingPoints(), lar_content::TwoDSlidingShowerFitResult::GetShowerFitResult(), GetShowerPositionMaps(), lar_content::ShowerOverlapResult::IsInitialized(), m_minShowerMatchedFraction, m_minShowerMatchedPoints, lar_content::ThreeDBaseAlgorithm< ShowerOverlapResult >::m_overlapTensor, m_slidingFitResultMap, 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::ThreeDBaseAlgorithm< ShowerOverlapResult >::RemoveUnavailableTensorElements ( )

virtualinherited

Update tensor to remove all elements that have been added to pfos and so are unavailable.

virtual void lar_content::ThreeDBaseAlgorithm< ShowerOverlapResult >::SelectAllInputClusters ( )

protectedvirtualinherited

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

void lar_content::ThreeDShowersAlgorithm::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

Implements lar_content::ThreeDBaseAlgorithm< ShowerOverlapResult >.

Definition at line 73 of file ThreeDShowersAlgorithm.cc.

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

 {
     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);
     }
 }

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

virtual

Calculate Pfo properties from proto particle.

Parameters

protoParticle	the input proto particle
pfoParameters	the output pfo parameters

Implements lar_content::ThreeDBaseAlgorithm< ShowerOverlapResult >.

Definition at line 94 of file ThreeDShowersAlgorithm.cc.

References f, lar_content::ProtoParticle::m_clusterListU, lar_content::ProtoParticle::m_clusterListV, and lar_content::ProtoParticle::m_clusterListW.

 {
     // TODO Correct these placeholder parameters
     pfoParameters.m_particleId = E_MINUS; // Shower
     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.insert(pfoParameters.m_clusterList.end(), protoParticle.m_clusterListU.begin(), protoParticle.m_clusterListU.end());
     pfoParameters.m_clusterList.insert(pfoParameters.m_clusterList.end(), protoParticle.m_clusterListV.begin(), protoParticle.m_clusterListV.end());
     pfoParameters.m_clusterList.insert(pfoParameters.m_clusterList.end(), protoParticle.m_clusterListW.begin(), protoParticle.m_clusterListW.end());
 }

void lar_content::ThreeDShowersAlgorithm::TidyUp ( )

privatevirtual

Tidy member variables in derived class.

Reimplemented from lar_content::ThreeDBaseAlgorithm< ShowerOverlapResult >.

Definition at line 141 of file ThreeDShowersAlgorithm.cc.

References m_slidingFitResultMap, and lar_content::ThreeDBaseAlgorithm< T >::TidyUp().

 {
     m_slidingFitResultMap.clear();
     return ThreeDBaseAlgorithm<ShowerOverlapResult>::TidyUp();
 }

void lar_content::ThreeDShowersAlgorithm::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

Reimplemented from lar_content::ThreeDBaseAlgorithm< ShowerOverlapResult >.

Definition at line 46 of file ThreeDShowersAlgorithm.cc.

References AddToSlidingFitCache(), and lar_content::ThreeDBaseAlgorithm< T >::UpdateForNewCluster().

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

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

virtual

Update to reflect cluster deletion.

Parameters

pDeletedCluster address of the deleted cluster

Reimplemented from lar_content::ThreeDBaseAlgorithm< ShowerOverlapResult >.

Definition at line 65 of file ThreeDShowersAlgorithm.cc.

References RemoveFromSlidingFitCache(), and lar_content::ThreeDBaseAlgorithm< T >::UpdateUponDeletion().

 {
     this->RemoveFromSlidingFitCache(pDeletedCluster);
     ThreeDBaseAlgorithm<ShowerOverlapResult>::UpdateUponDeletion(pDeletedCluster);
 }

Member Data Documentation

TensorToolVector lar_content::ThreeDShowersAlgorithm::m_algorithmToolVector

private

The algorithm tool vector.

Definition at line 156 of file ThreeDShowersAlgorithm.h.

Referenced by ExamineTensor(), and ReadSettings().

pandora::ClusterList lar_content::ThreeDBaseAlgorithm< ShowerOverlapResult >::m_clusterListU

protectedinherited

The selected modified cluster list U.

Definition at line 196 of file ThreeDBaseAlgorithm.h.

Referenced by PreparationStep().

pandora::ClusterList lar_content::ThreeDBaseAlgorithm< ShowerOverlapResult >::m_clusterListV

protectedinherited

The selected modified cluster list V.

Definition at line 197 of file ThreeDBaseAlgorithm.h.

Referenced by PreparationStep().

pandora::ClusterList lar_content::ThreeDBaseAlgorithm< ShowerOverlapResult >::m_clusterListW

protectedinherited

The selected modified cluster list W.

Definition at line 198 of file ThreeDBaseAlgorithm.h.

Referenced by PreparationStep().

bool lar_content::ThreeDShowersAlgorithm::m_ignoreUnavailableClusters

private

Whether to ignore (skip-over) unavailable clusters.

Definition at line 162 of file ThreeDShowersAlgorithm.h.

Referenced by ReadSettings(), and SelectInputClusters().

unsigned int lar_content::ThreeDShowersAlgorithm::m_minClusterCaloHits

private

The min number of hits in base cluster selection method.

Definition at line 163 of file ThreeDShowersAlgorithm.h.

Referenced by ReadSettings(), and SelectInputClusters().

float lar_content::ThreeDShowersAlgorithm::m_minClusterLengthSquared

private

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

Definition at line 164 of file ThreeDShowersAlgorithm.h.

Referenced by ReadSettings(), and SelectInputClusters().

float lar_content::ThreeDShowersAlgorithm::m_minShowerMatchedFraction

private

The minimum shower matched sampling fraction to allow shower grouping.

Definition at line 166 of file ThreeDShowersAlgorithm.h.

Referenced by ReadSettings(), and RemoveFromSlidingFitCache().

unsigned int lar_content::ThreeDShowersAlgorithm::m_minShowerMatchedPoints

private

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

Definition at line 167 of file ThreeDShowersAlgorithm.h.

Referenced by ReadSettings(), and RemoveFromSlidingFitCache().

unsigned int lar_content::ThreeDShowersAlgorithm::m_nMaxTensorToolRepeats

private

The maximum number of repeat loops over tensor tools.

Definition at line 157 of file ThreeDShowersAlgorithm.h.

Referenced by ExamineTensor(), and ReadSettings().

TensorType lar_content::ThreeDBaseAlgorithm< ShowerOverlapResult >::m_overlapTensor

protectedinherited

The overlap tensor.

Definition at line 200 of file ThreeDBaseAlgorithm.h.

Referenced by ExamineTensor(), and RemoveFromSlidingFitCache().

const pandora::ClusterList* lar_content::ThreeDBaseAlgorithm< ShowerOverlapResult >::m_pInputClusterListU

protectedinherited

Address of the input cluster list U.

Definition at line 192 of file ThreeDBaseAlgorithm.h.

const pandora::ClusterList* lar_content::ThreeDBaseAlgorithm< ShowerOverlapResult >::m_pInputClusterListV

protectedinherited

Address of the input cluster list V.

Definition at line 193 of file ThreeDBaseAlgorithm.h.

const pandora::ClusterList* lar_content::ThreeDBaseAlgorithm< ShowerOverlapResult >::m_pInputClusterListW

protectedinherited

Address of the input cluster list W.

Definition at line 194 of file ThreeDBaseAlgorithm.h.

TwoDSlidingShowerFitResultMap lar_content::ThreeDShowersAlgorithm::m_slidingFitResultMap

private

The sliding shower fit result map.

Definition at line 160 of file ThreeDShowersAlgorithm.h.

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

unsigned int lar_content::ThreeDShowersAlgorithm::m_slidingFitWindow

private

The layer window for the sliding linear fits.

Definition at line 159 of file ThreeDShowersAlgorithm.h.

Referenced by AddToSlidingFitCache(), 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/LArShowerMatching/ThreeDShowersAlgorithm.h
/cvmfs/larsoft.opensciencegrid.org/products/larpandoracontent/v03_14_03/source/larpandoracontent/LArThreeDReco/LArShowerMatching/ThreeDShowersAlgorithm.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