lar_content::SimpleShowersTool Class Reference

SimpleShowersTool class. More...

#include "SimpleShowersTool.h"

Inheritance diagram for lar_content::SimpleShowersTool:

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

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

Private Member Functions
void	FindBestShower (const TensorType &overlapTensor, ProtoParticleVector &protoParticleVector) const
	Find best shower match as a simple way to (try to) resolve ambiguities in the tensor. More...
bool	PassesElementCuts (TensorType::ElementList::const_iterator eIter) const
	Whether a provided (iterator to a) tensor element passes the selection cuts for particle creation. More...
pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)

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

Detailed Description

SimpleShowersTool class.

Definition at line 19 of file SimpleShowersTool.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::SimpleShowersTool::SimpleShowersTool

(

)

Default constructor.

Definition at line 18 of file SimpleShowersTool.cc.

                                     :
    m_minMatchedFraction(0.2f),
    m_minMatchedSamplingPoints(40),
    m_minXOverlapFraction(0.5f)
{
}

Member Function Documentation

void lar_content::SimpleShowersTool::FindBestShower ( const TensorType &  overlapTensor, ProtoParticleVector &  protoParticleVector  ) const

private

Find best shower match as a simple way to (try to) resolve ambiguities in the tensor.

Parameters

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

Definition at line 41 of file SimpleShowersTool.cc.

References lar_content::OverlapTensor< T >::GetConnectedElements(), lar_content::OverlapTensor< T >::GetSortedKeyClusters(), and lar_content::ProtoParticle::m_clusterList.

Referenced by Run().

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

        if (elementList.empty())
            continue;

        TensorType::Element bestElement(elementList.back());

        if (!bestElement.GetOverlapResult().IsInitialized())
            continue;

        if ((NULL == bestElement.GetClusterU()) || (NULL == bestElement.GetClusterV()) || (NULL == bestElement.GetClusterW()))
            continue;

        ProtoParticle protoParticle;
        protoParticle.m_clusterList.push_back(bestElement.GetClusterU());
        protoParticle.m_clusterList.push_back(bestElement.GetClusterV());
        protoParticle.m_clusterList.push_back(bestElement.GetClusterW());
        protoParticleVector.push_back(protoParticle);

        return;
    }
}

bool lar_content::SimpleShowersTool::PassesElementCuts ( TensorType::ElementList::const_iterator  eIter ) const

private

Whether a provided (iterator to a) tensor element passes the selection cuts for particle creation.

Parameters

eIter

the iterator to the tensor element

Definition at line 78 of file SimpleShowersTool.cc.

References m_minMatchedFraction, m_minMatchedSamplingPoints, and m_minXOverlapFraction.

{
    if (eIter->GetOverlapResult().GetMatchedFraction() < m_minMatchedFraction)
        return false;

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

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

    return false;
}

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

private

Definition at line 100 of file SimpleShowersTool.cc.

References m_minMatchedFraction, m_minMatchedSamplingPoints, and m_minXOverlapFraction.

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

    return STATUS_CODE_SUCCESS;
}

bool lar_content::SimpleShowersTool::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 27 of file SimpleShowersTool.cc.

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

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

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

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

Member Data Documentation

float lar_content::SimpleShowersTool::m_minMatchedFraction

private

The min matched sampling point fraction for particle creation.

Definition at line 47 of file SimpleShowersTool.h.

Referenced by PassesElementCuts(), and ReadSettings().

unsigned int lar_content::SimpleShowersTool::m_minMatchedSamplingPoints

private

The min number of matched sampling points for particle creation.

Definition at line 48 of file SimpleShowersTool.h.

Referenced by PassesElementCuts(), and ReadSettings().

float lar_content::SimpleShowersTool::m_minXOverlapFraction

private

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

Definition at line 49 of file SimpleShowersTool.h.

Referenced by PassesElementCuts(), and ReadSettings().

---

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

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