CutPfoCharacterisationAlgorithm class. More...

#include "CutPfoCharacterisationAlgorithm.h"

Inheritance diagram for lar_content::CutPfoCharacterisationAlgorithm:

Public Member Functions
	CutPfoCharacterisationAlgorithm ()
	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_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)

Private Attributes
bool	m_postBranchAddition
	Whether to use configuration for shower clusters post branch addition. More...

unsigned int	m_slidingFitWindow
	The layer window for the sliding linear fits. More...

unsigned int	m_slidingShowerFitWindow
	The layer window for the sliding shower fits. More...

float	m_maxShowerLengthCut
	The maximum cluster length to qualify as a shower. More...

float	m_dTdLWidthRatioCut
	The maximum ratio of transverse fit gradient width to straight line length to qualify as a track. More...

float	m_vertexDistanceRatioCut
	The maximum ratio of vertex separation to straight line length to qualify as a track. More...

float	m_showerWidthRatioCut
	The maximum ratio of shower fit width to straight line length to qualify as a track. More...

Detailed Description

CutPfoCharacterisationAlgorithm class.

Definition at line 19 of file CutPfoCharacterisationAlgorithm.h.

Constructor & Destructor Documentation

lar_content::CutPfoCharacterisationAlgorithm::CutPfoCharacterisationAlgorithm ( )

Default constructor.

Definition at line 24 of file CutPfoCharacterisationAlgorithm.cc.

References f, lar_content::TwoDSlidingFitResult::GetGlobalMaxLayerPosition(), lar_content::TwoDSlidingFitResult::GetGlobalMinLayerPosition(), lar_content::TwoDSlidingFitResult::GetLayerFitResultMap(), lar_content::CutClusterCharacterisationAlgorithm::GetShowerFitWidth(), lar_content::CutClusterCharacterisationAlgorithm::GetVertexDistance(), lar_content::LArGeometryHelper::GetWireZPitch(), IsClearTrack(), m_dTdLWidthRatioCut, m_maxShowerLengthCut, m_showerWidthRatioCut, m_slidingFitWindow, m_slidingShowerFitWindow, m_vertexDistanceRatioCut, max, and min.

                                                                  :
     m_postBranchAddition(false),
     m_slidingFitWindow(5),
     m_slidingShowerFitWindow(10),
     m_maxShowerLengthCut(80.f),
     m_dTdLWidthRatioCut(0.045f),
     m_vertexDistanceRatioCut(0.6f),
     m_showerWidthRatioCut(0.2f)
 {
 }

Member Function Documentation

bool lar_content::CutPfoCharacterisationAlgorithm::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.

Referenced by CutPfoCharacterisationAlgorithm().

bool lar_content::CutPfoCharacterisationAlgorithm::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 81 of file CutPfoCharacterisationAlgorithm.cc.

 {
         throw StatusCodeException(STATUS_CODE_NOT_ALLOWED);
 }

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

private

Definition at line 88 of file CutPfoCharacterisationAlgorithm.cc.

References m_dTdLWidthRatioCut, m_maxShowerLengthCut, m_postBranchAddition, m_showerWidthRatioCut, m_slidingFitWindow, m_slidingShowerFitWindow, m_vertexDistanceRatioCut, and lar_content::PfoCharacterisationBaseAlgorithm::ReadSettings().

 {
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "PostBranchAddition", m_postBranchAddition));
 
     // Allow change in default values via a single xml tag, can subsequently override all individual values below, if required
     if (m_postBranchAddition)
     {
         m_maxShowerLengthCut = 80.f;
         m_dTdLWidthRatioCut = 0.03f;
         m_vertexDistanceRatioCut = 1.f;
         m_showerWidthRatioCut = 0.3f;
     }
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "SlidingFitWindow", m_slidingFitWindow));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "SlidingShowerFitWindow", m_slidingShowerFitWindow));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "MaxShowerLengthCut", m_maxShowerLengthCut));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "DTDLWidthRatioCut", m_dTdLWidthRatioCut));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "VertexDistanceRatioCut", m_vertexDistanceRatioCut));
 
     PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
         "ShowerWidthRatioCut", m_showerWidthRatioCut));
 
     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

float lar_content::CutPfoCharacterisationAlgorithm::m_dTdLWidthRatioCut

private

The maximum ratio of transverse fit gradient width to straight line length to qualify as a track.

Definition at line 36 of file CutPfoCharacterisationAlgorithm.h.

Referenced by CutPfoCharacterisationAlgorithm(), and ReadSettings().

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

float lar_content::CutPfoCharacterisationAlgorithm::m_maxShowerLengthCut

private

The maximum cluster length to qualify as a shower.

Definition at line 35 of file CutPfoCharacterisationAlgorithm.h.

Referenced by CutPfoCharacterisationAlgorithm(), and ReadSettings().

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::CutPfoCharacterisationAlgorithm::m_postBranchAddition

private

Whether to use configuration for shower clusters post branch addition.

Definition at line 32 of file CutPfoCharacterisationAlgorithm.h.

Referenced by ReadSettings().

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

float lar_content::CutPfoCharacterisationAlgorithm::m_showerWidthRatioCut

private

The maximum ratio of shower fit width to straight line length to qualify as a track.

Definition at line 38 of file CutPfoCharacterisationAlgorithm.h.

Referenced by CutPfoCharacterisationAlgorithm(), and ReadSettings().

unsigned int lar_content::CutPfoCharacterisationAlgorithm::m_slidingFitWindow

private

The layer window for the sliding linear fits.

Definition at line 33 of file CutPfoCharacterisationAlgorithm.h.

Referenced by CutPfoCharacterisationAlgorithm(), and ReadSettings().

unsigned int lar_content::CutPfoCharacterisationAlgorithm::m_slidingShowerFitWindow

private

The layer window for the sliding shower fits.

Definition at line 34 of file CutPfoCharacterisationAlgorithm.h.

Referenced by CutPfoCharacterisationAlgorithm(), and ReadSettings().

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

float lar_content::CutPfoCharacterisationAlgorithm::m_vertexDistanceRatioCut

private

The maximum ratio of vertex separation to straight line length to qualify as a track.

Definition at line 37 of file CutPfoCharacterisationAlgorithm.h.

Referenced by CutPfoCharacterisationAlgorithm(), and ReadSettings().

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

/cvmfs/larsoft.opensciencegrid.org/products/larpandoracontent/v03_14_03/source/larpandoracontent/LArTrackShowerId/CutPfoCharacterisationAlgorithm.h
/cvmfs/larsoft.opensciencegrid.org/products/larpandoracontent/v03_14_03/source/larpandoracontent/LArTrackShowerId/CutPfoCharacterisationAlgorithm.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation