#include <ThreeViewMatchingControl.h>

Inheritance diagram for lar_content::ThreeViewMatchingControl< T >:

Public Types
typedef OverlapTensor< T >	TensorType

Public Member Functions
	ThreeViewMatchingControl (MatchingBaseAlgorithm *const pAlgorithm)
	Constructor. More...

virtual	~ThreeViewMatchingControl ()
	Destructor. More...

TensorType &	GetOverlapTensor ()
	Get the overlap tensor. More...

Public Member Functions inherited from lar_content::NViewMatchingControl
	NViewMatchingControl (MatchingBaseAlgorithm *const pAlgorithm)
	Constructor. More...

virtual	~NViewMatchingControl ()
	Destructor. More...

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

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

void	PrepareAllInputClusters ()
	Perform any preparatory steps required on the input clusters, e.g. caching expensive fit results. More...

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

void	TidyUp ()
	Tidy member variables. More...

pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)
	Read settings from xml. More...

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

std::string	m_inputClusterListNameU
	The name of the view U cluster list. More...

std::string	m_inputClusterListNameV
	The name of the view V cluster list. More...

std::string	m_inputClusterListNameW
	The name of the view W cluster list. More...

Friends
class	ThreeViewTrackFragmentsAlgorithm
	ATTN This is for legacy purposes only. More...

class	ThreeViewDeltaRayMatchingAlgorithm

template<typename U >
class	NViewMatchingAlgorithm

Additional Inherited Members
Protected Attributes inherited from lar_content::NViewMatchingControl
MatchingBaseAlgorithm *	m_pAlgorithm
	The address of the matching base algorithm. More...

Detailed Description

template<typename T>
class lar_content::ThreeViewMatchingControl< T >

ThreeViewMatchingControl class.

Definition at line 22 of file ThreeViewMatchingControl.h.

Member Typedef Documentation

template<typename T>

typedef OverlapTensor<T> lar_content::ThreeViewMatchingControl< T >::TensorType

Definition at line 25 of file ThreeViewMatchingControl.h.

Constructor & Destructor Documentation

template<typename T >

lar_content::ThreeViewMatchingControl< T >::ThreeViewMatchingControl ( MatchingBaseAlgorithm *const pAlgorithm )

Constructor.

Parameters

pAlgorithm address of the matching base algorithm

Definition at line 25 of file ThreeViewMatchingControl.cc.

                                                                                              :
     NViewMatchingControl(pAlgorithm),
     m_pInputClusterListU(nullptr),
     m_pInputClusterListV(nullptr),
     m_pInputClusterListW(nullptr)
 {
 }

template<typename T >

lar_content::ThreeViewMatchingControl< T >::~ThreeViewMatchingControl ( )

virtual

Destructor.

Definition at line 36 of file ThreeViewMatchingControl.cc.

37 {

38 }

Member Function Documentation

template<typename T>

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

privatevirtual

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

Parameters

hitType the hit type

Returns: the cluster list name

Implements lar_content::NViewMatchingControl.

Definition at line 117 of file ThreeViewMatchingControl.cc.

 {
     if (TPC_VIEW_U == hitType)
         return m_inputClusterListNameU;
 
     if (TPC_VIEW_V == hitType)
         return m_inputClusterListNameV;
 
     if (TPC_VIEW_W == hitType)
         return m_inputClusterListNameW;
 
     throw StatusCodeException(STATUS_CODE_INVALID_PARAMETER);
 }

template<typename T>

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

privatevirtual

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

Parameters

hitType the hit type

Returns: the input cluster list

Implements lar_content::NViewMatchingControl.

Definition at line 134 of file ThreeViewMatchingControl.cc.

 {
     if ((TPC_VIEW_U == hitType) && m_pInputClusterListU)
         return (*m_pInputClusterListU);
 
     if ((TPC_VIEW_V == hitType) && m_pInputClusterListV)
         return (*m_pInputClusterListV);
 
     if ((TPC_VIEW_W == hitType) && m_pInputClusterListW)
         return (*m_pInputClusterListW);
 
     throw pandora::StatusCodeException(pandora::STATUS_CODE_NOT_INITIALIZED);
 }

