Jpp 19.3.0-rc.2
the software that should make you happy
Loading...
Searching...
No Matches
Functions
JFitToT.cc File Reference

Auxiliary program to fit time-over-threshold distributions. More...

#include <string>
#include <iostream>
#include <iomanip>
#include "TROOT.h"
#include "TFile.h"
#include "TH1D.h"
#include "TH2D.h"
#include "TF1.h"
#include "TFitResult.h"
#include "TMath.h"
#include "km3net-dataformat/online/JDAQ.hh"
#include "km3net-dataformat/online/JDAQHeader.hh"
#include "JLang/JLangToolkit.hh"
#include "JPhysics/JConstants.hh"
#include "JDetector/JDetector.hh"
#include "JDetector/JDetectorToolkit.hh"
#include "JDetector/JPMTParametersMap.hh"
#include "JDetector/JPMTAnalogueSignalProcessor.hh"
#include "JROOT/JRootToolkit.hh"
#include "JTools/JRange.hh"
#include "JSupport/JMeta.hh"
#include "JSupport/JSupport.hh"
#include "JSupport/JFileRecorder.hh"
#include "JSupport/JSingleFileScanner.hh"
#include "JCalibrate/JCalibrateToT.hh"
#include "JCalibrate/JFitToT.hh"
#include "Jeep/JPrint.hh"
#include "Jeep/JParser.hh"
#include "Jeep/JMessage.hh"

Go to the source code of this file.

Functions

int main (int argc, char **argv)
 

Detailed Description

Auxiliary program to fit time-over-threshold distributions.

The fitted parameters are the PMT gain and gain spread.

Author
mkarel

Definition in file JFitToT.cc.

Function Documentation

◆ main()

int main ( int argc,
char ** argv )

Definition at line 57 of file JFitToT.cc.

