AliFMDBaseDA.h

Go to the documentation of this file.

// -*- mode: C++ -*- 
#ifndef ALIFMDBASEDA_H
#define ALIFMDBASEDA_H

/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights
 * reserved. 
 *
 * See cxx source for full Copyright notice                               
 */
//
// This class provides a base interface for the Detector Algorithms
// (DA) of the FMD.  At least three implementations are needed:
// AliFMDPedestalDA, AliFMDGainDA and AliFMDPhysicsDA .  These classes
// will provide the calibration data for the AliFMDPreprocessor to be
// used in the shuttle.  The input for this class are raw data
// (AliRawReader) and the output is a comma-separated file
// (std::ofstream) that contains the values defined in the
// implementations of this class.
//
// Author: Hans Hjersing Dalsgaard, hans.dalsgaard@cern.ch
//

#include "TNamed.h"
#include "TObjArray.h"
#include "TString.h"
#include "TArrayS.h"
#include "TList.h"
#include <iosfwd>
#include <fstream>
class AliFMDDigit;
class AliRawReader;
class AliFMDParameters;
class AliFMDRawReader;
class TDirectory;
class TH2;
class TFile;
class TClonesArray;

class AliFMDBaseDA: public TNamed 
{
public:
#if 0
  struct _Array : public TList 
  {
    _Array() : TList() {}
    _Array(Int_t) : TList() {}
    _Array(const _Array& a) : TList() {} 
    ~_Array();
    void AddAtAndExpand(TObject* o, Int_t idx) { AddAt(o,idx); }       
    Int_t GetEntriesFast() { return GetEntries(); }
  };
  typedef _Array Array;
#elif 0 
  struct _Array : public TObjArray 
  {
    _Array() : TObjArray() {}
    _Array(Int_t n) : TObjArray(n) {}
    ~_Array();
  };
  typedef _Array Array;
#else
  typedef TObjArray Array;
#endif

  AliFMDBaseDA() ;
  AliFMDBaseDA(const AliFMDBaseDA & baseDA) ;
  //  AliFMDBaseDA& operator = (const AliFMDBaseDA & baseDA) ; 
  ~AliFMDBaseDA() ;
  AliFMDBaseDA& operator=(const AliFMDBaseDA&) { return *this; }
  Bool_t Run(AliRawReader* fmdReader, Bool_t appendRun, Bool_t isBase=false);
  void SetSaveDiagnostics(Bool_t save) {fSaveHistograms = save;}
  void SetDiagnosticsFilename(const TString& f) { fDiagnosticsFilename = f; }
  void SetMakeSummaries(Bool_t save) {fMakeSummaries = save;}
  void SetRequiredEvents(Int_t nEvents) {fRequiredEvents = nEvents;}
  void SetTryAll(Bool_t all=true) { fAll = all; }
  Int_t GetRequiredEvents() const {return fRequiredEvents ;}
  const Array& GetSummaries() const { return fSummaries; }
  Bool_t HasSeenDetector(UShort_t d) const;

