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.
22 // The user can decide to store either calibrated or uncalibrated signals.
23 // Via the specification of a gain and offset or/and an explicit
24 // (de)calibration function both calibrated and uncalibrated signals
25 // can always be obtained. For details see the documentation of the
26 // memberfunction GetSignal() and the class AliAttrib.
27 // The explicit specification of a (de)calibration function offers the
28 // maximum flexibility and also allows automatic indication whether
29 // calibrated or uncalibrated data has been stored.
30 // The latter can be achieved by only specifying a calibration function
31 // (and no de-calibration function) in case uncalibrated data is stored,
32 // whereas in case of stored calibrated data the user should only
33 // provide a de-calibration function (and no calibration function).
37 // Signal positions (r) and reference frames (f) are specified via
38 // SetPosition(r,f) under the following conventions :
40 // f="car" ==> r is Cartesian (x,y,z)
41 // f="sph" ==> r is Spherical (r,theta,phi)
42 // f="cyl" ==> r is Cylindrical (rho,phi,z)
44 // The same holds for SetPositionErrors().
46 // All angles are in radians.
52 // s.SetName("Start counter");
53 // Float_t pos[3]={-1,25,7};
54 // Float_t err[3]={0.03,0.7,0.18};
55 // Float_t signal=120.8;
56 // Float_t error=1.73;
57 // Float_t offset=-12.78;
59 // s.SetPosition(pos,"car");
60 // s.SetPositionErrors(err,"car");
61 // s.SetSignal(signal);
62 // s.SetSignalError(error);
63 // s.SetOffset(offset);
65 // Float_t loc[3],dr[3],sigma;
66 // s.GetPosition(loc,"sph");
67 // s.GetPositionErrors(dr,"sph");
68 // Float_t adc=s.GetSignal();
69 // Float_t sigma=s.GetSignalError();
71 // AliSignal q; // In the example below a signal contains the
72 // // following data : timing, ADC and dE/dx
73 // q.SetNameTitle("Hybrid","Test for multiple signal data");
74 // q.SetPosition(pos,"car");
75 // q.SetPositionErrors(err,"car");
76 // signal=82.5; // e.g. signal time in ns
79 // q.SetSlotName("TOF",1);
80 // q.SetSignal(signal,1);
81 // q.SetSignalError(error,1);
82 // q.SetOffset(offset,1);
83 // signal=268.1; // e.g. ADC value of signal
87 // // Addressing via name specification instead of index
88 // q.SetSlotName("ADC",2);
89 // q.SetSignal(signal,"ADC");
90 // q.SetSignalError(error,"ADC");
91 // q.SetGain(gain,"ADC");
92 // q.SetOffset(offset,"ADC");
93 // signal=23.7; // e.g. corresponding dE/dx value
95 // TF1 f=("calib","[0]*pow(x,2)+[1]"); // dE/dx calib. function
96 // f.SetParameter(0,3.285);
97 // f.SetParameter(1,-18.67);
98 // q.SetSlotName("dE/dx",3);
99 // q.SetCalFunction(&f,"dE/dx");
100 // q.SetSignal(signal,"dE/dx");
101 // q.SetSignalError(error,"dE/dx");
103 // // Signal retrieval with various (de)calibration modes
104 // Float_t tof=q.GetSignal("TOF");
105 // Float_t adc=q.GetSignal("ADC",1);
106 // Float_t dedx=q.GetSignal("dE/dx",3);
108 //--- Author: Nick van Eijndhoven 23-jan-1999 UU-SAP Utrecht
109 //- Modified: NvE $Date$ UU-SAP Utrecht
110 ///////////////////////////////////////////////////////////////////////////
112 #include "AliSignal.h"
113 #include "AliTrack.h"
114 #include "Riostream.h"
116 ClassImp(AliSignal) // Class implementation to enable ROOT I/O
118 AliSignal::AliSignal() : TNamed(),AliPosition(),AliAttrib()
120 // Creation of an AliSignal object and initialisation of parameters.
121 // Several signal values (with errors) can be stored in different slots.
122 // If needed, the storage for values (and errors) will be expanded automatically
123 // when entering values and/or errors.
130 ///////////////////////////////////////////////////////////////////////////
131 AliSignal::~AliSignal()
133 // Destructor to delete dynamically allocated memory
151 // Remove this signal from all related tracks
152 for (Int_t i=1; i<=fLinks->GetNobjects(); i++)
154 TObject* obj=fLinks->GetObject(i);
156 if (obj->InheritsFrom("AliTrack"))
158 AliTrack* tx=(AliTrack*)obj;
159 tx->RemoveSignal(*this);
166 ///////////////////////////////////////////////////////////////////////////
167 AliSignal::AliSignal(const AliSignal& s) : TNamed(s),AliPosition(s),AliAttrib(s)
175 // Don't copy the owning device pointer for the copy
178 Int_t n=s.GetNvalues();
180 for (Int_t i=1; i<=n; i++)
187 for (Int_t j=1; j<=n; j++)
189 val=s.GetSignalError(j);
190 SetSignalError(val,j);
194 for (Int_t k=1; k<=n; k++)
196 TH1F* hist=s.GetWaveform(k);
197 if (hist) SetWaveform(hist,k);
203 n=s.GetIndices(dum,slotarr,posarr);
205 for (Int_t idx=0; idx<n; idx++)
207 slot=slotarr.At(idx);
209 TObject* obj=s.GetLink(slot,pos);
210 if (obj) SetLink(obj,slot,pos);
213 ///////////////////////////////////////////////////////////////////////////
214 void AliSignal::Reset(Int_t mode)
216 // Reset all signal and position values and errors to 0.
218 // mode = 0 Reset position and all signal values and their errors to 0.
219 // The waveform histograms are reset, but the calibration
220 // constants (i.e. gains and offsets) are kept.
221 // 1 Reset position and delete the signal and error storage arrays.
222 // Also the waveform histograms, gains and offset arrays are deleted.
224 // The default when invoking Reset() corresponds to mode=0.
226 // Note : In all cases the storage of the various links will be reset.
227 // The UniqueID, name and title will NOT be reset.
228 // In case the user wants to reset these attributes, this has to
229 // be done explicitly via the SET facilities.
231 // The usage of mode=0 allows to re-use the allocated memory for new
232 // signal (and error) values. This behaviour is preferable (i.e. faster)
233 // in case the various signals always contain the same number of values
234 // and have the same calibration constants.
235 // The usage of mode=1 is slower, but allows a more efficient memory
236 // occupation (and smaller output file size) in case the different
237 // signals have a variable number of values.
239 // For more specific actions see ResetPosition(), ResetSignals(),
240 // DeleteSignals(), ResetGain(), ResetOffset(), ResetLink(), ResetWaveform(),
241 // DeleteWaveform() and DeleteCalibrations().
244 if (mode<0 || mode>1)
246 cout << " *AliSignal::Reset* Invalid argument mode = " << mode << endl;
247 cout << " Default mode=0 will be used." << endl;
259 DeleteCalibrations();
262 if (fLinks) fLinks->Reset();
265 ///////////////////////////////////////////////////////////////////////////
266 void AliSignal::ResetSignals(Int_t mode)
268 // Reset various signal data according to user selection.
270 // mode = 0 Reset all signal values and their errors to 0.
271 // 1 Reset only signal values
272 // 2 Reset only signal errors
274 // The default when invoking ResetSignals() corresponds to mode=0.
276 // Irrespective of the mode, the waveform histograms are reset.
278 if (mode<0 || mode>2)
280 cout << " *AliSignal::ResetSignals* Invalid argument mode = " << mode << endl;
281 cout << " Default mode=0 will be used." << endl;
285 if (fSignals && (mode==0 || mode==1))
287 for (Int_t i=0; i<fSignals->GetSize(); i++)
289 fSignals->AddAt(0,i);
293 if (fDsignals && (mode==0 || mode==2))
295 for (Int_t j=0; j<fDsignals->GetSize(); j++)
297 fDsignals->AddAt(0,j);
303 ///////////////////////////////////////////////////////////////////////////
304 void AliSignal::DeleteSignals(Int_t mode)
306 // Delete storage arrays of various signal data according to user selection.
308 // mode = 0 Delete arrays of both signal values and their errors.
309 // 1 Delete only signal values array
310 // 2 Delete only signal errors array
312 // The default when invoking DeleteSignals() corresponds to mode=0.
314 // Irrespective of the mode, the waveform histograms are deleted.
316 if (mode<0 || mode>2)
318 cout << " *AliSignal::DeleteSignals* Invalid argument mode = " << mode << endl;
319 cout << " Default mode=0 will be used." << endl;
323 if (fSignals && (mode==0 || mode==1))
329 if (fDsignals && (mode==0 || mode==2))
337 ///////////////////////////////////////////////////////////////////////////
338 void AliSignal::SetSignal(Double_t sig,Int_t j)
340 // Store signal value for the j-th (default j=1) slot.
341 // Note : The first signal slot is at j=1.
342 // In case the value of the index j exceeds the maximum number of reserved
343 // slots for signal values, the number of reserved slots for the
344 // signal values is increased automatically.
348 fSignals=new TArrayF(j);
352 Int_t size=fSignals->GetSize();
359 fSignals->AddAt(float(sig),j-1);
361 ///////////////////////////////////////////////////////////////////////////
362 void AliSignal::SetSignal(Double_t sig,TString name)
364 // Store signal value for the name-specified slot.
366 // This procedure involves a slot-index search based on the specified name
367 // at each invokation. This may become slow in case many slots have been
368 // defined and/or when this procedure is invoked many times.
369 // In such cases it is preferable to use indexed addressing in the user code
370 // either directly or via a few invokations of GetSlotIndex().
372 Int_t j=GetSlotIndex(name);
373 if (j>0) SetSignal(sig,j);
375 ///////////////////////////////////////////////////////////////////////////
376 void AliSignal::AddSignal(Double_t sig,Int_t j)
378 // Add value to the signal of the j-th (default j=1) slot.
379 // Note : The first signal slot is at j=1.
380 // In case the value of the index j exceeds the maximum number of reserved
381 // slots for signal values, the number of reserved slots for the
382 // signal values is increased automatically.
386 fSignals=new TArrayF(j);
390 Int_t size=fSignals->GetSize();
397 Float_t sum=(fSignals->At(j-1))+sig;
398 fSignals->AddAt(sum,j-1);
400 ///////////////////////////////////////////////////////////////////////////
401 void AliSignal::AddSignal(Double_t sig,TString name)
403 // Add value to the signal of the name-specified slot.
405 // This procedure involves a slot-index search based on the specified name
406 // at each invokation. This may become slow in case many slots have been
407 // defined and/or when this procedure is invoked many times.
408 // In such cases it is preferable to use indexed addressing in the user code
409 // either directly or via a few invokations of GetSlotIndex().
411 Int_t j=GetSlotIndex(name);
412 if (j>0) AddSignal(sig,j);
414 ///////////////////////////////////////////////////////////////////////////
415 Float_t AliSignal::GetSignal(Int_t j,Int_t mode) const
417 // Provide signal value of the j-th (default j=1) slot.
418 // Note : The first signal slot is at j=1.
419 // In case no signal is present or the input argument "j" or "mode" is invalid,
420 // the value 0 is returned.
421 // The parameter "mode" allows for automatic (de)calibration of the signal
422 // (e.g. gain etc... correction or via explicit (de)calibration functions).
424 // mode = 0 : Just the j-th signal is returned.
425 // 1 : The j-th signal is corrected for the gain, offset, dead flag etc...
426 // In case the j-th slot was marked dead, 0 is returned.
427 // In case the gain value was not set, gain=1 will be assumed.
428 // In case the gain value was 0, a signal value of 0 is returned.
429 // In case the offset value was not set, offset=0 will be assumed.
430 // 2 : Same as mode=1 but gain, offset dead flag etc... are taken from
431 // the AliDevice which owns this AliSignal object.
432 // The corresponding AliDevice slot is obtained via matching of
433 // the slotnames. In case this fails, the slotindex "j" of the
434 // input argument will be used.
435 // In case this AliSignal object has no parent AliDevice, just
436 // the j-th signal is returned (like with mode=0).
437 // 3 : The j-th signal is corrected using the corresponding calibration
439 // In case the j-th slot was marked dead, 0 is returned.
440 // In case no calibration function is present, just the j-th signal
441 // is returned (like with mode=0).
442 // 4 : Same as mode=3 but the calibration function is taken from
443 // the AliDevice which owns this AliSignal object.
444 // The corresponding AliDevice slot is obtained via matching of
445 // the slotnames. In case this fails, the slotindex "j" of the
446 // input argument will be used.
447 // 5 : Same as mode=2 but in case no parent AliDevice is present
448 // an automatic switch to mode=1 will be made.
449 // 6 : Same as mode=4 but in case no parent AliDevice is present
450 // an automatic switch to mode=3 will be made.
451 // 7 : Same as mode=3 but in case no calibration function is present
452 // an automatic switch to mode=4 will be made.
454 // <0 : The corresponding de-correction or de-calibration is performed
456 // The corrected signal (sigc) is determined as follows :
458 // sigc=(signal/gain)-offset
460 // The de-corrected signal is determined as follows :
462 // signal=(sigc+offset)*gain
464 // The default is mode=0.
466 if (abs(mode)>7) return 0;
473 AliSignal* sx=(AliSignal*)this;
478 f=sx->GetCalFunction(jcal);
490 f=sx->GetDecalFunction(jcal);
501 if (abs(mode)==2 || abs(mode)>=4)
503 sx=(AliSignal*)GetDevice();
506 TString name=GetSlotName(j);
507 if (strlen(name.Data())) jcal=sx->GetSlotIndex(name);
511 if (!sx && abs(mode)>=5) sx=(AliSignal*)this;
513 if (mode==-5) mode=-2;
515 if (mode==-6) mode=-3;
519 if (j>0 && j<=(fSignals->GetSize()))
521 sig=fSignals->At(j-1);
523 if (mode==0 || !sx) return sig;
525 // Check for the dead flag setting
526 if (sx->GetDeadValue(jcal)) return 0;
528 // (De)correct the signal for the gain and offset
529 if (abs(mode)==1 || abs(mode)==2)
531 if (sx->GetGainFlag(jcal)) gain=sx->GetGain(jcal);
532 if (sx->GetOffsetFlag(jcal)) offset=sx->GetOffset(jcal);
536 if (mode>0) sig=(sig/gain)-offset; // Gain and offset correction
537 if (mode<0) sig=(sig+offset)*gain; // Gain and offset de-correction
546 // (De)calibrate the signal with the corresponding (de)calibration function
547 if (abs(mode)==3 || abs(mode)==4)
549 f=sx->GetCalFunction(jcal);
550 if (mode<0) f=sx->GetDecalFunction(jcal);
551 if (f) sig=f->Eval(sig);
557 cout << " *AliSignal::GetSignal* Index j = " << j << " invalid." << endl;
562 ///////////////////////////////////////////////////////////////////////////
563 Float_t AliSignal::GetSignal(TString name,Int_t mode) const
565 // Provide signal value of the name-specified slot.
566 // In case no signal is present, 0 is returned.
567 // The parameter "mode" allows for automatic (de)calibration of the signal
568 // (e.g. gain etc... correction or via explicit (de)calibration functions).
569 // For further details about the (de)calibration modes, please refer to the
570 // corresponding slot-index based memberfunction.
572 // The default is mode=0.
574 // This procedure involves a slot-index search based on the specified name
575 // at each invokation. This may become slow in case many slots have been
576 // defined and/or when this procedure is invoked many times.
577 // In such cases it is preferable to use indexed addressing in the user code
578 // either directly or via a few invokations of GetSlotIndex().
580 Int_t j=GetSlotIndex(name);
582 if (j>0) val=GetSignal(j,mode);
585 ///////////////////////////////////////////////////////////////////////////
586 void AliSignal::SetSignalError(Double_t dsig,Int_t j)
588 // Store error on the signal for the j-th (default j=1) slot.
589 // Note : The first signal slot is at j=1.
590 // In case the value of the index j exceeds the maximum number of reserved
591 // slots for signal error values, the number of reserved slots for the
592 // signal errors is increased automatically.
596 fDsignals=new TArrayF(j);
600 Int_t size=fDsignals->GetSize();
607 fDsignals->AddAt(float(dsig),j-1);
609 ///////////////////////////////////////////////////////////////////////////
610 void AliSignal::SetSignalError(Double_t dsig,TString name)
612 // Store error on the signal for the name-specified slot.
614 // This procedure involves a slot-index search based on the specified name
615 // at each invokation. This may become slow in case many slots have been
616 // defined and/or when this procedure is invoked many times.
617 // In such cases it is preferable to use indexed addressing in the user code
618 // either directly or via a few invokations of GetSlotIndex().
620 Int_t j=GetSlotIndex(name);
621 if (j>0) SetSignalError(dsig,j);
623 ///////////////////////////////////////////////////////////////////////////
624 Float_t AliSignal::GetSignalError(Int_t j) const
626 // Provide error on the signal of the j-th (default j=1) slot.
627 // Note : The first signal slot is at j=1.
628 // In case no signal is present or the argument j is invalid, 0 is returned.
632 if (j>0 && j<=(fDsignals->GetSize()))
634 err=fDsignals->At(j-1);
638 cout << " *AliSignal::GetSignalError* Index j = " << j << " invalid." << endl;
643 ///////////////////////////////////////////////////////////////////////////
644 Float_t AliSignal::GetSignalError(TString name) const
646 // Provide error on the signal of the name-specified slot.
648 // This procedure involves a slot-index search based on the specified name
649 // at each invokation. This may become slow in case many slots have been
650 // defined and/or when this procedure is invoked many times.
651 // In such cases it is preferable to use indexed addressing in the user code
652 // either directly or via a few invokations of GetSlotIndex().
654 Int_t j=GetSlotIndex(name);
656 if (j>0) val=GetSignalError(j);
659 ///////////////////////////////////////////////////////////////////////////
660 void AliSignal::Data(TString f) const
662 // Provide all signal information within the coordinate frame f.
664 const char* name=GetName();
665 const char* title=GetTitle();
667 cout << " *" << ClassName() << "::Data* Id : " << GetUniqueID();
668 if (strlen(name)) cout << " Name : " << name;
669 if (strlen(title)) cout << " Title : " << title;
672 AliPosition::Data(f);
675 const char* devname=fDevice->GetName();
676 const char* devtitle=fDevice->GetTitle();
677 cout << " Owned by device : " << fDevice->ClassName()
678 << " Id : " << fDevice->GetUniqueID();
679 if (strlen(devname)) cout << " Name : " << devname;
680 if (strlen(devtitle)) cout << " Title : " << devtitle;
684 // Provide an overview of the stored waveforms
687 // Provide an overview of all the data and attribute slots
690 ///////////////////////////////////////////////////////////////////////////
691 void AliSignal::List(Int_t j) const
693 // Provide signal information for the j-th slot.
694 // The first slot is at j=1.
695 // In case j=0 (default) the data of all slots will be listed.
696 // In case j=-1 the data of all slots will be listed, but the header
697 // information will be suppressed.
701 cout << " *AliSignal::List* Invalid argument j = " << j << endl;
707 const char* name=GetName();
708 const char* title=GetTitle();
710 cout << " *" << ClassName() << "::Data* Id :" << GetUniqueID();
711 if (strlen(name)) cout << " Name : " << name;
712 if (strlen(title)) cout << " Title : " << title;
716 const char* devname=fDevice->GetName();
717 const char* devtitle=fDevice->GetTitle();
718 cout << " Owned by device : " << fDevice->ClassName();
719 if (strlen(devname)) cout << " Name : " << devname;
720 if (strlen(devtitle)) cout << " Title : " << devtitle;
725 Int_t nvalues=GetNvalues();
726 Int_t nerrors=GetNerrors();
728 if (fLinks) nlinkslots=fLinks->GetMaxColumn();
729 Int_t ncalibs=GetNcalflags();
730 Int_t ncalfuncs=GetNcalfuncs();
731 Int_t ndecalfuncs=GetNdecalfuncs();
734 if (nerrors>n) n=nerrors;
735 if (nlinkslots>n) n=nlinkslots;
736 if (InheritsFrom("AliDevice"))
738 if (ncalibs>n) n=ncalibs;
739 if (ncalfuncs>n) n=ncalfuncs;
740 if (ndecalfuncs>n) n=ndecalfuncs;
750 for (Int_t i=1; i<=n; i++)
752 cout << " Slot : " << i;
753 if (i<=nvalues) cout << " Signal value : " << GetSignal(i);
754 if (i<=nerrors) cout << " error : " << GetSignalError(i);
758 nrefs=GetIndices(obj,i,posarr);
759 for (Int_t k=0; k<nrefs; k++)
765 cout << " Link at position " << pos << " to : " << obj->ClassName();
766 if (obj->InheritsFrom("TNamed"))
768 const char* lname=obj->GetName();
769 const char* ltitle=obj->GetTitle();
770 if (strlen(lname)) cout << " Name : " << lname;
771 if (strlen(ltitle)) cout << " Title : " << ltitle;
782 cout << " Slot : " << j;
783 if (j<=nvalues) cout << " Signal value : " << GetSignal(j);
784 if (j<=nerrors) cout << " error : " << GetSignalError(j);
788 nrefs=GetIndices(obj,j,posarr);
789 for (Int_t kj=0; kj<nrefs; kj++)
795 cout << " Link at position " << pos << " to : " << obj->ClassName();
796 if (obj->InheritsFrom("TNamed"))
798 const char* lnamej=obj->GetName();
799 const char* ltitlej=obj->GetTitle();
800 if (strlen(lnamej)) cout << " Name : " << lnamej;
801 if (strlen(ltitlej)) cout << " Title : " << ltitlej;
809 ///////////////////////////////////////////////////////////////////////////
810 void AliSignal::List(TString name) const
812 // Provide signal information for the name-specified slot.
814 // This procedure involves a slot-index search based on the specified name
815 // at each invokation. This may become slow in case many slots have been
816 // defined and/or when this procedure is invoked many times.
817 // In such cases it is preferable to use indexed addressing in the user code
818 // either directly or via a few invokations of GetSlotIndex().
820 Int_t j=GetSlotIndex(name);
823 ///////////////////////////////////////////////////////////////////////////
824 void AliSignal::ListWaveform(Int_t j) const
826 // Provide information for the j-th waveform.
827 // The first waveform is at j=1.
828 // In case j=0 (default) the info of all waveforms will be listed.
829 // In case j=-1 the info of all waveforms will be listed, but the header
830 // information will be suppressed.
834 cout << " *AliSignal::ListWaveform* Invalid argument j = " << j << endl;
840 const char* name=GetName();
841 const char* title=GetTitle();
843 cout << " *" << ClassName() << "::Data* Id :" << GetUniqueID();
844 if (strlen(name)) cout << " Name : " << name;
845 if (strlen(title)) cout << " Title : " << title;
849 const char* devname=fDevice->GetName();
850 const char* devtitle=fDevice->GetTitle();
851 cout << " Owned by device : " << fDevice->ClassName();
852 if (strlen(devname)) cout << " Name : " << devname;
853 if (strlen(devtitle)) cout << " Title : " << devtitle;
858 Int_t n=GetNwaveforms();
863 for (Int_t i=1; i<=n; i++)
868 const char* wfname=obj->GetName();
869 const char* wftitle=obj->GetTitle();
870 cout << " Waveform " << i << " : " << obj->ClassName();
871 if (strlen(wfname)) cout << " Name : " << wfname;
872 if (strlen(wftitle)) cout << " Title : " << wftitle;
884 const char* wfnamej=obj->GetName();
885 const char* wftitlej=obj->GetTitle();
886 cout << " Waveform " << j << " : " << obj->ClassName();
887 if (strlen(wfnamej)) cout << " Name : " << wfnamej;
888 if (strlen(wftitlej)) cout << " Title : " << wftitlej;
894 ///////////////////////////////////////////////////////////////////////////
895 Int_t AliSignal::GetNvalues() const
897 // Provide the number of values for this signal.
899 if (fSignals) n=fSignals->GetSize();
902 ///////////////////////////////////////////////////////////////////////////
903 Int_t AliSignal::GetNerrors() const
905 // Provide the number specified errors on the values for this signal.
907 if (fDsignals) n=fDsignals->GetSize();
910 ///////////////////////////////////////////////////////////////////////////
911 Int_t AliSignal::GetNwaveforms() const
913 // Provide the number of specified waveforms for this signal.
914 // Actually the return value is the highest index of the stored waveforms.
915 // This allows an index dependent meaning of waveform info (e.g. waveforms
916 // with various gain values).
917 // So, when all waveforms are stored in consequetive positions (e.g. 1,2,3),
918 // this memberfunction returns 3, being both the highest filled position
919 // and the actual number of waveforms.
920 // In case only waveforms are stored at positions 1,2,5,7 this memberfunction
921 // returns a value 7 whereas only 4 actual waveforms are present.
922 // This implies that when looping over the various waveform slots, one
923 // always has to check whether the returned pointer value is non-zero
924 // (which is a good practice anyhow).
926 if (fWaveforms) n=fWaveforms->GetLast();
929 ///////////////////////////////////////////////////////////////////////////
930 TH1F* AliSignal::GetWaveform(Int_t j) const
932 // Provide pointer to the j-th waveform histogram.
934 if (j <= GetNwaveforms()) waveform=(TH1F*)fWaveforms->At(j-1);
937 ///////////////////////////////////////////////////////////////////////////
938 TH1F* AliSignal::GetWaveform(TString name) const
940 // Provide pointer to the waveform histogram with the specified name.
941 // In case no match is found, zero is returned.
942 Int_t n=GetNwaveforms();
944 for (Int_t i=1; i<=n; i++)
946 TH1F* waveform=GetWaveform(i);
949 str=waveform->GetName();
950 if (str == name) return waveform;
953 return 0; // No match found
955 ///////////////////////////////////////////////////////////////////////////
956 Int_t AliSignal::GetWaveformIndex(TString name) const
958 // Provide index to the waveform histogram with the specified name.
959 // In case no match is found, zero is returned.
960 Int_t n=GetNwaveforms();
962 for (Int_t i=1; i<=n; i++)
964 TH1F* waveform=GetWaveform(i);
967 str=waveform->GetName();
968 if (str == name) return i;
971 return 0; // No match found
973 ///////////////////////////////////////////////////////////////////////////
974 void AliSignal::SetWaveform(TH1F* waveform,Int_t j)
976 // Set the 1D waveform histogram for the j-th waveform.
979 // The first waveform position at j=1.
980 // j=1 is the default value.
982 // In case the value of the index j exceeds the maximum number of reserved
983 // positions for the waveforms, the number of reserved positions for the waveforms
984 // is increased automatically.
986 // In case the histo pointer argument has the same value as the current waveform
987 // histogram pointer value, no action is taken since the user has already
988 // modified the actual histogram.
990 // In case the histo pointer argument is zero, the current waveform histogram
991 // is deleted and the pointer set to zero.
993 // In all other cases the current waveform histogram is deleted and a new
994 // copy of the input histogram is created which becomes the current waveform
1001 fWaveforms=new TObjArray(j);
1002 fWaveforms->SetOwner();
1005 if (j > fWaveforms->GetSize()) fWaveforms->Expand(j);
1007 TH1F* hcur=(TH1F*)fWaveforms->At(j-1);
1008 if (waveform != hcur)
1012 fWaveforms->Remove(hcur);
1018 hcur=new TH1F(*waveform);
1019 fWaveforms->AddAt(hcur,j-1);
1023 ///////////////////////////////////////////////////////////////////////////
1024 void AliSignal::ResetWaveform(Int_t j)
1026 // Reset the histogram of the j-th (default j=1) waveform.
1027 // This memberfunction invokes TH1F::Reset() for the corresponding waveform(s).
1028 // To actually delete the histograms from memory, use DeleteWaveform().
1029 // Notes : The first position is at j=1.
1030 // j=0 ==> All waveforms will be reset.
1032 if (!fWaveforms) return;
1034 Int_t size=fWaveforms->GetSize();
1036 if ((j>=0) && (j<=size))
1040 TH1F* hwave=(TH1F*)fWaveforms->At(j-1);
1041 if (hwave) hwave->Reset();
1045 for (Int_t i=0; i<size; i++)
1047 TH1F* hwave=(TH1F*)fWaveforms->At(i);
1048 if (hwave) hwave->Reset();
1054 cout << " *AliSignal::ResetWaveform* Index j = " << j << " invalid." << endl;
1058 ///////////////////////////////////////////////////////////////////////////
1059 void AliSignal::ResetWaveform(TString name)
1061 // Reset the waveform with the specified name.
1062 Int_t j=GetWaveformIndex(name);
1063 if (j>0) ResetWaveform(j);
1065 ///////////////////////////////////////////////////////////////////////////
1066 void AliSignal::DeleteWaveform(Int_t j)
1068 // Delete the histogram of the j-th (default j=1) waveform.
1069 // Notes : The first position is at j=1.
1070 // j=0 ==> All waveforms will be deleted.
1072 if (!fWaveforms) return;
1074 Int_t size=fWaveforms->GetSize();
1076 if ((j>=0) && (j<=size))
1080 TH1F* hwave=(TH1F*)fWaveforms->At(j-1);
1083 fWaveforms->Remove(hwave);
1095 cout << " *AliSignal::DeleteWaveform* Index j = " << j << " invalid." << endl;
1099 ///////////////////////////////////////////////////////////////////////////
1100 void AliSignal::DeleteWaveform(TString name)
1102 // Delete the waveform with the specified name.
1103 Int_t j=GetWaveformIndex(name);
1104 if (j>0) DeleteWaveform(j);
1106 ///////////////////////////////////////////////////////////////////////////
1107 Int_t AliSignal::GetNlinks(TObject* obj,Int_t j) const
1109 // Provide the number of links to the specified object for the j-th slot.
1110 // If j=0 (default) all slots will be scanned for the specified object.
1111 // If obj=0 (default) all encountered objects for the specified slot will be counted.
1112 // So, invokation of the default GetNlinks() will return the total number of
1113 // all references to all sorts of stored objects.
1116 cout << " *AliSignal::GetNlinks* Index j = " << j << " invalid." << endl;
1123 if (fLinks) n=fLinks->GetNrefs(obj);
1128 n=GetIndices(obj,j,posarr);
1132 ///////////////////////////////////////////////////////////////////////////
1133 Int_t AliSignal::GetNlinks(TObject* obj,TString name) const
1135 // Provide the number of links to the specified object for the name-spec. slot.
1136 // If obj=0 all encountered objects for the specified slot will be counted.
1138 // This procedure involves a slot-index search based on the specified name
1139 // at each invokation. This may become slow in case many slots have been
1140 // defined and/or when this procedure is invoked many times.
1141 // In such cases it is preferable to use indexed addressing in the user code
1142 // either directly or via a few invokations of GetSlotIndex().
1144 Int_t j=GetSlotIndex(name);
1146 if (j>0) n=GetNlinks(obj,j);
1149 ///////////////////////////////////////////////////////////////////////////
1150 TObject* AliSignal::GetLink(Int_t j,Int_t k) const
1152 // Provide pointer of the object linked to the j-th slot at position k.
1155 // Note : In the internal storage matrix slots=columns positions=rows
1156 if (fLinks) obj=fLinks->GetObject(k,j);
1159 ///////////////////////////////////////////////////////////////////////////
1160 TObject* AliSignal::GetLink(TString name,Int_t k) const
1162 // Provide pointer of the object linked to the name-spec. slot at position k.
1164 // This procedure involves a slot-index search based on the specified name
1165 // at each invokation. This may become slow in case many slots have been
1166 // defined and/or when this procedure is invoked many times.
1167 // In such cases it is preferable to use indexed addressing in the user code
1168 // either directly or via a few invokations of GetSlotIndex().
1170 Int_t j=GetSlotIndex(name);
1172 if (j>0) obj=GetLink(j,k);
1175 ///////////////////////////////////////////////////////////////////////////
1176 void AliSignal::SetLink(TObject* obj,Int_t j,Int_t k)
1178 // Introduce a link (=pointer) to an object for the j-th slot at position k.
1179 // Only the pointer values are stored for (backward) reference, meaning
1180 // that the objects of which the pointers are stored are NOT owned
1181 // by the AliSignal object.
1184 // The first slot is at j=1 and the first position is at k=1.
1185 // j=1 and k=1 are the default values.
1187 // If needed, the storage area for the links is increased automatically.
1189 // In case the pointer argument is zero, indeed a value of zero will be
1190 // stored at the specified position (k) for the specified slot (j).
1192 // In principle any object derived from TObject can be referred to by this
1194 // However, this "linking back" facility was introduced to enable AliSignal slots
1195 // to refer directly to the various AliTracks to which the AliSignal object itself
1196 // is related (see AliTrack::AddSignal).
1197 // Therefore, in case the input argument "obj" points to an AliTrack (or derived)
1198 // object, the current signal is automatically related to this AliTrack
1199 // (or derived) object.
1201 // Please also have a look at the docs of the memberfunction ResetLink()
1202 // to prevent the situation of stored pointers to non-existent object.
1204 if (!fLinks && obj) fLinks=new AliObjMatrix();
1206 if (!fLinks) return;
1208 // Note : In the internal storage matrix slots=columns positions=rows
1209 fLinks->EnterObject(k,j,obj);
1212 if (obj->InheritsFrom("AliTrack"))
1214 AliTrack* t=(AliTrack*)obj;
1215 t->AddSignal(*this);
1219 ///////////////////////////////////////////////////////////////////////////
1220 void AliSignal::SetLink(TObject* obj,TString name,Int_t k)
1222 // Introduce a link (=pointer) to an object for the name-spec. slot at position k.
1223 // Only the pointer values are stored for (backward) reference, meaning
1224 // that the objects of which the pointers are stored are NOT owned
1225 // by the AliSignal object.
1227 // This procedure involves a slot-index search based on the specified name
1228 // at each invokation. This may become slow in case many slots have been
1229 // defined and/or when this procedure is invoked many times.
1230 // In such cases it is preferable to use indexed addressing in the user code
1231 // either directly or via a few invokations of GetSlotIndex().
1233 Int_t j=GetSlotIndex(name);
1234 if (j>0) SetLink(obj,j,k);
1236 ///////////////////////////////////////////////////////////////////////////
1237 void AliSignal::AddLink(TObject* obj,Int_t j)
1239 // Introduce a link (=pointer) to an object for the j-th slot at the first
1241 // Only the pointer values are stored for (backward) reference, meaning
1242 // that the objects of which the pointers are stored are NOT owned
1243 // by the AliSignal object.
1246 // The first slot is at j=1 and the first position is at k=1.
1247 // j=1 is the default value.
1249 // If needed, the storage area for the links is increased automatically.
1251 // In case the pointer argument is zero, no link will be added.
1253 // In principle any object derived from TObject can be referred to by this
1255 // However, this "linking back" facility was introduced to enable AliSignal slots
1256 // to refer directly to the various AliTracks to which the AliSignal object itself
1257 // is related (see AliTrack::AddSignal).
1258 // Therefore, in case the input argument "obj" points to an AliTrack (or derived)
1259 // object, the current signal is automatically related to this AliTrack
1260 // (or derived) object.
1262 // Please also have a look at the docs of the memberfunction ResetLink()
1263 // to prevent the situation of stored pointers to non-existent object.
1265 if (!obj || j<=0) return;
1267 if (!fLinks) fLinks=new AliObjMatrix();
1270 Int_t n=GetNlinks(dum,j);
1272 for (Int_t k=1; k<=n; k++)
1281 ///////////////////////////////////////////////////////////////////////////
1282 void AliSignal::AddLink(TObject* obj,TString name)
1284 // Introduce a link (=pointer) to an object for the name-spec slot at the first
1286 // Only the pointer values are stored for (backward) reference, meaning
1287 // that the objects of which the pointers are stored are NOT owned
1288 // by the AliSignal object.
1290 // This procedure involves a slot-index search based on the specified name
1291 // at each invokation. This may become slow in case many slots have been
1292 // defined and/or when this procedure is invoked many times.
1293 // In such cases it is preferable to use indexed addressing in the user code
1294 // either directly or via a few invokations of GetSlotIndex().
1296 Int_t j=GetSlotIndex(name);
1297 if (j>0) AddLink(obj,j);
1299 ///////////////////////////////////////////////////////////////////////////
1300 void AliSignal::ResetLink(Int_t j,Int_t k)
1302 // Reset the link of the j-th slot at position k.
1305 // The first slot is at j=1 and the first position is at k=1.
1306 // j=1 and k=1 are the default values.
1308 // This memberfunction is intended to reset only 1 specified link location.
1309 // For extended functionality, please refer to the memberfuction ResetLinks().
1311 // In general the user should take care of properly clearing the corresponding
1312 // pointer here when the referred object is deleted.
1313 // However, this "linking back" facility was introduced to enable AliSignal slots
1314 // to refer directly to the various AliTracks to which the AliSignal object itself
1315 // is related (see AliTrack::AddSignal).
1316 // As such, the AliTrack destructor already takes care of clearing the corresponding
1317 // links from the various AliSignal slots for all the AliSignal objects that were
1318 // related to that AliTrack.
1319 // So, in case the link introduced via SetLink() is the pointer of an AliTrack object,
1320 // the user doesn't have to worry about clearing the corresponding AliTrack link from
1321 // the AliSignal object when the corresponding AliTrack object is deleted.
1323 // Note : In the internal storage matrix slots=columns positions=rows
1324 if (fLinks) fLinks->RemoveObject(k,j);
1326 ///////////////////////////////////////////////////////////////////////////
1327 void AliSignal::ResetLink(TString name,Int_t k)
1329 // Reset the link of the name-specified slot at position k.
1331 // This memberfunction is intended to reset only 1 specified link location.
1332 // For extended functionality, please refer to the memberfuction ResetLinks().
1334 // This procedure involves a slot-index search based on the specified name
1335 // at each invokation. This may become slow in case many slots have been
1336 // defined and/or when this procedure is invoked many times.
1337 // In such cases it is preferable to use indexed addressing in the user code
1338 // either directly or via a few invokations of GetSlotIndex().
1340 Int_t j=GetSlotIndex(name);
1341 if (j>0) ResetLink(j,k);
1343 ///////////////////////////////////////////////////////////////////////////
1344 void AliSignal::ResetLinks(TObject* obj,Int_t j,Int_t k)
1346 // Reset single or multiple link(s) according to user specified selections.
1348 // A link is only reset if the stored reference matches the argument "obj".
1349 // In case obj=0 no check on the matching of the stored reference is performed
1350 // and the stored link is always reset in accordance with the other
1351 // selection criteria.
1353 // In case the slot argument "j" is specified, only the links from that
1354 // specified slot will be deleted.
1355 // In case j=0 (default) no checking on the slot index is performed.
1357 // In case the position argument "k" is specified, only the links from that
1358 // specified position will be deleted.
1359 // In case k=0 (default) no checking on the position index is performed.
1361 // So, invokation of ResetLinks(obj) will remove all references to the
1362 // object "obj" from the total AliSignal, whereas ResetLinks(obj,j)
1363 // will remove all references to the object "obj" only from slot "j".
1367 // The first slot is indicated as j=1, whereas the first position is at k=1.
1369 // Invokation of ResetLinks(0,row,col) is equivalent to invoking the
1370 // memberfunction ResetLink(row,col).
1371 // Invoking the latter directly is slightly faster.
1373 // Invokation of ResetLinks(0) will reset all stored references in this AliSignal.
1375 // In general the user should take care of properly clearing the corresponding
1376 // pointer here when the referred object is deleted.
1377 // However, this "linking back" facility was introduced to enable AliSignal slots
1378 // to refer directly to the various AliTracks to which the AliSignal object itself
1379 // is related (see AliTrack::AddSignal).
1380 // As such, the AliTrack destructor already takes care of clearing the corresponding
1381 // links from the various AliSignal slots for all the AliSignal objects that were
1382 // related to that AliTrack.
1383 // So, in case the link introduced via SetLink() is the pointer of an AliTrack object,
1384 // the user doesn't have to worry about clearing the corresponding AliTrack link from
1385 // the AliSignal object when the corresponding AliTrack object is deleted.
1387 if (!fLinks) return;
1389 if (!obj && !j && !k)
1395 // Note : In the internal storage matrix slots=columns positions=rows
1396 fLinks->RemoveObjects(obj,k,j);
1399 ///////////////////////////////////////////////////////////////////////////
1400 void AliSignal::ResetLinks(TObject* obj,TString name,Int_t k)
1402 // Reset single or multiple link(s) according to user specified selections.
1404 // A link is only reset if the stored reference matches the argument "obj".
1405 // In case obj=0 no check on the matching of the stored reference is performed
1406 // and the stored link is always reset in accordance with the other
1407 // selection criteria.
1409 // In case the position argument "k" is specified, only the links from that
1410 // specified position will be deleted.
1411 // In case k=0 (default) no checking on the position index is performed.
1413 // This procedure involves a slot-index search based on the specified name
1414 // at each invokation. This may become slow in case many slots have been
1415 // defined and/or when this procedure is invoked many times.
1416 // In such cases it is preferable to use indexed addressing in the user code
1417 // either directly or via a few invokations of GetSlotIndex().
1419 Int_t j=GetSlotIndex(name);
1420 if (j>0) ResetLinks(obj,j,k);
1422 ///////////////////////////////////////////////////////////////////////////
1423 Int_t AliSignal::GetIndices(TObject* obj,TArrayI& js,TArrayI& ks) const
1425 // Provide the slot and position indices of all the storage locations
1426 // of the specified object.
1427 // The slot (j) and pos. (k) indices are returned in the two separate TArrayI arrays
1428 // from which the (j,k) pairs can be obtained from the corresponding
1429 // array indices like (j,k)=(js.At(i),ks.At(i)).
1430 // The integer return argument represents the number of (j,k) pairs which
1431 // were encountered for the specified object.
1433 // If obj=0 no object selection is performed and all (j,k) indices
1434 // of the stored references for all objects are returned.
1438 // As usual the convention is that slot and position numbering starts at 1.
1440 // This memberfunction always resets the two TArrayI arrays at the start.
1442 // This memberfunction can only be used to obtain the (j,k) indices
1443 // of the object as stored via the SetLink() or AddLink() memberfunction.
1444 // This means that in case the user has entered a TObjArray as object
1445 // (to increase the dimension of the resulting structure), the (j,k)
1446 // indices of that TObjArray are obtained and NOT the indices of the
1447 // actual objects contained in that TObjArray structure.
1452 // Note : In the internal storage matrix slots=columns positions=rows
1453 if (fLinks) nrefs=fLinks->GetIndices(obj,ks,js);
1456 ///////////////////////////////////////////////////////////////////////////
1457 Int_t AliSignal::GetIndices(TObject* obj,Int_t j,TArrayI& ks) const
1459 // Provide the position indices of all the storage locations of the
1460 // specified object in the j-th slot of this AliSignal.
1461 // The position indices are returned in the TArrayI array.
1462 // The integer return argument represents the number of storage locations which
1463 // were encountered for the specified object in the j-th slot.
1465 // If obj=0 no object selection is performed and all position indices
1466 // of the stored references for all objects of the j-th slot are returned.
1468 // If j=0 all slots will be scanned and all position indices matching the
1469 // object selection are returned.
1470 // Note that in this case multiple appearances of the same position index
1471 // will only be recorded once in the returned TArrayI array.
1475 // As usual the convention is that slot and position numbering starts at 1.
1477 // This memberfunction always resets the TArrayI array at the start.
1479 // This memberfunction can only be used to obtain the position indices
1480 // of the object as stored via the SetLink() or AddLink() memberfunction.
1481 // This means that in case the user has entered a TObjArray as object
1482 // (to increase the dimension of the resulting structure), the position
1483 // indices of that TObjArray are obtained and NOT the indices of the
1484 // actual objects contained in that TObjArray structure.
1488 // Note : In the internal storage matrix slots=columns positions=rows
1489 if (fLinks) nrefs=fLinks->GetIndices(obj,ks,j);
1492 ///////////////////////////////////////////////////////////////////////////
1493 Int_t AliSignal::GetIndices(TObject* obj,TString name,TArrayI& ks) const
1495 // Provide the position indices of all the storage locations of the
1496 // specified object in the name-specified slot of this AliSignal.
1497 // The position indices are returned in the TArrayI array.
1498 // The integer return argument represents the number of storage locations which
1499 // were encountered for the specified object in the j-th slot.
1501 // If obj=0 no object selection is performed and all position indices
1502 // of the stored references for all objects of the j-th slot are returned.
1504 // This procedure involves a slot-index search based on the specified name
1505 // at each invokation. This may become slow in case many slots have been
1506 // defined and/or when this procedure is invoked many times.
1507 // In such cases it is preferable to use indexed addressing in the user code
1508 // either directly or via a few invokations of GetSlotIndex().
1510 Int_t j=GetSlotIndex(name);
1512 if (j>0) n=GetIndices(obj,j,ks);
1515 ///////////////////////////////////////////////////////////////////////////
1516 Int_t AliSignal::GetIndices(TObject* obj,TArrayI& js,Int_t k) const
1518 // Provide the slot indices of all the storage locations of the
1519 // specified object for the k-th position in this AliSignal.
1520 // The slot indices are returned in the TArrayI array.
1521 // The integer return argument represents the number of storage locations which
1522 // were encountered for the specified object in the k-th position.
1524 // If obj=0 no object selection is performed and all slot indices
1525 // of the stored references for all objects in the k-th position are returned.
1527 // If k=0 all positions will be scanned and all slot indices matching the
1528 // object selection are returned.
1529 // Note that in this case multiple appearances of the same slot index
1530 // will only be recorded once in the returned TArrayI array.
1534 // As usual the convention is that slot and position numbering starts at 1.
1536 // This memberfunction always resets the TArrayI array at the start.
1538 // This memberfunction can only be used to obtain the slot indices
1539 // of the object as stored via the SetLink() or AddLink() memberfunction.
1540 // This means that in case the user has entered a TObjArray as object
1541 // (to increase the dimension of the resulting structure), the slot
1542 // indices of that TObjArray are obtained and NOT the indices of the
1543 // actual objects contained in that TObjArray structure.
1547 // Note : In the internal storage matrix slots=columns positions=rows
1548 if (fLinks) nrefs=fLinks->GetIndices(obj,k,js);
1551 ///////////////////////////////////////////////////////////////////////////
1552 void AliSignal::SetSwapMode(Int_t swap)
1554 // Set swapmode flag for the internal link storage.
1555 // In case for the stored links the maximum slot number differs considerably
1556 // from the maximum position number, it might be more efficient
1557 // (w.r.t. memory usage and/or output file size) to internally store the
1558 // link reference matrix with the rows and colums swapped.
1559 // This swapping is only related with the internal storage and as such
1560 // is completely hidden for the user.
1561 // At invokation of this memberfunction the default argument is swap=1.
1563 // Note : The swap mode can only be set as long as no links are
1564 // stored in the AliSignal (i.e. a new instance of AliSignal
1565 // or after invokation of the Reset() or ResetLinks() function).
1567 if (!fLinks) fLinks=new AliObjMatrix();
1568 fLinks->SetSwapMode(swap);
1570 ///////////////////////////////////////////////////////////////////////////
1571 Int_t AliSignal::GetSwapMode() const
1573 // Provide swapmode flag of the link storage.
1575 if (fLinks) swap=fLinks->GetSwapMode();
1578 ///////////////////////////////////////////////////////////////////////////
1579 void AliSignal::SetDevice(TObject* dev)
1581 // Store the pointer to the device which owns this AliSignal object.
1582 // This memberfunction is meant for internal use in AliDevice.
1585 ///////////////////////////////////////////////////////////////////////////
1586 AliDevice* AliSignal::GetDevice() const
1588 // Provide the pointer to the device which owns this AliSignal object.
1589 return (AliDevice*)fDevice;
1591 ///////////////////////////////////////////////////////////////////////////
1592 TObject* AliSignal::Clone(const char* name) const
1594 // Make a deep copy of the current object and provide the pointer to the copy.
1595 // This memberfunction enables automatic creation of new objects of the
1596 // correct type depending on the object type, a feature which may be very useful
1597 // for containers when adding objects in case the container owns the objects.
1598 // This feature allows e.g. AliTrack to store either AliSignal objects or
1599 // objects derived from AliSignal via the AddSignal memberfunction, provided
1600 // these derived classes also have a proper Clone memberfunction.
1602 AliSignal* sig=new AliSignal(*this);
1605 if (strlen(name)) sig->SetName(name);
1609 ///////////////////////////////////////////////////////////////////////////