lar_content::StreamSelectionAlgorithm Class Reference

StreamSelectionAlgorithm class. More...

#include <StreamSelectionAlgorithm.h>

Inheritance diagram for lar_content::StreamSelectionAlgorithm:

Public Member Functions
	StreamSelectionAlgorithm ()
	Default constructor. More...
virtual	~StreamSelectionAlgorithm ()=default

Protected Types
typedef std::map< std::string, pandora::ClusterList >	ClusterListMap

Protected Member Functions
virtual pandora::StatusCode	AllocateToStreams (const pandora::Cluster *const pCluster)=0
	Allocate a cluster to the appropriate streams. More...
pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)

Protected Attributes
std::string	m_inputListName
	The input list name if not using the current list. More...
std::string	m_listType
	The type of the input lists (currently only Cluster is supported) More...
pandora::StringVector	m_listNames
	The name of the output lists. More...
ClusterListMap	m_clusterListMap
	The map from cluster list names to cluster lists. More...

Private Member Functions
pandora::StatusCode	Run ()

Detailed Description

StreamSelectionAlgorithm class.

Definition at line 19 of file StreamSelectionAlgorithm.h.

Member Typedef Documentation

typedef std::map<std::string, pandora::ClusterList> lar_content::StreamSelectionAlgorithm::ClusterListMap

protected

Definition at line 30 of file StreamSelectionAlgorithm.h.

Constructor & Destructor Documentation

lar_content::StreamSelectionAlgorithm::StreamSelectionAlgorithm

(

)

Default constructor.

Definition at line 25 of file StreamSelectionAlgorithm.cc.

                                                   : m_inputListName{""}, m_listType{"cluster"}
{
}

virtual lar_content::StreamSelectionAlgorithm::~StreamSelectionAlgorithm ( )

virtualdefault

Member Function Documentation

virtual pandora::StatusCode lar_content::StreamSelectionAlgorithm::AllocateToStreams ( const pandora::Cluster *const  pCluster )

protectedpure virtual

Allocate a cluster to the appropriate streams.

Parameters

pCluster

The cluster to allocate to a stream

Returns

The StatusCode

Implemented in lar_dl_content::DlTrackShowerStreamSelectionAlgorithm.

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

protected

Definition at line 72 of file StreamSelectionAlgorithm.cc.

{
    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "InputListName", m_inputListName));
    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "ListType", m_listType));
    std::transform(m_listType.begin(), m_listType.end(), m_listType.begin(), ::tolower);
    if (m_listType != "cluster")
    {
        std::cout << "StreamingAlgorithm::ReadSettings - Error: Only Cluster list type is supported at this time" << std::endl;
        return STATUS_CODE_INVALID_PARAMETER;
    }

    // ATTN - Classes implementing this interface should ensure that m_listNames gets populated from the list names provided to the
    // implementing class
    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadVectorOfValues(xmlHandle, "ListNames", m_listNames));

    return STATUS_CODE_SUCCESS;
}

StatusCode lar_content::StreamSelectionAlgorithm::Run ( )

private

Definition at line 31 of file StreamSelectionAlgorithm.cc.

{
    if (m_listNames.empty())
    {
        std::cout << "StreamSelectionAlgorithm::Run - Error: No output lists found" << std::endl;
        return STATUS_CODE_NOT_FOUND;
    }

    const ClusterList *pClusterList{nullptr};
    std::string originalClusterListName;
    if (m_inputListName.empty())
    {
        PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::GetCurrentList(*this, pClusterList));
        PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::GetCurrentListName<Cluster>(*this, originalClusterListName));
    }
    else
    {
        PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::GetList(*this, m_inputListName, pClusterList));
        originalClusterListName = m_inputListName;
    }

    for (std::string listName : m_listNames)
        m_clusterListMap[listName] = ClusterList();

    for (const Cluster *pCluster : *pClusterList)
    {
        StatusCode status{this->AllocateToStreams(pCluster)};
        if (status != STATUS_CODE_SUCCESS)
            return status;
    }

    // ATTN - We're ok with saving empty lists here and allowing future algorithms to simply do nothing if there are no clusters
    // Moves the subset of clusters in the cluster list from the old list to the new list
    for (std::string listName : m_listNames)
        PandoraContentApi::SaveList<ClusterList>(*this, originalClusterListName, listName, m_clusterListMap.at(listName));

    return STATUS_CODE_SUCCESS;
}

Member Data Documentation

ClusterListMap lar_content::StreamSelectionAlgorithm::m_clusterListMap

protected

The map from cluster list names to cluster lists.

Definition at line 46 of file StreamSelectionAlgorithm.h.

std::string lar_content::StreamSelectionAlgorithm::m_inputListName

protected

The input list name if not using the current list.

Definition at line 43 of file StreamSelectionAlgorithm.h.

pandora::StringVector lar_content::StreamSelectionAlgorithm::m_listNames

protected

The name of the output lists.

Definition at line 45 of file StreamSelectionAlgorithm.h.

std::string lar_content::StreamSelectionAlgorithm::m_listType

protected

The type of the input lists (currently only Cluster is supported)

Definition at line 44 of file StreamSelectionAlgorithm.h.

---

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

• StreamSelectionAlgorithm.h
• StreamSelectionAlgorithm.cc