lar_content::ClearShowersTool Class Reference

ClearShowersTool class. More...

#include "ClearShowersTool.h"

Inheritance diagram for lar_content::ClearShowersTool:

Public Types
typedef ThreeViewShowersAlgorithm::MatchingType::TensorType	TensorType
typedef std::vector< TensorType::ElementList::const_iterator >	IteratorList

Public Member Functions
	ClearShowersTool ()
	Default constructor. More...
bool	Run (ThreeViewShowersAlgorithm *const pAlgorithm, TensorType &overlapTensor)
	Run the algorithm tool. More...

Static Public Member Functions
static bool	HasLargeDirectConnections (IteratorList::const_iterator iIter, const IteratorList &iteratorList)
	Whether a large shower-like element shares clusters with any other long elements. More...
static bool	IsLargerThanDirectConnections (IteratorList::const_iterator iIter, const TensorType::ElementList &elementList, const unsigned int minMatchedSamplingPointRatio, const float minXOverlapSpanRatio, const pandora::ClusterSet &usedClusters)
	Whether a large shower-like element is significantly larger that other elements with which it shares a cluster. More...

Private Member Functions
pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)
void	FindClearShowers (const TensorType &overlapTensor, ProtoParticleVector &protoParticleVector) const
	Find clear shower matches, hidden by simple ambiguities in the tensor. More...
void	SelectLargeShowerElements (const TensorType::ElementList &elementList, const pandora::ClusterSet &usedClusters, IteratorList &iteratorList) const
	Select a list of large shower-like elements from a set of connected tensor elements. More...

Private Attributes
float	m_minMatchedFraction
	The min matched sampling point fraction for particle creation. More...
unsigned int	m_minMatchedSamplingPoints
	The min number of matched sampling points for particle creation. More...
float	m_minXOverlapFraction
	The min x overlap fraction (in each view) for particle creation. More...
unsigned int	m_minMatchedSamplingPointRatio
	The min ratio between 1st and 2nd highest msps for simple ambiguity resolution. More...
float	m_minXOverlapSpanRatio
	The min ratio between 1st and 2nd highest x-overlap spans for simple ambiguity resolution. More...
bool	m_visualize
	Visualize cluster split locations. More...

Detailed Description

ClearShowersTool class.

Definition at line 19 of file ClearShowersTool.h.

Member Typedef Documentation

typedef std::vector<TensorType::ElementList::const_iterator> lar_content::ShowerTensorTool::IteratorList

inherited

Definition at line 175 of file ThreeViewShowersAlgorithm.h.

typedef ThreeViewShowersAlgorithm::MatchingType::TensorType lar_content::ShowerTensorTool::TensorType

inherited

Definition at line 174 of file ThreeViewShowersAlgorithm.h.

Constructor & Destructor Documentation

lar_content::ClearShowersTool::ClearShowersTool

(

)

Default constructor.

Definition at line 18 of file ClearShowersTool.cc.

                                   :
    m_minMatchedFraction(0.2f),
    m_minMatchedSamplingPoints(40),
    m_minXOverlapFraction(0.5f),
    m_minMatchedSamplingPointRatio(3),
    m_minXOverlapSpanRatio(3.f),
    m_visualize(false)
{
}

Member Function Documentation

void lar_content::ClearShowersTool::FindClearShowers ( const TensorType &  overlapTensor, ProtoParticleVector &  protoParticleVector  ) const

private

Find clear shower matches, hidden by simple ambiguities in the tensor.

Parameters

overlapTensor	the overlap tensor
protoParticleVector	to receive the list of proto particles

Definition at line 91 of file ClearShowersTool.cc.

References lar_content::OverlapTensor< T >::GetConnectedElements(), lar_content::OverlapTensor< T >::GetSortedKeyClusters(), HasLargeDirectConnections(), IsLargerThanDirectConnections(), lar_content::ProtoParticle::m_clusterList, m_minMatchedSamplingPointRatio, m_minXOverlapSpanRatio, m_visualize, and SelectLargeShowerElements().