template<typename T >

ThreeViewMatchingControl< T >::TensorType & lar_content::ThreeViewMatchingControl< T >::GetOverlapTensor ( )

Get the overlap tensor.

Returns: the overlap tensor

Definition at line 43 of file ThreeViewMatchingControl.cc.

 {
     return m_overlapTensor;
 }

template<typename T>

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

privatevirtual

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

Parameters

hitType the hit type

Returns: the selected cluster list

Implements lar_content::NViewMatchingControl.

Definition at line 151 of file ThreeViewMatchingControl.cc.

 {
     if (TPC_VIEW_U == hitType)
         return m_clusterListU;
 
     if (TPC_VIEW_V == hitType)
         return m_clusterListV;
 
     if (TPC_VIEW_W == hitType)
         return m_clusterListW;
 
     throw StatusCodeException(STATUS_CODE_INVALID_PARAMETER);
 }

template<typename T >

void lar_content::ThreeViewMatchingControl< T >::PerformMainLoop ( )

privatevirtual

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

Implements lar_content::NViewMatchingControl.

Definition at line 219 of file ThreeViewMatchingControl.cc.

 {
     ClusterVector clusterVectorU(m_clusterListU.begin(), m_clusterListU.end());
     ClusterVector clusterVectorV(m_clusterListV.begin(), m_clusterListV.end());
     ClusterVector clusterVectorW(m_clusterListW.begin(), m_clusterListW.end());
     std::sort(clusterVectorU.begin(), clusterVectorU.end(), LArClusterHelper::SortByNHits);
     std::sort(clusterVectorV.begin(), clusterVectorV.end(), LArClusterHelper::SortByNHits);
     std::sort(clusterVectorW.begin(), clusterVectorW.end(), LArClusterHelper::SortByNHits);
 
     for (const Cluster *const pClusterU : clusterVectorU)
     {
         for (const Cluster *const pClusterV : clusterVectorV)
         {
             for (const Cluster *const pClusterW : clusterVectorW)
                 m_pAlgorithm->CalculateOverlapResult(pClusterU, pClusterV, pClusterW);
         }
     }
 }

template<typename T >

void lar_content::ThreeViewMatchingControl< T >::PrepareAllInputClusters ( )

privatevirtual

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

Implements lar_content::NViewMatchingControl.

Definition at line 193 of file ThreeViewMatchingControl.cc.

 {
     m_pAlgorithm->PrepareInputClusters(m_clusterListU);
     m_pAlgorithm->PrepareInputClusters(m_clusterListV);
     m_pAlgorithm->PrepareInputClusters(m_clusterListW);
 }

template<typename T>

StatusCode lar_content::ThreeViewMatchingControl< T >::ReadSettings ( const pandora::TiXmlHandle xmlHandle )

privatevirtual

Read settings from xml.

Parameters

xmlHandle the xml handle

Implements lar_content::NViewMatchingControl.

Definition at line 241 of file ThreeViewMatchingControl.cc.

 {
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "InputClusterListNameU", m_inputClusterListNameU));
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "InputClusterListNameV", m_inputClusterListNameV));
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "InputClusterListNameW", m_inputClusterListNameW));
 
     return STATUS_CODE_SUCCESS;
 }

template<typename T >

void lar_content::ThreeViewMatchingControl< T >::SelectAllInputClusters ( )

privatevirtual

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

Implements lar_content::NViewMatchingControl.

