Jpp 20.0.0-rc.2
the software that should make you happy
Loading...
Searching...
No Matches
JRECONSTRUCTION::JMuonEnergy Class Reference

Auxiliary class to to determine muon energy. More...

#include <JMuonEnergy.hh>

Inheritance diagram for JRECONSTRUCTION::JMuonEnergy:
JRECONSTRUCTION::JMuonEnergyParameters_t JFIT::JRegressor< JModel_t, JMinimiser_t > TObject

Classes

struct  input_type
 Input data type. More...
 
struct  JResult
 Auxiliary class for energy estimation. More...
 

Public Types

typedef JRegressor< JEnergyJRegressor_t
 
typedef JModuleL0 module_type
 
typedef std::vector< module_typedetector_type
 

Public Member Functions

 JMuonEnergy (const JMuonEnergyParameters_t &parameters, const storage_type &storage, const JPMTParametersMap &pmtParameters, const JEnergyCorrection &correct, const int debug=0)
 Constructor.
 
input_type getInput (const JModuleRouter &router, const JSummaryRouter &summary, const JDAQEvent &event, const JEvt &in, const coverage_type &coverage) const
 Get input data.
 
JEvt operator() (const input_type &input)
 Fit function.
 
void reset ()
 Reset fit parameters.
 
bool equals (const JMuonEnergyParameters_t &parameters) const
 Equality.
 
 ClassDef (JMuonEnergyParameters_t, 2)
 

Public Attributes

const JPMTParametersMappmtParameters
 
JEnergyCorrection correct
 
double roadWidth_m
 road width [m]
 
double R_Hz
 default rate [Hz]
 
size_t numberOfPrefits
 number of prefits
 
double EMin_log
 minimal energy [log10(GeV)]
 
double EMax_log
 maximal energy [log10(GeV)]
 
double TMin_ns
 minimal time w.r.t. Cherenkov hypothesis [ns]
 
double TMax_ns
 maximal time w.r.t. Cherenkov hypothesis [ns]
 
double ZMin_m
 minimal z-position [m]
 
double resolution
 energy resolution [log10(GeV)]
 
int mestimator
 M-estimator.
 

Detailed Description

Auxiliary class to to determine muon energy.

Definition at line 69 of file JMuonEnergy.hh.

Member Typedef Documentation

◆ JRegressor_t

◆ module_type

◆ detector_type

Constructor & Destructor Documentation

◆ JMuonEnergy()

JRECONSTRUCTION::JMuonEnergy::JMuonEnergy ( const JMuonEnergyParameters_t & parameters,
const storage_type & storage,
const JPMTParametersMap & pmtParameters,
const JEnergyCorrection & correct,
const int debug = 0 )
inline

Constructor.

Parameters
parametersparameters
storagestorage
pmtParametersPMT parameters
correctenergy correction
debugdebug

Definition at line 122 of file JMuonEnergy.hh.

126 :
127 JMuonEnergyParameters_t(parameters),
128 JRegressor_t (storage),
131 {
132 using namespace JPP;
133
134 if (this->getRmax() < roadWidth_m) {
135 roadWidth_m = this->getRmax();
136 }
137
138 JRegressor_t::debug = debug;
139
140 this->estimator.reset(getMEstimator(mestimator));
141 }
int debug
debug level
Definition JSirene.cc:72
const JPMTParametersMap & pmtParameters
JRegressor< JEnergy > JRegressor_t
JMEstimator * getMEstimator(const int type)
Get M-Estimator.
This name space includes all other name spaces (except KM3NETDAQ, KM3NET and ANTARES).

Member Function Documentation

◆ getInput()

input_type JRECONSTRUCTION::JMuonEnergy::getInput ( const JModuleRouter & router,
const JSummaryRouter & summary,
const JDAQEvent & event,
const JEvt & in,
const coverage_type & coverage ) const
inline

Get input data.

Parameters
routermodule router
summarysummary data
eventevent
instart values
coveragecoverage
Returns
input data

Definition at line 154 of file JMuonEnergy.hh.