58{
59 using namespace std;
60 using namespace JPP;
61 using namespace KM3NETDAQ;
62
63 typedef JRange<double> JRange_t;
64 typedef JTYPELIST<JMeta, JDAQHeader, JRootTypes_t>::typelist typelist;
65
66 string inputFile;
67 JFileRecorder<typelist> outputFile;
68 string detectorFile;
69 string pmtFile;
70 bool writeFits;
71
72 double Wmin = 5e3; // Minimal histogram weight in fit range
73 double LeftMargin = 10.0; // Fit range left of time-over-threshold peak
74 double RightMargin = 10.0; // Fit range right of time-over-threshold peak
75 double gradientThreshold = -0.005; // Minimal right-to-left gradient value in time-over-threshold peak-search,\n
76 // normalized with respect to the total number of histogram entries
77 JRange_t gainLimits (FITTOT_GAIN_MIN,
78 FITTOT_GAIN_MAX); // gain limits
79 JRange_t gainSpreadLimits(FITTOT_GAINSPREAD_MIN,
80 FITTOT_GAINSPREAD_MAX); // gainspread limits
81
82 JRange_t ToTfitRange;
83 string option;
84
85 string regexp;
86 int debug;
87
88 try {
89
90 JProperties properties;
91
92 properties.insert(gmake_property(Wmin));
93 properties.insert(gmake_property(LeftMargin));
94 properties.insert(gmake_property(RightMargin));
95 properties.insert(gmake_property(gradientThreshold));
96 properties.insert(gmake_property(gainLimits));
97 properties.insert(gmake_property(gainSpreadLimits));
98
99 JParser<> zap("Auxiliary program to fit time-over-threshold distributions.");
100
101 zap['f'] = make_field(inputFile, "input file (output from JCalibrateToT).");
102 zap['o'] = make_field(outputFile, "output file.") = "fit.root";
103 zap['a'] = make_field(detectorFile, "detector file.");
104 zap['P'] = make_field(pmtFile, "specify PMT file name that can be given to JTriggerEfficiency.") = "";
105 zap['w'] = make_field(writeFits, "write fit results.");
106 zap['O'] = make_field(option, "ROOT fit options, see TH1::Fit") = "";
107 zap['@'] = make_field(properties, "fit properties") = JPARSER::initialised();
108 zap['x'] = make_field(ToTfitRange, "ROOT fit range (time-over-threshold).") = JRange_t(0.0, 35.0);
109 zap['R'] = make_field(regexp, "regular expression for histogram name.") = MAKE_CSTRING(WILDCARD << _2SToT);
110 zap['d'] = make_field(debug, "debug.") = 1;
111
112 zap(argc, argv);
113 }
114 catch(const exception &error) {
115 FATAL(error.what() << endl);
116 }
117
118
119 //----------------------------------------------------------
120 // load detector file and PMT parameters
121 //----------------------------------------------------------
122
123 JDetector detector;
124
125 try {
126 load(detectorFile, detector);
127 }
128 catch(const JException& error) {
129 FATAL(error);
130 }
131
132
133 JPMTParametersMap parametersMap;
134
135 if (!pmtFile.empty()) {
136
137 try {
138 parametersMap.load(pmtFile.c_str());
139 }
140 catch(const JException& error) {}
141 }
142
143 // Set ROOT fit options
144 if (option.find('R') == string::npos) { option += 'R'; }
145 if (option.find('S') == string::npos) { option += 'S'; }
146 if (option.find('Q') == string::npos && debug < JEEP::debug_t) { option += 'Q'; }
147
148
149 TFile* in = TFile::Open(inputFile.c_str(), "exist");
150
151 if (in == NULL || !in->IsOpen()) {
152 FATAL("File: " << inputFile << " not opened." << endl);
153 }
154
155
156 TH2D gain("gain", NULL,
157 100, 0.0, 2.0,
158 100, 0.0, 1.0);
159 TH1D chi2("chi2", NULL, 100, 0.0, 5.0);
160
161 outputFile.open();
162
163 if (!outputFile.is_open()) {
164 FATAL("Error opening file " << outputFile << endl);
165 }
166
167 outputFile.put(JMeta(argc, argv));
168
169 //----------------------------------------------------------
170 // loop over modules in detector file to fit histogram
171 //----------------------------------------------------------
172
173 for (JDetector::iterator module = detector.begin(); module != detector.end(); ++module) {
174
175 NOTICE("Module " << setw(10) << module->getID() << ' ' << module->getLocation() << endl);
176
177 if (module->empty()) {
178 continue;
179 }
180
181 //----------------------------------------------------------
182 // get histogram for this module
183 //----------------------------------------------------------
184
185 TH2D* h2s = (TH2D*) in->Get(replace(regexp, WILDCARD, MAKE_STRING(module->getID())).c_str());
186
187 if (h2s == NULL) {
188
189 WARNING("No histogram " << module->getID() << "; skip fit." << endl);
190
191 continue;
192 }
193
194 const double ny = h2s->GetYaxis()->GetNbins();
195 const double ymin = h2s->GetYaxis()->GetXmin();
196 const double ymax = h2s->GetYaxis()->GetXmax();
197
198 TH1D chi2_1d (MAKE_CSTRING(module->getID() << ".1chi2"), NULL, NUMBER_OF_PMTS, -0.5, NUMBER_OF_PMTS-0.5);
199 TH1D gain_1d (MAKE_CSTRING(module->getID() << ".1gain"), NULL, NUMBER_OF_PMTS, -0.5, NUMBER_OF_PMTS-0.5);
200 TH1D gainspread_1d(MAKE_CSTRING(module->getID() << ".1gainspread"), NULL, NUMBER_OF_PMTS, -0.5, NUMBER_OF_PMTS-0.5);
201
202 for (int ix = 1; ix <= h2s->GetXaxis()->GetNbins(); ++ix) {
203
204 const JPMTIdentifier id(module->getID(), ix-1);
205
206 const string name = MAKE_STRING(module->getID() << '.' << FILL(2,'0') <<
207 id.getPMTAddress() << FITTOT_SUFFIX);
208
209 DEBUG("Processing histogram " << name << endl);
210
211 TH1D h1(name.c_str(), NULL, ny, ymin, ymax);
212
213 h1.Sumw2();
214
215 for (int iy = h2s->GetNbinsY(); iy >= 1; --iy) {
216
217 const double w = h1.GetBinWidth (iy);
218 const double y = h2s->GetBinContent(ix, iy);
219
220 h1.SetBinContent(iy, y/w);
221 h1.SetBinError (iy, sqrt(y)/w);
222 }
223
224 JRange_t range(ToTfitRange);
225
226 const double weight = h1.Integral(h1.FindBin(range.getLowerLimit()),
227 h1.FindBin(range.getUpperLimit()));
228
229 if (weight <= Wmin) {
230
231 WARNING("Insufficient histogram entries for PMT " << id <<
232 "(" << weight << " < " << Wmin << "); skip fit." << endl);
233
234 if (writeFits) {
235 outputFile.put(h1);
236 }
237
238 continue;
239 }
240
241 //----------------------------------------------------------
242 // find the mode of the time-over-threshold distribution
243 //----------------------------------------------------------
244
245 double max = 0.0;
246 double ToTmode = JDETECTOR::TIME_OVER_THRESHOLD_NS;
247
248 JPMTParameters& parameters = parametersMap[id];
249
250 DEBUG(RIGHT(10) << "ToT" << RIGHT(10) << "Counts" << RIGHT(10) << "gradient" <<
251 RIGHT(10) << "threshold" << RIGHT(10) << "Mode" << RIGHT(10) << "Max" << endl);
252
253 for (int i = h1.GetBinCenter(ny-1);
254 i > h1.GetBinCenter(h1.FindBin(parameters.mean_ns + parameters.sigma_ns));
255 --i) {
256
257 const double x = h1.GetBinCenter (i);
258 const double y = h1.GetBinContent(i);
259
260 const double gradient = ( (h1.GetBinContent(i-1) - h1.GetBinContent(i+1)) /
261 (h1.GetBinCenter (i+1) - h1.GetBinCenter (i-1)) );
262
263 DEBUG(FIXED(10,1) << x << FIXED(10,1) << y << FIXED(10,1) << gradient <<
264 FIXED(10,1) << -fabs(gradientThreshold) * h1.Integral() << FIXED(10,1) << ToTmode << FIXED(10,1) << max << endl);
265
266
267 if (y > max) {
268
269 ToTmode = x;
270 max = y;
271
272 } else if (gradient < -fabs(gradientThreshold) * h1.Integral()) {
273
274 break;
275 }
276 }
277
278 //----------------------------------------------------------
279 // set fit range
280 //----------------------------------------------------------
281
282 if (!range.is_valid()) {
283 range.setRange(ToTmode - LeftMargin,
284 ToTmode + RightMargin);
285 }
286
287 range.setRange(std::max(h1.GetXaxis()->GetXmin(), range.getLowerLimit()),
288 std::min(h1.GetXaxis()->GetXmax(), range.getUpperLimit()));
289
290 DEBUG(LEFT(10) << "Fit-range: " << FIXED(20,1) << range << endl);
291
292 //----------------------------------------------------------
293 // perform minimum chi-square fit
294 //----------------------------------------------------------
295
296 JFitToT fit(parameters, range);
297
298 setParLimits(fit, fit.getModelParameter(&JFitToT::JFitToTParameters::gain),
299 gainLimits.getLowerLimit(), gainLimits.getUpperLimit());
300 setParLimits(fit, fit.getModelParameter(&JFitToT::JFitToTParameters::gainSpread),
301 gainSpreadLimits.getLowerLimit(), gainSpreadLimits.getUpperLimit());
302
303 const double initGain = fit.getCPU().getNPE(ToTmode);
304 const double initGainSpread = initGain / 3.0;
305
306 if (!gainLimits(initGain)) { // Invalid initial gain value
307
308 WARNING("Invalid initial gain for PMT " << id << "; set default values." << endl);
309
310 parameters.gain = gainLimits .constrain(initGain);
311 parameters.gainSpread = gainSpreadLimits.constrain(initGainSpread);
312
313 if (writeFits) {
314 outputFile.put(h1);
315 }
316
317 continue;
318 }
319
320 fit.gain = initGain;
321 fit.gainSpread = initGainSpread;
322
323 const TFitResultPtr result = fit(h1, option);
324
325 if (result.Get() == NULL) {
326 FATAL("Invalid TFitResultPtr " << h1.GetName() << endl);
327 }
328
329 if (int(result) < 0 || !result->IsValid()) { // Fit failed
330
331 WARNING("Fit failure for PMT " << id << "; set initialization values." << endl);
332
333 h1.GetListOfFunctions()->Clear();
334
335 parameters.gain = initGain;
336 parameters.gainSpread = initGainSpread;
337
338 if (writeFits) {
339 outputFile.put(h1);
340 }
341
342 continue;
343 }
344
345 if ((ymin < range.getLowerLimit() || ymax > range.getUpperLimit()) &&
346 (option.find("0") == string::npos && option.find("N") == string::npos)) {
347
348 // add function with full range
349
350 TF1* f1 = new TF1(MAKE_CSTRING(FITTOT_FNAME << "_fullRange"),
351 &fit,
352 &JFitToT::getValue,
353 ymin,
354 round(parameters.saturation) - 0.5,
355 JFitToT::getNumberOfModelParameters());
356 f1->SetParameters(fit.GetParameters());
357 f1->SetLineStyle(kDotted);
358 f1->SetNpx(1000);
359
360 h1.GetListOfFunctions()->Add(f1);
361 }
362
363 // store fit results
364
365 const double reducedChi2 = result->Chi2() / result->Ndf();
366
367 const JFitToTParameters values(fit.GetParameters());
368 const JFitToTParameters errors(fit.GetParErrors());
369
370 chi2_1d. SetBinContent(ix, reducedChi2);
371 gain_1d. SetBinContent(ix, values.gain);
372 gain_1d. SetBinError (ix, errors.gain);
373 gainspread_1d.SetBinContent(ix, values.gainSpread);
374 gainspread_1d.SetBinError (ix, errors.gainSpread);
375
376 gain.Fill(fit.gain, fit.gainSpread);
377 chi2.Fill(TMath::Log10(reducedChi2));
378
379 NOTICE("PMT " << id << " chi2 / NDF " << result->Chi2() << ' ' << result->Ndf() << endl);
380
381 parameters.gain = fit.gain;
382 parameters.gainSpread = fit.gainSpread;
383
384 if (writeFits) {
385 outputFile.put(h1);
386 }
387 }
388
389 if (writeFits) {
390 outputFile.put(chi2_1d);
391 outputFile.put(gain_1d);
392 outputFile.put(gainspread_1d);
393 }
394 }
395
396 {
397 vector<JMeta> buffer(1, JMeta(argc, argv));
398
399 for (JSingleFileScanner<JMeta> in(inputFile); in.hasNext(); ) {
400
401 const JMeta* meta = in.next();
402
403 buffer.push_back(*meta);
404
405 outputFile.put(*meta);
406 }
407
408 for (vector<JMeta>::const_reverse_iterator i = buffer.rbegin(); i != buffer.rend(); ++i) {
409 parametersMap.comment.add(*i);
410 }
411 }
412
413 for (JRootFileReader<JDAQHeader> in(inputFile.c_str()); in.hasNext(); ) {
414 outputFile.put(*in.next());
415 }
416
417
418 if (pmtFile != "") {
419 parametersMap.store(pmtFile.c_str());
420 }
421
422 outputFile.put(gain);
423 outputFile.put(chi2);
424
425 outputFile.close();
426}
outputFile
string outputFile
Definition JDAQTimesliceSelector.cc:37
DEBUG
#define DEBUG(A)
Message macros.
Definition JMessage.hh:62
NOTICE
#define NOTICE(A)
Definition JMessage.hh:64
FATAL
#define FATAL(A)
Definition JMessage.hh:67
debug
int debug
debug level
Definition JSirene.cc:72
WARNING
#define WARNING(A)
Definition JMessage.hh:65
make_field
#define make_field(A,...)
macro to convert parameter to JParserTemplateElement object
Definition JParser.hh:2142
MAKE_CSTRING
#define MAKE_CSTRING(A)
Make C-string.
Definition JPrint.hh:72
MAKE_STRING
#define MAKE_STRING(A)
Make string.
Definition JPrint.hh:63
gmake_property
#define gmake_property(A)
macros to convert (template) parameter to JPropertiesElement object
Definition JProperties.hh:1293
JDETECTOR::JDetector
Detector data structure.
Definition JDetector.hh:96
JDETECTOR::JPMTParametersMap
Auxiliary class for map of PMT parameters.
Definition JPMTParametersMap.hh:93
JDETECTOR::JPMTParameters
Data structure for PMT parameters.
Definition JPMTParameters.hh:29
JDETECTOR::JPMTParameters::sigma_ns
double sigma_ns
time-over-threshold standard deviation of threshold-band hits [ns]
Definition JPMTParameters.hh:244
JDETECTOR::JPMTParameters::gainSpread
double gainSpread
gain spread [unit]
Definition JPMTParameters.hh:237
JDETECTOR::JPMTParameters::mean_ns
double mean_ns
mean time-over-threshold of threshold-band hits [ns]
Definition JPMTParameters.hh:243
JDETECTOR::JPMTParameters::saturation
double saturation
saturation [ns]
Definition JPMTParameters.hh:246
JEEP::JProperties
Utility class to parse parameter values.
Definition JProperties.hh:501
JLANG::JException
General exception.
Definition JException.hh:24
JPARSER::JParser
Utility class to parse command line options.
Definition JParser.hh:1698
JSUPPORT::JFileRecorder
Object writing to file.
Definition JFileRecorder.hh:44
JSUPPORT::JSingleFileScanner
Object reading from a list of files.
Definition JSingleFileScanner.hh:172
JSUPPORT::JSingleFileScanner::hasNext
virtual bool hasNext() override
Check availability of next element.
Definition JSingleFileScanner.hh:257
JTOOLS::JRange
Range of values.
Definition JRange.hh:42
GAUSS_LEGENDRE::f1
const JPolynome f1(1.0, 2.0, 3.0)
Function.
JCALIBRATE::_2SToT
static const char *const _2SToT
Histogram naming.
Definition JCalibrateToT.hh:16
JCALIBRATE::FITTOT_GAINSPREAD_MAX
static const double FITTOT_GAINSPREAD_MAX
Default maximal gain spread.
Definition JFitToT.hh:48
JCALIBRATE::FITTOT_FNAME
static const std::string FITTOT_FNAME
Definition JFitToT.hh:38
JCALIBRATE::FITTOT_SUFFIX
static const std::string FITTOT_SUFFIX
Definition JFitToT.hh:37
JCALIBRATE::FITTOT_GAIN_MAX
static const double FITTOT_GAIN_MAX
Default maximal gain.
Definition JFitToT.hh:45
JCALIBRATE::FITTOT_GAIN_MIN
static const double FITTOT_GAIN_MIN
Default minimal gain.
Definition JFitToT.hh:44
JCALIBRATE::FITTOT_GAINSPREAD_MIN
static const double FITTOT_GAINSPREAD_MIN
Default minimal gain spread.
Definition JFitToT.hh:47
JDETECTOR::load
void load(const std::string &file_name, JDetector &detector)
Load detector from input file.
Definition JDetectorToolkit.hh:508
JDETECTOR::TIME_OVER_THRESHOLD_NS
const double TIME_OVER_THRESHOLD_NS
Specification for time-over-threshold corresponding to a one photo-electron pulse.
Definition JDetector/JCalibration.hh:30
JEEP::debug_t
@ debug_t
debug
Definition JMessage.hh:29
JLANG::replace
std::string replace(const std::string &input, const std::string &target, const std::string &replacement)
Replace tokens in string.
Definition JLangToolkit.hh:124
JLANG::LEFT
@ LEFT
Definition JTwosome.hh:18
JLANG::RIGHT
@ RIGHT
Definition JTwosome.hh:18
JPP
This name space includes all other name spaces (except KM3NETDAQ, KM3NET and ANTARES).
Definition JAAnetToolkit.hh:43
JROOT::setParLimits
bool setParLimits(TF1 &f1, const Int_t index, Double_t xmin, Double_t xmax)
Set fit parameter limits.
Definition JRootToolkit.hh:632
JTOOLS::result
return result
Definition JPolint.hh:862
KM3NETDAQ
KM3NeT DAQ data structures and auxiliaries.
Definition DataQueue.cc:39
KM3NETDAQ::WILDCARD
static const char WILDCARD
Definition JDAQTags.hh:56
FILL
Auxiliary data structure for sequence of same character.
Definition JManip.hh:330
FIXED
Auxiliary data structure for floating point format specification.
Definition JManip.hh:448
JAANET::JRange_t
Type definition of range.
Definition JHead.hh:43
JAANET::detector
Detector file.
Definition JHead.hh:227
JCALIBRATE::JFitToTParameters
Fit parameters for two-fold coincidence rate due to K40.
Definition JFitToT.hh:54
JCALIBRATE::JFitToT
Parametrisation of time-over-threshold distribution.
Definition JFitToT.hh:183
JCALIBRATE::JFitToT::getValue
Double_t getValue(const Double_t *x, const Double_t *par)
Get rate as a function of the fit parameters.
Definition JFitToT.hh:270
JEEP::JComment::add
JComment & add(const std::string &comment)
Add comment.
Definition JComment.hh:100
JLANG::JObjectStreamIO::store
void store(const char *file_name) const
Store to output file.
Definition JObjectStreamIO.hh:41
JLANG::JObjectStreamIO::load
void load(const char *file_name)
Load from input file.
Definition JObjectStreamIO.hh:30
JLANG::JTypeList
Type list.
Definition JTypeList.hh:23
JPARSER::initialised
Empty structure for specification of parser element that is initialised (i.e. does not require input)...
Definition JParser.hh:68
JSUPPORT::JMeta
Auxiliary class for ROOT I/O of application specific meta data.
Definition JMeta.hh:72
Generated by doxygen 1.12.0