lar_content::TwoViewMatchingControl< T > Class Template Reference

TwoViewMatchingControl class. More...

#include "TwoViewMatchingControl.h"

Inheritance diagram for lar_content::TwoViewMatchingControl< T >:

Public Types
typedef OverlapMatrix< T >	MatrixType

Public Member Functions
	TwoViewMatchingControl (MatchingBaseAlgorithm *const pAlgorithm)
	Constructor. More...
virtual	~TwoViewMatchingControl ()
	Destructor. More...
MatrixType &	GetOverlapMatrix ()
	Get the overlap matrix. More...
unsigned int	GetHitTypeIndex (const pandora::HitType hitType)
	Get the index of an input hit type returning 0 if not found in map. More...

Protected Attributes
MatchingBaseAlgorithm *	m_pAlgorithm
	The address of the matching base algorithm. More...

Private Types
typedef std::unordered_map< pandora::HitType, unsigned int, std::hash< int > >	HitTypeToIndexMap

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_pInputClusterList1
	Address of the input cluster list 1. More...
const pandora::ClusterList *	m_pInputClusterList2
	Address of the input cluster list 2. More...
pandora::ClusterList	m_clusterList1
	The selected modified cluster list 1. More...
pandora::ClusterList	m_clusterList2
	The selected modified cluster list 2. More...
MatrixType	m_overlapMatrix
	The overlap matrix. More...
HitTypeToIndexMap	m_hitTypeToIndexMap
	The hit type to index map. More...
std::string	m_inputClusterListName1
	The name of the view 1 cluster list. More...
std::string	m_inputClusterListName2
	The name of the view 2 cluster list. More...

Friends
template<typename U >
class	NViewMatchingAlgorithm

Detailed Description

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

TwoViewMatchingControl class.

Definition at line 24 of file TwoViewMatchingControl.h.

Member Typedef Documentation

template<typename T>

typedef std::unordered_map<pandora::HitType, unsigned int, std::hash<int> > lar_content::TwoViewMatchingControl< T >::HitTypeToIndexMap

private

Definition at line 75 of file TwoViewMatchingControl.h.

template<typename T>

typedef OverlapMatrix<T> lar_content::TwoViewMatchingControl< T >::MatrixType

Definition at line 27 of file TwoViewMatchingControl.h.

Constructor & Destructor Documentation

template<typename T >

lar_content::TwoViewMatchingControl< T >::TwoViewMatchingControl

(

MatchingBaseAlgorithm *const

pAlgorithm

)

Constructor.

Parameters

pAlgorithm

address of the matching base algorithm

Definition at line 24 of file TwoViewMatchingControl.cc.

                                                                                         :
    NViewMatchingControl(pAlgorithm),
    m_pInputClusterList1(nullptr),
    m_pInputClusterList2(nullptr)
{
}

template<typename T >

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

virtual

Destructor.

Definition at line 34 of file TwoViewMatchingControl.cc.

{
}

Member Function Documentation

template<typename T>

const std::string & lar_content::TwoViewMatchingControl< 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 115 of file TwoViewMatchingControl.cc.

References lar_content::TwoViewMatchingControl< T >::m_hitTypeToIndexMap, lar_content::TwoViewMatchingControl< T >::m_inputClusterListName1, and lar_content::TwoViewMatchingControl< T >::m_inputClusterListName2.

{
    HitTypeToIndexMap::const_iterator iter = m_hitTypeToIndexMap.find(hitType);
    if (m_hitTypeToIndexMap.end() == iter)
        throw StatusCodeException(STATUS_CODE_INVALID_PARAMETER);

    if ((1 != iter->second) && (2 != iter->second))
        throw StatusCodeException(STATUS_CODE_FAILURE);

    return ((1 == iter->second) ? m_inputClusterListName1 : m_inputClusterListName2);
}

template<typename T >

unsigned int lar_content::TwoViewMatchingControl< T >::GetHitTypeIndex

(

const pandora::HitType

hitType

)

Get the index of an input hit type returning 0 if not found in map.

Returns

the hit type index

Definition at line 49 of file TwoViewMatchingControl.cc.

References lar_content::TwoViewMatchingControl< T >::m_hitTypeToIndexMap.