Referenced by Run().

{
    ClusterSet usedClusters;
    ClusterVector sortedKeyClusters;
    overlapTensor.GetSortedKeyClusters(sortedKeyClusters);

    for (const Cluster *const pKeyCluster : sortedKeyClusters)
    {
        if (!pKeyCluster->IsAvailable())
            continue;

        unsigned int nU(0), nV(0), nW(0);
        TensorType::ElementList elementList;
        overlapTensor.GetConnectedElements(pKeyCluster, true, elementList, nU, nV, nW);

        IteratorList iteratorList;
        this->SelectLargeShowerElements(elementList, usedClusters, iteratorList);

        // Check that elements are not directly connected and are significantly longer than any other directly connected elements
        for (IteratorList::const_iterator iIter = iteratorList.begin(), iIterEnd = iteratorList.end(); iIter != iIterEnd; ++iIter)
        {
            if (ClearShowersTool::HasLargeDirectConnections(iIter, iteratorList))
                continue;

            if (!ClearShowersTool::IsLargerThanDirectConnections(iIter, elementList, m_minMatchedSamplingPointRatio, m_minXOverlapSpanRatio, usedClusters))
                continue;

            if (m_visualize)
            {
                ClusterList clusterList{(*iIter)->GetClusterU(), (*iIter)->GetClusterV(), (*iIter)->GetClusterW()};
                PANDORA_MONITORING_API(VisualizeClusters(this->GetPandora(), &clusterList, "Selected", BLUE));
                PANDORA_MONITORING_API(ViewEvent(this->GetPandora()));
            }

            ProtoParticle protoParticle;
            protoParticle.m_clusterList.push_back((*iIter)->GetClusterU());
            protoParticle.m_clusterList.push_back((*iIter)->GetClusterV());
            protoParticle.m_clusterList.push_back((*iIter)->GetClusterW());
            protoParticleVector.push_back(protoParticle);

            usedClusters.insert((*iIter)->GetClusterU());
            usedClusters.insert((*iIter)->GetClusterV());
            usedClusters.insert((*iIter)->GetClusterW());
        }
    }
}

bool lar_content::ClearShowersTool::HasLargeDirectConnections ( IteratorList::const_iterator  iIter, const IteratorList &  iteratorList  )

static

Whether a large shower-like element shares clusters with any other long elements.

Parameters

iIter	specifies the large element under consideration
iteratorList	list of iterators to other large elements

Returns

boolean

Definition at line 30 of file ClearShowersTool.cc.

Referenced by FindClearShowers().

{
    for (IteratorList::const_iterator iIter2 = iteratorList.begin(), iIter2End = iteratorList.end(); iIter2 != iIter2End; ++iIter2)
    {
        if (iIter == iIter2)
            continue;

        if (((*iIter)->GetClusterU() == (*iIter2)->GetClusterU()) || ((*iIter)->GetClusterV() == (*iIter2)->GetClusterV()) ||
            ((*iIter)->GetClusterW() == (*iIter2)->GetClusterW()))
            return true;
    }

    return false;
}

bool lar_content::ClearShowersTool::IsLargerThanDirectConnections ( IteratorList::const_iterator  iIter, const TensorType::ElementList &  elementList, const unsigned int  minMatchedSamplingPointRatio, const float  minXOverlapSpanRatio, const pandora::ClusterSet &  usedClusters  )

static

Whether a large shower-like element is significantly larger that other elements with which it shares a cluster.

Parameters

iIter	specifies the large element under consideration
elementList	the full list of connected tensor elements
minMatchedSamplingPointRatio	the min ratio between 1st and 2nd highest msps for simple ambiguity resolution
minMatchedSamplingPointRatio	the min ratio between 1st and 2nd highest x-overlap spans for simple ambiguity resolution
usedClusters	the list of clusters already marked as to be added to a pfo

Definition at line 47 of file ClearShowersTool.cc.

Referenced by FindClearShowers().

