lar_dl_content::DlClusterCharacterisationAlgorithm Class Reference

DlClusterCharacterisationBaseAlgorithm class. More...

#include "DlClusterCharacterisationAlgorithm.h"

Inheritance diagram for lar_dl_content::DlClusterCharacterisationAlgorithm:

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

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

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

DlClusterCharacterisationBaseAlgorithm class.

Definition at line 21 of file DlClusterCharacterisationAlgorithm.h.

Constructor & Destructor Documentation

lar_dl_content::DlClusterCharacterisationAlgorithm::DlClusterCharacterisationAlgorithm

(

)

Default constructor.

Definition at line 23 of file DlClusterCharacterisationAlgorithm.cc.

{
}

lar_dl_content::DlClusterCharacterisationAlgorithm::~DlClusterCharacterisationAlgorithm

(

)

Destructor.

Definition at line 29 of file DlClusterCharacterisationAlgorithm.cc.

{
}

Member Function Documentation

bool lar_dl_content::DlClusterCharacterisationAlgorithm::IsClearTrack ( const pandora::Cluster *const  pCluster ) const

protectedvirtual

Whether cluster is identified as a clear track.

Parameters

pCluster

address of the relevant cluster

Returns

boolean

Implements lar_content::ClusterCharacterisationBaseAlgorithm.

Definition at line 35 of file DlClusterCharacterisationAlgorithm.cc.

References util::begin(), util::end(), f, lar_content::LArCaloHit::GetTrackProbability(), and pmtana::mean().

{
    const OrderedCaloHitList &orderedCaloHitList{pCluster->GetOrderedCaloHitList()};
    CaloHitList caloHits;
    orderedCaloHitList.FillCaloHitList(caloHits);
    const CaloHitList &isolatedHits{pCluster->GetIsolatedCaloHitList()};
    caloHits.insert(caloHits.end(), isolatedHits.begin(), isolatedHits.end());
    FloatVector trackLikelihoods;
    try
    {
        for (const CaloHit *pCaloHit : caloHits)
        {
            const LArCaloHit *pLArCaloHit{dynamic_cast<const LArCaloHit *>(pCaloHit)};
            const float pTrack{pLArCaloHit->GetTrackProbability()};
            const float pShower{pLArCaloHit->GetShowerProbability()};
            if ((pTrack + pShower) > std::numeric_limits<float>::epsilon())
                trackLikelihoods.emplace_back(pTrack / (pTrack + pShower));
        }

        const unsigned long N{trackLikelihoods.size()};
        if (N > 0)
        {
            float mean{std::accumulate(std::begin(trackLikelihoods), std::end(trackLikelihoods), 0.f) / N};
            if (mean >= 0.5f)
                return true;
            else
                return false;
        }
    }
    catch (const StatusCodeException &)
    {
    }

    return true;
}

StatusCode lar_dl_content::DlClusterCharacterisationAlgorithm::ReadSettings ( const pandora::TiXmlHandle  xmlHandle )

protected

Definition at line 73 of file DlClusterCharacterisationAlgorithm.cc.

{
    return ClusterCharacterisationBaseAlgorithm::ReadSettings(xmlHandle);
}

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/larpandoradlcontent/LArTrackShowerId/DlClusterCharacterisationAlgorithm.h
• larpandoracontent/v04_08_01/source/larpandoradlcontent/LArTrackShowerId/DlClusterCharacterisationAlgorithm.cc