lar_content::ClusterCharacterisationBaseAlgorithm Class Reference

ClusterCharacterisationBaseAlgorithm class. More...

#include "ClusterCharacterisationBaseAlgorithm.h"

Inheritance diagram for lar_content::ClusterCharacterisationBaseAlgorithm:

Public Member Functions
	ClusterCharacterisationBaseAlgorithm ()
	Default constructor. More...
	~ClusterCharacterisationBaseAlgorithm ()
	Destructor. More...

Protected Member Functions
virtual bool	IsClearTrack (const pandora::Cluster *const pCluster) const =0
	Whether cluster is identified as a clear track. More...
pandora::StatusCode	Run ()
pandora::StatusCode	ReadSettings (const pandora::TiXmlHandle xmlHandle)

Protected Attributes
pandora::StringVector	m_inputClusterListNames
	The names of the input cluster lists. More...
bool	m_zeroMode
	Whether to zero all existing cluster particle id, overrides all other parameters. More...
bool	m_overwriteExistingId
	Whether to consider any clusters that already have an assigned particle id. More...
bool	m_useUnavailableClusters
	Whether to consider clusters that are already constituents of a pfo. More...

Detailed Description

ClusterCharacterisationBaseAlgorithm class.

Definition at line 19 of file ClusterCharacterisationBaseAlgorithm.h.

Constructor & Destructor Documentation

lar_content::ClusterCharacterisationBaseAlgorithm::ClusterCharacterisationBaseAlgorithm

(

)

Default constructor.

Definition at line 21 of file ClusterCharacterisationBaseAlgorithm.cc.

                                                                           :
    m_zeroMode(false),
    m_overwriteExistingId(false),
    m_useUnavailableClusters(false)
{
}

lar_content::ClusterCharacterisationBaseAlgorithm::~ClusterCharacterisationBaseAlgorithm

(

)

Destructor.

Definition at line 30 of file ClusterCharacterisationBaseAlgorithm.cc.

{
}

Member Function Documentation

virtual bool lar_content::ClusterCharacterisationBaseAlgorithm::IsClearTrack ( const pandora::Cluster *const  pCluster ) const

protectedpure virtual

Whether cluster is identified as a clear track.

Parameters

pCluster

address of the relevant cluster

Returns

boolean

Implemented in lar_content::CutClusterCharacterisationAlgorithm, lar_dl_content::DlClusterCharacterisationAlgorithm, and lar_content::CheatingClusterCharacterisationAlgorithm.

Referenced by Run().

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

protected

Definition at line 93 of file ClusterCharacterisationBaseAlgorithm.cc.

References m_inputClusterListNames, m_overwriteExistingId, m_useUnavailableClusters, and m_zeroMode.

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

{
    PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadVectorOfValues(xmlHandle, "InputClusterListNames", m_inputClusterListNames));

    PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "ZeroMode", m_zeroMode));

    PANDORA_RETURN_RESULT_IF_AND_IF(
        STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "OverwriteExistingId", m_overwriteExistingId));

    PANDORA_RETURN_RESULT_IF_AND_IF(
        STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "UseUnavailableClusters", m_useUnavailableClusters));

    return STATUS_CODE_SUCCESS;
}

StatusCode lar_content::ClusterCharacterisationBaseAlgorithm::Run ( )

protected

Definition at line 36 of file ClusterCharacterisationBaseAlgorithm.cc.

References IsClearTrack(), m_inputClusterListNames, m_overwriteExistingId, m_useUnavailableClusters, and m_zeroMode.

{
    for (const std::string &clusterListName : m_inputClusterListNames)
    {
        const ClusterList *pClusterList = NULL;
        PANDORA_RETURN_RESULT_IF_AND_IF(
            STATUS_CODE_SUCCESS, STATUS_CODE_NOT_INITIALIZED, !=, PandoraContentApi::GetList(*this, clusterListName, pClusterList));

        if (!pClusterList || pClusterList->empty())
        {
            if (PandoraContentApi::GetSettings(*this)->ShouldDisplayAlgorithmInfo())
                std::cout << "ClusterCharacterisationBaseAlgorithm: unable to find cluster list " << clusterListName << std::endl;

            continue;
        }

        if (m_zeroMode)
        {
            for (const Cluster *const pCluster : *pClusterList)
            {
                PandoraContentApi::Cluster::Metadata metadata;
                metadata.m_particleId = UNKNOWN_PARTICLE_TYPE;
                PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::Cluster::AlterMetadata(*this, pCluster, metadata));
            }

            return STATUS_CODE_SUCCESS;
        }

        for (const Cluster *const pCluster : *pClusterList)
        {
            if (!m_overwriteExistingId && (UNKNOWN_PARTICLE_TYPE != pCluster->GetParticleId()))
                continue;

            if (!m_useUnavailableClusters && !PandoraContentApi::IsAvailable(*this, pCluster))
                continue;

            PandoraContentApi::Cluster::Metadata metadata;

            if (this->IsClearTrack(pCluster))
            {
                metadata.m_particleId = MU_MINUS;
            }
            else
            {
                metadata.m_particleId = E_MINUS;
            }

            if (pCluster->GetParticleId() != metadata.m_particleId.Get())
                PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::Cluster::AlterMetadata(*this, pCluster, metadata));
        }
    }

    return STATUS_CODE_SUCCESS;
}

Member Data Documentation

pandora::StringVector lar_content::ClusterCharacterisationBaseAlgorithm::m_inputClusterListNames

protected

The names of the input cluster lists.

Definition at line 45 of file ClusterCharacterisationBaseAlgorithm.h.

Referenced by ReadSettings(), and Run().

bool lar_content::ClusterCharacterisationBaseAlgorithm::m_overwriteExistingId

protected

Whether to consider any clusters that already have an assigned particle id.

Definition at line 49 of file ClusterCharacterisationBaseAlgorithm.h.

Referenced by ReadSettings(), and Run().

bool lar_content::ClusterCharacterisationBaseAlgorithm::m_useUnavailableClusters

protected

Whether to consider clusters that are already constituents of a pfo.

Definition at line 50 of file ClusterCharacterisationBaseAlgorithm.h.

Referenced by ReadSettings(), and Run().

bool lar_content::ClusterCharacterisationBaseAlgorithm::m_zeroMode

protected

Whether to zero all existing cluster particle id, overrides all other parameters.

Definition at line 47 of file ClusterCharacterisationBaseAlgorithm.h.

Referenced by ReadSettings(), and Run().

---

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

• larpandoracontent/v04_08_01/source/larpandoracontent/LArTrackShowerId/ClusterCharacterisationBaseAlgorithm.h
• larpandoracontent/v04_08_01/source/larpandoracontent/LArTrackShowerId/ClusterCharacterisationBaseAlgorithm.cc