#include "ThreeDRemnantsAlgorithm.h"

Inheritance diagram for lar_content::ThreeDRemnantsAlgorithm:

Public Types
typedef OverlapTensor< float >	TensorType

Public Member Functions
	ThreeDRemnantsAlgorithm ()
	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...

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	UpdateForNewCluster (const pandora::Cluster *const pNewCluster)
	Update to reflect addition of a new cluster to the problem space. More...

virtual void	UpdateUponDeletion (const pandora::Cluster *const pDeletedCluster)
	Update to reflect cluster deletion. 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	PreparationStep ()
	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 tensor. Responsible for calling CalculateOverlapResult. More...

virtual void	TidyUp ()
	Tidy member variables in derived class. 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::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 tensor. 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
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...

Detailed Description

ThreeDRemnantsAlgorithm class.

Definition at line 28 of file ThreeDRemnantsAlgorithm.h.

Member Typedef Documentation

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

private

Definition at line 45 of file ThreeDRemnantsAlgorithm.h.

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

inherited

Definition at line 45 of file ThreeDBaseAlgorithm.h.

Constructor & Destructor Documentation

lar_content::ThreeDRemnantsAlgorithm::ThreeDRemnantsAlgorithm ( )

Default constructor.

Definition at line 21 of file ThreeDRemnantsAlgorithm.cc.

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

Member Function Documentation

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

Definition at line 64 of file ThreeDRemnantsAlgorithm.cc.

References f, lar_content::LArClusterHelper::GetAverageZ(), lar_content::LArClusterHelper::GetClusterSpanX(), lar_content::ThreeDBaseAlgorithm< float >::m_overlapTensor, m_pseudoChi2Cut, m_xOverlapWindow, max, lar_content::LArGeometryHelper::MergeTwoPositions(), min, lar_content::OverlapTensor< T >::SetOverlapResult(), and w.

 {
     // Requirements on X matching
     float xMinU(0.f), xMinV(0.f), xMinW(0.f), xMaxU(0.f), xMaxV(0.f), xMaxW(0.f);
     LArClusterHelper::GetClusterSpanX(pClusterU, xMinU, xMaxU);
     LArClusterHelper::GetClusterSpanX(pClusterV, xMinV, xMaxV);
     LArClusterHelper::GetClusterSpanX(pClusterW, 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());
     m_overlapTensor.SetOverlapResult(pClusterU, pClusterV, pClusterW, hackValue);
 }

virtual bool lar_content::ThreeDBaseAlgorithm< float >::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::ThreeDRemnantsAlgorithm::ExamineTensor ( )

privatevirtual

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

Implements lar_content::ThreeDBaseAlgorithm< float >.

Definition at line 105 of file ThreeDRemnantsAlgorithm.cc.

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

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

const std::string& lar_content::ThreeDBaseAlgorithm< float >::GetClusterListNameU ( ) const

inherited

Get the name of the u cluster list.

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

inherited

Get the name of the v cluster list.

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

inherited

Get the name of the w cluster list.

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

inherited

Get the input u cluster list.

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

inherited

Get the input v cluster list.

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

inherited

Get the input w cluster list.

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

inherited

Get the selected u cluster list.

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

inherited

Get the selected v cluster list.

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

inherited

Get the selected w cluster list.

virtual bool lar_content::ThreeDBaseAlgorithm< float >::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< float >::PerformMainLoop ( )

protectedvirtualinherited

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

virtual void lar_content::ThreeDBaseAlgorithm< float >::PreparationStep ( )

protectedvirtualinherited

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

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

privatevirtual

Reimplemented from lar_content::ThreeDBaseAlgorithm< float >.

Definition at line 127 of file ThreeDRemnantsAlgorithm.cc.