Definition at line 168 of file ThreeViewMatchingControl.cc.

 {
     PANDORA_THROW_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_INITIALIZED, !=,
         PandoraContentApi::GetList(*m_pAlgorithm, m_inputClusterListNameU, m_pInputClusterListU));
     PANDORA_THROW_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_INITIALIZED, !=,
         PandoraContentApi::GetList(*m_pAlgorithm, m_inputClusterListNameV, m_pInputClusterListV));
     PANDORA_THROW_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_INITIALIZED, !=,
         PandoraContentApi::GetList(*m_pAlgorithm, m_inputClusterListNameW, m_pInputClusterListW));
 
     if (!m_pInputClusterListU || !m_pInputClusterListV || !m_pInputClusterListW)
     {
         if (PandoraContentApi::GetSettings(*m_pAlgorithm)->ShouldDisplayAlgorithmInfo())
             std::cout << "ThreeViewMatchingControl: one or more input cluster lists unavailable." << std::endl;
 
         throw StatusCodeException(STATUS_CODE_SUCCESS);
     }
 
     m_pAlgorithm->SelectInputClusters(m_pInputClusterListU, m_clusterListU);
     m_pAlgorithm->SelectInputClusters(m_pInputClusterListV, m_clusterListV);
     m_pAlgorithm->SelectInputClusters(m_pInputClusterListW, m_clusterListW);
 }

template<typename T >

void lar_content::ThreeViewMatchingControl< T >::TidyUp ( )

privatevirtual

Tidy member variables.

Implements lar_content::NViewMatchingControl.

Definition at line 203 of file ThreeViewMatchingControl.cc.

 {
     m_overlapTensor.Clear();
 
     m_pInputClusterListU = nullptr;
     m_pInputClusterListV = nullptr;
     m_pInputClusterListW = nullptr;
 
     m_clusterListU.clear();
     m_clusterListV.clear();
     m_clusterListW.clear();
 }

template<typename T>

void lar_content::ThreeViewMatchingControl< T >::UpdateForNewCluster ( const pandora::Cluster *const pNewCluster )

privatevirtual

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

Parameters

pNewCluster address of the new cluster

Implements lar_content::NViewMatchingControl.

Definition at line 51 of file ThreeViewMatchingControl.cc.

 {
     const HitType hitType(LArClusterHelper::GetClusterHitType(pNewCluster));
 
     if (!((TPC_VIEW_U == hitType) || (TPC_VIEW_V == hitType) || (TPC_VIEW_W == hitType)))
         throw StatusCodeException(STATUS_CODE_FAILURE);
 
     ClusterList &clusterList((TPC_VIEW_U == hitType) ? m_clusterListU : (TPC_VIEW_V == hitType) ? m_clusterListV : m_clusterListW);
 
     if (clusterList.end() != std::find(clusterList.begin(), clusterList.end(), pNewCluster))
         throw StatusCodeException(STATUS_CODE_ALREADY_PRESENT);
 
     clusterList.push_back(pNewCluster);
 
     const ClusterList &clusterList2((TPC_VIEW_U == hitType) ? m_clusterListV : m_clusterListU);
     const ClusterList &clusterList3((TPC_VIEW_W == hitType) ? m_clusterListV : m_clusterListW);
 
     ClusterVector clusterVector2(clusterList2.begin(), clusterList2.end());
     ClusterVector clusterVector3(clusterList3.begin(), clusterList3.end());
     std::sort(clusterVector2.begin(), clusterVector2.end(), LArClusterHelper::SortByNHits);
     std::sort(clusterVector3.begin(), clusterVector3.end(), LArClusterHelper::SortByNHits);
 
     for (const Cluster *const pCluster2 : clusterVector2)
     {
         for (const Cluster *const pCluster3 : clusterVector3)
         {
             if (TPC_VIEW_U == hitType)
             {
                 m_pAlgorithm->CalculateOverlapResult(pNewCluster, pCluster2, pCluster3);
             }
             else if (TPC_VIEW_V == hitType)
             {
                 m_pAlgorithm->CalculateOverlapResult(pCluster2, pNewCluster, pCluster3);
             }
             else
             {
                 m_pAlgorithm->CalculateOverlapResult(pCluster2, pCluster3, pNewCluster);
             }
         }
     }
 }

template<typename T>

