lar_content::ShowerHierarchyMopUpAlgorithm Class Reference

ShowerHierarchyMopUpAlgorithm class. More...

#include "ShowerHierarchyMopUpAlgorithm.h"

Inheritance diagram for lar_content::ShowerHierarchyMopUpAlgorithm:

Public Member Functions
virtual void	MergeAndDeletePfos (const pandora::ParticleFlowObject *const pPfoToEnlarge, const pandora::ParticleFlowObject *const pPfoToDelete) const
	Merge and delete a pair of pfos, with a specific set of conventions for cluster merging, vertex use, etc. More...
template<typename T >
const std::string	GetListName (const T *const pT) const
	Find the name of the list hosting a specific object. More...

Static Public Member Functions
static const pandora::Cluster *	GetParentCluster (const pandora::ClusterList &clusterList, const pandora::HitType hitType)
	Select the parent cluster (same hit type and most hits) using a provided cluster list and hit type. More...

Protected Attributes
pandora::StringVector	m_daughterListNames
	The list of potential daughter object list names. More...

Private Member Functions
pandora::StatusCode	Run ()
void	FindParentShowerPfos (const pandora::PfoList *const pLeadingPfoList, pandora::PfoList &parentShowerPfos) const
	Starting with provided leading pfos, find all shower pfos that themselves have daughter pfos. More...
void	FindParentShowerPfos (const pandora::Pfo *const pLeadiPfo, pandora::PfoList &parentShowerPfos) const
	Starting with provided pfo, find all downstream shower pfos that themselves have daughter pfos. More...
void	PerformPfoMerges (const pandora::PfoList &parentShowerPfos) const
	For each parent shower pfo, merge all downstream pfos back into the parent shower. More...
pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)

Private Attributes
std::string	m_leadingPfoListName
	The input leading pfo list name (e.g. list of neutrino or testbeam pfos) More...

Detailed Description

ShowerHierarchyMopUpAlgorithm class.

Definition at line 19 of file ShowerHierarchyMopUpAlgorithm.h.

Member Function Documentation

void lar_content::ShowerHierarchyMopUpAlgorithm::FindParentShowerPfos ( const pandora::PfoList *const  pLeadingPfoList, pandora::PfoList &  parentShowerPfos  ) const

private

Starting with provided leading pfos, find all shower pfos that themselves have daughter pfos.

Parameters

pLeadingPfoList	the list of leading pfos
parentShowerPfos	to receive the list of parent shower pfos

void lar_content::ShowerHierarchyMopUpAlgorithm::FindParentShowerPfos ( const pandora::Pfo *const  pLeadiPfo, pandora::PfoList &  parentShowerPfos  ) const

private

Starting with provided pfo, find all downstream shower pfos that themselves have daughter pfos.

Parameters

pPfo	the address of a pfo
parentShowerPfos	to receive the list of parent shower pfos

template<typename T >

template const std::string lar_content::MopUpBaseAlgorithm::GetListName ( const T *const  pT ) const

inherited

Find the name of the list hosting a specific object.

Parameters

pT	the address of the object

Returns

the name of the list

Definition at line 19 of file MopUpBaseAlgorithm.cc.

Referenced by lar_content::IsolatedClusterMopUpAlgorithm::DissolveClustersToHits(), lar_content::ClusterMopUpBaseAlgorithm::MakeClusterMerges(), and lar_content::SlidingConeClusterMopUpAlgorithm::MakeClusterMerges().

{
    std::string currentListName;
    const MANAGED_CONTAINER<const T *> *pCurrentList(nullptr);
    (void)PandoraContentApi::GetCurrentList(*this, pCurrentList, currentListName);

    if (pCurrentList && (pCurrentList->end() != std::find(pCurrentList->begin(), pCurrentList->end(), pT)))
        return currentListName;

    for (const std::string &listName : m_daughterListNames)
    {
        const MANAGED_CONTAINER<const T *> *pList(nullptr);
        (void)PandoraContentApi::GetList(*this, listName, pList);

        if (pList && (pList->end() != std::find(pList->begin(), pList->end(), pT)))
            return listName;
    }

    throw StatusCodeException(STATUS_CODE_NOT_FOUND);
}

const Cluster * lar_content::PfoMopUpBaseAlgorithm::GetParentCluster ( const pandora::ClusterList &  clusterList, const pandora::HitType  hitType  )

staticinherited

Select the parent cluster (same hit type and most hits) using a provided cluster list and hit type.

Parameters

clusterList	the cluster list
hitType	the hit type

Returns

the address of the parent cluster

Definition at line 61 of file PfoMopUpBaseAlgorithm.cc.

Referenced by lar_content::SlidingConeClusterMopUpAlgorithm::MakeClusterMerges(), lar_content::SlidingConeClusterMopUpAlgorithm::ClusterMerge::operator<(), lar_content::SlidingConePfoMopUpAlgorithm::ClusterMerge::operator<(), and lar_content::MasterAlgorithm::StitchPfos().

{
    unsigned int mostHits(0);
    const Cluster *pBestParentCluster(nullptr);

    for (const Cluster *const pParentCluster : clusterList)
    {
        if (hitType != LArClusterHelper::GetClusterHitType(pParentCluster))
            continue;

        const unsigned int nParentHits(pParentCluster->GetNCaloHits());

        if (nParentHits > mostHits)
        {
            mostHits = nParentHits;
            pBestParentCluster = pParentCluster;
        }
    }

    return pBestParentCluster;
}

void lar_content::PfoMopUpBaseAlgorithm::MergeAndDeletePfos ( const pandora::ParticleFlowObject *const  pPfoToEnlarge, const pandora::ParticleFlowObject *const  pPfoToDelete  ) const

virtualinherited