{
    const unsigned int nMatchedSamplingPoints((*iIter)->GetOverlapResult().GetNMatchedSamplingPoints());
    const unsigned int xOverlapSpan((*iIter)->GetOverlapResult().GetXOverlap().GetXOverlapSpan());

    for (TensorType::ElementList::const_iterator eIter = elementList.begin(); eIter != elementList.end(); ++eIter)
    {
        if ((*iIter) == eIter)
            continue;

        if (usedClusters.count(eIter->GetClusterU()) || usedClusters.count(eIter->GetClusterV()) || usedClusters.count(eIter->GetClusterW()))
            continue;

        if (((*iIter)->GetClusterU() != eIter->GetClusterU()) && ((*iIter)->GetClusterV() != eIter->GetClusterV()) &&
            ((*iIter)->GetClusterW() != eIter->GetClusterW()))
            continue;

        if (nMatchedSamplingPoints < minMatchedSamplingPointRatio * eIter->GetOverlapResult().GetNMatchedSamplingPoints())
            return false;

        if (xOverlapSpan < minXOverlapSpanRatio * eIter->GetOverlapResult().GetXOverlap().GetXOverlapSpan())
            return false;
    }

    return true;
}

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

private

Definition at line 180 of file ClearShowersTool.cc.

References m_minMatchedFraction, m_minMatchedSamplingPointRatio, m_minMatchedSamplingPoints, m_minXOverlapFraction, m_minXOverlapSpanRatio, and m_visualize.

{
    PANDORA_RETURN_RESULT_IF_AND_IF(
        STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinMatchedFraction", m_minMatchedFraction));

    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
        XmlHelper::ReadValue(xmlHandle, "MinMatchedSamplingPoints", m_minMatchedSamplingPoints));

    PANDORA_RETURN_RESULT_IF_AND_IF(
        STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinXOverlapFraction", m_minXOverlapFraction));

    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
        XmlHelper::ReadValue(xmlHandle, "MinMatchedSamplingPointRatio", m_minMatchedSamplingPointRatio));

    PANDORA_RETURN_RESULT_IF_AND_IF(
        STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinXOverlapSpanRatio", m_minXOverlapSpanRatio));

    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "Visualize", m_visualize));

    return STATUS_CODE_SUCCESS;
}

bool lar_content::ClearShowersTool::Run ( ThreeViewShowersAlgorithm *const  pAlgorithm, TensorType &  overlapTensor  )

virtual

Run the algorithm tool.

Parameters

pAlgorithm	address of the calling algorithm
overlapTensor	the overlap tensor

Returns

whether changes have been made by the tool

Implements lar_content::ShowerTensorTool.

Definition at line 77 of file ClearShowersTool.cc.

References lar_content::MatchingBaseAlgorithm::CreateThreeDParticles(), and FindClearShowers().

{
    if (PandoraContentApi::GetSettings(*pAlgorithm)->ShouldDisplayAlgorithmInfo())
        std::cout << "----> Running Algorithm Tool: " << this->GetInstanceName() << ", " << this->GetType() << std::endl;

    ProtoParticleVector protoParticleVector;
    this->FindClearShowers(overlapTensor, protoParticleVector);

    const bool particlesMade(pAlgorithm->CreateThreeDParticles(protoParticleVector));
    return particlesMade;
}

void lar_content::ClearShowersTool::SelectLargeShowerElements ( const TensorType::ElementList &  elementList, const pandora::ClusterSet &  usedClusters, IteratorList &  iteratorList  ) const

private

Select a list of large shower-like elements from a set of connected tensor elements.

Parameters

elementList	the full list of connected tensor elements
usedClusters	the list of clusters already marked as to be added to a pfo
iteratorList	to receive a list of iterators to large shower-like elements

Definition at line 140 of file ClearShowersTool.cc.

References m_minMatchedFraction, m_minMatchedSamplingPoints, m_minXOverlapFraction, and m_visualize.

Referenced by FindClearShowers().

{
    for (TensorType::ElementList::const_iterator eIter = elementList.begin(); eIter != elementList.end(); ++eIter)
    {
        if (m_visualize)
        {
            ClusterList clusterList{eIter->GetClusterU(), eIter->GetClusterV(), eIter->GetClusterW()};
            PANDORA_MONITORING_API(VisualizeClusters(this->GetPandora(), &clusterList, "Considered", RED));
            PANDORA_MONITORING_API(ViewEvent(this->GetPandora()));
        }

        if (usedClusters.count(eIter->GetClusterU()) || usedClusters.count(eIter->GetClusterV()) || usedClusters.count(eIter->GetClusterW()))
            continue;

        if (eIter->GetOverlapResult().GetMatchedFraction() < m_minMatchedFraction)
            continue;

        if (eIter->GetOverlapResult().GetNMatchedSamplingPoints() < m_minMatchedSamplingPoints)
            continue;

        const XOverlap &xOverlap(eIter->GetOverlapResult().GetXOverlap());

        if ((xOverlap.GetXSpanU() > std::numeric_limits<float>::epsilon()) && (xOverlap.GetXOverlapSpan() / xOverlap.GetXSpanU() > m_minXOverlapFraction) &&
            (xOverlap.GetXSpanV() > std::numeric_limits<float>::epsilon()) && (xOverlap.GetXOverlapSpan() / xOverlap.GetXSpanV() > m_minXOverlapFraction) &&
            (xOverlap.GetXSpanW() > std::numeric_limits<float>::epsilon()) && (xOverlap.GetXOverlapSpan() / xOverlap.GetXSpanW() > m_minXOverlapFraction))
        {
            iteratorList.push_back(eIter);
            if (m_visualize)
            {
                ClusterList clusterList{eIter->GetClusterU(), eIter->GetClusterV(), eIter->GetClusterW()};
                PANDORA_MONITORING_API(VisualizeClusters(this->GetPandora(), &clusterList, "Large", GREEN));
                PANDORA_MONITORING_API(ViewEvent(this->GetPandora()));
            }
        }
    }
}

Member Data Documentation

float lar_content::ClearShowersTool::m_minMatchedFraction

private

The min matched sampling point fraction for particle creation.

Definition at line 71 of file ClearShowersTool.h.

Referenced by ReadSettings(), and SelectLargeShowerElements().

unsigned int lar_content::ClearShowersTool::m_minMatchedSamplingPointRatio

private

The min ratio between 1st and 2nd highest msps for simple ambiguity resolution.

Definition at line 74 of file ClearShowersTool.h.

Referenced by FindClearShowers(), and ReadSettings().

unsigned int lar_content::ClearShowersTool::m_minMatchedSamplingPoints

private

The min number of matched sampling points for particle creation.

Definition at line 72 of file ClearShowersTool.h.

Referenced by ReadSettings(), and SelectLargeShowerElements().

float lar_content::ClearShowersTool::m_minXOverlapFraction

private

The min x overlap fraction (in each view) for particle creation.

Definition at line 73 of file ClearShowersTool.h.

Referenced by ReadSettings(), and SelectLargeShowerElements().

float lar_content::ClearShowersTool::m_minXOverlapSpanRatio

private

The min ratio between 1st and 2nd highest x-overlap spans for simple ambiguity resolution.

Definition at line 75 of file ClearShowersTool.h.

Referenced by FindClearShowers(), and ReadSettings().

bool lar_content::ClearShowersTool::m_visualize

private

Visualize cluster split locations.

Definition at line 76 of file ClearShowersTool.h.

Referenced by FindClearShowers(), ReadSettings(), and SelectLargeShowerElements().

---

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

• larpandoracontent/v04_08_01/source/larpandoracontent/LArThreeDReco/LArShowerMatching/ClearShowersTool.h
• larpandoracontent/v04_08_01/source/larpandoracontent/LArThreeDReco/LArShowerMatching/ClearShowersTool.cc