void lar_content::ThreeViewMatchingControl< T >::UpdateUponDeletion ( const pandora::Cluster *const pDeletedCluster )

privatevirtual

Update to reflect cluster deletion.

Parameters

pDeletedCluster address of the deleted cluster

Implements lar_content::NViewMatchingControl.

Definition at line 96 of file ThreeViewMatchingControl.cc.

 {
     ClusterList::iterator iterU = std::find(m_clusterListU.begin(), m_clusterListU.end(), pDeletedCluster);
     ClusterList::iterator iterV = std::find(m_clusterListV.begin(), m_clusterListV.end(), pDeletedCluster);
     ClusterList::iterator iterW = std::find(m_clusterListW.begin(), m_clusterListW.end(), pDeletedCluster);
 
     if (m_clusterListU.end() != iterU)
         m_clusterListU.erase(iterU);
 
     if (m_clusterListV.end() != iterV)
         m_clusterListV.erase(iterV);
 
     if (m_clusterListW.end() != iterW)
         m_clusterListW.erase(iterW);
 
     m_overlapTensor.RemoveCluster(pDeletedCluster);
 }

Friends And Related Function Documentation

template<typename T>

template<typename U >

friend class NViewMatchingAlgorithm

friend

Definition at line 76 of file ThreeViewMatchingControl.h.

template<typename T>

friend class ThreeViewDeltaRayMatchingAlgorithm

friend

Definition at line 73 of file ThreeViewMatchingControl.h.

template<typename T>

friend class ThreeViewTrackFragmentsAlgorithm

friend

ATTN This is for legacy purposes only.

Definition at line 72 of file ThreeViewMatchingControl.h.

Member Data Documentation

template<typename T>

pandora::ClusterList lar_content::ThreeViewMatchingControl< T >::m_clusterListU

private

The selected modified cluster list U.

Definition at line 62 of file ThreeViewMatchingControl.h.

template<typename T>

pandora::ClusterList lar_content::ThreeViewMatchingControl< T >::m_clusterListV

private

The selected modified cluster list V.

Definition at line 63 of file ThreeViewMatchingControl.h.

template<typename T>

pandora::ClusterList lar_content::ThreeViewMatchingControl< T >::m_clusterListW

private

The selected modified cluster list W.

Definition at line 64 of file ThreeViewMatchingControl.h.

template<typename T>

std::string lar_content::ThreeViewMatchingControl< T >::m_inputClusterListNameU

private

The name of the view U cluster list.

Definition at line 68 of file ThreeViewMatchingControl.h.

template<typename T>

std::string lar_content::ThreeViewMatchingControl< T >::m_inputClusterListNameV

private

The name of the view V cluster list.

Definition at line 69 of file ThreeViewMatchingControl.h.

template<typename T>

std::string lar_content::ThreeViewMatchingControl< T >::m_inputClusterListNameW

private

The name of the view W cluster list.

Definition at line 70 of file ThreeViewMatchingControl.h.

template<typename T>

TensorType lar_content::ThreeViewMatchingControl< T >::m_overlapTensor

private

The overlap tensor.

Definition at line 66 of file ThreeViewMatchingControl.h.

template<typename T>

const pandora::ClusterList* lar_content::ThreeViewMatchingControl< T >::m_pInputClusterListU

private

Address of the input cluster list U.

Definition at line 58 of file ThreeViewMatchingControl.h.

template<typename T>

const pandora::ClusterList* lar_content::ThreeViewMatchingControl< T >::m_pInputClusterListV

private

Address of the input cluster list V.

Definition at line 59 of file ThreeViewMatchingControl.h.

template<typename T>

const pandora::ClusterList* lar_content::ThreeViewMatchingControl< T >::m_pInputClusterListW

private

Address of the input cluster list W.

Definition at line 60 of file ThreeViewMatchingControl.h.

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

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

template<typename T> class lar_content::ThreeViewMatchingControl< T >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

template<typename T>
class lar_content::ThreeViewMatchingControl< T >