]> git.uio.no Git - u/mrichter/AliRoot.git/blobdiff - RALICE/AliSignal.cxx
10-aug-2005 NvE AliSignal::GetSignal extended with mode=8 to support dead flag of...
[u/mrichter/AliRoot.git] / RALICE / AliSignal.cxx
index a74153cbaf931b537fabea37b7496cbd239bbf70..99afcf777e567c0d99a5e04d9e6f6f12331c729c 100644 (file)
 // Class AliSignal
 // Generic handling of (extrapolated) detector signals.
 //
+// The user can decide to store either calibrated or uncalibrated signals.
+// Via the specification of a gain and offset or/and an explicit
+// (de)calibration function both calibrated and uncalibrated signals
+// can always be obtained. For details see the documentation of the
+// memberfunction GetSignal() and the class AliAttrib.
+// The explicit specification of a (de)calibration function offers the
+// maximum flexibility and also allows automatic indication whether
+// calibrated or uncalibrated data has been stored.
+// The latter can be achieved by only specifying a calibration function
+// (and no de-calibration function) in case uncalibrated data is stored,
+// whereas in case of stored calibrated data the user should only
+// provide a de-calibration function (and no calibration function).
+//
 // Note :
 // ------
 // Signal positions (r) and reference frames (f) are specified via
 // signal=82.5; // e.g. signal time in ns
 // error=2.01;
 // offset=0.003;
-// q.SetSlotName("TOF");
+// q.SetSlotName("TOF",1);
 // q.SetSignal(signal,1);
 // q.SetSignalError(error,1);
 // q.SetOffset(offset,1);
 // signal=268.1; // e.g. ADC value of signal
 // error=3.75;
 // gain=120.78;
+// offset=1.5732;
 // // Addressing via name specification instead of index 
-// q.SetSlotName("ADC");
+// q.SetSlotName("ADC",2);
 // q.SetSignal(signal,"ADC");
 // q.SetSignalError(error,"ADC");
 // q.SetGain(gain,"ADC");
+// q.SetOffset(offset,"ADC");
 // signal=23.7; // e.g. corresponding dE/dx value
 // error=0.48;
-// offset=0.2;
-// gain=150;
-// q.SetSlotName("dE/dx");
-// q.SetSignal(signal,3);
-// q.SetSignalError(error,3);
-// q.SetOffset(offset,3);
-// q.SetGain(gain,3);
-//
-// Float_t dedx=q.GetSignal("dE/dx");
+// TF1 f=("calib","[0]*pow(x,2)+[1]"); // dE/dx calib. function
+// f.SetParameter(0,3.285);
+// f.SetParameter(1,-18.67);
+// q.SetSlotName("dE/dx",3);
+// q.SetCalFunction(&f,"dE/dx");
+// q.SetSignal(signal,"dE/dx");
+// q.SetSignalError(error,"dE/dx");
+//
+// // Signal retrieval with various (de)calibration modes
+// Float_t tof=q.GetSignal("TOF");
+// Float_t adc=q.GetSignal("ADC",1);
+// Float_t dedx=q.GetSignal("dE/dx",3);
 //
 //--- Author: Nick van Eijndhoven 23-jan-1999 UU-SAP Utrecht
 //- Modified: NvE $Date$ UU-SAP Utrecht
@@ -130,6 +148,17 @@ AliSignal::~AliSignal()
  }
  if (fLinks)
  {
+  // Remove this signal from all related tracks
+  for (Int_t i=1; i<=fLinks->GetNobjects(); i++)
+  {
+   TObject* obj=fLinks->GetObject(i);
+   if (!obj) continue;
+   if (obj->InheritsFrom("AliTrack"))
+   {
+    AliTrack* tx=(AliTrack*)obj;
+    tx->RemoveSignal(*this);
+   }
+  }
   delete fLinks;
   fLinks=0;
  }
@@ -387,46 +416,153 @@ Float_t AliSignal::GetSignal(Int_t j,Int_t mode) const
 {
 // Provide signal value of the j-th (default j=1) slot.
 // Note : The first signal slot is at j=1.
-// In case no signal is present or the argument j is invalid, 0 is returned.
-// The parameter "mode" allows for automatic gain etc... correction of the signal.
+// In case no signal is present or the input argument "j" or "mode" is invalid,
+// the value 0 is returned.
+// The parameter "mode" allows for automatic (de)calibration of the signal
+// (e.g. gain etc... correction or via explicit (de)calibration functions).
 //
 // mode = 0 : Just the j-th signal is returned.
 //        1 : The j-th signal is corrected for the gain, offset, dead flag etc...
+//            In case the j-th slot was marked dead, 0 is returned.
 //            In case the gain value was not set, gain=1 will be assumed.
 //            In case the gain value was 0, a signal value of 0 is returned.
 //            In case the offset value was not set, offset=0 will be assumed.
+//        2 : Same as mode=1 but gain, offset dead flag etc... are taken from
+//            the AliDevice which owns this AliSignal object.
+//            The corresponding AliDevice slot is obtained via matching of
+//            the slotnames. In case this fails, the slotindex "j" of the
+//            input argument will be used. 
+//            In case this AliSignal object has no parent AliDevice, just
+//            the j-th signal is returned (like with mode=0).
+//        3 : The j-th signal is corrected using the corresponding calibration
+//            function.
 //            In case the j-th slot was marked dead, 0 is returned.
+//            In case no calibration function is present, just the j-th signal
+//            is returned (like with mode=0).
+//        4 : Same as mode=3 but the calibration function and dead flag are
+//            taken from the AliDevice which owns this AliSignal object.
+//            The corresponding AliDevice slot is obtained via matching of
+//            the slotnames. In case this fails, the slotindex "j" of the
+//            input argument will be used. 
+//        5 : Same as mode=2 but in case no parent AliDevice is present
+//            an automatic switch to mode=1 will be made.
+//        6 : Same as mode=4 but in case no parent AliDevice is present
+//            an automatic switch to mode=3 will be made.
+//        7 : Same as mode=3 but in case no calibration function is present
+//            an automatic switch to mode=4 will be made.
+//        8 : Same as mode=7 but also the corresponding dead flag of the
+//            parent device (if any) will be checked.
+//            If either the dead flag of the requested signal slot of this
+//            AliSignal object or the corresponding parent device slot is
+//            set, 0 is returned.
+//
+//       <0 : The corresponding de-correction or de-calibration is performed
 //
 // The corrected signal (sigc) is determined as follows :
 //
 //              sigc=(signal/gain)-offset 
 //
+// The de-corrected signal is determined as follows :
+//
+//              signal=(sigc+offset)*gain 
+//
 // The default is mode=0.
 
+ if (abs(mode)>8) return 0;
+
+ Int_t jcal=j;
  Float_t sig=0;
  Float_t gain=1;
  Float_t offset=0;
+
+ // Get the corresponding slot index (and dead flag) of the parent device
+ Int_t pj=0;
+ Int_t pdead=0;
+ AliSignal* parent=(AliSignal*)GetDevice();
+ if ((abs(mode)==2 || abs(mode)>=4) && parent)
+ {
+   TString name=GetSlotName(j);
+   if (strlen(name.Data())) pj=parent->GetSlotIndex(name);
+   if (abs(mode)==8 && pj) pdead=parent->GetDeadValue(pj);
+ }
+ if (mode==8) mode=7;
+ if (mode==-8) mode=-7;
+
+ AliSignal* sx=(AliSignal*)this;
+
+ TF1* f=0;
+ if (mode==7)
+ {
+  f=sx->GetCalFunction(jcal);
+  if (f)
+  {
+   mode=3;
+  }
+  else
+  {
+   mode=4;
+  } 
+ }
+ if (mode==-7)
+ {
+  f=sx->GetDecalFunction(jcal);
+  if (f)
+  {
+   mode=-3;
+  }
+  else
+  {
+   mode=-4;
+  } 
+ }
+
+ if (abs(mode)==2 || abs(mode)>=4)
+ {
+  sx=(AliSignal*)GetDevice();
+  if (pj) jcal=pj;
+ }
+ if (!sx && abs(mode)>=5) sx=(AliSignal*)this;
+ if (mode==5) mode=2;
+ if (mode==-5) mode=-2;
+ if (mode==6) mode=3;
+ if (mode==-6) mode=-3;
+
  if (fSignals)
  {
   if (j>0 && j<=(fSignals->GetSize()))
   {
    sig=fSignals->At(j-1);
 
-   if (mode==0) return sig;
-
-   // Correct the signal for the gain, offset, dead flag etc...
-   if (GetDeadValue(j)) return 0;
+   if (mode==0 || !sx) return sig;
 
-   if (GetGainFlag(j)) gain=GetGain(j);
-   if (GetOffsetFlag(j)) offset=GetOffset(j);
+   // Check for the dead flag setting
+   if (sx->GetDeadValue(jcal) || pdead) return 0;
 
-   if (fabs(gain)>0.)
+   // (De)correct the signal for the gain and offset
+   if (abs(mode)==1 || abs(mode)==2)
    {
-    sig=(sig/gain)-offset;
+    if (sx->GetGainFlag(jcal)) gain=sx->GetGain(jcal);
+    if (sx->GetOffsetFlag(jcal)) offset=sx->GetOffset(jcal);
+
+    if (fabs(gain)>0.)
+    {
+     if (mode>0) sig=(sig/gain)-offset; // Gain and offset correction
+     if (mode<0) sig=(sig+offset)*gain; // Gain and offset de-correction
+    }
+    else
+    {
+     sig=0;
+    }
+    return sig;
    }
-   else
+
+   // (De)calibrate the signal with the corresponding (de)calibration function
+   if (abs(mode)==3 || abs(mode)==4)
    {
-    sig=0;
+    f=sx->GetCalFunction(jcal);
+    if (mode<0) f=sx->GetDecalFunction(jcal);
+    if (f) sig=f->Eval(sig);
+    return sig;
    }
   }
   else
@@ -441,18 +577,10 @@ Float_t AliSignal::GetSignal(TString name,Int_t mode) const
 {
 // Provide signal value of the name-specified slot.
 // In case no signal is present, 0 is returned.
-// The parameter "mode" allows for automatic gain etc... correction of the signal.
-//
-// mode = 0 : Just the j-th signal is returned.
-//        1 : The j-th signal is corrected for the gain, offset, dead flag etc...
-//            In case the gain value was not set, gain=1 will be assumed.
-//            In case the gain value was 0, a signal value of 0 is returned.
-//            In case the offset value was not set, offset=0 will be assumed.
-//            In case the j-th slot was marked dead, 0 is returned.
-//
-// The corrected signal (sigc) is determined as follows :
-//
-//              sigc=(signal/gain)-offset 
+// The parameter "mode" allows for automatic (de)calibration of the signal
+// (e.g. gain etc... correction or via explicit (de)calibration functions).
+// For further details about the (de)calibration modes, please refer to the
+// corresponding slot-index based memberfunction. 
 //
 // The default is mode=0.
 //
@@ -549,17 +677,18 @@ void AliSignal::Data(TString f) const
  const char* name=GetName();
  const char* title=GetTitle();
 
- cout << " *" << ClassName() << "::Data* Id :" << GetUniqueID();
+ cout << " *" << ClassName() << "::Data* Id : " << GetUniqueID();
  if (strlen(name))  cout << " Name : " << name;
  if (strlen(title)) cout << " Title : " << title;
  cout << endl;
  cout << "   Position";
- Ali3Vector::Data(f);
+ AliPosition::Data(f);
  if (fDevice)
  {
   const char* devname=fDevice->GetName();
   const char* devtitle=fDevice->GetTitle();
-  cout << "   Owned by device : " << fDevice->ClassName();
+  cout << "   Owned by device : " << fDevice->ClassName()
+       << " Id : " << fDevice->GetUniqueID();
   if (strlen(devname))  cout << " Name : " << devname;
   if (strlen(devtitle)) cout << " Title : " << devtitle;
   cout << endl;
@@ -610,10 +739,20 @@ void AliSignal::List(Int_t j) const
  Int_t nerrors=GetNerrors();
  Int_t nlinkslots=0;
  if (fLinks) nlinkslots=fLinks->GetMaxColumn();
+ Int_t ncalibs=GetNcalflags();
+ Int_t ncalfuncs=GetNcalfuncs();
+ Int_t ndecalfuncs=GetNdecalfuncs();
+
  Int_t n=nvalues;
  if (nerrors>n) n=nerrors;
  if (nlinkslots>n) n=nlinkslots;
-
+ if (InheritsFrom("AliDevice"))
+ {
+  if (ncalibs>n) n=ncalibs;
+  if (ncalfuncs>n) n=ncalfuncs;
+  if (ndecalfuncs>n) n=ndecalfuncs;
+ }
  TObject* obj=0;
  Int_t nrefs=0;
  TArrayI posarr;