{
    HitTypeToIndexMap::const_iterator iter = m_hitTypeToIndexMap.find(hitType);

    if ((iter != m_hitTypeToIndexMap.end()) && (iter->second != 1) && (iter->second != 2))
        throw StatusCodeException(STATUS_CODE_FAILURE);

    return iter == m_hitTypeToIndexMap.end() ? 0 : iter->second;
}

template<typename T>

const pandora::ClusterList & lar_content::TwoViewMatchingControl< 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 130 of file TwoViewMatchingControl.cc.

References lar_content::TwoViewMatchingControl< T >::m_hitTypeToIndexMap, lar_content::TwoViewMatchingControl< T >::m_pInputClusterList1, and lar_content::TwoViewMatchingControl< T >::m_pInputClusterList2.

{
    HitTypeToIndexMap::const_iterator iter = m_hitTypeToIndexMap.find(hitType);
    if (m_hitTypeToIndexMap.end() == iter)
        throw StatusCodeException(STATUS_CODE_NOT_INITIALIZED);

    if ((1 == iter->second) && m_pInputClusterList1)
        return (*m_pInputClusterList1);

    if ((2 == iter->second) && m_pInputClusterList2)
        return (*m_pInputClusterList2);

    throw pandora::StatusCodeException(pandora::STATUS_CODE_NOT_INITIALIZED);
}

template<typename T >

TwoViewMatchingControl< T >::MatrixType & lar_content::TwoViewMatchingControl< T >::GetOverlapMatrix

(

)

Get the overlap matrix.

Returns

the overlap matrix

Definition at line 41 of file TwoViewMatchingControl.cc.

References lar_content::TwoViewMatchingControl< T >::m_overlapMatrix.

Referenced by lar_content::TwoViewDeltaRayMatchingAlgorithm::DoesClusterPassTensorThreshold(), and lar_content::TwoViewTransverseTracksAlgorithm::TwoViewTransverseTracksAlgorithm().

{
    return m_overlapMatrix;
}

template<typename T>

const pandora::ClusterList & lar_content::TwoViewMatchingControl< 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 148 of file TwoViewMatchingControl.cc.

References lar_content::TwoViewMatchingControl< T >::m_clusterList1, lar_content::TwoViewMatchingControl< T >::m_clusterList2, and lar_content::TwoViewMatchingControl< T >::m_hitTypeToIndexMap.

{
    HitTypeToIndexMap::const_iterator iter = m_hitTypeToIndexMap.find(hitType);
    if (m_hitTypeToIndexMap.end() == iter)
        throw StatusCodeException(STATUS_CODE_INVALID_PARAMETER);

    if ((1 != iter->second) && (2 != iter->second))
        throw StatusCodeException(STATUS_CODE_FAILURE);

    return ((1 == iter->second) ? m_clusterList1 : m_clusterList2);
}

template<typename T >

void lar_content::TwoViewMatchingControl< 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 215 of file TwoViewMatchingControl.cc.

References lar_content::MatchingBaseAlgorithm::CalculateOverlapResult(), lar_content::TwoViewMatchingControl< T >::m_clusterList1, lar_content::TwoViewMatchingControl< T >::m_clusterList2, lar_content::NViewMatchingControl::m_pAlgorithm, and lar_content::LArClusterHelper::SortByNHits().

{
    ClusterVector clusterVector1(m_clusterList1.begin(), m_clusterList1.end());
    ClusterVector clusterVector2(m_clusterList2.begin(), m_clusterList2.end());
    std::sort(clusterVector1.begin(), clusterVector1.end(), LArClusterHelper::SortByNHits);
    std::sort(clusterVector2.begin(), clusterVector2.end(), LArClusterHelper::SortByNHits);

    for (const Cluster *const pCluster1 : clusterVector1)
    {
        for (const Cluster *const pCluster2 : clusterVector2)
            m_pAlgorithm->CalculateOverlapResult(pCluster1, pCluster2);
    }
}

template<typename T >

void lar_content::TwoViewMatchingControl< 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 191 of file TwoViewMatchingControl.cc.

References lar_content::TwoViewMatchingControl< T >::m_clusterList1, lar_content::TwoViewMatchingControl< T >::m_clusterList2, lar_content::NViewMatchingControl::m_pAlgorithm, and lar_content::MatchingBaseAlgorithm::PrepareInputClusters().

