lar_content::MopUpBaseAlgorithm Class Reference

MopUpBaseAlgorithm class. More...

#include "MopUpBaseAlgorithm.h"

Inheritance diagram for lar_content::MopUpBaseAlgorithm:

Public Member Functions
template<typename T >
const std::string	GetListName (const T *const pT) const
	Find the name of the list hosting a specific object. More...

Protected Member Functions
virtual pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)

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

Detailed Description

MopUpBaseAlgorithm class.

Definition at line 19 of file MopUpBaseAlgorithm.h.

Member Function Documentation

template<typename T >

template const std::string lar_content::MopUpBaseAlgorithm::GetListName

(

const T *const

pT

)

const

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

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

protectedvirtual

Reimplemented in lar_content::VertexBasedPfoMopUpAlgorithm, lar_content::SlidingConePfoMopUpAlgorithm, lar_content::SlidingConeClusterMopUpAlgorithm, lar_content::ClusterMopUpBaseAlgorithm, lar_content::BoundedClusterMopUpAlgorithm, lar_content::IsolatedClusterMopUpAlgorithm, lar_content::ConeClusterMopUpAlgorithm, lar_content::PfoMopUpBaseAlgorithm, lar_content::NearbyClusterMopUpAlgorithm, and lar_content::ShowerPfoMopUpAlgorithm.

Definition at line 42 of file MopUpBaseAlgorithm.cc.

Referenced by lar_content::ClusterMopUpBaseAlgorithm::ReadSettings().

{
    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadVectorOfValues(xmlHandle,
        "DaughterListNames", m_daughterListNames));

    if (m_daughterListNames.empty())
    {
        std::cout << "MopUpBaseAlgorithm::ReadSettings - Must provide names of daughter object lists for use in mop up." << std::endl;
        return STATUS_CODE_INVALID_PARAMETER;
    }

    return STATUS_CODE_SUCCESS;
}

Member Data Documentation

pandora::StringVector lar_content::MopUpBaseAlgorithm::m_daughterListNames

protected

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

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/larpandoracontent/v03_14_03/source/larpandoracontent/LArUtility/MopUpBaseAlgorithm.h
• /cvmfs/larsoft.opensciencegrid.org/products/larpandoracontent/v03_14_03/source/larpandoracontent/LArUtility/MopUpBaseAlgorithm.cc