PfoCharacterisationBaseAlgorithm class. More...

#include <PfoCharacterisationBaseAlgorithm.h>

Inheritance diagram for lar_content::PfoCharacterisationBaseAlgorithm:

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

virtual	~PfoCharacterisationBaseAlgorithm ()
	Destructor. 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...

virtual bool	IsClearTrack (const pandora::ParticleFlowObject *const pPfo) const =0
	Whether pfo is identified as a clear track. More...

virtual bool	IsClearTrack (const pandora::Cluster *const pCluster) const =0
	Whether cluster is identified as a clear track. More...

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

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...

Detailed Description

PfoCharacterisationBaseAlgorithm class.

Definition at line 19 of file PfoCharacterisationBaseAlgorithm.h.

Constructor & Destructor Documentation

lar_content::PfoCharacterisationBaseAlgorithm::PfoCharacterisationBaseAlgorithm ( )

Default constructor.

Definition at line 23 of file PfoCharacterisationBaseAlgorithm.cc.

                                                                    :
     m_updateClusterIds(true),
     m_postBranchAddition(false),
     m_useThreeDInformation(true),
     m_minTrackLikeViews(2)
 {
 }

lar_content::PfoCharacterisationBaseAlgorithm::~PfoCharacterisationBaseAlgorithm ( )

virtual

Destructor.

Definition at line 33 of file PfoCharacterisationBaseAlgorithm.cc.

34 {

35 }

Member Function Documentation

virtual bool lar_content::PfoCharacterisationBaseAlgorithm::IsClearTrack ( const pandora::ParticleFlowObject *const pPfo ) const

protectedpure virtual

Whether pfo is identified as a clear track.

Parameters

pPfo	address of the relevant pfo

Returns: boolean

Implemented in lar_content::MvaPfoCharacterisationAlgorithm< T >, lar_content::CutPfoCharacterisationAlgorithm, lar_dl_content::DlPfoCharacterisationAlgorithm, and lar_content::CheatingPfoCharacterisationAlgorithm.

virtual bool lar_content::PfoCharacterisationBaseAlgorithm::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::MvaPfoCharacterisationAlgorithm< T >, lar_content::CutPfoCharacterisationAlgorithm, lar_dl_content::DlPfoCharacterisationAlgorithm, and lar_content::CheatingPfoCharacterisationAlgorithm.

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

protectedvirtual

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.

 {
     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_content::PfoCharacterisationBaseAlgorithm::ReadSettings ( const pandora::TiXmlHandle xmlHandle )

protected

Definition at line 135 of file PfoCharacterisationBaseAlgorithm.cc.

 {
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "TrackPfoListName", m_trackPfoListName));
     m_inputPfoListNames.push_back(m_trackPfoListName);
 
     PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "ShowerPfoListName", m_showerPfoListName));
     m_inputPfoListNames.push_back(m_showerPfoListName);
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "UpdateClusterIds", m_updateClusterIds));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "MinTrackLikeViews", m_minTrackLikeViews));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(
         STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "UseThreeDInformation", m_useThreeDInformation));
 
     return STATUS_CODE_SUCCESS;
 }

StatusCode lar_content::PfoCharacterisationBaseAlgorithm::Run ( )

protected

Definition at line 39 of file PfoCharacterisationBaseAlgorithm.cc.

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