source: trunk/MagicSoft/Mars/mcalib/MCalibCalcFromPast.cc@ 8040

Last change on this file since 8040 was 7829, checked in by tbretz, 18 years ago
*** empty log message ***
File size: 15.3 KB
Line 
1/* ======================================================================== *\
2!
3! *
4! * This file is part of MARS, the MAGIC Analysis and Reconstruction
5! * Software. It is distributed to you in the hope that it can be a useful
6! * and timesaving tool in analysing Data of imaging Cerenkov telescopes.
7! * It is distributed WITHOUT ANY WARRANTY.
8! *
9! * Permission to use, copy, modify and distribute this software and its
10! * documentation for any purpose is hereby granted without fee,
11! * provided that the above copyright notice appear in all copies and
12! * that both that copyright notice and this permission notice appear
13! * in supporting documentation. It is provided "as is" without express
14! * or implied warranty.
15! *
16!
17!
18! Author(s): Markus Gaug, 12/2004 <mailto:markus@ifae.es>
19!
20! Copyright: MAGIC Software Development, 2000-2004
21!
22!
23\* ======================================================================== */
24//////////////////////////////////////////////////////////////////////////////
25//
26// MCalibCalcFromPast
27//
28// Steers the occurrance of interlaced calibration events in one data run
29//
30// Input Containers:
31// MParList
32// MCalibrationIntensityChargeCam
33// MCalibrationIntensityRelTimeCam
34// MCalibrationIntensityConstCam
35// MBadPixelsIntensityCam
36//
37// Output Containers:
38// MCalibrationIntensityChargeCam
39// MCalibrationIntensityRelTimeCam
40// MBadPixelsIntensityCam
41//
42// Class version 2:
43// + UInt_t fNumPhesDump; // Number of cams after which the number of phes gets averaged
44// + Float_t fMeanPhes;
45// + Float_t fMeanPhesRelVar;
46// + Bool_t fUpdateNumPhes; // Update the number of photo-electrons only after fNumPhesDump number of Cams
47// + TArrayF fPhes;
48// + TArrayF fPhesVar;
49//
50//////////////////////////////////////////////////////////////////////////////
51#include "MCalibCalcFromPast.h"
52
53#include "MLog.h"
54#include "MLogManip.h"
55
56#include "MParList.h"
57
58#include "MRawRunHeader.h"
59
60#include "MHCalibrationCam.h"
61
62#include "MCalibrationIntensityChargeCam.h"
63#include "MCalibrationIntensityBlindCam.h"
64#include "MCalibrationIntensityQECam.h"
65#include "MCalibrationIntensityRelTimeCam.h"
66#include "MCalibrationIntensityConstCam.h"
67
68#include "MBadPixelsIntensityCam.h"
69
70#include "MCalibrationChargePix.h"
71#include "MCalibrationChargeCalc.h"
72#include "MCalibrationRelTimeCalc.h"
73#include "MCalibrateData.h"
74
75ClassImp(MCalibCalcFromPast);
76
77using namespace std;
78
79const UInt_t MCalibCalcFromPast::fgNumEventsDump = 500;
80const UInt_t MCalibCalcFromPast::fgNumPhesDump = 10;
81
82// --------------------------------------------------------------------------
83//
84// Default constructor.
85//
86// Sets:
87// - fNumEventsDump to fgNumEventsDump
88// - fNumPhesDump to fgNumPhesDump
89//
90MCalibCalcFromPast::MCalibCalcFromPast(const char *name, const char *title)
91 : fGeom(NULL), fParList(NULL), fRunHeader(NULL),
92 fIntensCharge(NULL), fIntensBlind(NULL), fIntensRelTime(NULL), fIntensConst(NULL),
93 fIntensBad(NULL),
94 fChargeCalc(NULL), fRelTimeCalc(NULL), fCalibrate(NULL),
95 fNumCam(0), fNumEvents(0), fUpdateWithFFactorMethod(kTRUE), fUpdateNumPhes(kTRUE),
96 fNumFails(0)
97{
98
99 fName = name ? name : "MCalibCalcFromPast";
100 fTitle = title ? title : "Task to steer the processing of interlaced calibration events";
101
102 SetNumEventsDump();
103 SetNumPhesDump ();
104}
105
106// -----------------------------------------------------------------------------------
107//
108Int_t MCalibCalcFromPast::PreProcess(MParList *pList)
109{
110
111 fGeom = (MGeomCam*)pList->FindObject("MGeomCam");
112 if (!fGeom)
113 {
114 *fLog << err << "MGeomCam not found... abort." << endl;
115 return kFALSE;
116 }
117
118 fParList = pList;
119 if (!fParList)
120 {
121 *fLog << err << "MParList not found... abort." << endl;
122 return kFALSE;
123 }
124
125 fRunHeader = (MRawRunHeader*)pList->FindObject("MRawRunHeader");
126 if (!fRunHeader)
127 {
128 *fLog << err << "MRawRunHeader not found... abort." << endl;
129 return kFALSE;
130 }
131
132 //
133 // Look for the MBadPixels Intensity Cam
134 //
135 fIntensBad = (MBadPixelsIntensityCam*)pList->FindCreateObj("MBadPixelsIntensityCam");
136 if (fIntensBad)
137 *fLog << inf << "Found MBadPixelsIntensityCam ... " << flush;
138 else
139 return kFALSE;
140
141 //
142 // Look for the MFillH-class "MHCalibrationBlindCam". In case yes, initialize the
143 // corresponding IntensityCam
144 //
145 if (pList->FindObject(AddSerialNumber("MHCalibrationBlindCam")))
146 {
147
148 *fLog << inf << "Found MHCalibrationBlindCam ... " << flush;
149
150 fIntensBlind = (MCalibrationIntensityBlindCam*)pList->FindCreateObj("MCalibrationIntensityBlindCam");
151 if (!fIntensBlind)
152 {
153 *fLog << err << "Could not find nor create MCalibrationIntensitBlindCam abort... " << endl;
154 return kFALSE;
155 }
156 }
157
158 //
159 // Look for the MFillH-class "MHCalibrationChargeCam". In case yes, initialize the
160 // corresponding IntensityCam
161 //
162 if (pList->FindObject(AddSerialNumber("MHCalibrationChargeCam")))
163 {
164
165 fIntensCharge = (MCalibrationIntensityChargeCam*)pList->FindCreateObj("MCalibrationIntensityChargeCam");
166 fIntensQE = (MCalibrationIntensityQECam*) pList->FindCreateObj("MCalibrationIntensityQECam");
167 fIntensConst = (MCalibrationIntensityConstCam*) pList->FindCreateObj("MCalibrationIntensityConstCam");
168
169 MCalibrationChargeCam *chargeinit = (MCalibrationChargeCam*)pList->FindObject("MCalibrationChargeCam");
170 MCalibrationQECam *qeinit = (MCalibrationQECam*) pList->FindObject("MCalibrationQECam");
171
172 if (chargeinit)
173 fIntensCharge->SetCam(chargeinit,0);
174 else
175 *fLog << "Could not find initial MCalibrationChargeCam, cannot initialize intensity cam" << endl;
176
177 if (qeinit)
178 fIntensQE->SetCam(qeinit,0);
179 else
180 *fLog << "Could not find initial MCalibrationQECam, cannot initialize intensity cam" << endl;
181
182 fIntensConst->GetCam()->Init(*fGeom);
183
184 if (!fChargeCalc)
185 fChargeCalc = (MCalibrationChargeCalc*)pList->FindObject("MCalibrationChargeCalc");
186
187 if (!fCalibrate)
188 fCalibrate = (MCalibrateData*)pList->FindObject("MCalibrateData");
189
190 *fLog << inf << "Found MHCalibrationChargeCam ... " << flush;
191
192 if (!fIntensCharge)
193 {
194 *fLog << err << "Could not find nor create MCalibrationIntensityChargeCam abort... " << endl;
195 return kFALSE;
196 }
197
198 if (!fIntensQE)
199 {
200 *fLog << err << "Could not find nor create MCalibrationIntensityQECam abort... " << endl;
201 return kFALSE;
202 }
203
204 if (!fChargeCalc)
205 {
206 *fLog << err << "Could not find MCalibrationChargeCalc abort... " << endl;
207 return kFALSE;
208 }
209
210 if (!fCalibrate)
211 {
212 *fLog << err << "Could not find MCalibrateData abort... " << endl;
213 return kFALSE;
214 }
215 }
216
217 //
218 // Look for the MFillH name "FillRelTimeCam". In case yes, initialize the
219 // corresponding IntensityCam
220 //
221 if (pList->FindObject(AddSerialNumber("MHCalibrationRelTimeCam")))
222 {
223
224 fIntensRelTime = (MCalibrationIntensityRelTimeCam*)pList->FindCreateObj("MCalibrationIntensityRelTimeCam");
225 if (!fRelTimeCalc)
226 fRelTimeCalc = (MCalibrationRelTimeCalc*)pList->FindObject(AddSerialNumber("MCalibrationRelTimeCalc"));
227
228 *fLog << inf << "Found MHCalibrationRelTimeCam ... " << flush;
229
230 if (!fIntensRelTime)
231 {
232 *fLog << err << "Could not find nor create MCalibrationIntensityRelTimeCam abort... " << endl;
233 return kFALSE;
234 }
235
236 if (!fRelTimeCalc)
237 {
238 *fLog << err << "Could not find MCalibrationRelTimeCalc abort... " << endl;
239 return kFALSE;
240 }
241 }
242
243 fNumCam = 0;
244 fNumEvents = 0;
245 fNumPhes = 0;
246
247 fChargeCalc->SetUseExternalNumPhes(kFALSE);
248
249 if (fUpdateNumPhes)
250 {
251 fPhes.Set(fNumPhesDump);
252 fPhesVar.Set(fNumPhesDump);
253 }
254
255 fNumFails = 0;
256
257 return kTRUE;
258}
259
260// --------------------------------------------------------------------------
261//
262// Set fNumEvents=0
263//
264// This is necessary because the calibration histograms do reset themself
265// if ReInit is called, so they are empty. MCalibCalcFromPast errornously
266// ignores how many events are in the histograms but count the number
267// itself.
268//
269Bool_t MCalibCalcFromPast::ReInit(MParList *pList)
270{
271 if (fNumEvents>0)
272 *fLog << inf << fNumEvents << " calibration events at the end of the last file have been skipped." << endl;
273
274 fNumEvents = 0;
275
276 return kTRUE;
277}
278
279// --------------------------------------------------------------------------
280//
281// - Initializes new containers in the
282// - Intensity Cams, if the number of calibration events has reach fNumEventsDump.
283// - Executes Finalize() of the MCalibration*Calc classes in that case.
284// - Sets the latest MCalibrationChargeCam as update class into MCalibrateData
285// - Initialize new MCalibration*Cams into the intensity cams.
286//
287Int_t MCalibCalcFromPast::Process()
288{
289 if (fNumEvents++ < fNumEventsDump)
290 return kTRUE;
291
292 fNumEvents = 0;
293 ReInitialize();
294
295 //
296 // Finalize Possible calibration histogram classes...
297 //
298 *fLog << inf << GetDescriptor() << ": Finalize calibration histograms: " << flush;
299
300 if (Finalize("MHCalibrationChargeCam")) *fLog << "MHCalibrationChargeCam..." << flush;
301 if (Finalize("MHCalibrationChargeBlindCam")) *fLog << "MHCalibrationChargeBlindCam..." << flush;
302 if (Finalize("MHCalibrationRelTimeCam")) *fLog << "MHCalibrationRelTimeCam..." << flush;
303
304 //
305 // Finalize possible calibration calculation tasks
306 //
307 *fLog << endl;
308 *fLog << inf << "Finalize calibration calculations..." << endl;
309 if (fChargeCalc)
310 {
311 if (!fChargeCalc->Finalize())
312 {
313 fNumFails++;
314 *fLog << warn << "WARNING - Finalization of charges failed the " << fNumFails << ". time..." << endl;
315 return kTRUE;
316 }
317
318 if (fUpdateNumPhes)
319 {
320 MCalibrationChargePix &avpix =(MCalibrationChargePix&)fIntensCharge->GetCam()->GetAverageArea(0);
321 fPhes [fNumPhes] = avpix.GetPheFFactorMethod();
322 fPhesVar[fNumPhes] = avpix.GetPheFFactorMethodVar();
323
324 fNumPhes++;
325
326 if (fNumPhes == fNumPhesDump)
327 {
328 fNumPhes = 0;
329 if (!UpdateMeanPhes())
330 {
331 *fLog << warn << "Could not update mean number of photo-electrons. "
332 << "Skip it until next update" << endl;
333 fChargeCalc->SetUseExternalNumPhes(kFALSE);
334 }
335 else
336 {
337 *fLog << inf << "New averaged number photo-electrons: " << fMeanPhes << endl;
338 fChargeCalc->SetExternalNumPhes ( fMeanPhes );
339 fChargeCalc->SetExternalNumPhesRelVar( fMeanPhesRelVar );
340 fChargeCalc->SetUseExternalNumPhes();
341 }
342 }
343 }
344 }
345
346 if (fRelTimeCalc)
347 fRelTimeCalc->Finalize();
348
349 if (fCalibrate)
350 fCalibrate->UpdateConversionFactors(fUpdateWithFFactorMethod ? NULL
351 : (MCalibrationChargeCam*)fIntensCharge->GetCam() );
352
353 return kTRUE;
354}
355
356
357// --------------------------------------------------------------------------
358//
359// Searches for name in the MParList and calls, if existing:
360// - MHCalibrationCam::Finalize()
361// - MHCalibrationCam::ResetHists()
362//
363Bool_t MCalibCalcFromPast::Finalize(const char* name, Bool_t finalize)
364{
365 MHCalibrationCam *hist = (MHCalibrationCam*)fParList->FindObject(name, "MHCalibrationCam");
366 if (!hist)
367 return kFALSE;
368
369 if (finalize)
370 hist->Finalize();
371
372 hist->ResetHists();
373 return kTRUE;
374}
375
376// --------------------------------------------------------------------------
377//
378// Re-Intitializes new containers inside the Intensity Cams.
379// From now on, a call to the IntensityCam functions returns pointers
380// to the newly created Containers.
381//
382Bool_t MCalibCalcFromPast::ReInitialize()
383{
384 fNumCam++;
385
386 *fLog << inf << "MCalibCalcFromPast::ReInitialize #" << fNumCam << ": ";
387
388 const Int_t runnumber = fRunHeader->GetRunNumber();
389
390 if (fIntensBad)
391 {
392 fIntensBad->AddToList(Form("MBadPixelsCam%04d",fNumCam),*fGeom);
393 *fLog << "MBadPixelsCam...";
394 }
395
396 if (fIntensCharge)
397 {
398 MCalibrationChargeCam *cold = (MCalibrationChargeCam*)fIntensCharge->GetCam();
399
400 fIntensCharge->AddToList(Form("MCalibrationChargeCam%04d",fNumCam),*fGeom);
401
402 MCalibrationChargeCam *cnew = (MCalibrationChargeCam*)fIntensCharge->GetCam();
403 cnew->SetRunNumber(runnumber);
404
405 if (cold)
406 cnew->MergeHiLoConversionFactors(*cold);
407
408 *fLog << "MCalibrationChargeCam...";
409 }
410 if (fIntensQE)
411 {
412 fIntensQE->AddToList(Form("MCalibrationQECam%04d",fNumCam),*fGeom);
413 fIntensQE->GetCam()->SetRunNumber(runnumber);
414 *fLog << "MCalibrationQECam...";
415 }
416 if (fIntensBlind)
417 {
418 fIntensBlind->AddToList(Form("MCalibrationBlindCam%04d",fNumCam),*fGeom);
419 fIntensBlind->GetCam()->SetRunNumber(runnumber);
420 *fLog << "MCalibrationBlindCam...";
421 }
422
423 *fLog << endl;
424
425 return kTRUE;
426
427}
428
429Int_t MCalibCalcFromPast::PostProcess()
430{
431 if (GetNumExecutions()==0)
432 return kTRUE;
433
434 // Now we reset all histograms to make sure that the PostProcess
435 // of the following tasks doesn't try to finalize a partly empty
436 // histogram!
437 Finalize("MHCalibrationChargeCam", kFALSE);
438 Finalize("MHCalibrationChargeBlindCam", kFALSE);
439 Finalize("MHCalibrationRelTimeCam", kFALSE);
440
441 if (fChargeCalc)
442 fChargeCalc->ResetNumProcessed();
443
444 if (fNumCam==0)
445 return kTRUE;
446
447 *fLog << inf << endl;
448 *fLog << GetDescriptor() << " execution statistics:" << endl;
449 *fLog << " " << setfill(' ') << setw(7) << fNumFails << " (" << Form("%5.1f", 100.*fNumFails/fNumCam) << "%) updates failed." << endl;
450 *fLog << endl;
451
452 return kTRUE;
453}
454
455
456Bool_t MCalibCalcFromPast::UpdateMeanPhes()
457{
458 Float_t sumw = 0.;
459 Float_t sum = 0.;
460
461 for (Int_t i=0; i<fPhes.GetSize(); i++)
462 {
463 const Float_t weight = 1./fPhesVar[i];
464 sum += fPhes[i]*weight;
465 sumw += weight;
466 }
467
468 if (sumw < 0.000001)
469 return kFALSE;
470
471 if (sum < 0.000001)
472 return kFALSE;
473
474 fMeanPhes = sum/sumw;
475 fMeanPhesRelVar = sumw/sum/sum;
476
477 return kTRUE;
478}
479
480// --------------------------------------------------------------------------
481//
482// Read the setup from a TEnv, eg:
483// MCalibCalcFromPast.UpdateWithFFactorMethod: Off, On
484// MCalibCalcFromPast.NumEventsDump: 500
485// MCalibCalcFromPast.UpdateNumPhes: yes/no
486// MCalibCalcFromPast.NumPhesDump: 10
487//
488Int_t MCalibCalcFromPast::ReadEnv(const TEnv &env, TString prefix, Bool_t print)
489{
490 Bool_t rc = kFALSE;
491 if (IsEnvDefined(env, prefix, "UpdateWithFFactorMethod", print))
492 {
493 rc = kTRUE;
494 SetUpdateWithFFactorMethod(GetEnvValue(env, prefix, "UpdateWithFFactorMethod", fUpdateWithFFactorMethod));
495 }
496
497 if (IsEnvDefined(env, prefix, "NumEventsDump", print))
498 {
499 SetNumEventsDump(GetEnvValue(env, prefix, "NumEventsDump", (Int_t)fNumEventsDump));
500 rc = kTRUE;
501 }
502
503 if (IsEnvDefined(env, prefix, "UpdateNumPhes", print))
504 {
505 TString s = GetEnvValue(env, prefix, "UpdateNumPhes", "");
506 s.ToLower();
507 if (s.BeginsWith("no"))
508 SetUpdateNumPhes(kFALSE);
509 if (s.BeginsWith("yes"))
510 SetUpdateNumPhes(kTRUE);
511 rc = kTRUE;
512 }
513
514 if (IsEnvDefined(env, prefix, "NumPhesDump", print))
515 {
516 SetNumPhesDump(GetEnvValue(env, prefix, "NumPhesDump", (Int_t)fNumPhesDump));
517 rc = kTRUE;
518 }
519
520 return rc;
521}
Note: See TracBrowser for help on using the repository browser.