]> git.uio.no Git - u/mrichter/AliRoot.git/blobdiff - FMD/AliFMDRawReader.h
Added option to swap sides (Ruben)
[u/mrichter/AliRoot.git] / FMD / AliFMDRawReader.h
index fa5cbdb85e9d347c4555b32c2893c41f6c335149..d50037451ddfac15183aa1c89db402cf121a3fbc 100644 (file)
 
 //____________________________________________________________________
 class AliRawReader;
+class AliAltroRawStreamV3;
 class TTree;
 class TClonesArray;
 class TArrayS;
 class AliFMDCalibSampleRate;
 class AliFMDCalibStripRange;
+class AliFMDUShortMap;
 
 //____________________________________________________________________
 /** @brief Class to read ALTRO formated raw data from an AliRawReader
@@ -47,6 +49,13 @@ class AliFMDCalibStripRange;
 class AliFMDRawReader : public TTask 
 {
 public:
+  /** Number of possible DDLs */
+  enum { 
+    kNDDL = 3
+  };
+  enum { 
+    kBadSignal = 0x7FFF // Largest signed 16bit short integer
+  };
   /** 
    * CTOR 
    *
@@ -68,14 +77,18 @@ public:
    * Read ADC's into a TClonesArray of AliFMDDigit objects. 
    *
    * @param array       Array to read into 
-   * @param summable    Create SDigits rather than digits 
-   * @param pedSub      Whether to do pedestal subtraction.
-   * @param noiseFactor If we do pedestal subtraction, then this is
-   *        the number we use to suppress remenants of the noise.
    * 
    * @return @c true on success 
    */
   virtual Bool_t ReadAdcs(TClonesArray* array);
+  /** 
+   * Read ADCs into a unsigned short map. 
+   * 
+   * @param map Map to read into 
+   * 
+   * @return true on success 
+   */
+  virtual Bool_t ReadAdcs(AliFMDUShortMap& map);
   /** 
    * Read SOD event into passed objects.
    * 
@@ -122,9 +135,15 @@ public:
    * @param zs   On return, whether zero-supp. is enabled
    * @param fac  On return, the usd noise factor
    * 
-   * @return true if valid data is returned
+   * @return 0 if there's no more data.  -1 if the read sample
+   * corresponds to a bad bunch in the channel.  Positive return
+   * values represent a bit mask of 
+   * - 0x1  New DDL 
+   * - 0x2  New Channel 
+   * - 0x4  New Bunch 
+   * - 0x8  New Sample 
    */
