lar_content::MopUpRemnantsTool Class Reference

MopUpRemnantsTool class. More...

#include "MopUpRemnantsTool.h"

Inheritance diagram for lar_content::MopUpRemnantsTool:

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

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

Private Member Functions
pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)
void	FindBestShowers (const TensorType &overlapTensor, ProtoParticleVector &protoParticleVector) const
	Identify candidate particles. More...
void	GetUsedClusters (const TensorType::ElementList &elementList, pandora::ClusterSet &usedClusters) const
	Copy used clusters into cluster list. More...
void	SelectBestElement (const TensorType::ElementList &elementList, const pandora::ClusterSet &usedClusters, TensorType::ElementList::const_iterator &bestIter) const
	Select the best triplet of clusters. More...

Detailed Description

MopUpRemnantsTool class.

Definition at line 19 of file MopUpRemnantsTool.h.

Member Typedef Documentation

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

inherited

Definition at line 63 of file ThreeDRemnantsAlgorithm.h.

typedef ThreeDRemnantsAlgorithm::TensorType lar_content::RemnantTensorTool::TensorType

inherited

Definition at line 62 of file ThreeDRemnantsAlgorithm.h.

Constructor & Destructor Documentation

lar_content::MopUpRemnantsTool::MopUpRemnantsTool

(

)

Default constructor.

Definition at line 18 of file MopUpRemnantsTool.cc.

{
}

Member Function Documentation

void lar_content::MopUpRemnantsTool::FindBestShowers ( const TensorType &  overlapTensor, ProtoParticleVector &  protoParticleVector  ) 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 38 of file MopUpRemnantsTool.cc.

References lar_content::OverlapTensor< T >::GetConnectedElements(), lar_content::OverlapTensor< T >::GetSortedKeyClusters(), lar_content::ProtoParticle::m_clusterListU, lar_content::ProtoParticle::m_clusterListV, and lar_content::ProtoParticle::m_clusterListW.

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

        TensorType::ElementList::const_iterator eIter = connectedElements.end();
        this->SelectBestElement(connectedElements, usedClusters, eIter);
        this->GetUsedClusters(connectedElements, usedClusters);

        if (connectedElements.end() == eIter)
            continue;

        ProtoParticle protoParticle;
        protoParticle.m_clusterListU.push_back(eIter->GetClusterU());
        protoParticle.m_clusterListV.push_back(eIter->GetClusterV());
        protoParticle.m_clusterListW.push_back(eIter->GetClusterW());
        protoParticleVector.push_back(protoParticle);
    }
}

void lar_content::MopUpRemnantsTool::GetUsedClusters ( const TensorType::ElementList &  elementList, pandora::ClusterSet &  usedClusters  ) const

private

Copy used clusters into cluster list.

Parameters

elementList	the input list of elements
usedClusters	to receive the list of used clusters

Definition at line 69 of file MopUpRemnantsTool.cc.

{
    for (TensorType::ElementList::const_iterator eIter = elementList.begin(); eIter != elementList.end(); ++eIter)
    {
        usedClusters.insert(eIter->GetClusterU());
        usedClusters.insert(eIter->GetClusterV());
        usedClusters.insert(eIter->GetClusterW());
    }
}

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

private

Definition at line 107 of file MopUpRemnantsTool.cc.

{
    return STATUS_CODE_SUCCESS;
}

bool lar_content::MopUpRemnantsTool::Run ( ThreeDRemnantsAlgorithm *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 24 of file MopUpRemnantsTool.cc.

References lar_content::ThreeDBaseAlgorithm< T >::CreateThreeDParticles().

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

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

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

void lar_content::MopUpRemnantsTool::SelectBestElement ( const TensorType::ElementList &  elementList, const pandora::ClusterSet &  usedClusters, TensorType::ElementList::const_iterator &  bestIter  ) const

private

Select the best triplet of clusters.

Parameters

elementList	the input list of elements
usedClusters	the list of cluster analysed so far
bestIter	iterator to the best element in the list

Definition at line 81 of file MopUpRemnantsTool.cc.

References f.

{
    float bestFigureOfMerit(0.f);

    for (TensorType::ElementList::const_iterator eIter = elementList.begin(); eIter != elementList.end(); ++eIter)
    {
        const Cluster *const pClusterU = eIter->GetClusterU();
        const Cluster *const pClusterV = eIter->GetClusterV();
        const Cluster *const pClusterW = eIter->GetClusterW();

        if (usedClusters.count(pClusterU) || usedClusters.count(pClusterV) || usedClusters.count(pClusterW))
            continue;

        const float figureOfMerit(pClusterU->GetHadronicEnergy() + pClusterV->GetHadronicEnergy() + pClusterW->GetHadronicEnergy());

        if (figureOfMerit > bestFigureOfMerit)
        {
            bestFigureOfMerit = figureOfMerit;
            bestIter = eIter;
        }
    }
}

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/larpandoracontent/v03_14_03/source/larpandoracontent/LArThreeDReco/LArShowerFragments/MopUpRemnantsTool.h
• /cvmfs/larsoft.opensciencegrid.org/products/larpandoracontent/v03_14_03/source/larpandoracontent/LArThreeDReco/LArShowerFragments/MopUpRemnantsTool.cc