159 {
160 using namespace std;
161 using namespace JTRIGGER;
162
163 input_type input(event.getDAQEventHeader(), in, coverage);
164
165 const JBuildL0 <JHitR0> buildL0;
167
168 const JDAQTimeslice timeslice(event, true);
169
170 JSuperFrame2D<JHit> buffer;
171
172 for (JDAQTimeslice::const_iterator i = timeslice.begin(); i != timeslice.end(); ++i) {
173
174 if (router.hasModule(i->getModuleID())) {
175
176 buffer(*i, router.getModule(i->getModuleID()));
177
178 buildL0(buffer, back_inserter(data[i->getModuleID()]));
179 }
180 }
181
182 for (const auto& module : router.getReference()) {
183 if (!module.empty()) {
184 input.data.push_back(module_type(module, summary.getSummaryFrame(module.getID(), R_Hz), data[module.getID()]));
185 }
186 }
187
188 return input;
189 }
bool hasModule(const JObjectID &id) const
Has module.
const JModule & getModule(const JObjectID &id) const
Get module parameters.
const JClass_t & getReference() const
Get reference to object.
Definition JReference.hh:38
const JDAQSummaryFrame & getSummaryFrame(const JDAQModuleIdentifier &module) const
Get summary frame.
2-dimensional frame with time calibrated data from one optical module.
const JDAQEventHeader & getDAQEventHeader() const
Get DAQ event header.
Auxiliary classes and methods for triggering.

◆ operator()()

JEvt JRECONSTRUCTION::JMuonEnergy::operator() ( const input_type & input)
inline

Fit function.

Parameters
inputinput data
Returns
fit results

Definition at line 230 of file JMuonEnergy.hh.

