1 /**************************************************************************
2 * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
4 * Author: The ALICE Off-line Project. *
5 * Contributors are mentioned in the code where appropriate. *
7 * Permission to use, copy, modify and distribute this software and its *
8 * documentation strictly for non-commercial purposes is hereby granted *
9 * without fee, provided that the above copyright notice appears in all *
10 * copies and that both the copyright notice and this permission notice *
11 * appear in the supporting documentation. The authors make no claims *
12 * about the suitability of this software for any purpose. It is *
13 * provided "as is" without express or implied warranty. *
14 **************************************************************************/
18 ///////////////////////////////////////////////////////////////////////////
20 // Generic handling of (extrapolated) detector signals.
24 // Signal positions (r) and reference frames (f) are specified via
25 // SetPosition(r,f) under the following conventions :
27 // f="car" ==> r is Cartesian (x,y,z)
28 // f="sph" ==> r is Spherical (r,theta,phi)
29 // f="cyl" ==> r is Cylindrical (rho,phi,z)
31 // The same holds for SetPositionErrors().
33 // All angles are in radians.
39 // s.SetName("Start counter");
40 // Float_t pos[3]={-1,25,7};
41 // Float_t err[3]={0.03,0.7,0.18};
42 // Float_t signal=120.8;
43 // Float_t error=1.73;
44 // Float_t offset=-12.78;
46 // s.SetPosition(pos,"car");
47 // s.SetPositionErrors(err,"car");
48 // s.SetSignal(signal);
49 // s.SetSignalError(error);
50 // s.SetOffset(offset);
52 // Float_t loc[3],dr[3],sigma;
53 // s.GetPosition(loc,"sph");
54 // s.GetPositionErrors(dr,"sph");
55 // Float_t adc=s.GetSignal();
56 // Float_t sigma=s.GetSignalError();
58 // AliSignal q; // In the example below a signal contains the
59 // // following data : timing, ADC and dE/dx
60 // q.SetName("TOF hit");
61 // q.SetPosition(pos,"car");
62 // q.SetPositionErrors(err,"car");
63 // signal=82.5; // e.g. signal time in ns
66 // q.SetSignal(signal,1);
67 // q.SetSignalError(error,1);
68 // q.SetOffset(offset,1);
69 // signal=268.1; // e.g. ADC value of signal
72 // q.SetSignal(signal,2);
73 // q.SetSignalError(error,2);
75 // signal=23.7; // e.g. corresponding dE/dx value
79 // q.SetSignal(signal,3);
80 // q.SetSignalError(error,3);
81 // q.SetOffset(offset,3);
84 //--- Author: Nick van Eijndhoven 23-jan-1999 UU-SAP Utrecht
85 //- Modified: NvE $Date$ UU-SAP Utrecht
86 ///////////////////////////////////////////////////////////////////////////
88 #include "AliSignal.h"
89 #include "Riostream.h"
91 ClassImp(AliSignal) // Class implementation to enable ROOT I/O
93 AliSignal::AliSignal() : TNamed(),AliPosition(),AliAttrib()
95 // Creation of an AliSignal object and initialisation of parameters.
96 // Several signal values (with errors) can be stored in different slots.
97 // If needed, the storage for values (and errors) will be expanded automatically
98 // when entering values and/or errors.
102 SetName("Unspecified");
104 ///////////////////////////////////////////////////////////////////////////
105 AliSignal::~AliSignal()
107 // Destructor to delete dynamically allocated memory
124 ///////////////////////////////////////////////////////////////////////////
125 AliSignal::AliSignal(AliSignal& s) : TNamed(s),AliPosition(s),AliAttrib(s)
132 Int_t n=s.GetNvalues();
134 for (Int_t i=1; i<=n; i++)
141 for (Int_t j=1; j<=n; j++)
143 val=s.GetSignalError(j);
144 SetSignalError(val,j);
148 for (Int_t k=1; k<=n; k++)
150 TH1F* hist=s.GetWaveform(k);
151 if (hist) SetWaveform(hist,k);
154 ///////////////////////////////////////////////////////////////////////////
155 void AliSignal::Reset(Int_t mode)
157 // Reset all signal and position values and errors to 0.
159 // mode = 0 Reset position and all signal values and their errors to 0.
160 // The waveform histograms are reset, but the calibration
161 // constants (i.e. gains and offsets) are kept.
162 // 1 Reset position and delete the signal and error storage arrays.
163 // Also the waveform histograms, gains and offset arrays are deleted.
165 // The default when invoking Reset() corresponds to mode=0.
167 // The usage of mode=0 allows to re-use the allocated memory for new
168 // signal (and error) values. This behaviour is preferable (i.e. faster)
169 // in case the various signals always contain the same number of values
170 // and have the same calibration constants.
171 // The usage of mode=1 is slower, but allows a more efficient memory
172 // occupation (and smaller output file size) in case the different
173 // signals have a variable number of values.
175 // For more specific actions see ResetPosition(), ResetSignals(),
176 // DeleteSignals(), ResetGain(), ResetOffset() and DeleteCalibrations().
179 if (mode<0 || mode>1)
181 cout << " *AliSignal::Reset* Invalid argument mode = " << mode << endl;
182 cout << " Default mode=0 will be used." << endl;
194 DeleteCalibrations();
197 ///////////////////////////////////////////////////////////////////////////
198 void AliSignal::ResetSignals(Int_t mode)
200 // Reset various signal data according to user selection.
202 // mode = 0 Reset all signal values and their errors to 0.
203 // 1 Reset only signal values
204 // 2 Reset only signal errors
206 // The default when invoking ResetSignals() corresponds to mode=0.
208 // Irrespective of the mode, the waveform histograms are reset.
210 if (mode<0 || mode>2)
212 cout << " *AliSignal::ResetSignals* Invalid argument mode = " << mode << endl;
213 cout << " Default mode=0 will be used." << endl;
217 if (fSignals && (mode==0 || mode==1))
219 for (Int_t i=0; i<fSignals->GetSize(); i++)
221 fSignals->AddAt(0,i);
225 if (fDsignals && (mode==0 || mode==2))
227 for (Int_t j=0; j<fDsignals->GetSize(); j++)
229 fDsignals->AddAt(0,j);
235 ///////////////////////////////////////////////////////////////////////////
236 void AliSignal::DeleteSignals(Int_t mode)
238 // Delete storage arrays of various signal data according to user selection.
240 // mode = 0 Delete arrays of both signal values and their errors.
241 // 1 Delete only signal values array
242 // 2 Delete only signal errors array
244 // The default when invoking DeleteSignals() corresponds to mode=0.
246 // Irrespective of the mode, the waveform histograms are deleted.
248 if (mode<0 || mode>2)
250 cout << " *AliSignal::DeleteSignals* Invalid argument mode = " << mode << endl;
251 cout << " Default mode=0 will be used." << endl;
255 if (fSignals && (mode==0 || mode==1))
261 if (fDsignals && (mode==0 || mode==2))
269 ///////////////////////////////////////////////////////////////////////////
270 void AliSignal::SetSignal(Double_t sig,Int_t j)
272 // Store value in the j-th (default j=1) signal slot.
273 // Note : The first signal slot is at j=1.
274 // In case the value of the index j exceeds the maximum number of reserved
275 // slots for signal values, the number of reserved slots for the
276 // signal values is increased automatically.
280 fSignals=new TArrayF(j);
284 Int_t size=fSignals->GetSize();
291 fSignals->AddAt(float(sig),j-1);
293 ///////////////////////////////////////////////////////////////////////////
294 void AliSignal::AddSignal(Double_t sig,Int_t j)
296 // Add value to the j-th (default j=1) signal slot.
297 // Note : The first signal slot is at j=1.
298 // In case the value of the index j exceeds the maximum number of reserved
299 // slots for signal values, the number of reserved slots for the
300 // signal values is increased automatically.
304 fSignals=new TArrayF(j);
308 Int_t size=fSignals->GetSize();
315 Float_t sum=(fSignals->At(j-1))+sig;
316 fSignals->AddAt(sum,j-1);
318 ///////////////////////////////////////////////////////////////////////////
319 Float_t AliSignal::GetSignal(Int_t j,Int_t mode)
321 // Provide value of the j-th (default j=1) signal slot.
322 // Note : The first signal slot is at j=1.
323 // In case no signal is present or the argument j is invalid, 0 is returned.
324 // The parameter "mode" allows for automatic gain etc... correction of the signal.
326 // mode = 0 : Just the j-th signal is returned.
327 // 1 : The j-th signal is corrected for the gain, offset, dead flag etc...
328 // In case the gain value was not set, gain=1 will be assumed.
329 // In case the gain value was 0, a signal value of 0 is returned.
330 // In case the offset value was not set, offset=0 will be assumed.
331 // In case the j-th slot was marked dead, 0 is returned.
333 // The corrected signal (sigc) is determined as follows :
335 // sigc=(signal/gain)-offset
337 // The default is mode=0.
344 if (j>0 && j<=(fSignals->GetSize()))
346 sig=fSignals->At(j-1);
348 if (mode==0) return sig;
350 // Correct the signal for the gain, offset, dead flag etc...
351 if (GetDeadValue(j)) return 0;
353 if (GetGainFlag(j)) gain=GetGain(j);
354 if (GetOffsetFlag(j)) offset=GetOffset(j);
358 sig=(sig/gain)-offset;
367 cout << " *AliSignal::GetSignal* Index j = " << j << " invalid." << endl;
372 ///////////////////////////////////////////////////////////////////////////
373 void AliSignal::SetSignalError(Double_t dsig,Int_t j)
375 // Store error for the j-th (default j=1) signal slot.
376 // Note : The first signal slot is at j=1.
377 // In case the value of the index j exceeds the maximum number of reserved
378 // slots for signal error values, the number of reserved slots for the
379 // signal errors is increased automatically.
383 fDsignals=new TArrayF(j);
387 Int_t size=fDsignals->GetSize();
394 fDsignals->AddAt(float(dsig),j-1);
396 ///////////////////////////////////////////////////////////////////////////
397 Float_t AliSignal::GetSignalError(Int_t j)
399 // Provide error of the j-th (default j=1) signal slot.
400 // Note : The first signal slot is at j=1.
401 // In case no signal is present or the argument j is invalid, 0 is returned.
405 if (j>0 && j<=(fDsignals->GetSize()))
407 err=fDsignals->At(j-1);
411 cout << " *AliSignal::GetSignalError* Index j = " << j << " invalid." << endl;
416 ///////////////////////////////////////////////////////////////////////////
417 void AliSignal::Data(TString f)
419 // Provide all signal information within the coordinate frame f.
421 cout << " *" << ClassName() << "::Data* Signal of kind : " << GetName() << endl;
427 ///////////////////////////////////////////////////////////////////////////
428 void AliSignal::List(Int_t j)
430 // Provide signal information for the j-th slot.
431 // The first slot is at j=1.
432 // In case j=0 (default) the data of all slots will be listed.
433 // In case j=-1 the data of all slots will be listed, but the header
434 // information will be suppressed.
438 cout << " *AliSignal::List* Invalid argument j = " << j << endl;
442 if (j != -1) cout << " *" << ClassName() << "::List* Signal of kind : " << GetName() << endl;
444 Int_t nvalues=GetNvalues();
445 Int_t nerrors=GetNerrors();
447 if (nerrors>n) n=nerrors;
451 for (Int_t i=1; i<=n; i++)
454 if (i<=nvalues) cout << " value : " << GetSignal(i);
455 if (i<=nerrors) cout << " error : " << GetSignalError(i);
465 if (j<=nvalues) cout << " value : " << GetSignal(j);
466 if (j<=nerrors) cout << " error : " << GetSignalError(j);
472 ///////////////////////////////////////////////////////////////////////////
473 Int_t AliSignal::GetNvalues()
475 // Provide the number of values for this signal.
477 if (fSignals) n=fSignals->GetSize();
480 ///////////////////////////////////////////////////////////////////////////
481 Int_t AliSignal::GetNerrors()
483 // Provide the number specified errors on the values for this signal.
485 if (fDsignals) n=fDsignals->GetSize();
488 ///////////////////////////////////////////////////////////////////////////
489 Int_t AliSignal::GetNwaveforms()
491 // Provide the number specified waveforms for this signal.
493 if (fWaveforms) n=fWaveforms->GetSize();
496 ///////////////////////////////////////////////////////////////////////////
497 TH1F* AliSignal::GetWaveform(Int_t j)
499 // Provide pointer to the j-th waveform histogram.
501 if (j <= GetNwaveforms()) waveform=(TH1F*)fWaveforms->At(j-1);
504 ///////////////////////////////////////////////////////////////////////////
505 void AliSignal::SetWaveform(TH1F* waveform,Int_t j)
507 // Set the 1D waveform histogram corresponding to the j-th signal value.
510 // The waveform of the first signal value is at j=1.
511 // j=1 is the default value.
513 // In case the value of the index j exceeds the maximum number of reserved
514 // slots for the waveforms, the number of reserved slots for the waveforms
515 // is increased automatically.
517 // In case the histo pointer argument has the same value as the current waveform
518 // histogram pointer value, no action is taken since the user has already
519 // modified the actual histogram.
521 // In case the histo pointer argument is zero, the current waveform histogram
522 // is deleted and the pointer set to zero.
524 // In all other cases the current waveform histogram is deleted and a new
525 // copy of the input histogram is created which becomes the current waveform
530 fWaveforms=new TObjArray(j);
531 fWaveforms->SetOwner();
534 if (j > fWaveforms->GetSize()) fWaveforms->Expand(j);
536 TH1F* hcur=(TH1F*)fWaveforms->At(j-1);
537 if (waveform != hcur)
541 fWaveforms->Remove(hcur);
547 hcur=new TH1F(*waveform);
548 fWaveforms->AddAt(hcur,j-1);
552 ///////////////////////////////////////////////////////////////////////////
553 void AliSignal::ResetWaveform(Int_t j)
555 // Reset the waveform of the j-th (default j=1) signal value.
556 // This memberfunction invokes TH1F::Reset() for the corresponding waveform(s).
557 // To actually delete the histograms from memory, use DeleteWaveform().
558 // Notes : The first signal value is at j=1.
559 // j=0 ==> All waveforms will be reset.
561 if (!fWaveforms) return;
563 Int_t size=fWaveforms->GetSize();
565 if ((j>=0) && (j<=size))
569 TH1F* hwave=(TH1F*)fWaveforms->At(j-1);
570 if (hwave) hwave->Reset();
574 for (Int_t i=0; i<size; i++)
576 TH1F* hwave=(TH1F*)fWaveforms->At(i);
577 if (hwave) hwave->Reset();
583 cout << " *AliSignal::ResetWaveform* Index j = " << j << " invalid." << endl;
587 ///////////////////////////////////////////////////////////////////////////
588 void AliSignal::DeleteWaveform(Int_t j)
590 // Delete the waveform of the j-th (default j=1) signal value.
591 // Notes : The first signal value is at j=1.
592 // j=0 ==> All waveforms will be deleted.
594 if (!fWaveforms) return;
596 Int_t size=fWaveforms->GetSize();
598 if ((j>=0) && (j<=size))
602 TH1F* hwave=(TH1F*)fWaveforms->At(j-1);
605 fWaveforms->Remove(hwave);
617 cout << " *AliSignal::DeleteWaveform* Index j = " << j << " invalid." << endl;
621 ///////////////////////////////////////////////////////////////////////////
622 TObject* AliSignal::Clone(char* name)
624 // Make a deep copy of the current object and provide the pointer to the copy.
625 // This memberfunction enables automatic creation of new objects of the
626 // correct type depending on the object type, a feature which may be very useful
627 // for containers when adding objects in case the container owns the objects.
628 // This feature allows e.g. AliTrack to store either AliSignal objects or
629 // objects derived from AliSignal via the AddSignal memberfunction, provided
630 // these derived classes also have a proper Clone memberfunction.
632 AliSignal* sig=new AliSignal(*this);
635 if (strlen(name)) sig->SetName(name);
639 ///////////////////////////////////////////////////////////////////////////