-  Bool_t NextSample(UShort_t& det, Char_t&   rng, UShort_t& sec, UShort_t& str,
+  Int_t NextSample(UShort_t& det, Char_t&   rng, UShort_t& sec, UShort_t& str,
                    UShort_t& sam, UShort_t& rat, Short_t&  adc, 
                    Bool_t&   zs,  UShort_t& fac);
   /** 
@@ -138,12 +157,35 @@ public:
    * @param zs   On return, whether zero-supp. is enabled
    * @param fac  On return, the usd noise factor
    * 
-   * @return true if valid data is returned
+   * @return 0 if there's no more data.  -1 if the read sample
+   * corresponds to a bad bunch in the channel.  Positive return
+   * values represent a bit mask of 
+   * - 0x1  New DDL 
+   * - 0x2  New Channel 
+   * - 0x4  New Bunch 
+   * - 0x8  New Sample 
+   */
+  Int_t NextSignal(UShort_t& det, Char_t&   rng, 
+                  UShort_t& sec, UShort_t& str, 
+                  Short_t&  adc, Bool_t&   zs, 
+                  UShort_t& fac);
+  /** 
+   * Get number of read-out errors.  Note, that a channel marked as
+   * bad counts as 10 errors 
+   * 
+   * @param ddl DDL off set ([0,kNDDL-1])
+   * 
+   * @return Number of seen errors 
+   */
+  UShort_t GetNErrors(UShort_t ddl) const {return (ddl >= kNDDL ? 0 : fNErrors[ddl]);}
+  /** 
+   * Get the phase of the L1 signal 
+   * 
+   * @param ddl DDL number ([0,kNDDL-1])
+   * 
+   * @return Phase of the L1 signal in steps of 25ns. 
    */
-  Bool_t NextSignal(UShort_t& det, Char_t&   rng, 
-                   UShort_t& sec, UShort_t& str, 
-                   Short_t&  adc, Bool_t&   zs, 
-                   UShort_t& fac);
+  UShort_t GetL1Phase(UShort_t ddl) const {return (ddl >= kNDDL ? -1 : fL1Phase[ddl]);}
   /** 
    * Whether to keep a sample based on the rate used. 
    * 
@@ -154,26 +196,119 @@ public:
    */
   static Bool_t SelectSample(UShort_t samp, UShort_t rate);
 protected:
+  /** 
+   * Copy constructor 
+   * 
+   * @param o Object to construct from
+   */  
   AliFMDRawReader(const AliFMDRawReader& o) 
     : TTask(o), 
       fTree(0), 
       fReader(0), 
       fData(0),
       fNbytes(0), 
+      fMinStrip(0), 
+      fMaxStrip(127),
+      fPreSamp(14+5),
       fSeen(0)
   {}
+  /** 
+   * Assignment operator
+   * 
+   * @return Reference to this object
+   */
   AliFMDRawReader& operator=(const AliFMDRawReader&) { return *this; }
+  /** 
+   * Process a new DDL.  Sets the internal data members fZeroSuppress, 
+   * fSampleRate, and fNoiseFactor based on information in the RCU trailer. 
+   * 
+   * @param input Input stream
+   * @param det   On return, the detector number
+   * 
+   * @return negative value in case of problems, the DDL number otherwise
+   */
+  Int_t NewDDL(AliAltroRawStreamV3& input, UShort_t& det);
+  /** 
+   * Processs a new channel.  Sets the internal data members
+   * fMinStrip, fMaxStrip, and fPreSamp. 
+   * 
+   * @param input   Input stream
+   * @param det     Detector number
+   * @param ring    On return, the ring identifier 
+   * @param sec     On return, the sector number
+   * @param strbase On return, the strip base
+   * 
+   * @return negative value in case of problems, hardware address otherwise
+   */
+  Int_t NewChannel(const AliAltroRawStreamV3& input, 
+                  UShort_t det, Char_t&  ring, 
+                  UShort_t& sec, Short_t& strbase);
+  /** 
+   * Process a new bunch.
+   * 
+   * @param input    Input stream
+   * @param start    On input, the old start time. On return, the start time
+   * @param length   On return, the bunch length
+   * 
+   * @return true on success, false otherwise 
+   */
+  Bool_t NewBunch(const AliAltroRawStreamV3& input, 
+                 UShort_t&  start, UShort_t& length);
+  /** 
+   * Process a new timebin
+   * 
+   * @param input   Input stream
+   * @param i       Index into bunch data
+   * @param t       Time
+   * @param sec     Sector number
+   * @param strbase Base of strip numbers for this channel
+   * @param str     On return, the strip number
+   * @param samp    On return, the sample number
+   * 
+   * @return negative value in case of problems, ADC value otherwise
+   */  
+  Int_t NewSample(const AliAltroRawStreamV3& input, 
+                 Int_t i, UShort_t t, UShort_t sec,
+                 UShort_t  strbase, Short_t&  str, UShort_t& samp);
+
+  /** 
+   * 
+   * Get the number of words 
+   * 
+   * @return Number of 32bit words 
+   */
   ULong_t GetNwords() const {return fNbytes / 4;}
+  /** 
+   * Get the next 32bit word from payload
+   * 
+   * @param idx Which 32bit word to get
+   * 
+   * @return 
+   */
   UInt_t Get32bitWord(Int_t idx);
-  Int_t GetHalfringIndex(UShort_t det, Char_t ring, UShort_t board);
-  TTree*          fTree;       //! Pointer to tree to read into 
-  AliRawReader*   fReader;     //! Pointer to raw reader 
-  UShort_t        fSampleRate[3]; // The sample rate (if 0, inferred from data)
-  UChar_t*        fData; 
-  ULong_t        fNbytes; 
-  Bool_t          fZeroSuppress[3];
-  UShort_t        fNoiseFactor[3];
-  AliFMDUShortMap fSeen;
+  /** 
+   * Get short index for a given half-ring
+   * 
+   * @param det   Detector number
+   * @param ring  Ring identifer
+   * @param board Board number
+   * 
+   * @return 
+   */
+  Int_t GetHalfringIndex(UShort_t det, Char_t ring, UShort_t board) const;
+  TTree*          fTree;             //! Pointer to tree to read into 
+  AliRawReader*   fReader;           //! Pointer to raw reader 
+  UShort_t        fSampleRate[kNDDL];// The sample rate (if 0,infer from data)
+  UChar_t*        fData;             // Data pointer
+  ULong_t        fNbytes;           // Number of bytes
+  Bool_t          fZeroSuppress[kNDDL]; // Zero suppression flag
+  UShort_t        fNoiseFactor[kNDDL];  // Noise factor 
+  UShort_t        fMinStrip;        // Current minimum strip number (0)
+  UShort_t        fMaxStrip;        // Current maximum strip number (127)
+  UShort_t        fPreSamp;         // Current number of pre-samples (14+5)
+  AliFMDUShortMap fSeen;            // Seen strips 
+  UShort_t        fNErrors[kNDDL];  // Number of errors per DDL
+  UShort_t        fL1Phase[kNDDL];  // Number of errors per DDL
   
   ClassDef(AliFMDRawReader, 0) // Read FMD raw data into a cache 
 };
@@ -187,3 +322,4 @@ protected:
 //
 // EOF
 //
+