  struct Runner {
    Runner();
    Runner(const Runner&) 
      : fReader(0),
  fSource(""),
  fDiagFile(""), 
  fDiag(false), 
  fAll(false),
  fFast(true),
  fUpload(true),
  fAppendRun(false),
  fOwnUpload(false)
    {}
    ~Runner() {} 
    Runner& operator=(const Runner&) { return *this; }
    void   AddHandlers();
    void   ShowUsage(std::ostream& o, const char* progname);
    Int_t  Init(int argc, char** argv, Bool_t reader=true);
    Bool_t Exec(AliFMDBaseDA& da);
    Int_t  RunNumber() const;
    AliRawReader* fReader;
    TString       fSource;
    TString       fDiagFile;
    Bool_t        fDiag;
    Bool_t        fAll;
    Bool_t        fFast;
    Bool_t        fUpload;
    Bool_t        fAppendRun;
    Bool_t        fOwnUpload;
  };
protected:
  virtual Bool_t OpenFiles(Bool_t appendRun=false);
  virtual void CloseFiles();
  virtual void Init()  {};
  virtual void FillChannels(AliFMDDigit* )  {};
  virtual void Analyse(UShort_t, Char_t, UShort_t, UShort_t)  {};
  virtual void WriteHeaderToFile()  {};
  virtual void AddChannelContainer(Array*, UShort_t, Char_t, 
           UShort_t, UShort_t )  {};
  virtual void AddSectorSummary(Array*, UShort_t, Char_t, UShort_t, 
        UShort_t) {}
  virtual void FinishEvent()  {};
  virtual void Terminate(TFile* ) {};
  Int_t GetCurrentEvent() const {return fCurrentEvent;}
  void Rotate(const char* base, int max) const;
  Int_t GetHalfringIndex(UShort_t, Char_t, UShort_t) const;
  Int_t GetPulseSize(UShort_t det , 
         Char_t ring, 
         UShort_t board) 
  {
    return fPulseSize.At(GetHalfringIndex(det,ring,board));
  }
  Int_t GetPulseLength(UShort_t det, 
           Char_t ring, 
           UShort_t board) 
  {
    return fPulseLength.At(GetHalfringIndex(det,ring,board));
  }

  TString GetDetectorPath(UShort_t det, Bool_t full=kTRUE) const;
  TString GetRingPath(UShort_t det, Char_t ring, Bool_t full=kTRUE) const;
  TString GetSectorPath(UShort_t det, Char_t ring, UShort_t sec, 
          Bool_t full=kTRUE) const;
  TString GetStripPath(UShort_t det, Char_t ring, UShort_t sec, 
         UShort_t str, Bool_t full=kTRUE) const;
  Array* GetDetectorArray(UShort_t det);
  Array* GetRingArray(UShort_t det, Char_t ring);
  Array* GetSectorArray(UShort_t det, Char_t ring, UShort_t sector);
  Array* GetStripArray(UShort_t det, Char_t ring, 
         UShort_t sector, UShort_t strip);
  void WriteConditionsData(AliFMDRawReader* fmdReader);
  void SetCurrentEvent(Int_t currentEvent) {fCurrentEvent = currentEvent; }
  virtual void InitContainer(TDirectory* dir);
  TH2* MakeSummaryHistogram(const char* prefix, const char* title, 
          UShort_t det, Char_t ring);
  virtual void  MakeSummary(UShort_t, Char_t) { }
  
  virtual Bool_t HaveEnough(Int_t nEvent) const;
  virtual UShort_t GetProgress(Int_t nEvent) const;

  static const UInt_t fgkBaseDDL = 3072;   // base FMD ddl
  //Char_t* fDiagnosticsFilename;
  TString       fDiagnosticsFilename;  // name of diagnostics file
  std::ofstream fOutputFile;           // output file
  std::ofstream fConditionsFile;       // conditions file
  Bool_t        fSaveHistograms;       // save hists or not
  Bool_t        fMakeSummaries;        // save hists or not
  Array         fDetectorArray;        // array indiced by detector
  TArrayS       fPulseSize;            // Pulse size for gain calib
  TArrayS       fPulseLength;          // Pulse length for gain calib
  Bool_t        fSeenDetectors[3];     // Detectors seen so far
  UInt_t        fNEventsPerDetector[3];// # events per detector
  Int_t         fRequiredEvents;       // # events required for this calib
  Int_t         fCurrentEvent;         // the current event       
  UInt_t        fRunno;                // Current run number 
  Array         fSummaries;            // Summary histograms 
  Bool_t        fAll;                  // Try to get data from all dets
  
  ClassDef(AliFMDBaseDA,0) // Base Detector algorithm for all run types

};
//____________________________________________________________________
inline Bool_t
AliFMDBaseDA::HasSeenDetector(UShort_t d) const
{ 
  return (d == 0 || d > 3) ? false : fSeenDetectors[d-1]; 
}

#endif