lar_content::CheatingClusterCharacterisationAlgorithm Class Reference

CheatingClusterCharacterisationAlgorithm class. More...

#include "CheatingClusterCharacterisationAlgorithm.h"

Inheritance diagram for lar_content::CheatingClusterCharacterisationAlgorithm:

Protected Member Functions
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...

Private Member Functions
bool	IsClearTrack (const pandora::Cluster *const pCluster) const
	Whether cluster is identified as a clear track. More...

Detailed Description

CheatingClusterCharacterisationAlgorithm class.

Definition at line 19 of file CheatingClusterCharacterisationAlgorithm.h.

Member Function Documentation

bool lar_content::CheatingClusterCharacterisationAlgorithm::IsClearTrack ( const pandora::Cluster *const  pCluster ) const

privatevirtual

Whether cluster is identified as a clear track.

Parameters

pCluster

address of the relevant cluster

Returns

boolean

Implements lar_content::ClusterCharacterisationBaseAlgorithm.

Definition at line 20 of file CheatingClusterCharacterisationAlgorithm.cc.

References util::abs().

{
    try
    {
        // ATTN Slightly curious definition of a clear track, but this is most-likely what is needed for shower-growing
        const MCParticle *const pMCParticle(MCParticleHelper::GetMainMCParticle(pCluster));

        if ((PHOTON != pMCParticle->GetParticleId()) && (E_MINUS != std::abs(pMCParticle->GetParticleId())))
            return true;
    }
    catch (const StatusCodeException &)
    {
    }

    return false;
}

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

protectedinherited

Definition at line 93 of file ClusterCharacterisationBaseAlgorithm.cc.

References lar_content::ClusterCharacterisationBaseAlgorithm::m_inputClusterListNames, lar_content::ClusterCharacterisationBaseAlgorithm::m_overwriteExistingId, lar_content::ClusterCharacterisationBaseAlgorithm::m_useUnavailableClusters, and lar_content::ClusterCharacterisationBaseAlgorithm::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 ( )

protectedinherited

Definition at line 36 of file ClusterCharacterisationBaseAlgorithm.cc.

References lar_content::ClusterCharacterisationBaseAlgorithm::IsClearTrack(), lar_content::ClusterCharacterisationBaseAlgorithm::m_inputClusterListNames, lar_content::ClusterCharacterisationBaseAlgorithm::m_overwriteExistingId, lar_content::ClusterCharacterisationBaseAlgorithm::m_useUnavailableClusters, and lar_content::ClusterCharacterisationBaseAlgorithm::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

protectedinherited

The names of the input cluster lists.

Definition at line 45 of file ClusterCharacterisationBaseAlgorithm.h.

Referenced by lar_content::ClusterCharacterisationBaseAlgorithm::ReadSettings(), and lar_content::ClusterCharacterisationBaseAlgorithm::Run().

bool lar_content::ClusterCharacterisationBaseAlgorithm::m_overwriteExistingId

protectedinherited

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

Definition at line 49 of file ClusterCharacterisationBaseAlgorithm.h.

Referenced by lar_content::ClusterCharacterisationBaseAlgorithm::ReadSettings(), and lar_content::ClusterCharacterisationBaseAlgorithm::Run().

bool lar_content::ClusterCharacterisationBaseAlgorithm::m_useUnavailableClusters

protectedinherited

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

Definition at line 50 of file ClusterCharacterisationBaseAlgorithm.h.

Referenced by lar_content::ClusterCharacterisationBaseAlgorithm::ReadSettings(), and lar_content::ClusterCharacterisationBaseAlgorithm::Run().

bool lar_content::ClusterCharacterisationBaseAlgorithm::m_zeroMode

protectedinherited

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

Definition at line 47 of file ClusterCharacterisationBaseAlgorithm.h.

Referenced by lar_content::ClusterCharacterisationBaseAlgorithm::ReadSettings(), and lar_content::ClusterCharacterisationBaseAlgorithm::Run().

---

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

• larpandoracontent/v04_08_01/source/larpandoracontent/LArCheating/CheatingClusterCharacterisationAlgorithm.h
• larpandoracontent/v04_08_01/source/larpandoracontent/LArCheating/CheatingClusterCharacterisationAlgorithm.cc