Public Member Functions | Private Member Functions | Private Attributes | List of all members
lar_content::PfoValidationAlgorithm Class Reference

PfoValidationAlgorithm class. More...

#include <PfoValidationAlgorithm.h>

Inheritance diagram for lar_content::PfoValidationAlgorithm:

Public Member Functions

 PfoValidationAlgorithm ()
 Default constructor. More...
 

Private Member Functions

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

Private Attributes

std::string m_caloHitListName
 Name of input calo hit list. More...
 
std::string m_pfoListName
 Name of input pfo list. More...
 
LArMCParticleHelper::PrimaryParameters m_parameters
 Parameters used to decide when an MCParticle is reconstructable. More...
 
unsigned int m_nMatchesToShow
 The maximum number of MCParticle to Pfo matches to show. More...
 

Detailed Description

PfoValidationAlgorithm class.

Definition at line 19 of file PfoValidationAlgorithm.h.

Constructor & Destructor Documentation

lar_content::PfoValidationAlgorithm::PfoValidationAlgorithm ( )

Default constructor.

Definition at line 23 of file PfoValidationAlgorithm.cc.

23  : m_nMatchesToShow(3)
24 {
25 }
lar_content::PfoValidationAlgorithm::m_nMatchesToShow
unsigned int m_nMatchesToShow
The maximum number of MCParticle to Pfo matches to show.
Definition: PfoValidationAlgorithm.h:34

Member Function Documentation

StatusCode lar_content::PfoValidationAlgorithm::ReadSettings ( const pandora::TiXmlHandle  xmlHandle)
private

Definition at line 102 of file PfoValidationAlgorithm.cc.

103 {
104  PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "CaloHitListName", m_caloHitListName));
105  PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "PfoListName", m_pfoListName));
106 
107  PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
108  XmlHelper::ReadValue(xmlHandle, "MinPrimaryGoodHits", m_parameters.m_minPrimaryGoodHits));
109 
110  PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
111  XmlHelper::ReadValue(xmlHandle, "MinHitsForGoodView", m_parameters.m_minHitsForGoodView));
112 
113  PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
114  XmlHelper::ReadValue(xmlHandle, "MinPrimaryGoodViews", m_parameters.m_minPrimaryGoodViews));
115 
116  PANDORA_RETURN_RESULT_IF_AND_IF(
117  STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "SelectInputHits", m_parameters.m_selectInputHits));
118 
119  PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
120  XmlHelper::ReadValue(xmlHandle, "MaxPhotonPropagation", m_parameters.m_maxPhotonPropagation));
121 
122  PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=,
123  XmlHelper::ReadValue(xmlHandle, "MinHitSharingFraction", m_parameters.m_minHitSharingFraction));
124 
125  PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "NumMatchesToShow", m_nMatchesToShow));
126 
127  return STATUS_CODE_SUCCESS;
128 }
lar_content::LArMCParticleHelper::PrimaryParameters::m_minPrimaryGoodViews
unsigned int m_minPrimaryGoodViews
the minimum number of primary good views
Definition: LArMCParticleHelper.h:65
lar_content::LArMCParticleHelper::PrimaryParameters::m_selectInputHits
bool m_selectInputHits
whether to select input hits
Definition: LArMCParticleHelper.h:66
lar_content::LArMCParticleHelper::PrimaryParameters::m_minPrimaryGoodHits
unsigned int m_minPrimaryGoodHits
the minimum number of primary good Hits
Definition: LArMCParticleHelper.h:63
lar_content::PfoValidationAlgorithm::m_nMatchesToShow
unsigned int m_nMatchesToShow
The maximum number of MCParticle to Pfo matches to show.
Definition: PfoValidationAlgorithm.h:34
lar_content::LArMCParticleHelper::PrimaryParameters::m_minHitsForGoodView
unsigned int m_minHitsForGoodView
the minimum number of Hits for a good view
Definition: LArMCParticleHelper.h:64
lar_content::LArMCParticleHelper::PrimaryParameters::m_maxPhotonPropagation
float m_maxPhotonPropagation
the maximum photon propagation length
Definition: LArMCParticleHelper.h:67
lar_content::LArMCParticleHelper::PrimaryParameters::m_minHitSharingFraction
float m_minHitSharingFraction
the minimum Hit sharing fraction
Definition: LArMCParticleHelper.h:68
lar_content::PfoValidationAlgorithm::m_parameters
LArMCParticleHelper::PrimaryParameters m_parameters
Parameters used to decide when an MCParticle is reconstructable.
Definition: PfoValidationAlgorithm.h:33
lar_content::PfoValidationAlgorithm::m_caloHitListName
std::string m_caloHitListName
Name of input calo hit list.
Definition: PfoValidationAlgorithm.h:31
lar_content::PfoValidationAlgorithm::m_pfoListName
std::string m_pfoListName
Name of input pfo list.
Definition: PfoValidationAlgorithm.h:32
StatusCode lar_content::PfoValidationAlgorithm::Run ( )
private

