Pandora
Pandora source code navigator
Loading...
Searching...
No Matches
BinaryFileWriter.cc
Go to the documentation of this file.
1
9#include "Api/PandoraContentApi.h"
10#include "Api/PandoraContentApiImpl.h"
11
12#include "Geometry/DetectorGap.h"
13#include "Geometry/LArTPC.h"
14#include "Geometry/SubDetector.h"
15
16#include "Objects/CaloHit.h"
17#include "Objects/MCParticle.h"
18#include "Objects/Track.h"
19
20#include "Persistency/BinaryFileWriter.h"
21
22namespace pandora
23{
24
25BinaryFileWriter::BinaryFileWriter(const pandora::Pandora &pandora, const std::string &fileName, const FileMode fileMode) :
26 FileWriter(pandora, fileName)
27{
28 m_fileType = BINARY;
29
30 if (APPEND == fileMode)
31 {
32 m_fileStream.open(fileName.c_str(), std::ios::out | std::ios::in | std::ios::binary | std::ios::ate);
33
34 if (!m_fileStream.is_open())
35 {
36 m_fileStream.open(fileName.c_str(), std::ios::out | std::ios::binary);
37 }
38 }
39 else if (OVERWRITE == fileMode)
40 {
41 m_fileStream.open(fileName.c_str(), std::ios::out | std::ios::binary | std::ios::trunc);
42 }
43 else
44 {
45 throw StatusCodeException(STATUS_CODE_INVALID_PARAMETER);
46 }
47
48 if (!m_fileStream.is_open() || !m_fileStream.good())
49 throw StatusCodeException(STATUS_CODE_FAILURE);
50
51 m_containerPosition = m_fileStream.tellp();
52}
53
54//------------------------------------------------------------------------------------------------------------------------------------------
55
60
61//------------------------------------------------------------------------------------------------------------------------------------------
62
63StatusCode BinaryFileWriter::WriteHeader(const ContainerId containerId)
64{
65 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(PANDORA_FILE_HASH));
66 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(containerId));
67
68 m_containerPosition = m_fileStream.tellp();
69 const std::ofstream::pos_type dummyContainerSize(0);
70 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(dummyContainerSize));
71
72 m_containerId = containerId;
73
74 return STATUS_CODE_SUCCESS;
75}
76
77//------------------------------------------------------------------------------------------------------------------------------------------
78
79StatusCode BinaryFileWriter::WriteFooter()
80{
81 if ((EVENT_CONTAINER != m_containerId) && (GEOMETRY_CONTAINER != m_containerId))
82 return STATUS_CODE_FAILURE;
83
84 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable((EVENT_CONTAINER == m_containerId) ? EVENT_END_COMPONENT : GEOMETRY_END_COMPONENT));
85 m_containerId = UNKNOWN_CONTAINER;
86
87 const std::ofstream::pos_type containerSize(m_fileStream.tellp() - m_containerPosition);
88 m_fileStream.seekp(m_containerPosition, std::ios::beg);
89
90 if (!m_fileStream.good())
91 return STATUS_CODE_FAILURE;
92
93 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(containerSize));
94 m_fileStream.seekp(0, std::ios::end);
95
96 if (!m_fileStream.good())
97 return STATUS_CODE_FAILURE;
98
99 m_containerPosition = m_fileStream.tellp();
100
101 return STATUS_CODE_SUCCESS;
102}
103
104//------------------------------------------------------------------------------------------------------------------------------------------
105
106StatusCode BinaryFileWriter::WriteSubDetector(const SubDetector *const pSubDetector)
107{
108 if (GEOMETRY_CONTAINER != m_containerId)
109 return STATUS_CODE_FAILURE;
110
111 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(SUB_DETECTOR_COMPONENT));
112 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, m_pSubDetectorFactory->Write(pSubDetector, *this));
113
114 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pSubDetector->GetSubDetectorName()));
115 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pSubDetector->GetSubDetectorType()));
116 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pSubDetector->GetInnerRCoordinate()));
117 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pSubDetector->GetInnerZCoordinate()));
118 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pSubDetector->GetInnerPhiCoordinate()));
119 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pSubDetector->GetInnerSymmetryOrder()));
120 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pSubDetector->GetOuterRCoordinate()));
121 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pSubDetector->GetOuterZCoordinate()));
122 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pSubDetector->GetOuterPhiCoordinate()));
123 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pSubDetector->GetOuterSymmetryOrder()));
124 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pSubDetector->IsMirroredInZ()));
125
126 const unsigned int nLayers(pSubDetector->GetNLayers());
127 const SubDetector::SubDetectorLayerVector &subDetectorLayerVector(pSubDetector->GetSubDetectorLayerVector());
128
129 if (subDetectorLayerVector.size() != nLayers)
130 return STATUS_CODE_FAILURE;
131
132 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(nLayers));
133
134 for (unsigned int iLayer = 0; iLayer < nLayers; ++iLayer)
135 {
136 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(subDetectorLayerVector.at(iLayer).GetClosestDistanceToIp()));
137 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(subDetectorLayerVector.at(iLayer).GetNRadiationLengths()));
138 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(subDetectorLayerVector.at(iLayer).GetNInteractionLengths()));
139 }
140
141 return STATUS_CODE_SUCCESS;
142}
143
144//------------------------------------------------------------------------------------------------------------------------------------------
145
146StatusCode BinaryFileWriter::WriteLArTPC(const LArTPC *const pLArTPC)
147{
148 if (GEOMETRY_CONTAINER != m_containerId)
149 return STATUS_CODE_FAILURE;
150
151 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(LAR_TPC_COMPONENT));
152 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, m_pLArTPCFactory->Write(pLArTPC, *this));
153
154 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pLArTPC->GetLArTPCVolumeId()));
155 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pLArTPC->GetCenterX()));
156 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pLArTPC->GetCenterY()));
157 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pLArTPC->GetCenterZ()));
158 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pLArTPC->GetWidthX()));
159 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pLArTPC->GetWidthY()));
160 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pLArTPC->GetWidthZ()));
161 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pLArTPC->GetWirePitchU()));
162 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pLArTPC->GetWirePitchV()));
163 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pLArTPC->GetWirePitchW()));
164 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pLArTPC->GetWireAngleU()));
165 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pLArTPC->GetWireAngleV()));
166 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pLArTPC->GetWireAngleW()));
167 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pLArTPC->GetSigmaUVW()));
168 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pLArTPC->IsDriftInPositiveX()));
169
170 return STATUS_CODE_SUCCESS;
171}
172
173//------------------------------------------------------------------------------------------------------------------------------------------
174
175StatusCode BinaryFileWriter::WriteDetectorGap(const DetectorGap *const pDetectorGap)
176{
177 if (GEOMETRY_CONTAINER != m_containerId)
178 return STATUS_CODE_FAILURE;
179
180 const LineGap *pLineGap(nullptr);
181 pLineGap = dynamic_cast<const LineGap *>(pDetectorGap);
182
183 const BoxGap *pBoxGap(nullptr);
184 pBoxGap = dynamic_cast<const BoxGap *>(pDetectorGap);
185
186 const ConcentricGap *pConcentricGap(nullptr);
187 pConcentricGap = dynamic_cast<const ConcentricGap *>(pDetectorGap);
188
189 if (nullptr != pLineGap)
190 {
191 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(LINE_GAP_COMPONENT));
192 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, m_pLineGapFactory->Write(pLineGap, *this));
193
194 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pLineGap->GetLineGapType()));
195 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pLineGap->GetLineStartX()));
196 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pLineGap->GetLineEndX()));
197 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pLineGap->GetLineStartZ()));
198 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pLineGap->GetLineEndZ()));
199 }
200 else if (nullptr != pBoxGap)
201 {
202 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(BOX_GAP_COMPONENT));
203 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, m_pBoxGapFactory->Write(pBoxGap, *this));
204
205 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pBoxGap->GetVertex()));
206 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pBoxGap->GetSide1()));
207 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pBoxGap->GetSide2()));
208 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pBoxGap->GetSide3()));
209 }
210 else if (nullptr != pConcentricGap)
211 {
212 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(CONCENTRIC_GAP_COMPONENT));
213 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, m_pConcentricGapFactory->Write(pConcentricGap, *this));
214
215 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pConcentricGap->GetMinZCoordinate()));
216 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pConcentricGap->GetMaxZCoordinate()));
217 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pConcentricGap->GetInnerRCoordinate()));
218 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pConcentricGap->GetInnerPhiCoordinate()));
219 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pConcentricGap->GetInnerSymmetryOrder()));
220 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pConcentricGap->GetOuterRCoordinate()));
221 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pConcentricGap->GetOuterPhiCoordinate()));
222 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pConcentricGap->GetOuterSymmetryOrder()));
223 }
224 else
225 {
226 return STATUS_CODE_FAILURE;
227 }
228
229 return STATUS_CODE_SUCCESS;
230}
231
232//------------------------------------------------------------------------------------------------------------------------------------------
233
234StatusCode BinaryFileWriter::WriteCaloHit(const CaloHit *const pCaloHit)
235{
236 if (EVENT_CONTAINER != m_containerId)
237 return STATUS_CODE_FAILURE;
238
239 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(CALO_HIT_COMPONENT));
240 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, m_pCaloHitFactory->Write(pCaloHit, *this));
241
242 const CellGeometry cellGeometry(pCaloHit->GetCellGeometry());
243 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(cellGeometry));
244 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pCaloHit->GetPositionVector()));
245 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pCaloHit->GetExpectedDirection()));
246 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pCaloHit->GetCellNormalVector()));
247 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pCaloHit->GetCellThickness()));
248 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pCaloHit->GetNCellRadiationLengths()));
249 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pCaloHit->GetNCellInteractionLengths()));
250 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pCaloHit->GetTime()));
251 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pCaloHit->GetInputEnergy()));
252 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pCaloHit->GetMipEquivalentEnergy()));
253 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pCaloHit->GetElectromagneticEnergy()));
254 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pCaloHit->GetHadronicEnergy()));
255 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pCaloHit->IsDigital()));
256 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pCaloHit->GetHitType()));
257 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pCaloHit->GetHitRegion()));
258 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pCaloHit->GetLayer()));
259 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pCaloHit->IsInOuterSamplingLayer()));
260 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pCaloHit->GetParentAddress()));
261 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pCaloHit->GetCellSize0()));
262 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pCaloHit->GetCellSize1()));
263
264 return STATUS_CODE_SUCCESS;
265}
266
267//------------------------------------------------------------------------------------------------------------------------------------------
268
269StatusCode BinaryFileWriter::WriteTrack(const Track *const pTrack)
270{
271 if (EVENT_CONTAINER != m_containerId)
272 return STATUS_CODE_FAILURE;
273
274 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(TRACK_COMPONENT));
275 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, m_pTrackFactory->Write(pTrack, *this));
276
277 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pTrack->GetD0()));
278 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pTrack->GetZ0()));
279 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pTrack->GetParticleId()));
280 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pTrack->GetCharge()));
281 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pTrack->GetMass()));
282 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pTrack->GetMomentumAtDca()));
283 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pTrack->GetTrackStateAtStart()));
284 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pTrack->GetTrackStateAtEnd()));
285 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pTrack->GetTrackStateAtCalorimeter()));
286 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pTrack->GetTimeAtCalorimeter()));
287 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pTrack->ReachesCalorimeter()));
288 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pTrack->IsProjectedToEndCap()));
289 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pTrack->CanFormPfo()));
290 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pTrack->CanFormClusterlessPfo()));
291 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pTrack->GetParentAddress()));
292
293 return STATUS_CODE_SUCCESS;
294}
295
296//------------------------------------------------------------------------------------------------------------------------------------------
297
298StatusCode BinaryFileWriter::WriteMCParticle(const MCParticle *const pMCParticle)
299{
300 if (EVENT_CONTAINER != m_containerId)
301 return STATUS_CODE_FAILURE;
302
303 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(MC_PARTICLE_COMPONENT));
304 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, m_pMCParticleFactory->Write(pMCParticle, *this));
305
306 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pMCParticle->GetEnergy()));
307 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pMCParticle->GetMomentum()));
308 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pMCParticle->GetVertex()));
309 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pMCParticle->GetEndpoint()));
310 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pMCParticle->GetParticleId()));
311 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pMCParticle->GetMCParticleType()));
312 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(pMCParticle->GetUid()));
313
314 return STATUS_CODE_SUCCESS;
315}
316
317//------------------------------------------------------------------------------------------------------------------------------------------
318
319StatusCode BinaryFileWriter::WriteRelationship(const RelationshipId relationshipId, const void *address1, const void *address2, const float weight)
320{
321 if (EVENT_CONTAINER != m_containerId)
322 return STATUS_CODE_FAILURE;
323
324 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(RELATIONSHIP_COMPONENT));
325 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(relationshipId));
326 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(address1));
327 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(address2));
328 PANDORA_RETURN_RESULT_IF(STATUS_CODE_SUCCESS, !=, this->WriteVariable(weight));
329
330 return STATUS_CODE_SUCCESS;
331}
332
333} // namespace pandora
BinaryFileWriter.h
Header file for the binary file writer class.
CaloHit.h
Header file for the calo hit class.
DetectorGap.h
Header file for the detector gap class.
LArTPC.h
Header file for the lar tpc class.
MCParticle.h
Header file for the mc particle class.
PandoraContentApi.h
Header file for the pandora content api class.
PandoraContentApiImpl.h
Header file for the pandora content api implementation class.
PANDORA_RETURN_RESULT_IF
#define PANDORA_RETURN_RESULT_IF(StatusCode1, Operator, Command)
Definition StatusCodes.h:19
SubDetector.h
Header file for the sub detector class.
Track.h
Header file for the track class.
pandora::BinaryFileWriter::WriteSubDetector
StatusCode WriteSubDetector(const SubDetector *const pSubDetector)
Write a sub detector to the file.
Definition BinaryFileWriter.cc:106
pandora::BinaryFileWriter::m_containerPosition
std::ofstream::pos_type m_containerPosition
Position of start of the current event/geometry container object in file.
Definition BinaryFileWriter.h:60
pandora::BinaryFileWriter::WriteDetectorGap
StatusCode WriteDetectorGap(const DetectorGap *const pDetectorGap)
Write the detector gap parameters to the file.
Definition BinaryFileWriter.cc:175
pandora::BinaryFileWriter::WriteTrack
StatusCode WriteTrack(const Track *const pTrack)
Write a track to the current position in the file.
Definition BinaryFileWriter.cc:269
pandora::BinaryFileWriter::WriteLArTPC
StatusCode WriteLArTPC(const LArTPC *const pLArTPC)
Write a lar tpc to the file.
Definition BinaryFileWriter.cc:146
pandora::BinaryFileWriter::BinaryFileWriter
BinaryFileWriter(const pandora::Pandora &pandora, const std::string &fileName, const FileMode fileMode=APPEND)
Constructor.
Definition BinaryFileWriter.cc:25
pandora::BinaryFileWriter::WriteHeader
StatusCode WriteHeader(const ContainerId containerId)
Write the container header to the file.
Definition BinaryFileWriter.cc:63
pandora::BinaryFileWriter::WriteCaloHit
StatusCode WriteCaloHit(const CaloHit *const pCaloHit)
Write a calo hit to the current position in the file.
Definition BinaryFileWriter.cc:234
pandora::BinaryFileWriter::WriteMCParticle
StatusCode WriteMCParticle(const MCParticle *const pMCParticle)
Write a mc particle to the current position in the file.
Definition BinaryFileWriter.cc:298
pandora::BinaryFileWriter::m_fileStream
std::ofstream m_fileStream
The stream class to write to the file.
Definition BinaryFileWriter.h:61
pandora::BinaryFileWriter::WriteRelationship
StatusCode WriteRelationship(const RelationshipId relationshipId, const void *address1, const void *address2, const float weight)
Write a relationship between two objects with specified addresses.
Definition BinaryFileWriter.cc:319
pandora::BinaryFileWriter::WriteFooter
StatusCode WriteFooter()
Write the container footer to the file.
Definition BinaryFileWriter.cc:79
pandora::BinaryFileWriter::WriteVariable
StatusCode WriteVariable(const T &t)
Write a variable to the file.
Definition BinaryFileWriter.h:67
pandora::BoxGap
BoxGap class, associated with all 3D hit types.
Definition DetectorGap.h:112
pandora::BoxGap::GetSide1
const CartesianVector & GetSide1() const
Get the vector describing first side meeting vertex.
Definition DetectorGap.h:318
pandora::BoxGap::GetSide2
const CartesianVector & GetSide2() const
Get the vector describing second side meeting vertex.
Definition DetectorGap.h:325
pandora::BoxGap::GetSide3
const CartesianVector & GetSide3() const
Get the vector describing third side meeting vertex.
Definition DetectorGap.h:332
pandora::BoxGap::GetVertex
const CartesianVector & GetVertex() const
Get the gap vertex.
Definition DetectorGap.h:311
pandora::CaloHit
CaloHit class.
Definition CaloHit.h:26
pandora::CaloHit::GetElectromagneticEnergy
float GetElectromagneticEnergy() const
Get the calibrated electromagnetic energy measure.
Definition CaloHit.h:483
pandora::CaloHit::GetHitType
HitType GetHitType() const
Get the calorimeter hit type.
Definition CaloHit.h:441
pandora::CaloHit::GetCellGeometry
CellGeometry GetCellGeometry() const
Get the cell geometry.
Definition CaloHit.h:378
pandora::CaloHit::IsInOuterSamplingLayer
bool IsInOuterSamplingLayer() const
Whether cell is in one of the outermost detector sampling layers.
Definition CaloHit.h:469
pandora::CaloHit::GetHitRegion
HitRegion GetHitRegion() const
Get the region of the detector in which the calo hit is located.
Definition CaloHit.h:448
pandora::CaloHit::GetPositionVector
const CartesianVector & GetPositionVector() const
Get the position vector of center of calorimeter cell, units mm.
Definition CaloHit.h:350
pandora::CaloHit::GetLayer
unsigned int GetLayer() const
Get the subdetector readout layer number.
Definition CaloHit.h:455
pandora::CaloHit::GetMipEquivalentEnergy
float GetMipEquivalentEnergy() const
Get the calibrated mip equivalent energy.
Definition CaloHit.h:476
pandora::CaloHit::GetNCellRadiationLengths
float GetNCellRadiationLengths() const
Get the absorber material in front of cell, units radiation lengths.
Definition CaloHit.h:406
pandora::CaloHit::GetNCellInteractionLengths
float GetNCellInteractionLengths() const
Get the absorber material in front of cell, units interaction lengths.
Definition CaloHit.h:413
pandora::CaloHit::GetCellThickness
float GetCellThickness() const
Get the thickness of cell, units mm.
Definition CaloHit.h:399
pandora::CaloHit::GetCellSize1
float GetCellSize1() const
Get the cell size 1 [pointing: phi, rectangular: perpendicular to size 0 and thickness,...
Definition CaloHit.h:392
pandora::CaloHit::IsDigital
bool IsDigital() const
Whether cell should be treated as digital.
Definition CaloHit.h:434
pandora::CaloHit::GetCellSize0
float GetCellSize0() const
Get the cell size 0 [pointing: eta, rectangular: up in ENDCAP, along beam in BARREL,...
Definition CaloHit.h:385
pandora::CaloHit::GetCellNormalVector
const CartesianVector & GetCellNormalVector() const
Get the unit vector normal to the sampling layer, pointing outwards from the origin.
Definition CaloHit.h:371
pandora::CaloHit::GetHadronicEnergy
float GetHadronicEnergy() const
Get the calibrated hadronic energy measure.
Definition CaloHit.h:490
pandora::CaloHit::GetInputEnergy
float GetInputEnergy() const
Get the corrected energy of the calorimeter cell, units GeV, as supplied by the user.
Definition CaloHit.h:420
pandora::CaloHit::GetTime
float GetTime() const
Get the time of (earliest) energy deposition in this cell, units ns.
Definition CaloHit.h:427
pandora::CaloHit::GetParentAddress
const void * GetParentAddress() const
Get the address of the parent calo hit in the user framework.
Definition CaloHit.h:532
pandora::CaloHit::GetExpectedDirection
const CartesianVector & GetExpectedDirection() const
Get the unit vector in direction of expected hit propagation.
Definition CaloHit.h:364
pandora::ConcentricGap
ConcentricGap class, associated with all 3D hit types.
Definition DetectorGap.h:166
pandora::ConcentricGap::GetInnerRCoordinate
float GetInnerRCoordinate() const
Get the inner cylindrical polar r coordinate, origin interaction point.
Definition DetectorGap.h:354
pandora::ConcentricGap::GetMaxZCoordinate
float GetMaxZCoordinate() const
Get the max cylindrical polar z coordinate, origin interaction point.
Definition DetectorGap.h:347
pandora::ConcentricGap::GetOuterPhiCoordinate
float GetOuterPhiCoordinate() const
Get the outer cylindrical polar phi coordinate.
Definition DetectorGap.h:382
pandora::ConcentricGap::GetOuterSymmetryOrder
unsigned int GetOuterSymmetryOrder() const
Get the order of symmetry of the outermost edge of gap.
Definition DetectorGap.h:389
pandora::ConcentricGap::GetInnerPhiCoordinate
float GetInnerPhiCoordinate() const
Get the inner cylindrical polar phi coordinate.
Definition DetectorGap.h:361
pandora::ConcentricGap::GetInnerSymmetryOrder
unsigned int GetInnerSymmetryOrder() const
Get the order of symmetry of the innermost edge of gap.
Definition DetectorGap.h:368
pandora::ConcentricGap::GetOuterRCoordinate
float GetOuterRCoordinate() const
Get the outer cylindrical polar r coordinate, origin interaction point.
Definition DetectorGap.h:375
pandora::ConcentricGap::GetMinZCoordinate
float GetMinZCoordinate() const
Get the min cylindrical polar z coordinate, origin interaction point.
Definition DetectorGap.h:340
pandora::DetectorGap
DetectorGap class.
Definition DetectorGap.h:25
pandora::FileWriter
FileWriter class.
Definition FileWriter.h:29
pandora::LArTPC
LArTPC class.
Definition LArTPC.h:26
pandora::LArTPC::GetWireAngleV
float GetWireAngleV() const
Get the v wire angle to the vertical, units radians.
Definition LArTPC.h:245
pandora::LArTPC::GetWirePitchU
float GetWirePitchU() const
Get the u wire pitch, units mm.
Definition LArTPC.h:217
pandora::LArTPC::GetCenterY
float GetCenterY() const
Get center in y, units mm.
Definition LArTPC.h:182
pandora::LArTPC::GetWidthZ
float GetWidthZ() const
Get the width in z, units mm.
Definition LArTPC.h:210
pandora::LArTPC::GetWireAngleW
float GetWireAngleW() const
Get the w wire angle to the vertical, units radians.
Definition LArTPC.h:252
pandora::LArTPC::GetCenterZ
float GetCenterZ() const
Get center in z, units mm.
Definition LArTPC.h:189
pandora::LArTPC::IsDriftInPositiveX
bool IsDriftInPositiveX() const
Whether the electron drift is in the positive x direction.
Definition LArTPC.h:266
pandora::LArTPC::GetCenterX
float GetCenterX() const
Get center in x, units mm.
Definition LArTPC.h:175
pandora::LArTPC::GetWirePitchV
float GetWirePitchV() const
Get the v wire pitch, units mm.
Definition LArTPC.h:224
pandora::LArTPC::GetWidthX
float GetWidthX() const
Get the width in x, units mm.
Definition LArTPC.h:196
pandora::LArTPC::GetWidthY
float GetWidthY() const
Get the width in y, units mm.
Definition LArTPC.h:203
pandora::LArTPC::GetWireAngleU
float GetWireAngleU() const
Get the u wire angle to the vertical, units radians.
Definition LArTPC.h:238
pandora::LArTPC::GetWirePitchW
float GetWirePitchW() const
Get the w wire pitch, units mm.
Definition LArTPC.h:231
pandora::LArTPC::GetLArTPCVolumeId
unsigned int GetLArTPCVolumeId() const
Get the lar volume id, uniquely specifying the lar tpc.
Definition LArTPC.h:168
pandora::LArTPC::GetSigmaUVW
float GetSigmaUVW() const
Get the u, v, w resolution, units mm.
Definition LArTPC.h:259
pandora::LineGap
LineGap class, associated only with 2D TPC hit types and applied only to the z coordinate when sampli...
Definition DetectorGap.h:50
pandora::LineGap::GetLineEndZ
float GetLineEndZ() const
Get the line end z coordinate.
Definition DetectorGap.h:303
pandora::LineGap::GetLineGapType
LineGapType GetLineGapType() const
Get the line gap type.
Definition DetectorGap.h:275
pandora::LineGap::GetLineStartX
float GetLineStartX() const
Get the line start x coordinate.
Definition DetectorGap.h:282
pandora::LineGap::GetLineStartZ
float GetLineStartZ() const
Get the line start z coordinate.
Definition DetectorGap.h:296
pandora::LineGap::GetLineEndX
float GetLineEndX() const
Get the line end x coordinate.
Definition DetectorGap.h:289
pandora::MCParticle
MCParticle class.
Definition MCParticle.h:26
pandora::MCParticle::GetMCParticleType
MCParticleType GetMCParticleType() const
Get the type of the mc particle, e.g. vertex, 2D-projection, etc.
Definition MCParticle.h:292
pandora::MCParticle::GetUid
Uid GetUid() const
Get the mc particle unique identifier.
Definition MCParticle.h:236
pandora::MCParticle::GetEnergy
float GetEnergy() const
Get energy of mc particle, units GeV.
Definition MCParticle.h:243
pandora::MCParticle::GetMomentum
const CartesianVector & GetMomentum() const
Get momentum of mc particle, units GeV.
Definition MCParticle.h:250
pandora::MCParticle::GetEndpoint
const CartesianVector & GetEndpoint() const
Get the endpoint of the mc particle, units mm.
Definition MCParticle.h:264
pandora::MCParticle::GetVertex
const CartesianVector & GetVertex() const
Get the production vertex of the mc particle, units mm.
Definition MCParticle.h:257
pandora::MCParticle::GetParticleId
int GetParticleId() const
Get the PDG code of the mc particle.
Definition MCParticle.h:285
pandora::ObjectFactory::Write
virtual StatusCode Write(const Object *const pObject, FileWriter &fileWriter) const =0
Persist any additional (derived class only) object parameters using the specified file writer.
pandora::Pandora
Pandora class.
Definition Pandora.h:40
pandora::Persistency::m_pBoxGapFactory
ObjectFactory< object_creation::Geometry::BoxGap::Parameters, object_creation::Geometry::BoxGap::Object > * m_pBoxGapFactory
Address of the box gap factory.
Definition Persistency.h:84
pandora::Persistency::m_containerId
ContainerId m_containerId
The type of container currently being written to file.
Definition Persistency.h:76
pandora::Persistency::m_pMCParticleFactory
ObjectFactory< object_creation::MCParticle::Parameters, object_creation::MCParticle::Object > * m_pMCParticleFactory
Address of the mc particle factory.
Definition Persistency.h:80
pandora::Persistency::m_pLArTPCFactory
ObjectFactory< object_creation::Geometry::LArTPC::Parameters, object_creation::Geometry::LArTPC::Object > * m_pLArTPCFactory
Address of the lar tpc factory.
Definition Persistency.h:82
pandora::Persistency::m_pTrackFactory
ObjectFactory< object_creation::Track::Parameters, object_creation::Track::Object > * m_pTrackFactory
Address of the track factory.
Definition Persistency.h:79
pandora::Persistency::m_pCaloHitFactory
ObjectFactory< object_creation::CaloHit::Parameters, object_creation::CaloHit::Object > * m_pCaloHitFactory
Address of the calo hit factory.
Definition Persistency.h:78
pandora::Persistency::m_pLineGapFactory
ObjectFactory< object_creation::Geometry::LineGap::Parameters, object_creation::Geometry::LineGap::Object > * m_pLineGapFactory
Address of the line gap factory.
Definition Persistency.h:83
pandora::Persistency::m_pConcentricGapFactory
ObjectFactory< object_creation::Geometry::ConcentricGap::Parameters, object_creation::Geometry::ConcentricGap::Object > * m_pConcentricGapFactory
Address of the concentric gap factory.
Definition Persistency.h:85
pandora::Persistency::m_pSubDetectorFactory
ObjectFactory< object_creation::Geometry::SubDetector::Parameters, object_creation::Geometry::SubDetector::Object > * m_pSubDetectorFactory
Address of the sub detector factory.
Definition Persistency.h:81
pandora::Persistency::m_fileType
FileType m_fileType
The file type.
Definition Persistency.h:75
pandora::StatusCodeException
StatusCodeException class.
Definition StatusCodes.h:119
pandora::SubDetector
SubDetector class.
Definition SubDetector.h:26
pandora::SubDetector::GetSubDetectorName
const std::string & GetSubDetectorName() const
Get the sub detector name, uniquely specifying the sub detector.
Definition SubDetector.h:227
pandora::SubDetector::GetOuterPhiCoordinate
float GetOuterPhiCoordinate() const
Get the outer cylindrical polar phi coordinate (angle wrt cartesian x axis)
Definition SubDetector.h:283
pandora::SubDetector::GetInnerRCoordinate
float GetInnerRCoordinate() const
Get the inner cylindrical polar r coordinate, origin interaction point, units mm.
Definition SubDetector.h:241
pandora::SubDetector::GetOuterSymmetryOrder
unsigned int GetOuterSymmetryOrder() const
Get the order of symmetry of the outermost edge of sub detector.
Definition SubDetector.h:290
pandora::SubDetector::GetInnerPhiCoordinate
float GetInnerPhiCoordinate() const
Get the inner cylindrical polar phi coordinate (angle wrt cartesian x axis)
Definition SubDetector.h:255
pandora::SubDetector::GetSubDetectorType
SubDetectorType GetSubDetectorType() const
Get the sub detector type, e.g. ECAL_BARREL, HCAL_ENDCAP, TPC, etc.
Definition SubDetector.h:234
pandora::SubDetector::GetOuterRCoordinate
float GetOuterRCoordinate() const
Get the outer cylindrical polar r coordinate, origin interaction point, units mm.
Definition SubDetector.h:269
pandora::SubDetector::GetInnerSymmetryOrder
unsigned int GetInnerSymmetryOrder() const
Get the order of symmetry of the innermost edge of subdetector.
Definition SubDetector.h:262
pandora::SubDetector::GetOuterZCoordinate
float GetOuterZCoordinate() const
Get the outer cylindrical polar z coordinate, origin interaction point, units mm.
Definition SubDetector.h:276
pandora::SubDetector::GetNLayers
unsigned int GetNLayers() const
Get the number of layers in the sub detector.
Definition SubDetector.h:304
pandora::SubDetector::SubDetectorLayerVector
std::vector< SubDetectorLayer > SubDetectorLayerVector
Definition SubDetector.h:70
pandora::SubDetector::IsMirroredInZ
bool IsMirroredInZ() const
Whether a second sub detector exists, equivalent to a reflection in z=0 plane.
Definition SubDetector.h:297
pandora::SubDetector::GetSubDetectorLayerVector
const SubDetectorLayerVector & GetSubDetectorLayerVector() const
Get the vector of layer parameters for the sub detector.
Definition SubDetector.h:311
pandora::SubDetector::GetInnerZCoordinate
float GetInnerZCoordinate() const
Get the inner cylindrical polar z coordinate, origin interaction point, units mm.
Definition SubDetector.h:248
pandora::Track
Track class.
Definition Track.h:26
pandora::Track::CanFormClusterlessPfo
bool CanFormClusterlessPfo() const
Whether track should form a pfo, even if it has no associated cluster.
Definition Track.h:393
pandora::Track::GetZ0
float GetZ0() const
Get the z coordinate at the 2D distance of closest approach.
Definition Track.h:302
pandora::Track::GetTrackStateAtStart
const TrackState & GetTrackStateAtStart() const
Get the track state at the start of the track.
Definition Track.h:344
pandora::Track::ReachesCalorimeter
bool ReachesCalorimeter() const
Whether the track reaches the calorimeter.
Definition Track.h:372
pandora::Track::IsProjectedToEndCap
bool IsProjectedToEndCap() const
Whether the calorimeter projection is to an endcap.
Definition Track.h:379
pandora::Track::GetMomentumAtDca
const CartesianVector & GetMomentumAtDca() const
Get the track momentum at the 2D distance of closest approach.
Definition Track.h:330
pandora::Track::GetParticleId
int GetParticleId() const
Get the PDG code of the tracked particle.
Definition Track.h:309
pandora::Track::GetTrackStateAtEnd
const TrackState & GetTrackStateAtEnd() const
Get the track state at the end of the track.
Definition Track.h:351
pandora::Track::GetTimeAtCalorimeter
float GetTimeAtCalorimeter() const
Get the (sometimes projected) time at the calorimeter.
Definition Track.h:365
pandora::Track::CanFormPfo
bool CanFormPfo() const
Whether track should form a pfo, if it has an associated cluster.
Definition Track.h:386
pandora::Track::GetCharge
int GetCharge() const
Get the charge of the tracked particle.
Definition Track.h:316
pandora::Track::GetD0
float GetD0() const
Get the 2D impact parameter wrt (0,0)
Definition Track.h:295
pandora::Track::GetTrackStateAtCalorimeter
const TrackState & GetTrackStateAtCalorimeter() const
Get the (sometimes projected) track state at the calorimeter.
Definition Track.h:358
pandora::Track::GetMass
float GetMass() const
Get the mass of the tracked particle, units GeV.
Definition Track.h:323
pandora::Track::GetParentAddress
const void * GetParentAddress() const
Get the address of the parent track in the user framework.
Definition Track.h:414
pandora::GEOMETRY_END_COMPONENT
@ GEOMETRY_END_COMPONENT
Definition PandoraIO.h:46
pandora::LINE_GAP_COMPONENT
@ LINE_GAP_COMPONENT
Definition PandoraIO.h:43
pandora::TRACK_COMPONENT
@ TRACK_COMPONENT
Definition PandoraIO.h:38
pandora::BOX_GAP_COMPONENT
@ BOX_GAP_COMPONENT
Definition PandoraIO.h:44
pandora::CONCENTRIC_GAP_COMPONENT
@ CONCENTRIC_GAP_COMPONENT
Definition PandoraIO.h:45
pandora::SUB_DETECTOR_COMPONENT
@ SUB_DETECTOR_COMPONENT
Definition PandoraIO.h:42
pandora::MC_PARTICLE_COMPONENT
@ MC_PARTICLE_COMPONENT
Definition PandoraIO.h:39
pandora::EVENT_END_COMPONENT
@ EVENT_END_COMPONENT
Definition PandoraIO.h:41
pandora::LAR_TPC_COMPONENT
@ LAR_TPC_COMPONENT
Definition PandoraIO.h:47
pandora::RELATIONSHIP_COMPONENT
@ RELATIONSHIP_COMPONENT
Definition PandoraIO.h:40
pandora::CALO_HIT_COMPONENT
@ CALO_HIT_COMPONENT
Definition PandoraIO.h:37
pandora::FileMode
FileMode
The file mode enum.
Definition PandoraIO.h:84
pandora::OVERWRITE
@ OVERWRITE
Definition PandoraIO.h:86
pandora::RelationshipId
RelationshipId
The relationship identification enum.
Definition PandoraIO.h:57
pandora::CellGeometry
CellGeometry
Cell geometry enum.
Definition PandoraEnumeratedTypes.h:18
pandora::ContainerId
ContainerId
The container identification enum.
Definition PandoraIO.h:24
pandora::EVENT_CONTAINER
@ EVENT_CONTAINER
Definition PandoraIO.h:25
pandora::UNKNOWN_CONTAINER
@ UNKNOWN_CONTAINER
Definition PandoraIO.h:27
pandora::GEOMETRY_CONTAINER
@ GEOMETRY_CONTAINER
Definition PandoraIO.h:26
pandora::StatusCode
StatusCode
The StatusCode enum.
Definition StatusCodes.h:100
pandora::PANDORA_FILE_HASH
const std::string PANDORA_FILE_HASH("pandora")
Look for hash each event to check integrity.