{
    m_pAlgorithm->PrepareInputClusters(m_clusterList1);
    m_pAlgorithm->PrepareInputClusters(m_clusterList2);
}

template<typename T>

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

privatevirtual

Read settings from xml.

Parameters

xmlHandle

the xml handle

Implements lar_content::NViewMatchingControl.

Definition at line 232 of file TwoViewMatchingControl.cc.

References lar_content::TwoViewMatchingControl< T >::m_inputClusterListName1, and lar_content::TwoViewMatchingControl< T >::m_inputClusterListName2.

{
    PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "InputClusterListName1", m_inputClusterListName1));
    PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "InputClusterListName2", m_inputClusterListName2));

    return STATUS_CODE_SUCCESS;
}

template<typename T >

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

privatevirtual

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

Implements lar_content::NViewMatchingControl.

Definition at line 163 of file TwoViewMatchingControl.cc.

References lar_content::LArClusterHelper::GetClusterHitType(), lar_content::TwoViewMatchingControl< T >::m_clusterList1, lar_content::TwoViewMatchingControl< T >::m_clusterList2, lar_content::TwoViewMatchingControl< T >::m_hitTypeToIndexMap, lar_content::TwoViewMatchingControl< T >::m_inputClusterListName1, lar_content::TwoViewMatchingControl< T >::m_inputClusterListName2, lar_content::NViewMatchingControl::m_pAlgorithm, lar_content::TwoViewMatchingControl< T >::m_pInputClusterList1, lar_content::TwoViewMatchingControl< T >::m_pInputClusterList2, and lar_content::MatchingBaseAlgorithm::SelectInputClusters().

{
    PANDORA_THROW_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_INITIALIZED, !=,
        PandoraContentApi::GetList(*m_pAlgorithm, m_inputClusterListName1, m_pInputClusterList1));
    PANDORA_THROW_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_INITIALIZED, !=,
        PandoraContentApi::GetList(*m_pAlgorithm, m_inputClusterListName2, m_pInputClusterList2));

    if (!m_pInputClusterList1 || !m_pInputClusterList2)
    {
        if (PandoraContentApi::GetSettings(*m_pAlgorithm)->ShouldDisplayAlgorithmInfo())
            std::cout << "TwoViewMatchingControl: one or more input cluster lists unavailable." << std::endl;

        throw StatusCodeException(STATUS_CODE_SUCCESS);
    }

    if (!m_pInputClusterList1->empty())
        m_hitTypeToIndexMap.insert(HitTypeToIndexMap::value_type(LArClusterHelper::GetClusterHitType(m_pInputClusterList1->front()), 1));

    if (!m_pInputClusterList2->empty())
        m_hitTypeToIndexMap.insert(HitTypeToIndexMap::value_type(LArClusterHelper::GetClusterHitType(m_pInputClusterList2->front()), 2));

    m_pAlgorithm->SelectInputClusters(m_pInputClusterList1, m_clusterList1);
    m_pAlgorithm->SelectInputClusters(m_pInputClusterList2, m_clusterList2);
}

template<typename T >

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

privatevirtual

Tidy member variables.

Implements lar_content::NViewMatchingControl.

Definition at line 200 of file TwoViewMatchingControl.cc.

References lar_content::OverlapMatrix< T >::Clear(), lar_content::TwoViewMatchingControl< T >::m_clusterList1, lar_content::TwoViewMatchingControl< T >::m_clusterList2, lar_content::TwoViewMatchingControl< T >::m_hitTypeToIndexMap, lar_content::TwoViewMatchingControl< T >::m_overlapMatrix, lar_content::TwoViewMatchingControl< T >::m_pInputClusterList1, and lar_content::TwoViewMatchingControl< T >::m_pInputClusterList2.

{
    m_overlapMatrix.Clear();
    m_hitTypeToIndexMap.clear();

    m_pInputClusterList1 = nullptr;
    m_pInputClusterList2 = nullptr;

    m_clusterList1.clear();
    m_clusterList2.clear();
}

template<typename T>

void lar_content::TwoViewMatchingControl< 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 62 of file TwoViewMatchingControl.cc.

