RecursivePfoMopUpAlgorithm class. More...

#include <RecursivePfoMopUpAlgorithm.h>

Inheritance diagram for lar_content::RecursivePfoMopUpAlgorithm:

Classes
struct	PfoMergeStats
	PfoMergeStats class: Object to compare PFO before/after merging algs have run to see if anything changed. More...

Public Member Functions
	RecursivePfoMopUpAlgorithm ()
	Default constructor. More...

Private Types
typedef std::vector< unsigned int >	ClusterNumHitsList

typedef std::vector < PfoMergeStats >	PfoMergeStatsList

Private Member Functions
PfoMergeStatsList	GetPfoMergeStats () const
	Get the PfoMergeStats for all of the particles in the event from m_pfoListNames. More...

pandora::StatusCode	Run ()

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

Static Private Member Functions
static bool	PfoMergeStatsComp (const PfoMergeStats &lhs, const PfoMergeStats &rhs)
	Equality comparator for two PfoMergeStats. More...

Private Attributes
unsigned int	m_maxIterations
	Maximum number of iterations. More...

pandora::StringVector	m_pfoListNames
	The list of pfo list names. More...

pandora::StringVector	m_mopUpAlgorithms
	Ordered list of mop up algorithms to run. More...

Detailed Description

RecursivePfoMopUpAlgorithm class.

Definition at line 20 of file RecursivePfoMopUpAlgorithm.h.

Member Typedef Documentation

typedef std::vector<unsigned int> lar_content::RecursivePfoMopUpAlgorithm::ClusterNumHitsList

private

Definition at line 29 of file RecursivePfoMopUpAlgorithm.h.

typedef std::vector<PfoMergeStats> lar_content::RecursivePfoMopUpAlgorithm::PfoMergeStatsList

private

Definition at line 49 of file RecursivePfoMopUpAlgorithm.h.

Constructor & Destructor Documentation

lar_content::RecursivePfoMopUpAlgorithm::RecursivePfoMopUpAlgorithm ( )

inline

Default constructor.

Definition at line 78 of file RecursivePfoMopUpAlgorithm.h.

                                                               : m_maxIterations(10)
 {
 }

Member Function Documentation

RecursivePfoMopUpAlgorithm::PfoMergeStatsList lar_content::RecursivePfoMopUpAlgorithm::GetPfoMergeStats ( ) const

private

Get the PfoMergeStats for all of the particles in the event from m_pfoListNames.

Returns: List of PfoMergeStats for each Pfo

Definition at line 42 of file RecursivePfoMopUpAlgorithm.cc.

 {
     PfoMergeStatsList pfoMergeStatsList;
 
     for (auto const &pfoListName : m_pfoListNames)
     {
         const PfoList *pPfoList(nullptr);
         if (STATUS_CODE_SUCCESS != PandoraContentApi::GetList(*this, pfoListName, pPfoList))
             continue;
 
         for (const ParticleFlowObject *const pPfo : *pPfoList)
         {
             ClusterNumHitsList pfoHits;
             ClusterList clusterList;
             LArPfoHelper::GetTwoDClusterList(pPfo, clusterList);
 
             for (auto const &cluster : clusterList)
                 pfoHits.push_back(cluster->GetNCaloHits());
 
             const PropertiesMap &pfoMeta(pPfo->GetPropertiesMap());
             const auto &trackScoreIter(pfoMeta.find("TrackScore"));
             const float trackScore(trackScoreIter != pfoMeta.end() ? trackScoreIter->second : -1.f);
 
             pfoMergeStatsList.emplace_back(PfoMergeStats{pfoHits, trackScore});
         }
     }
     return pfoMergeStatsList;
 }

bool lar_content::RecursivePfoMopUpAlgorithm::PfoMergeStatsComp	(	const PfoMergeStats &	lhs,
		const PfoMergeStats &	rhs
	)

inlinestaticprivate

Equality comparator for two PfoMergeStats.

Parameters

lhs	PfoMergeStats for comparison
rhs	PfoMergeStats for comparison

Returns: boolean if the lhs and rhs are the same

Definition at line 92 of file RecursivePfoMopUpAlgorithm.h.

 {
     return ((lhs.m_numClusterHits == rhs.m_numClusterHits) && (std::abs(lhs.m_trackScore - rhs.m_trackScore) < std::numeric_limits<float>::epsilon()));
 }

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

private

Definition at line 73 of file RecursivePfoMopUpAlgorithm.cc.

 {
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ProcessAlgorithmList(*this, xmlHandle, "MopUpAlgorithms", m_mopUpAlgorithms));
 
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadVectorOfValues(xmlHandle, "PfoListNames", m_pfoListNames));
 
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "MaxIterations", m_maxIterations));
 
     return STATUS_CODE_SUCCESS;
 }

StatusCode lar_content::RecursivePfoMopUpAlgorithm::Run ( )

private

Definition at line 20 of file RecursivePfoMopUpAlgorithm.cc.

 {
     PfoMergeStatsList mergeStatsListBefore(this->GetPfoMergeStats());
 
     for (unsigned int iter = 0; iter < m_maxIterations; ++iter)
     {
         for (auto const &mopUpAlg : m_mopUpAlgorithms)
             PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::RunDaughterAlgorithm(*this, mopUpAlg));
 
         PfoMergeStatsList mergeStatsListAfter(this->GetPfoMergeStats());
 
         if (std::equal(mergeStatsListBefore.cbegin(), mergeStatsListBefore.cend(), mergeStatsListAfter.cbegin(), mergeStatsListAfter.cend(), PfoMergeStatsComp))
             break;
 
         mergeStatsListBefore = std::move(mergeStatsListAfter);
     }
 
     return STATUS_CODE_SUCCESS;
 }