References m_algorithmToolVector, m_minClusterCaloHits, m_nMaxTensorToolRepeats, m_pseudoChi2Cut, m_xOverlapWindow, and lar_content::ThreeDBaseAlgorithm< T >::ReadSettings().

 {
     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 (NULL == 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 ThreeDBaseAlgorithm<float>::ReadSettings(xmlHandle);
 }

virtual void lar_content::ThreeDBaseAlgorithm< float >::RemoveUnavailableTensorElements ( )

virtualinherited

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

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

protectedvirtualinherited

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

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

Definition at line 31 of file ThreeDRemnantsAlgorithm.cc.

References m_minClusterCaloHits.

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

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

Definition at line 49 of file ThreeDRemnantsAlgorithm.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());
 }

virtual void lar_content::ThreeDBaseAlgorithm< float >::TidyUp ( )

protectedvirtualinherited

Tidy member variables in derived class.

virtual void lar_content::ThreeDBaseAlgorithm< float >::UpdateForNewCluster ( const pandora::Cluster *const pNewCluster )

virtualinherited

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

Parameters

pNewCluster address of the new cluster

virtual void lar_content::ThreeDBaseAlgorithm< float >::UpdateUponDeletion ( const pandora::Cluster *const pDeletedCluster )

virtualinherited

Update to reflect cluster deletion.

Parameters

pDeletedCluster address of the deleted cluster

Member Data Documentation

RemnantTensorToolVector lar_content::ThreeDRemnantsAlgorithm::m_algorithmToolVector

private

The algorithm tool list.

Definition at line 46 of file ThreeDRemnantsAlgorithm.h.

Referenced by ExamineTensor(), and ReadSettings().

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

protectedinherited

The selected modified cluster list U.

Definition at line 196 of file ThreeDBaseAlgorithm.h.

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

protectedinherited

The selected modified cluster list V.

Definition at line 197 of file ThreeDBaseAlgorithm.h.

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

protectedinherited

The selected modified cluster list W.

Definition at line 198 of file ThreeDBaseAlgorithm.h.

unsigned int lar_content::ThreeDRemnantsAlgorithm::m_minClusterCaloHits

private

The selection cut on the number of cluster calo hits.

Definition at line 49 of file ThreeDRemnantsAlgorithm.h.

Referenced by ReadSettings(), and SelectInputClusters().

unsigned int lar_content::ThreeDRemnantsAlgorithm::m_nMaxTensorToolRepeats

private

The maximum number of repeat loops over tensor tools.

Definition at line 48 of file ThreeDRemnantsAlgorithm.h.

Referenced by ExamineTensor(), and ReadSettings().

TensorType lar_content::ThreeDBaseAlgorithm< float >::m_overlapTensor

protectedinherited

The overlap tensor.

Definition at line 200 of file ThreeDBaseAlgorithm.h.

Referenced by CalculateOverlapResult(), and ExamineTensor().

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

protectedinherited

Address of the input cluster list U.

Definition at line 192 of file ThreeDBaseAlgorithm.h.

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

protectedinherited

Address of the input cluster list V.

Definition at line 193 of file ThreeDBaseAlgorithm.h.

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

protectedinherited

Address of the input cluster list W.

Definition at line 194 of file ThreeDBaseAlgorithm.h.

float lar_content::ThreeDRemnantsAlgorithm::m_pseudoChi2Cut

private

The selection cut on the matched chi2.

Definition at line 51 of file ThreeDRemnantsAlgorithm.h.

Referenced by CalculateOverlapResult(), and ReadSettings().

float lar_content::ThreeDRemnantsAlgorithm::m_xOverlapWindow

private

The sampling pitch in the x coordinate.

Definition at line 50 of file ThreeDRemnantsAlgorithm.h.

Referenced by CalculateOverlapResult(), 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/LArShowerFragments/ThreeDRemnantsAlgorithm.h
/cvmfs/larsoft.opensciencegrid.org/products/larpandoracontent/v03_14_03/source/larpandoracontent/LArThreeDReco/LArShowerFragments/ThreeDRemnantsAlgorithm.cc

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