References lar_content::MatchingBaseAlgorithm::CalculateOverlapResult(), lar_content::LArClusterHelper::GetClusterHitType(), lar_content::TwoViewMatchingControl< T >::m_clusterList1, lar_content::TwoViewMatchingControl< T >::m_clusterList2, lar_content::TwoViewMatchingControl< T >::m_hitTypeToIndexMap, lar_content::NViewMatchingControl::m_pAlgorithm, and lar_content::LArClusterHelper::SortByNHits().

{
    const HitType hitType(LArClusterHelper::GetClusterHitType(pNewCluster));
    HitTypeToIndexMap::const_iterator iter = m_hitTypeToIndexMap.find(hitType);

    if ((m_hitTypeToIndexMap.end() == iter) || ((1 != iter->second) && (2 != iter->second)))
        throw StatusCodeException(STATUS_CODE_FAILURE);

    ClusterList &clusterList((1 == iter->second) ? m_clusterList1 : m_clusterList2);

    if (clusterList.end() != std::find(clusterList.begin(), clusterList.end(), pNewCluster))
        throw StatusCodeException(STATUS_CODE_ALREADY_PRESENT);

    clusterList.push_back(pNewCluster);

    const ClusterList &clusterList2((1 == iter->second) ? m_clusterList2 : m_clusterList1);

    ClusterVector clusterVector2(clusterList2.begin(), clusterList2.end());
    std::sort(clusterVector2.begin(), clusterVector2.end(), LArClusterHelper::SortByNHits);

    for (const Cluster *const pCluster2 : clusterVector2)
    {
        if (1 == iter->second)
        {
            m_pAlgorithm->CalculateOverlapResult(pNewCluster, pCluster2);
        }
        else
        {
            m_pAlgorithm->CalculateOverlapResult(pCluster2, pNewCluster);
        }
    }
}

template<typename T>

void lar_content::TwoViewMatchingControl< 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 98 of file TwoViewMatchingControl.cc.

References lar_content::TwoViewMatchingControl< T >::m_clusterList1, lar_content::TwoViewMatchingControl< T >::m_clusterList2, lar_content::TwoViewMatchingControl< T >::m_overlapMatrix, and lar_content::OverlapMatrix< T >::RemoveCluster().

{
    ClusterList::iterator iter1 = std::find(m_clusterList1.begin(), m_clusterList1.end(), pDeletedCluster);
    ClusterList::iterator iter2 = std::find(m_clusterList2.begin(), m_clusterList2.end(), pDeletedCluster);

    if (m_clusterList1.end() != iter1)
        m_clusterList1.erase(iter1);

    if (m_clusterList2.end() != iter2)
        m_clusterList2.erase(iter2);

    m_overlapMatrix.RemoveCluster(pDeletedCluster);
}

Friends And Related Function Documentation

template<typename T>

template<typename U >

friend class NViewMatchingAlgorithm

friend

Definition at line 82 of file TwoViewMatchingControl.h.

Member Data Documentation

template<typename T>

pandora::ClusterList lar_content::TwoViewMatchingControl< T >::m_clusterList1

private

The selected modified cluster list 1.

Definition at line 70 of file TwoViewMatchingControl.h.

Referenced by lar_content::TwoViewMatchingControl< T >::GetSelectedClusterList(), lar_content::TwoViewMatchingControl< T >::PerformMainLoop(), lar_content::TwoViewMatchingControl< T >::PrepareAllInputClusters(), lar_content::TwoViewMatchingControl< T >::SelectAllInputClusters(), lar_content::TwoViewMatchingControl< T >::TidyUp(), lar_content::TwoViewMatchingControl< T >::UpdateForNewCluster(), and lar_content::TwoViewMatchingControl< T >::UpdateUponDeletion().

template<typename T>

pandora::ClusterList lar_content::TwoViewMatchingControl< T >::m_clusterList2

private

The selected modified cluster list 2.

Definition at line 71 of file TwoViewMatchingControl.h.

Referenced by lar_content::TwoViewMatchingControl< T >::GetSelectedClusterList(), lar_content::TwoViewMatchingControl< T >::PerformMainLoop(), lar_content::TwoViewMatchingControl< T >::PrepareAllInputClusters(), lar_content::TwoViewMatchingControl< T >::SelectAllInputClusters(), lar_content::TwoViewMatchingControl< T >::TidyUp(), lar_content::TwoViewMatchingControl< T >::UpdateForNewCluster(), and lar_content::TwoViewMatchingControl< T >::UpdateUponDeletion().

template<typename T>

HitTypeToIndexMap lar_content::TwoViewMatchingControl< T >::m_hitTypeToIndexMap

private

The hit type to index map.

Definition at line 76 of file TwoViewMatchingControl.h.

Referenced by lar_content::TwoViewMatchingControl< T >::GetClusterListName(), lar_content::TwoViewMatchingControl< T >::GetHitTypeIndex(), lar_content::TwoViewMatchingControl< T >::GetInputClusterList(), lar_content::TwoViewMatchingControl< T >::GetSelectedClusterList(), lar_content::TwoViewMatchingControl< T >::SelectAllInputClusters(), lar_content::TwoViewMatchingControl< T >::TidyUp(), and lar_content::TwoViewMatchingControl< T >::UpdateForNewCluster().

template<typename T>

std::string lar_content::TwoViewMatchingControl< T >::m_inputClusterListName1

private

The name of the view 1 cluster list.

Definition at line 78 of file TwoViewMatchingControl.h.

Referenced by lar_content::TwoViewMatchingControl< T >::GetClusterListName(), lar_content::TwoViewMatchingControl< T >::ReadSettings(), and lar_content::TwoViewMatchingControl< T >::SelectAllInputClusters().

template<typename T>

std::string lar_content::TwoViewMatchingControl< T >::m_inputClusterListName2

private

The name of the view 2 cluster list.

Definition at line 79 of file TwoViewMatchingControl.h.

Referenced by lar_content::TwoViewMatchingControl< T >::GetClusterListName(), lar_content::TwoViewMatchingControl< T >::ReadSettings(), and lar_content::TwoViewMatchingControl< T >::SelectAllInputClusters().

template<typename T>

MatrixType lar_content::TwoViewMatchingControl< T >::m_overlapMatrix

private

The overlap matrix.

Definition at line 73 of file TwoViewMatchingControl.h.

Referenced by lar_content::TwoViewMatchingControl< T >::GetOverlapMatrix(), lar_content::TwoViewMatchingControl< T >::TidyUp(), and lar_content::TwoViewMatchingControl< T >::UpdateUponDeletion().

MatchingBaseAlgorithm* lar_content::NViewMatchingControl::m_pAlgorithm

protectedinherited

The address of the matching base algorithm.

Definition at line 105 of file NViewMatchingControl.h.

Referenced by lar_content::ThreeViewMatchingControl< T >::PerformMainLoop(), lar_content::TwoViewMatchingControl< T >::PerformMainLoop(), lar_content::ThreeViewMatchingControl< T >::PrepareAllInputClusters(), lar_content::TwoViewMatchingControl< T >::PrepareAllInputClusters(), lar_content::ThreeViewMatchingControl< T >::SelectAllInputClusters(), lar_content::TwoViewMatchingControl< T >::SelectAllInputClusters(), lar_content::ThreeViewMatchingControl< T >::UpdateForNewCluster(), and lar_content::TwoViewMatchingControl< T >::UpdateForNewCluster().

template<typename T>

const pandora::ClusterList* lar_content::TwoViewMatchingControl< T >::m_pInputClusterList1

private

Address of the input cluster list 1.

Definition at line 67 of file TwoViewMatchingControl.h.

Referenced by lar_content::TwoViewMatchingControl< T >::GetInputClusterList(), lar_content::TwoViewMatchingControl< T >::SelectAllInputClusters(), and lar_content::TwoViewMatchingControl< T >::TidyUp().

template<typename T>

const pandora::ClusterList* lar_content::TwoViewMatchingControl< T >::m_pInputClusterList2

private

Address of the input cluster list 2.

Definition at line 68 of file TwoViewMatchingControl.h.

Referenced by lar_content::TwoViewMatchingControl< T >::GetInputClusterList(), lar_content::TwoViewMatchingControl< T >::SelectAllInputClusters(), and lar_content::TwoViewMatchingControl< T >::TidyUp().

---

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

• larpandoracontent/v04_08_01/source/larpandoracontent/LArThreeDReco/LArThreeDBase/TwoViewMatchingControl.h
• larpandoracontent/v04_08_01/source/larpandoracontent/LArThreeDReco/LArThreeDBase/TwoViewMatchingControl.cc