lar_content::ConnectedRemnantsTool Class Reference

ConnectedRemnantsTool class. More...

#include <ConnectedRemnantsTool.h>

Inheritance diagram for lar_content::ConnectedRemnantsTool:

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

Private Member Functions
pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)
void	FindConnectedShowers (const TensorType &overlapTensor, ProtoParticleVector &protoParticleVector, ClusterMergeMap &clusterMergeMap) const
	Identify candidate particles. More...
void	GetClusters (const TensorType::ElementList &connectedElements, const pandora::ClusterSet &usedClusters, pandora::ClusterVector &clusterVectorU, pandora::ClusterVector &clusterVectorV, pandora::ClusterVector &clusterVectorW) const
	Separate connected clusters into cluster lists by view. More...
void	FillMergeMap (const pandora::Cluster *const pCluster, const pandora::ClusterVector &clusterVector, ClusterMergeMap &clusterMergeMap) const
	Fill map of clusters to be merged. More...
bool	IsConnected (const pandora::ClusterVector &clusterVector) const
	Check whether all clusters in a list are spatially connected. More...

Private Attributes
float	m_maxClusterSeparation

Additional Inherited Members
Public Types inherited from lar_content::RemnantTensorTool
typedef ThreeViewRemnantsAlgorithm::MatchingType::TensorType	TensorType
typedef std::vector < TensorType::ElementList::const_iterator >	IteratorList

Detailed Description

ConnectedRemnantsTool class.

Definition at line 19 of file ConnectedRemnantsTool.h.

Constructor & Destructor Documentation

lar_content::ConnectedRemnantsTool::ConnectedRemnantsTool

(

)

Default constructor.

Definition at line 20 of file ConnectedRemnantsTool.cc.

                                             : m_maxClusterSeparation(10.f)
{
}

Member Function Documentation

void lar_content::ConnectedRemnantsTool::FillMergeMap ( const pandora::Cluster *const  pCluster, const pandora::ClusterVector &  clusterVector, ClusterMergeMap &  clusterMergeMap  ) const

private

Fill map of clusters to be merged.

Parameters

clusterVector	the input vector of clusters
clusterMergeMap	the output map of cluster merges

Definition at line 105 of file ConnectedRemnantsTool.cc.

{
    if (clusterVector.empty())
        throw StatusCodeException(STATUS_CODE_FAILURE);

    for (const Cluster *const pSecondCluster : clusterVector)
    {
        if (pFirstCluster == pSecondCluster)
            continue;

        ClusterList &clusterList(clusterMergeMap[pFirstCluster]);

        if (clusterList.end() == std::find(clusterList.begin(), clusterList.end(), pSecondCluster))
            clusterList.push_back(pSecondCluster);
    }
}

void lar_content::ConnectedRemnantsTool::FindConnectedShowers ( const TensorType &  overlapTensor, ProtoParticleVector &  protoParticleVector, ClusterMergeMap &  clusterMergeMap  ) const

private

Identify candidate particles.

Parameters

overlapTensor	the input overlap tensor
protoParticleVector	the output vector of candidate particles
clusterMergeMap	the output map of clusters to be merged

Definition at line 43 of file ConnectedRemnantsTool.cc.

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

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

        TensorType::ElementList connectedElements;
        overlapTensor.GetConnectedElements(pKeyCluster, true, connectedElements);

        ClusterVector clusterVectorU, clusterVectorV, clusterVectorW;
        this->GetClusters(connectedElements, usedClusters, clusterVectorU, clusterVectorV, clusterVectorW);

        if (clusterVectorU.empty() || clusterVectorV.empty() || clusterVectorW.empty())
            continue;

        usedClusters.insert(clusterVectorU.begin(), clusterVectorU.end());
        usedClusters.insert(clusterVectorV.begin(), clusterVectorV.end());
        usedClusters.insert(clusterVectorW.begin(), clusterVectorW.end());

        if (!(this->IsConnected(clusterVectorU) && this->IsConnected(clusterVectorV) && this->IsConnected(clusterVectorW)))
            continue;

        const Cluster *const pClusterU = clusterVectorU.front();
        const Cluster *const pClusterV = clusterVectorV.front();
        const Cluster *const pClusterW = clusterVectorW.front();

        ProtoParticle protoParticle;
        protoParticle.m_clusterList.push_back(pClusterU);
        protoParticle.m_clusterList.push_back(pClusterV);
        protoParticle.m_clusterList.push_back(pClusterW);
        protoParticleVector.push_back(protoParticle);

        this->FillMergeMap(pClusterU, clusterVectorU, clusterMergeMap);
        this->FillMergeMap(pClusterV, clusterVectorV, clusterMergeMap);
        this->FillMergeMap(pClusterW, clusterVectorW, clusterMergeMap);
    }
}

void lar_content::ConnectedRemnantsTool::GetClusters ( const TensorType::ElementList &  connectedElements, const pandora::ClusterSet &  usedClusters, pandora::ClusterVector &  clusterVectorU, pandora::ClusterVector &  clusterVectorV, pandora::ClusterVector &  clusterVectorW  ) const

private

Separate connected clusters into cluster lists by view.

Parameters

connectedElements	the input list of connected elements
usedClusters	the list of clusters already analysed
clusterVectorU	the output vector of clusters for the U view
clusterVectorV	the output vector of clusters for the V view
clusterVectorW	the output vector of clusters for the W view

Definition at line 89 of file ConnectedRemnantsTool.cc.

{
    for (const TensorType::Element &element : elementList)
    {
        if (usedClusters.count(element.GetClusterU()) || usedClusters.count(element.GetClusterV()) || usedClusters.count(element.GetClusterW()))
            continue;

        clusterVectorU.push_back(element.GetClusterU());
        clusterVectorV.push_back(element.GetClusterV());
        clusterVectorW.push_back(element.GetClusterW());
    }
}

bool lar_content::ConnectedRemnantsTool::IsConnected ( const pandora::ClusterVector &  clusterVector ) const

private

Check whether all clusters in a list are spatially connected.

Parameters

clusterVector

the input cluster vector

Definition at line 124 of file ConnectedRemnantsTool.cc.

{
    for (const Cluster *const pCluster1 : clusterVector)
    {
        for (const Cluster *const pCluster2 : clusterVector)
        {
            if (pCluster1 == pCluster2)
                continue;

            if (LArClusterHelper::GetClosestDistance(pCluster1, pCluster2) > m_maxClusterSeparation)
                return false;
        }
    }

    return true;
}

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

private

Definition at line 143 of file ConnectedRemnantsTool.cc.

{
    PANDORA_RETURN_RESULT_IF_AND_IF(
        STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MaxClusterSeparation", m_maxClusterSeparation));

    return STATUS_CODE_SUCCESS;
}

bool lar_content::ConnectedRemnantsTool::Run ( ThreeViewRemnantsAlgorithm *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::RemnantTensorTool.

Definition at line 26 of file ConnectedRemnantsTool.cc.

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

    ProtoParticleVector protoParticleVector;
    ClusterMergeMap clusterMergeMap;
    this->FindConnectedShowers(overlapTensor, protoParticleVector, clusterMergeMap);

    const bool particlesMade(pAlgorithm->CreateThreeDParticles(protoParticleVector));
    const bool mergesMade(pAlgorithm->MakeClusterMerges(clusterMergeMap));

    return (particlesMade || mergesMade);
}

Member Data Documentation

float lar_content::ConnectedRemnantsTool::m_maxClusterSeparation

private

Definition at line 68 of file ConnectedRemnantsTool.h.

---

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

• ConnectedRemnantsTool.h
• ConnectedRemnantsTool.cc