LArSoft  v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
NeutrinoHierarchyAlgorithm.h
Go to the documentation of this file.
1 
8 #ifndef LAR_NEUTRINO_HIERARCHY_ALGORITHM_H
9 #define LAR_NEUTRINO_HIERARCHY_ALGORITHM_H 1
10 
11 #include "Pandora/Algorithm.h"
12 
14 
15 #include <unordered_map>
16 
17 namespace lar_content
18 {
19 
20 class PfoRelationTool;
21 
22 //------------------------------------------------------------------------------------------------------------------------------------------
23 
27 class NeutrinoHierarchyAlgorithm : public pandora::Algorithm
28 {
29 public:
34 
38  class PfoInfo
39  {
40  public:
48  PfoInfo(const pandora::ParticleFlowObject *const pPfo, const unsigned int halfWindowLayers, const float layerPitch);
49 
55  PfoInfo(const PfoInfo &rhs);
56 
62  PfoInfo &operator=(const PfoInfo &rhs);
63 
67  ~PfoInfo();
68 
74  const pandora::ParticleFlowObject *GetThisPfo() const;
75 
81  const pandora::Cluster *GetCluster3D() const;
82 
89 
95  bool IsNeutrinoVertexAssociated() const;
96 
102  bool IsInnerLayerAssociated() const;
103 
109  const pandora::ParticleFlowObject *GetParentPfo() const;
110 
116  const pandora::PfoList &GetDaughterPfoList() const;
117 
123  void SetNeutrinoVertexAssociation(const bool isNeutrinoVertexAssociated);
124 
130  void SetInnerLayerAssociation(const bool isInnerLayerAssociated);
131 
137  void SetParentPfo(const pandora::ParticleFlowObject *const pParentPfo);
138 
142  void RemoveParentPfo();
143 
149  void AddDaughterPfo(const pandora::ParticleFlowObject *const pDaughterPfo);
150 
156  void RemoveDaughterPfo(const pandora::ParticleFlowObject *const pDaughterPfo);
157 
158  private:
159  const pandora::ParticleFlowObject *m_pThisPfo;
160  const pandora::Cluster *m_pCluster3D;
163 
166  const pandora::ParticleFlowObject *m_pParentPfo;
167  pandora::PfoList m_daughterPfoList;
168  };
169 
170  typedef std::unordered_map<const pandora::ParticleFlowObject *, PfoInfo *> PfoInfoMap;
171 
179  void SeparatePfos(const NeutrinoHierarchyAlgorithm::PfoInfoMap &pfoInfoMap, pandora::PfoVector &assignedPfos, pandora::PfoVector &unassignedPfos) const;
180 
181 private:
182  pandora::StatusCode Run();
183 
189  void GetNeutrinoPfo(const pandora::ParticleFlowObject *&pNeutrinoPfo) const;
190 
196  void GetCandidateDaughterPfoList(pandora::PfoList &candidateDaughterPfoList) const;
197 
204  void GetInitialPfoInfoMap(const pandora::PfoList &pfoList, PfoInfoMap &pfoInfoMap) const;
205 
214  void ProcessPfoInfoMap(const pandora::ParticleFlowObject *const pNeutrinoPfo, const pandora::PfoList &candidateDaughterPfoList,
215  PfoInfoMap &pfoInfoMap, const unsigned int callDepth = 0) const;
216 
224  void AdjustVertexAndPfoInfo(const pandora::ParticleFlowObject *const pNeutrinoPfo, const pandora::PfoList &candidateDaughterPfoList,
225  PfoInfoMap &pfoInfoMap) const;
226 
233  void DisplayPfoInfoMap(const pandora::ParticleFlowObject *const pNeutrinoPfo, const PfoInfoMap &pfoInfoMap) const;
234 
235  pandora::StatusCode ReadSettings(const pandora::TiXmlHandle xmlHandle);
236 
237  typedef std::vector<PfoRelationTool *> PfoRelationToolVector;
238  PfoRelationToolVector m_algorithmToolVector;
239 
240  std::string m_neutrinoPfoListName;
241  pandora::StringVector m_daughterPfoListNames;
242 
244 
245  unsigned int m_halfWindowLayers;
247 };
248 
249 //------------------------------------------------------------------------------------------------------------------------------------------
250 
254 class PfoRelationTool : public pandora::AlgorithmTool
255 {
256 public:
264  virtual void Run(const NeutrinoHierarchyAlgorithm *const pAlgorithm, const pandora::Vertex *const pNeutrinoVertex,
266 };
267 
268 //------------------------------------------------------------------------------------------------------------------------------------------
269 
270 inline const pandora::ParticleFlowObject *NeutrinoHierarchyAlgorithm::PfoInfo::GetThisPfo() const
271 {
272  return m_pThisPfo;
273 }
274 
275 //------------------------------------------------------------------------------------------------------------------------------------------
276 
277 inline const pandora::Cluster *NeutrinoHierarchyAlgorithm::PfoInfo::GetCluster3D() const
278 {
279  return m_pCluster3D;
280 }
281 
282 //------------------------------------------------------------------------------------------------------------------------------------------
283 
285 {
286  return m_pSlidingFitResult3D;
287 }
288 
289 //------------------------------------------------------------------------------------------------------------------------------------------
290 
292 {
294 }
295 
296 //------------------------------------------------------------------------------------------------------------------------------------------
297 
299 {
301 }
302 
303 //------------------------------------------------------------------------------------------------------------------------------------------
304 
305 inline const pandora::ParticleFlowObject *NeutrinoHierarchyAlgorithm::PfoInfo::GetParentPfo() const
306 {
307  return m_pParentPfo;
308 }
309 
310 //------------------------------------------------------------------------------------------------------------------------------------------
311 
312 inline const pandora::PfoList &NeutrinoHierarchyAlgorithm::PfoInfo::GetDaughterPfoList() const
313 {
314  return m_daughterPfoList;
315 }
316 
317 } // namespace lar_content
318 
319 #endif // #ifndef LAR_NEUTRINO_HIERARCHY_ALGORITHM_H
void SetInnerLayerAssociation(const bool isInnerLayerAssociated)
Set the inner layer association flag.
pandora::StatusCode ReadSettings(const pandora::TiXmlHandle xmlHandle)
const pandora::ParticleFlowObject * GetThisPfo() const
Get the address of the pfo.
const pandora::Cluster * m_pCluster3D
The address of the three dimensional cluster.
PfoInfo & operator=(const PfoInfo &rhs)
Assignment operator.
void ProcessPfoInfoMap(const pandora::ParticleFlowObject *const pNeutrinoPfo, const pandora::PfoList &candidateDaughterPfoList, PfoInfoMap &pfoInfoMap, const unsigned int callDepth=0) const
Process the information in a pfo info map, creating pfo parent/daughter links.
const ThreeDSlidingFitResult * GetSlidingFitResult3D() const
Get the address of the three dimensional sliding fit result.
bool m_isNeutrinoVertexAssociated
Whether the pfo is associated with the neutrino vertex.
const pandora::Cluster * GetCluster3D() const
Get the address of the three dimensional cluster.
PfoRelationToolVector m_algorithmToolVector
The algorithm tool vector.
const pandora::ParticleFlowObject * m_pThisPfo
The address of the pfo.
bool m_displayPfoInfoMap
Whether to display the pfo info map (if monitoring is enabled)
void DisplayPfoInfoMap(const pandora::ParticleFlowObject *const pNeutrinoPfo, const PfoInfoMap &pfoInfoMap) const
Display the information in a pfo info map, visualising pfo parent/daughter links. ...
void SeparatePfos(const NeutrinoHierarchyAlgorithm::PfoInfoMap &pfoInfoMap, pandora::PfoVector &assignedPfos, pandora::PfoVector &unassignedPfos) const
Query the pfo info map and separate/extract pfos currently either acting as parents or associated wit...
unsigned int m_halfWindowLayers
The number of layers to use for half-window of sliding fit.
std::string m_neutrinoVertexListName
The neutrino vertex list name - if not specified will assume current list.
bool m_isInnerLayerAssociated
If associated, whether association to parent (vtx or pfo) is at sliding fit inner layer...
bool IsInnerLayerAssociated() const
If associated, whether association to parent (vtx or pfo) is at sliding fit inner layer...
void RemoveDaughterPfo(const pandora::ParticleFlowObject *const pDaughterPfo)
Remove a daughter pfo.
void AdjustVertexAndPfoInfo(const pandora::ParticleFlowObject *const pNeutrinoPfo, const pandora::PfoList &candidateDaughterPfoList, PfoInfoMap &pfoInfoMap) const
Adjust neutrino vertex to ensure agreement with at least one pfo (first in sorted input list) ...
const pandora::ParticleFlowObject * GetParentPfo() const
Get the address of the parent pfo.
ThreeDSlidingFitResult * m_pSlidingFitResult3D
The three dimensional sliding fit result.
pandora::PfoList m_daughterPfoList
The daughter pfo list.
const pandora::PfoList & GetDaughterPfoList() const
Get the daughter pfo list.
bool IsNeutrinoVertexAssociated() const
Whether the pfo is associated with the neutrino vertex.
void SetParentPfo(const pandora::ParticleFlowObject *const pParentPfo)
Set the parent pfo.
std::unordered_map< const pandora::ParticleFlowObject *, PfoInfo * > PfoInfoMap
void GetNeutrinoPfo(const pandora::ParticleFlowObject *&pNeutrinoPfo) const
Get the address of the input neutrino pfo - enforces only one pfo present in input list; can return N...
PfoInfo(const pandora::ParticleFlowObject *const pPfo, const unsigned int halfWindowLayers, const float layerPitch)
Constructor.
std::vector< PfoRelationTool * > PfoRelationToolVector
Header file for the lar three dimensional sliding fit result class.
std::string m_neutrinoPfoListName
The neutrino pfo list name.
const pandora::Vertex * m_pVertex3D
The address of the three dimensional vertex.
pandora::StringVector m_daughterPfoListNames
The list of daughter pfo list names.
void SetNeutrinoVertexAssociation(const bool isNeutrinoVertexAssociated)
Set the neutrino vertex association flag.
void AddDaughterPfo(const pandora::ParticleFlowObject *const pDaughterPfo)
Add a daughter pfo.
boost::graph_traits< ModuleGraph >::vertex_descriptor Vertex
Definition: ModuleGraph.h:25
const pandora::ParticleFlowObject * m_pParentPfo
The address of the parent pfo.
void GetCandidateDaughterPfoList(pandora::PfoList &candidateDaughterPfoList) const
Get the list of candidate daughter pfos.
void GetInitialPfoInfoMap(const pandora::PfoList &pfoList, PfoInfoMap &pfoInfoMap) const
Process a provided pfo list and populate an initial pfo info map.