Merge and delete a pair of pfos, with a specific set of conventions for cluster merging, vertex use, etc.

Parameters

pPfoToEnlarge	the address of the pfo to enlarge
pPfoToDelete	the address of the pfo to delete (will become a dangling pointer)

Definition at line 20 of file PfoMopUpBaseAlgorithm.cc.

Referenced by lar_content::SlidingConePfoMopUpAlgorithm::MakePfoMerges(), and lar_content::VertexBasedPfoMopUpAlgorithm::MergePfos().

{
    if (pPfoToEnlarge == pPfoToDelete)
        throw StatusCodeException(STATUS_CODE_NOT_ALLOWED);

    const PfoList daughterPfos(pPfoToDelete->GetDaughterPfoList());
    const ClusterVector daughterClusters(pPfoToDelete->GetClusterList().begin(), pPfoToDelete->GetClusterList().end());
    const VertexVector daughterVertices(pPfoToDelete->GetVertexList().begin(), pPfoToDelete->GetVertexList().end());

    PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::Delete(*this, pPfoToDelete, this->GetListName(pPfoToDelete)));

    for (const ParticleFlowObject *const pDaughterPfo : daughterPfos)
    {
        PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::SetPfoParentDaughterRelationship(*this, pPfoToEnlarge, pDaughterPfo));
    }

    for (const Vertex *const pDaughterVertex : daughterVertices)
    {
        PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::Delete(*this, pDaughterVertex, this->GetListName(pDaughterVertex)));
    }

    for (const Cluster *const pDaughterCluster : daughterClusters)
    {
        const HitType daughterHitType(LArClusterHelper::GetClusterHitType(pDaughterCluster));
        const Cluster *pParentCluster(PfoMopUpBaseAlgorithm::GetParentCluster(pPfoToEnlarge->GetClusterList(), daughterHitType));

        if (pParentCluster)
        {
            PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=,
                PandoraContentApi::MergeAndDeleteClusters(
                    *this, pParentCluster, pDaughterCluster, this->GetListName(pParentCluster), this->GetListName(pDaughterCluster)));
        }
        else
        {
            PANDORA_THROW_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::AddToPfo(*this, pPfoToEnlarge, pDaughterCluster));
        }
    }
}

void lar_content::ShowerHierarchyMopUpAlgorithm::PerformPfoMerges ( const pandora::PfoList &  parentShowerPfos ) const

private

For each parent shower pfo, merge all downstream pfos back into the parent shower.

Parameters

parentShowerPfos

the list of parent shower pfos

Definition at line 74 of file ShowerHierarchyMopUpAlgorithm.cc.

{
    for (const Pfo *const pParentShowerPfo : parentShowerPfos)
    {
        PfoList downstreamPfos;
        LArPfoHelper::GetAllDownstreamPfos(pParentShowerPfo, downstreamPfos);

        for (const Pfo *const pDownstreamPfo : downstreamPfos)
        {
            if (pDownstreamPfo != pParentShowerPfo)
                this->MergeAndDeletePfos(pParentShowerPfo, pDownstreamPfo);
        }
    }
}

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

privatevirtual

Reimplemented from lar_content::PfoMopUpBaseAlgorithm.

Definition at line 91 of file ShowerHierarchyMopUpAlgorithm.cc.

{
    PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "LeadingPfoListName", m_leadingPfoListName));

    return PfoMopUpBaseAlgorithm::ReadSettings(xmlHandle);
}

StatusCode lar_content::ShowerHierarchyMopUpAlgorithm::Run ( )

private

Definition at line 20 of file ShowerHierarchyMopUpAlgorithm.cc.

{
    const PfoList *pLeadingPfoList(nullptr);
    PANDORA_RETURN_RESULT_IF_AND_IF(
        STATUS_CODE_SUCCESS, STATUS_CODE_NOT_INITIALIZED, !=, PandoraContentApi::GetList(*this, m_leadingPfoListName, pLeadingPfoList));

    if (!pLeadingPfoList || pLeadingPfoList->empty())
    {
        if (PandoraContentApi::GetSettings(*this)->ShouldDisplayAlgorithmInfo())
            std::cout << "ShowerHierarchyMopUpAlgorithm: unable to find pfos in provided list, " << m_leadingPfoListName << std::endl;

        return STATUS_CODE_SUCCESS;
    }

    PfoList parentShowerPfos;
    this->FindParentShowerPfos(pLeadingPfoList, parentShowerPfos);
    this->PerformPfoMerges(parentShowerPfos);

    return STATUS_CODE_SUCCESS;
}

Member Data Documentation

pandora::StringVector lar_content::MopUpBaseAlgorithm::m_daughterListNames

protectedinherited

The list of potential daughter object list names.

Definition at line 35 of file MopUpBaseAlgorithm.h.

Referenced by lar_content::SlidingConeClusterMopUpAlgorithm::GetAvailableTwoDClusters(), lar_content::ClusterMopUpBaseAlgorithm::GetDaughterClusterLists(), lar_content::SlidingConePfoMopUpAlgorithm::ReadSettings(), and lar_content::VertexBasedPfoMopUpAlgorithm::ReadSettings().

std::string lar_content::ShowerHierarchyMopUpAlgorithm::m_leadingPfoListName

private

The input leading pfo list name (e.g. list of neutrino or testbeam pfos)

Definition at line 49 of file ShowerHierarchyMopUpAlgorithm.h.

---

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

• larpandoracontent/v04_08_01/source/larpandoracontent/LArThreeDReco/LArPfoMopUp/ShowerHierarchyMopUpAlgorithm.h
• larpandoracontent/v04_08_01/source/larpandoracontent/LArThreeDReco/LArPfoMopUp/ShowerHierarchyMopUpAlgorithm.cc