231 {
232 using namespace std;
233 using namespace JPP;
234
235 JEvent event(JMUONENERGY);
236
237 JEvt out;
238
239 // select start values
240
241 JEvt in = input.in;
242
243 in.select(numberOfPrefits, qualitySorter);
244
245 if (!in.empty()) {
246 in.select(JHistory::is_event(in.begin()->getHistory()));
247 }
248
249 for (JEvt::const_iterator track = in.begin(); track != in.end(); ++track) {
250
251 const JRotation3D R (getDirection(*track));
252 const JLine1Z tz(getPosition (*track).rotate(R), track->getT());
253
254 double zmin = numeric_limits<double>::lowest();
255
256 if (track->hasW(JSTART_LENGTH_METRES) && track->getW(JSTART_LENGTH_METRES) > 0.0) {
257 zmin = this->ZMin_m;
258 }
259
261
262 for (const auto& module : input.data) {
263
264 JPosition3D pos(module->getPosition());
265
266 pos.transform(R, tz.getPosition());
267
268 if (pos.getX() <= roadWidth_m) {
269
270 const double z1 = pos.getZ() - pos.getX() / getTanThetaC();
271 const double t1 = tz .getT() + (pos.getZ() + pos.getX() * getKappaC()) * getInverseSpeedOfLight();
272
273 if (z1 >= zmin) {
274
275 for (size_t i = 0; i != module->size(); ++i) {
276
277 if (module.getStatus(i)) {
278
279 const struct {
280
281 bool operator()(const JHitR0& hit) const
282 {
283 return (hit.getPMT() == pmt && T_ns(hit.getT()));
284 }
285
286 const JTimeRange T_ns;
287 const size_t pmt;
288
289 } match = { T_ns + t1, i };
290
291 const JPMTIdentifier id(module->getID(), i);
292
294
295 JPMT pmt = module->getPMT(i);
296
297 pmt.transform(R, tz.getPosition());
298
299 const JNPEHit hit(this->getNPE(pmt, module.frame.getRate(i)), count_if(module.begin(), module.end(), match), ps);
300
301 DEBUG("hit: " << setw(8) << module->getID() << '.' << FILL(2,'0') << i << ' '
302 << FIXED(7,3) << hypot(pmt.getX(), pmt.getY()) << ' '
303 << FIXED(7,3) << module.frame.getRate(i) * 1.0e-3 << ' '
304 << SCIENTIFIC(9,3) << hit.getY0() << ' '
305 << SCIENTIFIC(9,3) << hit.getY1() << ' '
306 << SCIENTIFIC(9,3) << hit.getYA() << ' '
307 << SCIENTIFIC(9,3) << hit.getYB() << ' '
308 << setw(2) << hit.getN() << endl);
309
310 data.push_back(hit);
311 }
312 }
313 }
314 }
315 }
316
317 const int NDF = distance(data.begin(), data.end()) - 1;
318
319 if (NDF >= 0) {
320
321 // 5-point search between given limits
322
323 const int N = 5;
324
325 JResult result[N];
326
327 for (int i = 0; i != N; ++i) {
328 result[i].x = EMin_log + i * (EMax_log - EMin_log) / (N-1);
329 }
330
331 map<double, double> buffer;
332
333 do {
334
335 int j = 0;
336
337 for (int i = 0; i != N; ++i) {
338
339 if (!result[i]) {
340
341 const JEnergy x = result[i].x;
342 const double chi2 = (*this)(x, data.begin(), data.end());
343
344 result[i].chi2 = chi2;
345 buffer[chi2] = x.getE();
346 }
347
348 if (result[i].chi2 < result[j].chi2) {
349 j = i;
350 }
351 }
352
353
354 for (int i = 0; i != N; ++i) {
355 DEBUG(' ' << FIXED(5,2) << result[i].x << ' ' << FIXED(9,3) << result[i].chi2);
356 }
357 DEBUG(endl);
358
359 // squeeze range
360
361 switch (j) {
362
363 case 0:
364 result[4] = result[1];
365 result[2] = result[0];
366 result[0] = JResult(2*result[2].x - result[4].x);
367 break;
368
369 case 1:
370 result[4] = result[2];
371 result[2] = result[1];
372 break;
373
374 case 2:
375 result[0] = result[1];
376 result[4] = result[3];
377 break;
378
379 case 3:
380 result[0] = result[2];
381 result[2] = result[3];
382 break;
383
384 case 4:
385 result[0] = result[3];
386 result[2] = result[4];
387 result[4] = JResult(2*result[2].x - result[0].x);
388 break;
389 }
390
391 result[1] = JResult(0.5 * (result[0].x + result[2].x));
392 result[3] = JResult(0.5 * (result[2].x + result[4].x));
393
394 } while (result[4].x - result[0].x > resolution);
395
396
397 if (result[1].chi2 != result[3].chi2) {
398
399 result[2].x += 0.25 * (result[3].x - result[1].x) * (result[1].chi2 - result[3].chi2) / (result[1].chi2 + result[3].chi2 - 2*result[2].chi2);
400 result[2].chi2 = (*this)(result[2].x, data.begin(), data.end());
401
402 }
403
404 const double chi2 = result[2].chi2;
405 const double E = result[2].x.getE();
406
407 // calculate additional variables
408
409 double Emin = numeric_limits<double>::max();
410 double Emax = numeric_limits<double>::lowest();
411
412 for (map<double, double>::const_iterator i = buffer.begin(); i != buffer.end() && i->first <= chi2 + 1.0; ++i) {
413 if (i->second < Emin) { Emin = i->second; }
414 if (i->second > Emax) { Emax = i->second; }
415 }
416
417 const double mu_range = gWater(E); // range of a muon with the reconstructed energy
418
419 double noise_likelihood = 0.0; // log-likelihood of every hit being from K40
420 int number_of_hits = 0; // number of hits selected for JEnergy
421
422 for (vector<JNPEHit>::const_iterator i = data.begin(); i != data.end(); ++i) {
423 noise_likelihood += log10(getP(i->getY0(), i->getN())); // probability of getting the observed multiplicity with K40
424 number_of_hits += i->getN(); // hit multiplicity
425 }
426
427 JFit fit = *track;
428
429 fit.push_back(event());
430
431 // set corrected energy
432
433 fit.setE(pow(10.0, correct(log10(E))));
434
435 out.push_back(fit);
436
437 // set additional values
438
439 out.rbegin()->setW(track->getW());
440 out.rbegin()->setW(JENERGY_ENERGY, E);
441 out.rbegin()->setW(JENERGY_CHI2, chi2);
442 out.rbegin()->setW(JENERGY_MUON_RANGE_METRES, mu_range);
443 out.rbegin()->setW(JENERGY_NOISE_LIKELIHOOD, noise_likelihood);
444 out.rbegin()->setW(JENERGY_NDF, NDF);
445 out.rbegin()->setW(JENERGY_NUMBER_OF_HITS, number_of_hits);
446 out.rbegin()->setW(JENERGY_MINIMAL_ENERGY, Emin);
447 out.rbegin()->setW(JENERGY_MAXIMAL_ENERGY, Emax);
448 out.rbegin()->setW(JPP_COVERAGE_ORIENTATION, input.coverage.orientation);
449 out.rbegin()->setW(JPP_COVERAGE_POSITION, input.coverage.position);
450 }
451 }
452
453 // apply default sorter
454
455 sort(out.begin(), out.end(), qualitySorter);
456
457 copy(input.in.begin(), input.in.end(), back_inserter(out));
458
459 return out;
460 }
#define DEBUG(A)
Message macros.
Definition JMessage.hh:62
std::vector< T >::difference_type distance(typename std::vector< T >::const_iterator first, typename PhysicsEvent::const_iterator< T > second)
Specialisation of STL distance.
const JPMTParameters & getPMTParameters(const JPMTIdentifier &id) const
Get PMT parameters.
Data structure for PMT geometry, calibration and status.
Definition JPMT.hh:49
Data structure for fit of energy.
Data structure for fit of straight line paralel to z-axis.
Definition JLine1Z.hh:29
void transform(const JAxis3D &axis)
Transform axis to reference frame of given axis.
Definition JAxis3D.hh:359
Data structure for position in three dimensions.
JPosition3D & rotate(const JRotation3D &R)
Rotate.
double getY() const
Get y position.
Definition JVector3D.hh:104
double getX() const
Get x position.
Definition JVector3D.hh:94
JEvt operator()(const input_type &input)
Fit function.
Reduced data structure for L0 hit.
Definition JHitR0.hh:27
JPMT_t getPMT() const
Get PMT.
Definition JHitR0.hh:60
int getN() const
Get count.
Definition JHitR0.hh:71
double getT() const
Get calibrated time of hit.
static const int JENERGY_NDF
number of degrees of freedom from JMuonEnergy
static const int JENERGY_ENERGY
uncorrected energy [GeV] from JMuonEnergy
static const int JENERGY_NOISE_LIKELIHOOD
log likelihood of every hit being K40 from JMuonEnergy
static const int JENERGY_CHI2
chi2 from JMuonEnergy
static const int JENERGY_MUON_RANGE_METRES
range of a muon with the reconstructed energy [m] from JMuonEnergy
static const int JPP_COVERAGE_POSITION
coverage of dynamic position calibration from any Jpp application
static const int JENERGY_NUMBER_OF_HITS
number of hits from JMuonEnergy
static const int JSTART_LENGTH_METRES
distance between projected positions on the track of optical modules for which the response does not ...
static const int JPP_COVERAGE_ORIENTATION
coverage of dynamic orientation calibration from any Jpp application
static const int JENERGY_MINIMAL_ENERGY
minimal energy [GeV] from JMuonEnergy
static const int JENERGY_MAXIMAL_ENERGY
maximal energy [GeV] from JMuonEnergy
double getNPE(const Hit &hit)
Get true charge of hit.
double getSurvivalProbability(const JPMTParameters &parameters)
Get model dependent probability that a one photo-electron hit survives the simulation of the PMT assu...
double getP(const double expval, bool hit)
Get Poisson probability to observe a hit or not for given expectation value for the number of hits.
T pow(const T &x, const double y)
Power .
Definition JMath.hh:97
double getKappaC()
Get average R-dependence of arrival time of Cherenkov light (a.k.a.
const double getInverseSpeedOfLight()
Get inverse speed of light.
static const JGeaneWater gWater
Function object for energy loss of muon in sea water.
Definition JGeane.hh:381
double getTanThetaC()
Get average tangent of Cherenkov angle of water corresponding to group velocity.
JPosition3D getPosition(const JFit &fit)
Get position.
void copy(const JFIT::JEvt::const_iterator __begin, const JFIT::JEvt::const_iterator __end, Evt &out)
Copy tracks.
bool qualitySorter(const JFit &first, const JFit &second)
Comparison of fit results.
JDirection3D getDirection(const JFit &fit)
Get direction.
return result
Definition JPolint.hh:862
int j
Definition JPolint.hh:801
Auxiliary data structure for sequence of same character.
Definition JManip.hh:330
Auxiliary data structure for floating point format specification.
Definition JManip.hh:448
Acoustic event fit.
Acoustic single fit.
Auxiliary class to test history.
Definition JHistory.hh:157
Auxiliary class for simultaneously handling light yields and response of PMT.
Definition JNPEHit.hh:21
double resolution
energy resolution [log10(GeV)]
double EMin_log
minimal energy [log10(GeV)]
double EMax_log
maximal energy [log10(GeV)]
Auxiliary data structure for floating point format specification.
Definition JManip.hh:488

◆ reset()

void JRECONSTRUCTION::JMuonEnergyParameters_t::reset ( )
inlineinherited

Reset fit parameters.

Definition at line 44 of file JMuonEnergyParameters_t.hh.

45 {
46 roadWidth_m = std::numeric_limits<double>::max();
47 R_Hz = 6.0e3;
49 EMin_log = 1.0;
50 EMax_log = 8.0;
51 TMin_ns = -50.0;
52 TMax_ns = +450.0;
53 ZMin_m = std::numeric_limits<double>::lowest();
54 resolution = 0.01;
56 }
@ EM_NORMAL
double TMin_ns
minimal time w.r.t. Cherenkov hypothesis [ns]
double TMax_ns
maximal time w.r.t. Cherenkov hypothesis [ns]

◆ equals()

bool JRECONSTRUCTION::JMuonEnergyParameters_t::equals ( const JMuonEnergyParameters_t & parameters) const
inlineinherited

Equality.

Parameters
parametersfit parameters
Returns
true if equals; else false

Definition at line 64 of file JMuonEnergyParameters_t.hh.

65 {
66 return (this->roadWidth_m == parameters.roadWidth_m &&
67 this->R_Hz == parameters.R_Hz &&
68 this->numberOfPrefits == parameters.numberOfPrefits &&
69 this->EMin_log == parameters.EMin_log &&
70 this->EMax_log == parameters.EMax_log &&
71 this->TMin_ns == parameters.TMin_ns &&
72 this->TMax_ns == parameters.TMax_ns &&
73 this->ZMin_m == parameters.ZMin_m &&
74 this->resolution == parameters.resolution &&
75 this->mestimator == parameters.mestimator);
76 }

◆ ClassDef()

JRECONSTRUCTION::JMuonEnergyParameters_t::ClassDef ( JMuonEnergyParameters_t ,
2  )
inherited

Member Data Documentation

◆ pmtParameters

const JPMTParametersMap& JRECONSTRUCTION::JMuonEnergy::pmtParameters

Definition at line 462 of file JMuonEnergy.hh.

◆ correct

JEnergyCorrection JRECONSTRUCTION::JMuonEnergy::correct

Definition at line 464 of file JMuonEnergy.hh.

◆ roadWidth_m

double JRECONSTRUCTION::JMuonEnergyParameters_t::roadWidth_m
inherited

road width [m]

Definition at line 80 of file JMuonEnergyParameters_t.hh.

◆ R_Hz

double JRECONSTRUCTION::JMuonEnergyParameters_t::R_Hz
inherited

default rate [Hz]

Definition at line 81 of file JMuonEnergyParameters_t.hh.

◆ numberOfPrefits

size_t JRECONSTRUCTION::JMuonEnergyParameters_t::numberOfPrefits
inherited

number of prefits

Definition at line 82 of file JMuonEnergyParameters_t.hh.

◆ EMin_log

double JRECONSTRUCTION::JMuonEnergyParameters_t::EMin_log
inherited

minimal energy [log10(GeV)]

Definition at line 83 of file JMuonEnergyParameters_t.hh.

◆ EMax_log

double JRECONSTRUCTION::JMuonEnergyParameters_t::EMax_log
inherited

maximal energy [log10(GeV)]

Definition at line 84 of file JMuonEnergyParameters_t.hh.

◆ TMin_ns

double JRECONSTRUCTION::JMuonEnergyParameters_t::TMin_ns
inherited

minimal time w.r.t. Cherenkov hypothesis [ns]

Definition at line 85 of file JMuonEnergyParameters_t.hh.

◆ TMax_ns

double JRECONSTRUCTION::JMuonEnergyParameters_t::TMax_ns
inherited

maximal time w.r.t. Cherenkov hypothesis [ns]

Definition at line 86 of file JMuonEnergyParameters_t.hh.

◆ ZMin_m

double JRECONSTRUCTION::JMuonEnergyParameters_t::ZMin_m
inherited

minimal z-position [m]

Definition at line 87 of file JMuonEnergyParameters_t.hh.

◆ resolution

double JRECONSTRUCTION::JMuonEnergyParameters_t::resolution
inherited

energy resolution [log10(GeV)]

Definition at line 88 of file JMuonEnergyParameters_t.hh.

◆ mestimator

int JRECONSTRUCTION::JMuonEnergyParameters_t::mestimator
inherited

M-estimator.

Definition at line 89 of file JMuonEnergyParameters_t.hh.


The documentation for this class was generated from the following file: