ThreeViewRemnantsAlgorithm class. More...

#include <ThreeViewRemnantsAlgorithm.h>

Inheritance diagram for lar_content::ThreeViewRemnantsAlgorithm:

Public Types
typedef NViewMatchingAlgorithm < ThreeViewMatchingControl < float > >	BaseAlgorithm

Public Types inherited from lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< float > >
typedef ThreeViewMatchingControl < float >	MatchingType

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

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

Public Member Functions inherited from lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< float > >
	NViewMatchingAlgorithm ()
	Default constructor. More...

virtual	~NViewMatchingAlgorithm ()
	Destructor. 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...

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

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

virtual	~MatchingBaseAlgorithm ()
	Destructor. More...

virtual void	PrepareInputClusters (pandora::ClusterList &preparedClusterList)
	Perform any preparatory steps required on the input clusters, e.g. caching expensive fit results. 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...

Private Types
typedef std::vector < RemnantTensorTool * >	RemnantTensorToolVector

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

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
RemnantTensorToolVector	m_algorithmToolVector
	The algorithm tool list. More...

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

unsigned int	m_minClusterCaloHits
	The selection cut on the number of cluster calo hits. More...

float	m_xOverlapWindow
	The sampling pitch in the x coordinate. More...

float	m_pseudoChi2Cut
	The selection cut on the matched chi2. More...

Additional Inherited Members
Protected Member Functions inherited from lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< float > >
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...

virtual void	TidyUp ()
	Tidy member variables in derived class. More...

Protected Attributes inherited from lar_content::NViewMatchingAlgorithm< ThreeViewMatchingControl< float > >
MatchingType	m_matchingControl
	The matching control. More...

Detailed Description

ThreeViewRemnantsAlgorithm class.

Definition at line 27 of file ThreeViewRemnantsAlgorithm.h.

Member Typedef Documentation

typedef NViewMatchingAlgorithm<ThreeViewMatchingControl<float> > lar_content::ThreeViewRemnantsAlgorithm::BaseAlgorithm

Definition at line 30 of file ThreeViewRemnantsAlgorithm.h.

typedef std::vector<RemnantTensorTool *> lar_content::ThreeViewRemnantsAlgorithm::RemnantTensorToolVector

private

Definition at line 45 of file ThreeViewRemnantsAlgorithm.h.

Constructor & Destructor Documentation

lar_content::ThreeViewRemnantsAlgorithm::ThreeViewRemnantsAlgorithm ( )

Default constructor.

Definition at line 21 of file ThreeViewRemnantsAlgorithm.cc.

                                                        :
     m_nMaxTensorToolRepeats(1000),
     m_minClusterCaloHits(5),
     m_xOverlapWindow(2.f),
     m_pseudoChi2Cut(10.f)
 {
 }

Member Function Documentation

void lar_content::ThreeViewRemnantsAlgorithm::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.

Definition at line 49 of file ThreeViewRemnantsAlgorithm.cc.

 {
     // Requirements on X matching
     float xMinU(0.f), xMinV(0.f), xMinW(0.f), xMaxU(0.f), xMaxV(0.f), xMaxW(0.f);
     pClusterU->GetClusterSpanX(xMinU, xMaxU);
     pClusterV->GetClusterSpanX(xMinV, xMaxV);
     pClusterW->GetClusterSpanX(xMinW, xMaxW);
 
     const float xMin(std::max(xMinU, std::max(xMinV, xMinW)) - m_xOverlapWindow);
     const float xMax(std::min(xMaxU, std::min(xMaxV, xMaxW)) + m_xOverlapWindow);
     const float xOverlap(xMax - xMin);
 
     if (xOverlap < std::numeric_limits<float>::epsilon())
         return;
 
     // Requirements on 3D matching
     float u(std::numeric_limits<float>::max()), v(std::numeric_limits<float>::max()), w(std::numeric_limits<float>::max());
 
     if ((STATUS_CODE_SUCCESS != LArClusterHelper::GetAverageZ(pClusterU, xMin, xMax, u)) ||
         (STATUS_CODE_SUCCESS != LArClusterHelper::GetAverageZ(pClusterV, xMin, xMax, v)) ||
         (STATUS_CODE_SUCCESS != LArClusterHelper::GetAverageZ(pClusterW, xMin, xMax, w)))
     {
         return;
     }
 
     const float uv2w(LArGeometryHelper::MergeTwoPositions(this->GetPandora(), TPC_VIEW_U, TPC_VIEW_V, u, v));
     const float vw2u(LArGeometryHelper::MergeTwoPositions(this->GetPandora(), TPC_VIEW_V, TPC_VIEW_W, v, w));
     const float wu2v(LArGeometryHelper::MergeTwoPositions(this->GetPandora(), TPC_VIEW_W, TPC_VIEW_U, w, u));
 
     const float pseudoChi2(((u - vw2u) * (u - vw2u) + (v - wu2v) * (v - wu2v) + (w - uv2w) * (w - uv2w)) / 3.f);
 
     if (pseudoChi2 > m_pseudoChi2Cut)
         return;
 
     // ATTN Essentially a boolean result; actual value matters only so as to ensure that overlap results can be sorted
     const float hackValue(
         pseudoChi2 + pClusterU->GetElectromagneticEnergy() + pClusterV->GetElectromagneticEnergy() + pClusterW->GetElectromagneticEnergy());
     this->GetMatchingControl().GetOverlapTensor().SetOverlapResult(pClusterU, pClusterV, pClusterW, hackValue);
 }

void lar_content::ThreeViewRemnantsAlgorithm::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 91 of file ThreeViewRemnantsAlgorithm.cc.

 {
     unsigned int repeatCounter(0);
 
     for (RemnantTensorToolVector::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;
         }
     }
 }

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

privatevirtual

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

Definition at line 113 of file ThreeViewRemnantsAlgorithm.cc.

 {
     AlgorithmToolVector algorithmToolVector;
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ProcessAlgorithmToolList(*this, xmlHandle, "TrackTools", algorithmToolVector));
 
     for (AlgorithmToolVector::const_iterator iter = algorithmToolVector.begin(), iterEnd = algorithmToolVector.end(); iter != iterEnd; ++iter)
     {
         RemnantTensorTool *const pRemnantTensorTool(dynamic_cast<RemnantTensorTool *>(*iter));
 
         if (!pRemnantTensorTool)
             return STATUS_CODE_INVALID_PARAMETER;
 
         m_algorithmToolVector.push_back(pRemnantTensorTool);
     }
 
     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, "MinClusterCaloHits", m_minClusterCaloHits));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "OverlapWindow", m_xOverlapWindow));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "PseudoChi2Cut", m_pseudoChi2Cut));
 
     return BaseAlgorithm::ReadSettings(xmlHandle);
 }

void lar_content::ThreeViewRemnantsAlgorithm::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 31 of file ThreeViewRemnantsAlgorithm.cc.

 {
     for (ClusterList::const_iterator iter = pInputClusterList->begin(), iterEnd = pInputClusterList->end(); iter != iterEnd; ++iter)
     {
         const Cluster *const pCluster = *iter;
 
         if (!pCluster->IsAvailable())
             continue;
 
         if (pCluster->GetNCaloHits() < m_minClusterCaloHits)
             continue;
 
         selectedClusterList.push_back(pCluster);
     }
 }