lar_dl_content::DlPfoCharacterisationAlgorithm Class Reference

DlPfoCharacterisationAlgorithm class. More...

#include "DlPfoCharacterisationAlgorithm.h"

Inheritance diagram for lar_dl_content::DlPfoCharacterisationAlgorithm:

Public Member Functions
	DlPfoCharacterisationAlgorithm ()
	Default constructor. More...

Protected Member Functions
pandora::StatusCode	Run ()
virtual bool	IsClearTrack3x2D (const pandora::ParticleFlowObject *const pPfo) const
	Whether pfo is identified as a clear track using its three clusters. More...

Protected Attributes
std::string	m_trackPfoListName
	The track pfo list name. More...
std::string	m_showerPfoListName
	The shower pfo list name. More...
pandora::StringVector	m_inputPfoListNames
	The names of the input pfo lists. More...
bool	m_updateClusterIds
	Whether to update daughter cluster particle id labels to match pfo id. More...
bool	m_postBranchAddition
	Whether to use configuration for shower clusters post branch addition. More...
bool	m_useThreeDInformation
	Whether to use PFO and 3D information or clusters for characterisation. More...
unsigned int	m_minTrackLikeViews
	The minimum number of track-like views to declare a pfo as track-like. More...

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

Detailed Description

DlPfoCharacterisationAlgorithm class.

Definition at line 19 of file DlPfoCharacterisationAlgorithm.h.

Constructor & Destructor Documentation

lar_dl_content::DlPfoCharacterisationAlgorithm::DlPfoCharacterisationAlgorithm

(

)

Default constructor.

Definition at line 24 of file DlPfoCharacterisationAlgorithm.cc.

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

{
}

Member Function Documentation

bool lar_dl_content::DlPfoCharacterisationAlgorithm::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::PfoCharacterisationBaseAlgorithm.

bool lar_dl_content::DlPfoCharacterisationAlgorithm::IsClearTrack ( const pandora::ParticleFlowObject *const  pPfo ) const

privatevirtual

Whether pfo is identified as a clear track.

Parameters

pPfo	address of the relevant pfo

Returns

boolean

Implements lar_content::PfoCharacterisationBaseAlgorithm.

Definition at line 68 of file DlPfoCharacterisationAlgorithm.cc.

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

{
    ClusterList allClusters;
    LArPfoHelper::GetTwoDClusterList(pPfo, allClusters);
    FloatVector trackLikelihoods;
    for (const Cluster *pCluster : allClusters)
    {
        const OrderedCaloHitList &orderedCaloHitList{pCluster->GetOrderedCaloHitList()};
        CaloHitList caloHits;
        orderedCaloHitList.FillCaloHitList(caloHits);
        const CaloHitList &isolatedHits{pCluster->GetIsolatedCaloHitList()};
        caloHits.insert(caloHits.end(), isolatedHits.begin(), isolatedHits.end());
        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));
            }
        }
        catch (const StatusCodeException &)
        {
        }
    }

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

    return true;
}

bool lar_content::PfoCharacterisationBaseAlgorithm::IsClearTrack3x2D ( const pandora::ParticleFlowObject *const  pPfo ) const

protectedvirtualinherited

Whether pfo is identified as a clear track using its three clusters.

Parameters

pPfo	address of the relevant pfo

Returns

boolean

Definition at line 108 of file PfoCharacterisationBaseAlgorithm.cc.

References lar_content::LArClusterHelper::GetClusterHitType(), lar_content::LArPfoHelper::GetTwoDClusterList(), lar_content::PfoCharacterisationBaseAlgorithm::IsClearTrack(), and lar_content::PfoCharacterisationBaseAlgorithm::m_minTrackLikeViews.

Referenced by lar_content::PfoCharacterisationBaseAlgorithm::Run().

{
    ClusterList twoDClusterList;
    LArPfoHelper::GetTwoDClusterList(pPfo, twoDClusterList);

    typedef std::set<pandora::HitType> HitTypeSet;
    HitTypeSet hitTypeSet;

    unsigned int nTrackLikeViews(0);
    for (const Cluster *const pCluster : twoDClusterList)
    {
        const HitType hitType(LArClusterHelper::GetClusterHitType(pCluster));
        if (!hitTypeSet.insert(hitType).second)
            continue;

        if (this->IsClearTrack(pCluster))
            ++nTrackLikeViews;

        if (nTrackLikeViews >= m_minTrackLikeViews)
            return true;
    }

    return false;
}

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

private

Definition at line 111 of file DlPfoCharacterisationAlgorithm.cc.

{
    return PfoCharacterisationBaseAlgorithm::ReadSettings(xmlHandle);
}

StatusCode lar_content::PfoCharacterisationBaseAlgorithm::Run ( )

protectedinherited

Definition at line 39 of file PfoCharacterisationBaseAlgorithm.cc.

References lar_content::LArPfoHelper::GetTwoDClusterList(), lar_content::PfoCharacterisationBaseAlgorithm::IsClearTrack(), lar_content::PfoCharacterisationBaseAlgorithm::IsClearTrack3x2D(), lar_content::PfoCharacterisationBaseAlgorithm::m_inputPfoListNames, lar_content::PfoCharacterisationBaseAlgorithm::m_showerPfoListName, lar_content::PfoCharacterisationBaseAlgorithm::m_trackPfoListName, lar_content::PfoCharacterisationBaseAlgorithm::m_updateClusterIds, and lar_content::PfoCharacterisationBaseAlgorithm::m_useThreeDInformation.

{
    PfoList tracksToShowers, showersToTracks;

    for (const std::string &pfoListName : m_inputPfoListNames)
    {
        const PfoList *pPfoList(nullptr);
        PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_INITIALIZED, !=, PandoraContentApi::GetList(*this, pfoListName, pPfoList));

        if (!pPfoList || pPfoList->empty())
        {
            if (PandoraContentApi::GetSettings(*this)->ShouldDisplayAlgorithmInfo())
                std::cout << "PfoCharacterisationBaseAlgorithm: unable to find pfo list " << pfoListName << std::endl;

            continue;
        }

        for (const ParticleFlowObject *const pPfo : *pPfoList)
        {
            PandoraContentApi::ParticleFlowObject::Metadata pfoMetadata;
            const bool isTrackLike(m_useThreeDInformation ? this->IsClearTrack(pPfo) : this->IsClearTrack3x2D(pPfo));

            if (isTrackLike)
            {
                pfoMetadata.m_particleId = MU_MINUS;

                if (m_showerPfoListName == pfoListName)
                    showersToTracks.push_back(pPfo);
            }
            else
            {
                pfoMetadata.m_particleId = E_MINUS;

                if (m_trackPfoListName == pfoListName)
                    tracksToShowers.push_back(pPfo);
            }

            if (pPfo->GetParticleId() != pfoMetadata.m_particleId.Get())
                PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::ParticleFlowObject::AlterMetadata(*this, pPfo, pfoMetadata));

            if (!m_updateClusterIds)
                continue;

            ClusterList twoDClusterList;
            LArPfoHelper::GetTwoDClusterList(pPfo, twoDClusterList);

            for (const Cluster *const pCluster : twoDClusterList)
            {
                if (pCluster->GetParticleId() == pfoMetadata.m_particleId.Get())
                    continue;

                PandoraContentApi::Cluster::Metadata clusterMetadata;
                clusterMetadata.m_particleId = pfoMetadata.m_particleId.Get();
                PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::Cluster::AlterMetadata(*this, pCluster, clusterMetadata));
            }
        }
    }

    if (!tracksToShowers.empty())
        PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::SaveList(*this, m_trackPfoListName, m_showerPfoListName, tracksToShowers));

    if (!showersToTracks.empty())
        PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::SaveList(*this, m_showerPfoListName, m_trackPfoListName, showersToTracks));

    return STATUS_CODE_SUCCESS;
}

Member Data Documentation

pandora::StringVector lar_content::PfoCharacterisationBaseAlgorithm::m_inputPfoListNames

protectedinherited

The names of the input pfo lists.

Definition at line 66 of file PfoCharacterisationBaseAlgorithm.h.

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

unsigned int lar_content::PfoCharacterisationBaseAlgorithm::m_minTrackLikeViews

protectedinherited

The minimum number of track-like views to declare a pfo as track-like.

Definition at line 71 of file PfoCharacterisationBaseAlgorithm.h.

Referenced by lar_content::PfoCharacterisationBaseAlgorithm::IsClearTrack3x2D(), and lar_content::PfoCharacterisationBaseAlgorithm::ReadSettings().

bool lar_content::PfoCharacterisationBaseAlgorithm::m_postBranchAddition

protectedinherited

Whether to use configuration for shower clusters post branch addition.

Definition at line 69 of file PfoCharacterisationBaseAlgorithm.h.

std::string lar_content::PfoCharacterisationBaseAlgorithm::m_showerPfoListName

protectedinherited

The shower pfo list name.

Definition at line 65 of file PfoCharacterisationBaseAlgorithm.h.

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

std::string lar_content::PfoCharacterisationBaseAlgorithm::m_trackPfoListName

protectedinherited

The track pfo list name.

Definition at line 64 of file PfoCharacterisationBaseAlgorithm.h.

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

bool lar_content::PfoCharacterisationBaseAlgorithm::m_updateClusterIds

protectedinherited

Whether to update daughter cluster particle id labels to match pfo id.

Definition at line 68 of file PfoCharacterisationBaseAlgorithm.h.

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

bool lar_content::PfoCharacterisationBaseAlgorithm::m_useThreeDInformation

protectedinherited

Whether to use PFO and 3D information or clusters for characterisation.

Definition at line 70 of file PfoCharacterisationBaseAlgorithm.h.

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

---

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

• larpandoracontent/v04_08_01/source/larpandoradlcontent/LArTrackShowerId/DlPfoCharacterisationAlgorithm.h
• larpandoracontent/v04_08_01/source/larpandoradlcontent/LArTrackShowerId/DlPfoCharacterisationAlgorithm.cc