Pandora
Pandora source code navigator
Loading...
Searching...
No Matches
VertexMonitoringAlgorithm.cc
Go to the documentation of this file.
1
9#include "Pandora/AlgorithmHeaders.h"
10
11#include "larpandoracontent/LArMonitoring/VertexMonitoringAlgorithm.h"
12
13#include "larpandoracontent/LArHelpers/LArGeometryHelper.h"
14#include "larpandoracontent/LArHelpers/LArInteractionTypeHelper.h"
15#include "larpandoracontent/LArHelpers/LArMCParticleHelper.h"
16#include "larpandoracontent/LArHelpers/LArPfoHelper.h"
17#include "larpandoracontent/LArHelpers/LArVertexHelper.h"
18
19using namespace pandora;
20
21namespace lar_content
22{
23
24VertexMonitoringAlgorithm::VertexMonitoringAlgorithm() :
25 m_visualise{true},
26 m_writeFile{false},
27 m_transparencyThresholdE{-1.f},
28 m_energyScaleThresholdE{1.f},
29 m_scalingFactor{1.f}
30{
31}
32
33//------------------------------------------------------------------------------------------------------------------------------------------
34
35VertexMonitoringAlgorithm::~VertexMonitoringAlgorithm()
36{
37 if (m_writeFile)
38 {
39 PANDORA_MONITORING_API(SaveTree(this->GetPandora(), m_treename.c_str(), m_filename.c_str(), "UPDATE"));
40 }
41}
42
43//------------------------------------------------------------------------------------------------------------------------------------------
44
45StatusCode VertexMonitoringAlgorithm::Run()
46{
47 if (m_visualise)
48 {
49 PANDORA_MONITORING_API(SetEveDisplayParameters(
50 this->GetPandora(), true, DETECTOR_VIEW_XZ, m_transparencyThresholdE, m_energyScaleThresholdE, m_scalingFactor));
51 }
52
53 this->AssessVertices();
54
55 if (m_visualise)
56 {
57 PANDORA_MONITORING_API(ViewEvent(this->GetPandora()));
58 }
59
60 return STATUS_CODE_SUCCESS;
61}
62
63//------------------------------------------------------------------------------------------------------------------------------------------
64
65StatusCode VertexMonitoringAlgorithm::AssessVertices() const
66{
67#ifdef MONITORING
68 const MCParticleList *pMCParticleList{nullptr};
69 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::GetCurrentList(*this, pMCParticleList));
70 const PfoList *pPfoList{nullptr};
71 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, PandoraContentApi::GetCurrentList(*this, pPfoList));
72
73 LArMCParticleHelper::MCContributionMap mcToHitsMap;
74 MCParticleVector primaries;
75 LArMCParticleHelper::GetPrimaryMCParticleList(pMCParticleList, primaries);
76 const MCParticle *pTrueNeutrino{nullptr};
77 const ParticleFlowObject *pRecoNeutrino{nullptr};
78 if (!primaries.empty())
79 {
80 for (const MCParticle *primary : primaries)
81 {
82 const MCParticleList &parents{primary->GetParentList()};
83 if (parents.size() == 1 && LArMCParticleHelper::IsNeutrino(parents.front()))
84 {
85 pTrueNeutrino = parents.front();
86 break;
87 }
88 }
89 }
90
91 for (const ParticleFlowObject *pPfo : *pPfoList)
92 {
93 if (LArPfoHelper::IsNeutrino(pPfo))
94 {
95 pRecoNeutrino = pPfo;
96 break;
97 }
98 }
99
100 MCParticleList primariesList(primaries.begin(), primaries.end());
101 const InteractionDescriptor descriptor{LArInteractionTypeHelper::GetInteractionDescriptor(primariesList)};
102
103 if (pRecoNeutrino && pTrueNeutrino)
104 {
105 const LArTransformationPlugin *transform{this->GetPandora().GetPlugins()->GetLArTransformationPlugin()};
106 const CartesianVector &trueVertex{pTrueNeutrino->GetVertex()};
107 const CartesianVector &recoVertex{LArPfoHelper::GetVertex(pRecoNeutrino)->GetPosition()};
108 if (m_visualise)
109 {
110 const CartesianVector tu(trueVertex.GetX(), 0.f, static_cast<float>(transform->YZtoU(trueVertex.GetY(), trueVertex.GetZ())));
111 const CartesianVector tv(trueVertex.GetX(), 0.f, static_cast<float>(transform->YZtoV(trueVertex.GetY(), trueVertex.GetZ())));
112 const CartesianVector tw(trueVertex.GetX(), 0.f, static_cast<float>(transform->YZtoW(trueVertex.GetY(), trueVertex.GetZ())));
113
114 const CartesianVector ru(recoVertex.GetX(), 0.f, static_cast<float>(transform->YZtoU(recoVertex.GetY(), recoVertex.GetZ())));
115 const CartesianVector rv(recoVertex.GetX(), 0.f, static_cast<float>(transform->YZtoV(recoVertex.GetY(), recoVertex.GetZ())));
116 const CartesianVector rw(recoVertex.GetX(), 0.f, static_cast<float>(transform->YZtoW(recoVertex.GetY(), recoVertex.GetZ())));
117
118 const float du{(ru - tu).GetMagnitude()};
119 const float dv{(rv - tv).GetMagnitude()};
120 const float dw{(rw - tw).GetMagnitude()};
121
122 std::cout << "delta(u, v, w): (" << du << ", " << dv << "," << dw << ")" << std::endl;
123
124 PANDORA_MONITORING_API(AddMarkerToVisualization(this->GetPandora(), &tu, "U true vertex", BLUE, 2));
125 PANDORA_MONITORING_API(AddMarkerToVisualization(this->GetPandora(), &tv, "V true vertex", BLUE, 2));
126 PANDORA_MONITORING_API(AddMarkerToVisualization(this->GetPandora(), &tw, "W true vertex", BLUE, 2));
127 PANDORA_MONITORING_API(AddMarkerToVisualization(this->GetPandora(), &ru, "U reco vertex", RED, 2));
128 PANDORA_MONITORING_API(AddMarkerToVisualization(this->GetPandora(), &rv, "V reco vertex", RED, 2));
129 PANDORA_MONITORING_API(AddMarkerToVisualization(this->GetPandora(), &rw, "W reco vertex", RED, 2));
130 }
131
132 if (m_writeFile && LArVertexHelper::IsInFiducialVolume(this->GetPandora(), trueVertex, "dune_fd_hd"))
133 {
134 const CartesianVector delta{recoVertex - trueVertex};
135 const float dx{delta.GetX()}, dy{delta.GetY()}, dz{delta.GetZ()}, dr{delta.GetMagnitude()};
136 const float trueNuEnergy{pTrueNeutrino->GetEnergy()};
137 const int success{1};
138 const int isCC{descriptor.IsCC()};
139 const int isQE{descriptor.IsQE()};
140 const int isRes{descriptor.IsResonant()};
141 const int isDIS{descriptor.IsDIS()};
142 const int isCoh{descriptor.IsCoherent()};
143 const int isOther{!(isCC || isQE || isRes || isDIS)};
144 const int isMu{descriptor.IsMuonNeutrino()};
145 const int isElectron{descriptor.IsElectronNeutrino()};
146 const int nPiZero{static_cast<int>(descriptor.GetNumPiZero())};
147 const int nPiPlus{static_cast<int>(descriptor.GetNumPiPlus())};
148 const int nPiMinus{static_cast<int>(descriptor.GetNumPiMinus())};
149 const int nPhotons{static_cast<int>(descriptor.GetNumPhotons())};
150 const int nProtons{static_cast<int>(descriptor.GetNumProtons())};
151 PANDORA_MONITORING_API(SetTreeVariable(this->GetPandora(), m_treename.c_str(), "success", success));
152 PANDORA_MONITORING_API(SetTreeVariable(this->GetPandora(), m_treename.c_str(), "trueNuEnergy", trueNuEnergy));
153 PANDORA_MONITORING_API(SetTreeVariable(this->GetPandora(), m_treename.c_str(), "isCC", isCC));
154 PANDORA_MONITORING_API(SetTreeVariable(this->GetPandora(), m_treename.c_str(), "isQE", isQE));
155 PANDORA_MONITORING_API(SetTreeVariable(this->GetPandora(), m_treename.c_str(), "isRes", isRes));
156 PANDORA_MONITORING_API(SetTreeVariable(this->GetPandora(), m_treename.c_str(), "isDIS", isDIS));
157 PANDORA_MONITORING_API(SetTreeVariable(this->GetPandora(), m_treename.c_str(), "isCoh", isCoh));
158 PANDORA_MONITORING_API(SetTreeVariable(this->GetPandora(), m_treename.c_str(), "isOther", isOther));
159 PANDORA_MONITORING_API(SetTreeVariable(this->GetPandora(), m_treename.c_str(), "isMu", isMu));
160 PANDORA_MONITORING_API(SetTreeVariable(this->GetPandora(), m_treename.c_str(), "isElectron", isElectron));
161 PANDORA_MONITORING_API(SetTreeVariable(this->GetPandora(), m_treename.c_str(), "nPiZero", nPiZero));
162 PANDORA_MONITORING_API(SetTreeVariable(this->GetPandora(), m_treename.c_str(), "nPiPlus", nPiPlus));
163 PANDORA_MONITORING_API(SetTreeVariable(this->GetPandora(), m_treename.c_str(), "nPiMinus", nPiMinus));
164 PANDORA_MONITORING_API(SetTreeVariable(this->GetPandora(), m_treename.c_str(), "nPhotons", nPhotons));
165 PANDORA_MONITORING_API(SetTreeVariable(this->GetPandora(), m_treename.c_str(), "nProtons", nProtons));
166 PANDORA_MONITORING_API(SetTreeVariable(this->GetPandora(), m_treename.c_str(), "dx", dx));
167 PANDORA_MONITORING_API(SetTreeVariable(this->GetPandora(), m_treename.c_str(), "dy", dy));
168 PANDORA_MONITORING_API(SetTreeVariable(this->GetPandora(), m_treename.c_str(), "dz", dz));
169 PANDORA_MONITORING_API(SetTreeVariable(this->GetPandora(), m_treename.c_str(), "dr", dr));
170 PANDORA_MONITORING_API(FillTree(this->GetPandora(), m_treename.c_str()));
171 }
172 }
173 else if (pTrueNeutrino)
174 {
175 const CartesianVector &trueVertex{pTrueNeutrino->GetVertex()};
176
177 if (m_writeFile && LArVertexHelper::IsInFiducialVolume(this->GetPandora(), trueVertex, "dune_fd_hd"))
178 {
179 const int success{0};
180 const float dx{-999.f}, dy{-999.f}, dz{-999.f}, dr{-999.f};
181 const float trueNuEnergy{pTrueNeutrino->GetEnergy()};
182 const int isCC{descriptor.IsCC()};
183 const int isQE{descriptor.IsQE()};
184 const int isRes{descriptor.IsResonant()};
185 const int isDIS{descriptor.IsDIS()};
186 const int isCoh{descriptor.IsCoherent()};
187 const int isOther{!(isCC || isQE || isRes || isDIS)};
188 const int isMu{descriptor.IsMuonNeutrino()};
189 const int isElectron{descriptor.IsElectronNeutrino()};
190 const int nPiZero{static_cast<int>(descriptor.GetNumPiZero())};
191 const int nPiPlus{static_cast<int>(descriptor.GetNumPiPlus())};
192 const int nPiMinus{static_cast<int>(descriptor.GetNumPiMinus())};
193 const int nPhotons{static_cast<int>(descriptor.GetNumPhotons())};
194 const int nProtons{static_cast<int>(descriptor.GetNumProtons())};
195 PANDORA_MONITORING_API(SetTreeVariable(this->GetPandora(), m_treename.c_str(), "success", success));
196 PANDORA_MONITORING_API(SetTreeVariable(this->GetPandora(), m_treename.c_str(), "trueNuEnergy", trueNuEnergy));
197 PANDORA_MONITORING_API(SetTreeVariable(this->GetPandora(), m_treename.c_str(), "isCC", isCC));
198 PANDORA_MONITORING_API(SetTreeVariable(this->GetPandora(), m_treename.c_str(), "isQE", isQE));
199 PANDORA_MONITORING_API(SetTreeVariable(this->GetPandora(), m_treename.c_str(), "isRes", isRes));
200 PANDORA_MONITORING_API(SetTreeVariable(this->GetPandora(), m_treename.c_str(), "isDIS", isDIS));
201 PANDORA_MONITORING_API(SetTreeVariable(this->GetPandora(), m_treename.c_str(), "isCoh", isCoh));
202 PANDORA_MONITORING_API(SetTreeVariable(this->GetPandora(), m_treename.c_str(), "isOther", isOther));
203 PANDORA_MONITORING_API(SetTreeVariable(this->GetPandora(), m_treename.c_str(), "isMu", isMu));
204 PANDORA_MONITORING_API(SetTreeVariable(this->GetPandora(), m_treename.c_str(), "isElectron", isElectron));
205 PANDORA_MONITORING_API(SetTreeVariable(this->GetPandora(), m_treename.c_str(), "nPiZero", nPiZero));
206 PANDORA_MONITORING_API(SetTreeVariable(this->GetPandora(), m_treename.c_str(), "nPiPlus", nPiPlus));
207 PANDORA_MONITORING_API(SetTreeVariable(this->GetPandora(), m_treename.c_str(), "nPiMinus", nPiMinus));
208 PANDORA_MONITORING_API(SetTreeVariable(this->GetPandora(), m_treename.c_str(), "nPhotons", nPhotons));
209 PANDORA_MONITORING_API(SetTreeVariable(this->GetPandora(), m_treename.c_str(), "nProtons", nProtons));
210 PANDORA_MONITORING_API(SetTreeVariable(this->GetPandora(), m_treename.c_str(), "dx", dx));
211 PANDORA_MONITORING_API(SetTreeVariable(this->GetPandora(), m_treename.c_str(), "dy", dy));
212 PANDORA_MONITORING_API(SetTreeVariable(this->GetPandora(), m_treename.c_str(), "dz", dz));
213 PANDORA_MONITORING_API(SetTreeVariable(this->GetPandora(), m_treename.c_str(), "dr", dr));
214 PANDORA_MONITORING_API(FillTree(this->GetPandora(), m_treename.c_str()));
215 }
216 }
217#endif
218
219 return STATUS_CODE_SUCCESS;
220}
221
222//------------------------------------------------------------------------------------------------------------------------------------------
223
224StatusCode VertexMonitoringAlgorithm::ReadSettings(const TiXmlHandle xmlHandle)
225{
226 PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "Visualize", m_visualise));
227 PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "WriteFile", m_writeFile));
228 if (m_writeFile)
229 {
230 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "Filename", m_filename));
231 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, XmlHelper::ReadValue(xmlHandle, "Treename", m_treename));
232 }
233
234 PANDORA_RETURN_RESULT_IF_AND_IF(
235 STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "TransparencyThresholdE", m_transparencyThresholdE));
236 PANDORA_RETURN_RESULT_IF_AND_IF(
237 STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "EnergyScaleThresholdE", m_energyScaleThresholdE));
238 PANDORA_RETURN_RESULT_IF_AND_IF(STATUS_CODE_SUCCESS, STATUS_CODE_NOT_FOUND, !=, XmlHelper::ReadValue(xmlHandle, "ScalingFactor", m_scalingFactor));
239
240 return STATUS_CODE_SUCCESS;
241}
242
243} // namespace lar_content
AlgorithmHeaders.h
Grouping of header files for many classes of use in particle flow algorithms.
PANDORA_MONITORING_API
#define PANDORA_MONITORING_API(command)
Definition AlgorithmHeaders.h:66
LArGeometryHelper.h
Header file for the geometry helper class.
LArInteractionTypeHelper.h
Header file for the interaction type helper class.
LArMCParticleHelper.h
Header file for the lar monte carlo particle helper helper class.
LArPfoHelper.h
Header file for the pfo helper class.
LArVertexHelper.h
Header file for the vertex helper class.
PANDORA_RETURN_RESULT_IF_AND_IF
#define PANDORA_RETURN_RESULT_IF_AND_IF(StatusCode1, StatusCode2, Operator, Command)
Definition StatusCodes.h:31
PANDORA_RETURN_RESULT_IF
#define PANDORA_RETURN_RESULT_IF(StatusCode1, Operator, Command)
Definition StatusCodes.h:19
VertexMonitoringAlgorithm.h
Header file for the particle visualisation algorithm.
PandoraContentApi::GetCurrentList
static pandora::StatusCode GetCurrentList(const pandora::Algorithm &algorithm, const T *&pT)
Get the current list.
Definition PandoraContentApi.cc:75
lar_content::InteractionDescriptor
Definition LArInteractionTypeHelper.h:332
lar_content::LArInteractionTypeHelper::GetInteractionDescriptor
static InteractionDescriptor GetInteractionDescriptor(const pandora::MCParticleList &mcPrimaryList)
Get the interaction descriptor of an event.
Definition LArInteractionTypeHelper.cc:416
lar_content::LArMCParticleHelper::GetPrimaryMCParticleList
static void GetPrimaryMCParticleList(const pandora::MCParticleList *const pMCParticleList, pandora::MCParticleVector &mcPrimaryVector)
Get vector of primary MC particles from an input list of MC particles.
Definition LArMCParticleHelper.cc:308
lar_content::LArMCParticleHelper::IsNeutrino
static bool IsNeutrino(const pandora::MCParticle *const pMCParticle)
Whether a mc particle is a neutrino or antineutrino.
Definition LArMCParticleHelper.cc:131
lar_content::LArMCParticleHelper::MCContributionMap
std::unordered_map< const pandora::MCParticle *, pandora::CaloHitList > MCContributionMap
Definition LArMCParticleHelper.h:35
lar_content::LArPfoHelper::IsNeutrino
static bool IsNeutrino(const pandora::ParticleFlowObject *const pPfo)
Whether a pfo is a neutrino or (antineutrino)
Definition LArPfoHelper.cc:399
lar_content::LArPfoHelper::GetVertex
static const pandora::Vertex * GetVertex(const pandora::ParticleFlowObject *const pPfo)
Get the pfo vertex.
Definition LArPfoHelper.cc:471
lar_content::LArVertexHelper::IsInFiducialVolume
static bool IsInFiducialVolume(const pandora::Pandora &pandora, const pandora::CartesianVector &vertex, const std::string &detector)
Determine if a vertex is within a detector's fiducial volume. This throws a STATUS_CODE_INVALID_PARAM...
Definition LArVertexHelper.cc:67
lar_content::VertexMonitoringAlgorithm::AssessVertices
pandora::StatusCode AssessVertices() const
Definition VertexMonitoringAlgorithm.cc:65
lar_content::VertexMonitoringAlgorithm::m_writeFile
bool m_writeFile
Definition VertexMonitoringAlgorithm.h:36
lar_content::VertexMonitoringAlgorithm::m_transparencyThresholdE
float m_transparencyThresholdE
Cell energy for which transparency is saturated (0%, fully opaque)
Definition VertexMonitoringAlgorithm.h:39
lar_content::VertexMonitoringAlgorithm::Run
pandora::StatusCode Run()
Run the algorithm.
Definition VertexMonitoringAlgorithm.cc:45
lar_content::VertexMonitoringAlgorithm::ReadSettings
pandora::StatusCode ReadSettings(const pandora::TiXmlHandle xmlHandle)
Read the algorithm settings.
Definition VertexMonitoringAlgorithm.cc:224
lar_content::VertexMonitoringAlgorithm::m_energyScaleThresholdE
float m_energyScaleThresholdE
Cell energy for which color is at top end of continous color palette.
Definition VertexMonitoringAlgorithm.h:40
lar_content::VertexMonitoringAlgorithm::m_filename
std::string m_filename
Definition VertexMonitoringAlgorithm.h:37
lar_content::VertexMonitoringAlgorithm::m_scalingFactor
float m_scalingFactor
TEve works with [cm], Pandora usually works with [mm] (but LArContent went with cm too)
Definition VertexMonitoringAlgorithm.h:41
lar_content::VertexMonitoringAlgorithm::VertexMonitoringAlgorithm
VertexMonitoringAlgorithm()
Default constructor.
Definition VertexMonitoringAlgorithm.cc:24
lar_content::VertexMonitoringAlgorithm::m_visualise
bool m_visualise
Definition VertexMonitoringAlgorithm.h:35
lar_content::VertexMonitoringAlgorithm::m_treename
std::string m_treename
Definition VertexMonitoringAlgorithm.h:38
lar_content::VertexMonitoringAlgorithm::~VertexMonitoringAlgorithm
virtual ~VertexMonitoringAlgorithm()
Definition VertexMonitoringAlgorithm.cc:35
pandora::CartesianVector
CartesianVector class.
Definition CartesianVector.h:24
pandora::CartesianVector::GetX
float GetX() const
Get the cartesian x coordinate.
Definition CartesianVector.h:259
pandora::LArTransformationPlugin
LArTransformationPlugin class.
Definition LArTransformationPlugin.h:21
pandora::MCParticle
MCParticle class.
Definition MCParticle.h:26
pandora::Pandora::GetPlugins
const PluginManager * GetPlugins() const
Get the pandora plugin instance, providing access to user registered functions and calculators.
Definition Pandora.cc:196
pandora::ParticleFlowObject
ParticleFlowObject class.
Definition ParticleFlowObject.h:26
pandora::PluginManager::GetLArTransformationPlugin
const LArTransformationPlugin * GetLArTransformationPlugin() const
Get the address of the lar transformation plugin.
Definition PluginManager.cc:104
pandora::Process::GetPandora
const Pandora & GetPandora() const
Get the associated pandora instance.
Definition Process.h:116
pandora::Vertex::GetPosition
const CartesianVector & GetPosition() const
Get the vertex position.
Definition Vertex.h:103
pandora::XmlHelper::ReadValue
static StatusCode ReadValue(const TiXmlHandle &xmlHandle, const std::string &xmlElementName, T &t)
Read a value from an xml element.
Definition XmlHelper.h:136
lar_content
Definition CheatingBeamParticleIdTool.cc:19
pandora::MCParticleList
MANAGED_CONTAINER< const MCParticle * > MCParticleList
Definition PandoraInternal.h:437
pandora::MCParticleVector
std::vector< const MCParticle * > MCParticleVector
Definition PandoraInternal.h:448
pandora::StatusCode
StatusCode
The StatusCode enum.
Definition StatusCodes.h:100
pandora::PfoList
MANAGED_CONTAINER< const ParticleFlowObject * > PfoList
Definition PandoraInternal.h:439