Definition at line 29 of file PfoValidationAlgorithm.cc.

30 {
31  const MCParticleList *pMCParticleList = nullptr;
32  PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::GetCurrentList(*this, pMCParticleList));
33 
34  const CaloHitList *pCaloHitList = nullptr;
35  PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::GetList(*this, m_caloHitListName, pCaloHitList));
36 
37  const PfoList *pPfoList = nullptr;
38  PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::GetList(*this, m_pfoListName, pPfoList));
39 
40  // Identify reconstructable MCParticles, and get mappings to their good hits
41  LArMCParticleHelper::MCContributionMap nuMCParticlesToGoodHitsMap;
42  LArMCParticleHelper::MCContributionMap beamMCParticlesToGoodHitsMap;
43  LArMCParticleHelper::MCContributionMap crMCParticlesToGoodHitsMap;
44 
45  LArMCParticleHelper::SelectReconstructableMCParticles(
46  pMCParticleList, pCaloHitList, m_parameters, LArMCParticleHelper::IsBeamNeutrinoFinalState, nuMCParticlesToGoodHitsMap);
47  LArMCParticleHelper::SelectReconstructableMCParticles(
48  pMCParticleList, pCaloHitList, m_parameters, LArMCParticleHelper::IsBeamParticle, beamMCParticlesToGoodHitsMap);
49  LArMCParticleHelper::SelectReconstructableMCParticles(
50  pMCParticleList, pCaloHitList, m_parameters, LArMCParticleHelper::IsCosmicRay, crMCParticlesToGoodHitsMap);
51 
52  const LArMCParticleHelper::MCContributionMapVector mcParticlesToGoodHitsMaps{
53  nuMCParticlesToGoodHitsMap, beamMCParticlesToGoodHitsMap, crMCParticlesToGoodHitsMap};
54 
55  // Get the mappings detailing the hits shared between Pfos and reconstructable MCParticles
56  PfoList finalStatePfos;
57 
58  for (const ParticleFlowObject *const pPfo : *pPfoList)
59  {
60  if (LArPfoHelper::IsFinalState(pPfo))
61  finalStatePfos.push_back(pPfo);
62  }
63 
64  LArMCParticleHelper::PfoContributionMap pfoToReconstructable2DHitsMap;
65  LArMCParticleHelper::GetPfoToReconstructable2DHitsMap(
66  finalStatePfos, mcParticlesToGoodHitsMaps, pfoToReconstructable2DHitsMap, m_parameters.m_foldBackHierarchy);
67 
68  LArMCParticleHelper::PfoToMCParticleHitSharingMap pfoToMCParticleHitSharingMap;
69  LArMCParticleHelper::MCParticleToPfoHitSharingMap mcParticleToPfoHitSharingMap;
70  LArMCParticleHelper::GetPfoMCParticleHitSharingMaps(
71  pfoToReconstructable2DHitsMap, mcParticlesToGoodHitsMaps, pfoToMCParticleHitSharingMap, mcParticleToPfoHitSharingMap);
72 
73  // Print the monte-carlo information for this event
74  MCParticleVector orderedMCParticleVector;
75  LArMonitoringHelper::GetOrderedMCParticleVector(mcParticlesToGoodHitsMaps, orderedMCParticleVector);
76 
77  LArFormattingHelper::PrintHeader("MC : Reconstructable neutrino final state particles");
78  LArMonitoringHelper::PrintMCParticleTable(nuMCParticlesToGoodHitsMap, orderedMCParticleVector);
79 
80  LArFormattingHelper::PrintHeader("MC : Reconstructable primary beam particles");
81  LArMonitoringHelper::PrintMCParticleTable(beamMCParticlesToGoodHitsMap, orderedMCParticleVector);
82 
83  LArFormattingHelper::PrintHeader("MC : Reconstructable primary cosmic-rays");
84  LArMonitoringHelper::PrintMCParticleTable(crMCParticlesToGoodHitsMap, orderedMCParticleVector);
85 
86  // Print the pfo information for this event
87  PfoVector orderedPfoVector;
88  LArMonitoringHelper::GetOrderedPfoVector(pfoToReconstructable2DHitsMap, orderedPfoVector);
89 
90  LArFormattingHelper::PrintHeader("Reco : Primary Pfos");
91  LArMonitoringHelper::PrintPfoTable(pfoToReconstructable2DHitsMap, orderedPfoVector);
92 
93  // Print the raw matching between Pfos and MCParticles
94  LArFormattingHelper::PrintHeader("Raw Reco vs. MC matching");
95  LArMonitoringHelper::PrintMatchingTable(orderedPfoVector, orderedMCParticleVector, mcParticleToPfoHitSharingMap, m_nMatchesToShow);
96 
97  return STATUS_CODE_SUCCESS;
98 }
lar_content::LArMCParticleHelper::MCContributionMap
std::unordered_map< const pandora::MCParticle *, pandora::CaloHitList > MCContributionMap
Definition: LArMCParticleHelper.h:35
lar_content::LArMonitoringHelper::PrintMCParticleTable
static void PrintMCParticleTable(const LArMCParticleHelper::MCContributionMap &selectedMCParticleToGoodHitsMaps, const pandora::MCParticleVector &orderedMCParticleVector)
Print details of selected MCParticles to the terminal in a table.
Definition: LArMonitoringHelper.cc:124
lar_content::LArMCParticleHelper::GetPfoToReconstructable2DHitsMap
static void GetPfoToReconstructable2DHitsMap(const pandora::PfoList &pfoList, const MCContributionMap &selectedMCParticleToHitsMap, PfoContributionMap &pfoToReconstructable2DHitsMap, const bool foldBackHierarchy)
Get mapping from Pfo to reconstructable 2D hits (=good hits belonging to a selected reconstructable M...
lar_content::LArMCParticleHelper::GetPfoMCParticleHitSharingMaps
static void GetPfoMCParticleHitSharingMaps(const PfoContributionMap &pfoToReconstructable2DHitsMap, const MCContributionMapVector &selectedMCParticleToHitsMaps, PfoToMCParticleHitSharingMap &pfoToMCParticleHitSharingMap, MCParticleToPfoHitSharingMap &mcParticleToPfoHitSharingMap)
Get the mappings from Pfo -> pair (reconstructable MCparticles, number of reconstructable 2D hits sha...
Definition: LArMCParticleHelper.cc:671
lar_content::LArMCParticleHelper::MCParticleToPfoHitSharingMap
std::map< const pandora::MCParticle *, PfoToSharedHitsVector > MCParticleToPfoHitSharingMap
Definition: LArMCParticleHelper.h:50
lar_content::PfoValidationAlgorithm::m_nMatchesToShow
unsigned int m_nMatchesToShow
The maximum number of MCParticle to Pfo matches to show.
Definition: PfoValidationAlgorithm.h:34
gar::gar_pandora::MCParticleVector
std::vector< art::Ptr< simb::MCParticle > > MCParticleVector
Definition: MCParticleCreator.h:23
lar_content::LArMCParticleHelper::PrimaryParameters::m_foldBackHierarchy
bool m_foldBackHierarchy
whether to fold the hierarchy back to the primary (neutrino) or leading particles (test beam) ...
Definition: LArMCParticleHelper.h:69
lar_content::LArMonitoringHelper::GetOrderedMCParticleVector
static void GetOrderedMCParticleVector(const LArMCParticleHelper::MCContributionMapVector &selectedMCParticleToGoodHitsMaps, pandora::MCParticleVector &orderedMCParticleVector)
Order input MCParticles by their number of hits.
Definition: LArMonitoringHelper.cc:43
lar_content::LArMCParticleHelper::IsCosmicRay
static bool IsCosmicRay(const pandora::MCParticle *const pMCParticle)
Return true if passed a primary cosmic ray MCParticle.
Definition: LArMCParticleHelper.cc:110
lar_content::LArMCParticleHelper::SelectReconstructableMCParticles
static void SelectReconstructableMCParticles(const pandora::MCParticleList *pMCParticleList, const pandora::CaloHitList *pCaloHitList, const PrimaryParameters &parameters, std::function< bool(const pandora::MCParticle *const)> fCriteria, MCContributionMap &selectedMCParticlesToHitsMap)
Select target, reconstructable mc particles that match given criteria.
Definition: LArMCParticleHelper.cc:531
lar_content::LArMCParticleHelper::IsBeamParticle
static bool IsBeamParticle(const pandora::MCParticle *const pMCParticle)
Returns true if passed a primary beam MCParticle.
Definition: LArMCParticleHelper.cc:93
lar_content::LArFormattingHelper::PrintHeader
static void PrintHeader(const std::string &title="", const unsigned int width=140)
Print a header line of a given width.
Definition: LArFormattingHelper.cc:71
lar_content::LArMonitoringHelper::GetOrderedPfoVector
static void GetOrderedPfoVector(const LArMCParticleHelper::PfoContributionMap &pfoToReconstructable2DHitsMap, pandora::PfoVector &orderedPfoVector)
Order input Pfos by their number of hits.
Definition: LArMonitoringHelper.cc:91
lar_content::LArMCParticleHelper::MCContributionMapVector
std::vector< MCContributionMap > MCContributionMapVector
Definition: LArMCParticleHelper.h:36
lar_content::PfoValidationAlgorithm::m_parameters
LArMCParticleHelper::PrimaryParameters m_parameters
Parameters used to decide when an MCParticle is reconstructable.
Definition: PfoValidationAlgorithm.h:33
lar_content::LArPfoHelper::IsFinalState
static bool IsFinalState(const pandora::ParticleFlowObject *const pPfo)
Whether a pfo is a primary parent particle.
Definition: LArPfoHelper.cc:379
lar_content::PfoValidationAlgorithm::m_caloHitListName
std::string m_caloHitListName
Name of input calo hit list.
Definition: PfoValidationAlgorithm.h:31
lar_content::LArMonitoringHelper::PrintMatchingTable
static void PrintMatchingTable(const pandora::PfoVector &orderedPfoVector, const pandora::MCParticleVector &orderedMCParticleVector, const LArMCParticleHelper::MCParticleToPfoHitSharingMap &mcParticleToPfoHitSharingMap, const unsigned int nMatches)
Print the shared good hits between all Pfos and MCParticles.
Definition: LArMonitoringHelper.cc:203
lar_content::PfoValidationAlgorithm::m_pfoListName
std::string m_pfoListName
Name of input pfo list.
Definition: PfoValidationAlgorithm.h:32
lar_content::LArMCParticleHelper::PfoContributionMap
std::unordered_map< const pandora::ParticleFlowObject *, pandora::CaloHitList > PfoContributionMap
Definition: LArMCParticleHelper.h:39
lar_content::LArMCParticleHelper::IsBeamNeutrinoFinalState
static bool IsBeamNeutrinoFinalState(const pandora::MCParticle *const pMCParticle)
Returns true if passed a primary neutrino final state MCParticle.
Definition: LArMCParticleHelper.cc:77
lar_content::LArMonitoringHelper::PrintPfoTable
static void PrintPfoTable(const LArMCParticleHelper::PfoContributionMap &pfoToReconstructable2DHitsMap, const pandora::PfoVector &orderedPfoVector)
Print details of input Pfos to the terminal in a table.
Definition: LArMonitoringHelper.cc:169
lar_content::LArMCParticleHelper::PfoToMCParticleHitSharingMap
std::map< const pandora::ParticleFlowObject *, MCParticleToSharedHitsVector > PfoToMCParticleHitSharingMap
Definition: LArMCParticleHelper.h:49

Member Data Documentation

std::string lar_content::PfoValidationAlgorithm::m_caloHitListName
private

Name of input calo hit list.

Definition at line 31 of file PfoValidationAlgorithm.h.

unsigned int lar_content::PfoValidationAlgorithm::m_nMatchesToShow
private

The maximum number of MCParticle to Pfo matches to show.

Definition at line 34 of file PfoValidationAlgorithm.h.

LArMCParticleHelper::PrimaryParameters lar_content::PfoValidationAlgorithm::m_parameters
private

Parameters used to decide when an MCParticle is reconstructable.

Definition at line 33 of file PfoValidationAlgorithm.h.

std::string lar_content::PfoValidationAlgorithm::m_pfoListName
private

Name of input pfo list.

Definition at line 32 of file PfoValidationAlgorithm.h.

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.11