LArSoft  v06_85_00
Liquid Argon Software toolkit - http://larsoft.org/
ClusterCharacterisationBaseAlgorithm.cc
Go to the documentation of this file.
1 
9 #include "Pandora/AlgorithmHeaders.h"
10 
13 
15 
16 using namespace pandora;
17 
18 namespace lar_content
19 {
20 
21 ClusterCharacterisationBaseAlgorithm::ClusterCharacterisationBaseAlgorithm() :
22  m_zeroMode(false),
23  m_overwriteExistingId(false),
24  m_useUnavailableClusters(false)
25 {
26 }
27 
28 //------------------------------------------------------------------------------------------------------------------------------------------
29 
31 {
32 }
33 
34 //------------------------------------------------------------------------------------------------------------------------------------------
35 
37 {
38  for (const std::string &clusterListName : m_inputClusterListNames)
39  {
40  const ClusterList *pClusterList = NULL;
41  PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_INITIALIZED, !=, PandoraContentApi::GetList(*this, clusterListName, pClusterList));
42 
43  if (!pClusterList || pClusterList->empty())
44  {
45  if (PandoraContentApi::GetSettings(*this)->ShouldDisplayAlgorithmInfo())
46  std::cout << "ClusterCharacterisationBaseAlgorithm: unable to find cluster list " << clusterListName << std::endl;
47 
48  continue;
49  }
50 
51  if (m_zeroMode)
52  {
53  for (const Cluster *const pCluster : *pClusterList)
54  {
55  PandoraContentApi::Cluster::Metadata metadata;
56  metadata.m_particleId = UNKNOWN_PARTICLE_TYPE;
57  PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::Cluster::AlterMetadata(*this, pCluster, metadata));
58  }
59 
60  return STATUS_CODE_SUCCESS;
61  }
62 
63  for (const Cluster *const pCluster : *pClusterList)
64  {
65  if (!m_overwriteExistingId && (UNKNOWN_PARTICLE_TYPE != pCluster->GetParticleId()))
66  continue;
67 
68  if (!m_useUnavailableClusters && !PandoraContentApi::IsAvailable(*this, pCluster))
69  continue;
70 
71  PandoraContentApi::Cluster::Metadata metadata;
72 
73  if (this->IsClearTrack(pCluster))
74  {
75  metadata.m_particleId = MU_MINUS;
76  }
77  else
78  {
79  metadata.m_particleId = E_MINUS;
80  }
81 
82  if (pCluster->GetParticleId() != metadata.m_particleId.Get())
83  PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::Cluster::AlterMetadata(*this, pCluster, metadata));
84  }
85  }
86 
87  return STATUS_CODE_SUCCESS;
88 }
89 
90 //------------------------------------------------------------------------------------------------------------------------------------------
91 
92 StatusCode ClusterCharacterisationBaseAlgorithm::ReadSettings(const TiXmlHandle xmlHandle)
93 {
94  PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadVectorOfValues(xmlHandle,
95  "InputClusterListNames", m_inputClusterListNames));
96 
97  PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
98  "ZeroMode", m_zeroMode));
99 
100  PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
101  "OverwriteExistingId", m_overwriteExistingId));
102 
103  PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle,
104  "UseUnavailableClusters", m_useUnavailableClusters));
105 
106  return STATUS_CODE_SUCCESS;
107 }
108 
109 } // namespace lar_content
Header file for the cluster characterisation base algorithm class.
bool m_overwriteExistingId
Whether to consider any clusters that already have an assigned particle id.
Header file for the geometry helper class.
bool m_useUnavailableClusters
Whether to consider clusters that are already constituents of a pfo.
Header file for the cluster helper class.
pandora::StatusCode ReadSettings(const pandora::TiXmlHandle xmlHandle)
pandora::StringVector m_inputClusterListNames
The names of the input cluster lists.
bool m_zeroMode
Whether to zero all existing cluster particle id, overrides all other parameters. ...
virtual bool IsClearTrack(const pandora::Cluster *const pCluster) const =0
Whether cluster is identified as a clear track.