MUON/AliMUONRejectList.cxx

   1 /**************************************************************************
   2 * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
   3 *                                                                        *
   4 * Author: The ALICE Off-line Project.                                    *
   5 * Contributors are mentioned in the code where appropriate.              *
   6 *                                                                        *
   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 **************************************************************************/
  15
  16 // $Id$
  17
  18 ///
  19 /// \class AliMUONRejectList
  20 ///
  21 /// Object to hold the probability to reject elements during reconstruction.
  22 ///
  23 /// Those elements are either channels, manus,
  24 /// bus patches, detection elements, or all the four.
  25 /// (we do not consider the next level, chamber, because if a full
  26 /// chamber is missing, we assume we'll remove that run from the
  27 /// list of usable runs anyway).
  28 ///
  29 /// The probability of rejection can be different from 0.0 or 1.0 only for
  30 /// simulations, in which case it means that :
  31 /// - this object was created from inspection of real data occupancy maps + ad-hoc rejections over
  32 /// several runs
  33 /// - the probability then reflects the chance a given element was useable
  34 /// during data taking. For instance, if one DE has a probability of 0.8, it means
  35 /// it was on (or correctly behaving during data taking) only for 20% of the
  36 /// events.
  37 ///
  38 /// \author Laurent Aphecetche, Subatech
  39 ///
  40
  41 #include "AliMUONRejectList.h"
  42
  43 #include "AliMpConstants.h"
  44 #include "AliMUON2DMap.h"
  45 #include "AliMUONCalibParamNF.h"
  46 #include "Riostream.h"
  47 #include "TMath.h"
  48
  49 /// \cond CLASSIMP
  50 ClassImp(AliMUONRejectList)
  51 /// \endcond
  52
  53 namespace
  54 {
  55   /// The functions below are here to help re-invent the wheel,
  56   /// i.e. code something which acts as std::map<int,float>
  57   /// to circumvent the fact that AliRoot does not allow STL to be used.
  58
  59   void Dump(const char* str, UInt_t n, UInt_t* ids, Float_t* values, Bool_t debug)
  60   {
  61     /// Dump the values array
  62
  63     TString s(str);
  64     s += " PROBA %e";
  65
  66     for ( UInt_t i = 0; i < n; ++i )
  67     {
  68       UInt_t key = ids[i];
  69       Int_t a,b;
  70       AliMUONVCalibParam::DecodeUniqueID(key,a,b);
  71       if ( s.CountChar('%')==3 )
  72       {
  73         cout << Form(s.Data(),a,b,values[i]) << endl;
  74       }
  75       else
  76       {
  77         cout << Form(s.Data(),a,values[i]) << endl;
  78       }
  79     }
  80
  81     if ( debug )
  82     {
  83       cout << "------" << endl;
  84       for ( UInt_t i = 0; i < n; ++i )
  85       {
  86         UInt_t key = ids[i];
  87         Int_t a,b;
  88         AliMUONVCalibParam::DecodeUniqueID(key,a,b);
  89         cout << Form("ids[%5d]=%d values[%5d]=%e (a,b)=(%5d,%5d)",
  90         i,ids[i],i,values[i],a,b) << endl;
  91       }
  92
  93     }
  94   }
  95
  96   Float_t GetValue(UInt_t n, UInt_t* ids, Float_t* values, UInt_t key)
  97   {
  98     /// Get the value corresponding to key, or zero if not found
  99     Long64_t index = TMath::BinarySearch(n,ids,key);
 100
 101     Bool_t found = ( ( index >= 0 ) && ( ids[index] == key ) );
 102
 103     if ( found )
 104     {
 105       return values[index];
 106     }
 107     else
 108     {
 109       return 0.0;
 110     }
 111   }
 112
 113   void Insert(UInt_t n, UInt_t* ids, Float_t* values, UInt_t index, UInt_t key, Float_t value)
 114   {
 115     /// Insert (key,value) into arrays ids and values.
 116
 117     for ( UInt_t i = n; i > index; --i )
 118     {
 119       ids[i] = ids[i-1];
 120       values[i] = values[i-1];
 121     }
 122     ids[index] = key;
 123     values[index] = value;
 124   }
 125
 126   Bool_t SetValue(UInt_t n, UInt_t* ids, Float_t* values, UInt_t key, Float_t value)
 127   {
 128     /// Set the value for a given key
 129     Long64_t index = TMath::BinarySearch(n,ids, key);
 130
 131     Bool_t alreadyThere = ( ( index >= 0 ) && ( ids[index] == key ) );
 132
 133     if ( alreadyThere )
 134     {
 135       // replacement
 136       values[index] = value;
 137       return kFALSE;
 138     }
 139     Insert(n,ids,values,index+1,key,value);
 140     return kTRUE;
 141   }
 142
 143   void Copy(UInt_t n, UInt_t* src, UInt_t*& dest)
 144   {
 145     /// Copy src into dest
 146     delete[] dest;
 147     dest = new UInt_t[n];
 148     memcpy(src,dest,n*sizeof(UInt_t));
 149   }
 150
 151   void Copy(UInt_t n, Float_t* src, Float_t*& dest)
 152   {
 153     /// Copy src into dest
 154     delete[] dest;
 155     dest = new Float_t[n];
 156     memcpy(src,dest,n*sizeof(Float_t));
 157   }
 158
 159 }
 160
 161 //_____________________________________________________________________________
 162 AliMUONRejectList::AliMUONRejectList()
 163 : TObject(),
 164 fIsBinary(kTRUE),
 165 fMaxNofDEs(156), // not nice to put a constant here, but that way this object does not need the mapping at creation time...
 166 fMaxNofBPs(888), // same remark as above
 167 fMaxNofManus(16828), // same as above...
 168 fNofDEs(),
 169 fNofBPs(),
 170 fNofManus(),
 171 fDEIds(new UInt_t[fMaxNofDEs]),
 172 fDEProbas(new Float_t[fMaxNofDEs]),
 173 fBPIds(new UInt_t[fMaxNofBPs]),
 174 fBPProbas(new Float_t[fMaxNofBPs]),
 175 fManuIds(new UInt_t[fMaxNofManus]),
 176 fManuProbas(new Float_t[fMaxNofManus]),
 177 fChannels(new AliMUON2DMap(kTRUE))
 178 {
 179   /// normal ctor
 180   memset(fDEIds,0,fMaxNofDEs*sizeof(UInt_t));
 181   memset(fDEProbas,0,fMaxNofDEs*sizeof(Float_t));
 182   memset(fBPIds,0,fMaxNofBPs*sizeof(UInt_t));
 183   memset(fBPProbas,0,fMaxNofBPs*sizeof(Float_t));
 184   memset(fManuIds,0,fMaxNofManus*sizeof(UInt_t));
 185   memset(fManuProbas,0,fMaxNofManus*sizeof(Float_t));
 186 }
 187
 188 //_____________________________________________________________________________
 189 AliMUONRejectList::AliMUONRejectList(TRootIOCtor* /*ioCtor*/)
 190 : TObject(),
 191 fIsBinary(kTRUE),
 192 fMaxNofDEs(),
 193 fMaxNofBPs(),
 194 fMaxNofManus(),
 195 fNofDEs(),
 196 fNofBPs(),
 197 fNofManus(0),
 198 fDEIds(0x0),
 199 fDEProbas(0x0),
 200 fBPIds(0x0),
 201 fBPProbas(0x0),
 202 fManuIds(0x0),
 203 fManuProbas(0x0),
 204 fChannels(0x0)
 205 {
 206   /// ctor from root i/o
 207 }
 208
 209 //_____________________________________________________________________________
 210 AliMUONRejectList::AliMUONRejectList(const AliMUONRejectList& rl)
 211 : TObject(rl),
 212 fIsBinary(kTRUE),
 213 fMaxNofDEs(),
 214 fMaxNofBPs(),
 215 fMaxNofManus(),
 216 fNofDEs(),
 217 fNofBPs(),
 218 fNofManus(0),
 219 fDEIds(0x0),
 220 fDEProbas(0x0),
 221 fBPIds(0x0),
 222 fBPProbas(0x0),
 223 fManuIds(0x0),
 224 fManuProbas(0x0),
 225 fChannels(0x0)
 226 {
 227   /// Copy ctor
 228   rl.CopyTo(*this);
 229 }
 230
 231 //_____________________________________________________________________________
 232 AliMUONRejectList& AliMUONRejectList::operator=(const AliMUONRejectList& rl)
 233 {
 234   /// assignement operator
 235   rl.CopyTo(*this);
 236   return *this;
 237 }
 238
 239 //_____________________________________________________________________________
 240 void
 241 AliMUONRejectList::CopyTo(AliMUONRejectList& rl) const
 242 {
 243   /// Copy this to rl
 244   TObject::Copy(rl);
 245
 246   rl.fIsBinary = fIsBinary;
 247
 248   ::Copy(rl.fMaxNofDEs,fDEIds,rl.fDEIds);
 249   ::Copy(rl.fMaxNofDEs,fDEProbas,rl.fDEProbas);
 250   ::Copy(rl.fMaxNofBPs,fBPIds,rl.fBPIds);
 251   ::Copy(rl.fMaxNofBPs,fBPProbas,rl.fBPProbas);
 252   ::Copy(rl.fMaxNofManus,fManuIds,rl.fManuIds);
 253   ::Copy(rl.fMaxNofManus,fManuProbas,rl.fManuProbas);
 254
 255   delete rl.fChannels;
 256   rl.fChannels = static_cast<AliMUONVStore*>(fChannels->Clone());
 257 }
 258
 259 //_____________________________________________________________________________
 260 AliMUONRejectList::~AliMUONRejectList()
 261 {
 262   /// dtor
 263   delete fChannels;
 264   delete[] fDEIds;
 265   delete[] fDEProbas;
 266   delete[] fBPIds;
 267   delete[] fBPProbas;
 268   delete[] fManuIds;
 269   delete[] fManuProbas;
 270 }
 271
 272 //_____________________________________________________________________________
 273 Float_t AliMUONRejectList::DetectionElementProbability(Int_t detElemId) const
 274 {
 275   /// Get the probability to reject a given detection element
 276   return ::GetValue(fNofDEs,fDEIds,fDEProbas,AliMUONVCalibParam::BuildUniqueID(detElemId,0));
 277 }
 278
 279 //_____________________________________________________________________________
 280 Float_t AliMUONRejectList::BusPatchProbability(Int_t busPatchId) const
 281 {
 282   /// Get the probability to reject a given bus patch
 283   return ::GetValue(fNofBPs,fBPIds,fBPProbas,AliMUONVCalibParam::BuildUniqueID(busPatchId,0));
 284 }
 285
 286 //_____________________________________________________________________________
 287 Float_t AliMUONRejectList::ManuProbability(Int_t detElemId, Int_t manuId) const
 288 {
 289   /// Get the probability to reject a given manu
 290   return ::GetValue(fNofManus,fManuIds,fManuProbas,AliMUONVCalibParam::BuildUniqueID(detElemId,manuId));
 291 }
 292
 293 //_____________________________________________________________________________
 294 Float_t AliMUONRejectList::ChannelProbability(Int_t detElemId, Int_t manuId, Int_t manuChannel) const
 295 {
 296   /// Get the probability to reject a given channel
 297   AliMUONVCalibParam* param = static_cast<AliMUONVCalibParam*>(fChannels->FindObject(detElemId,manuId));
 298   if (!param) return 0.0;
 299   return param->ValueAsFloat(manuChannel);
 300 }
 301
 302 //_____________________________________________________________________________
 303 void AliMUONRejectList::SetDetectionElementProbability(Int_t detElemId, Float_t proba)
 304 {
 305   /// Set the probability to reject a given detection element
 306   if ( ::SetValue(fNofDEs,fDEIds,fDEProbas,AliMUONVCalibParam::BuildUniqueID(detElemId,0),proba) )
 307   {
 308     ++fNofDEs;
 309   }
 310
 311   ZeroOrOne(proba);
 312 }
 313
 314 //_____________________________________________________________________________
 315 void AliMUONRejectList::ZeroOrOne(Float_t proba)
 316 {
 317   /// If proba is anything else than 0 or 1, we set fIsBinary to kFALSe
 318
 319   Bool_t zeroorone = ( proba == 0.0 || proba == 1.0 );
 320   if (!zeroorone) fIsBinary = kFALSE;
 321 }
 322
 323 //_____________________________________________________________________________
 324 void AliMUONRejectList::SetBusPatchProbability(Int_t busPatchId, Float_t proba)
 325 {
 326   /// Set the probability to reject a given bus patch
 327   if ( ::SetValue(fNofBPs,fBPIds,fBPProbas,AliMUONVCalibParam::BuildUniqueID(busPatchId,0),proba) )
 328   {
 329     ++fNofBPs;
 330   }
 331   ZeroOrOne(proba);
 332 }
 333
 334 //_____________________________________________________________________________
 335 void AliMUONRejectList::SetManuProbability(Int_t detElemId, Int_t manuId, Float_t proba)
 336 {
 337   /// Set the probability to reject a given manu
 338   if ( ::SetValue(fNofManus,fManuIds,fManuProbas,AliMUONVCalibParam::BuildUniqueID(detElemId,manuId),proba) )
 339   {
 340     ++fNofManus;
 341   }
 342   ZeroOrOne(proba);
 343 }
 344
 345 //_____________________________________________________________________________
 346 void AliMUONRejectList::SetChannelProbability(Int_t detElemId, Int_t manuId, Int_t manuChannel, Float_t proba)
 347 {
 348   /// Set the probability to reject a given channel
 349   AliMUONVCalibParam* param = static_cast<AliMUONVCalibParam*>(fChannels->FindObject(detElemId,manuId));
 350   if (!param)
 351   {
 352     param = new AliMUONCalibParamNF(1,AliMpConstants::ManuNofChannels(),detElemId,manuId,0.0);
 353     fChannels->Add(param);
 354   }
 355   param->SetValueAsFloat(manuChannel,0,proba);
 356   ZeroOrOne(proba);
 357 }
 358
 359 //_____________________________________________________________________________
 360 void
 361 AliMUONRejectList::Print(Option_t* opt) const
 362 {
 363   /// Printout
 364
 365   TString sopt(opt);
 366   sopt.ToUpper();
 367   Bool_t debug(kFALSE);
 368
 369   if ( sopt.Contains("DEBUG") ) debug=kTRUE;
 370
 371   cout << Form("We have probabilities for %d detection element(s), %d bus patch(es), %d manu(s)",
 372                fNofDEs,fNofBPs,fNofManus) << endl;
 373
 374   ::Dump("DE %04d",fNofDEs,fDEIds,fDEProbas,debug);
 375   ::Dump("BusPatch %04d",fNofBPs,fBPIds,fBPProbas,debug);
 376   ::Dump("DE %04d MANU %4d",fNofManus,fManuIds,fManuProbas,debug);
 377 }