StTPCReader.h

/***************************************************************************
 *
 * $Id: StTPCReader.h,v 1.7 2004/03/10 05:59:04 jeromel Exp $
 *
 * Author: Victor Perev
 ***************************************************************************
 *
 * Description: Offline Wrapper for DAQ reader classes
 *
 ***************************************************************************
 *
 * $Log: StTPCReader.h,v $
 * Revision 1.7  2004/03/10 05:59:04  jeromel
 * Implement SetSequenceMerging(). See comment in St_tpcdaq_Maker
 *
 * Revision 1.6  2004/03/04 21:51:27  ward
 * Replaced MERGE_SEQUENCES with a StDAQMaker chain parameter, as suggested by Landgraf and Lauret.
 *
 * Revision 1.5  2004/01/23 16:06:43  jeromel
 * Added friend class for FCF
 *
 * Revision 1.4  2003/04/29 16:22:44  perev
 * non TPCoriented cleanup
 *
 * Revision 1.3  2002/10/13 20:43:36  ward
 * Support for decoding DAQ100 data and writing it into a table.
 *
 * Revision 1.2  2000/07/13 22:29:52  perev
 * Return kStErr when TPC data is not in event.
 *
 * Revision 1.1  2000/06/12 15:12:27  perev
 * SVT + cleanup
 *
 *
 *
 **************************************************************************/
#ifndef _StTPCReader_
#define _StTPCReader_

#ifndef __CINT__
#include "StDAQReader.h"

#endif /*__CINT__*/


//              Forward declarations
struct  EventInfo;
typedef  EventInfo DAQEventInfo;
class  EventReader;
class  DetectorReader;
class  ZeroSuppressedReader;
class  ADCRawReader;
class  PedestalReader;
class  PedestalRMSReader;
class  GainReader;
class  CPPReader;
class  BadChannelReader;
class  RICH_Reader;
//


typedef struct TPCSequence
{
  unsigned short startTimeBin;
  unsigned short Length;
  unsigned char *FirstAdc;

}TPCSequence;

typedef struct TPCCluster
{
  short start_time_bin;
  short stop_time_bin;
}TPCCluster;



typedef struct TPCGain
{
  int t0;          // t0 * 16
  int t0_rms;      // t0_rms * 16
  int rel_gain;    // rel_gain * 64
}TPCGain;

class StTPCReader;
class StFTPCReader;
 

class  StTPCReader
{
  friend class St_tpcdaq_Maker;      // Herb Oct 2002 for DAQ100, for access to ptrTPCP.
  friend class StRTSClientFCFMaker;  // allow RTSClient to access ptrTPCP
  public:

  StTPCReader(StDAQReader *rd,char);
 ~StTPCReader();
  int close();
  int empty();

  int getMaxPad(int PadRow) const;      //Number of pads in padrow

  int getPadList(int Sector, int PadRow, unsigned char *&padList);
      // Fills (*padList[]) with the list of pad numbers containing hits
      // returns number of pads in (*padList)[]
      // or negative if call fails
  
  int getSequences(int Sector, int PadRow, int Pad, int &nSeq,
                           TPCSequence *&SeqData);
        //  Fills (*SeqData)[] along with the ADC
        // buffers pointed to by (*SeqData)[]
        // Set nSeq to the # of elements in the (*SeqData)[] array
        // returns 0 if OK.
        // or negative if call fails

  int getRawADC(int Sector,int PadRow, int Pad, int &nArray,
                        unsigned char *&Array);
        // Fills (*Array)[] with Raw data
        // Fills nArray with the # of elements in (*Array)[] (512 bytes / TPC)
        // returns 0 if OK.
        // returns negative if call fails


  int getPedestals(int Sector,int PadRow, int Pad, int &nArray,
                           unsigned char *&Array);

        // Fills (*Array)[] with Pedestal data
        // Fills nArray with the # of elements in Array (512 bytes for TPC)
        // returns 0 if OK.
        // returns negative if call fails


  int getRMSPedestals(int Sector,int PadRow, int Pad, int &nArray,
                              unsigned char *&Array);

        // Fills (*Array)[] with Pedestal RMS data * 16
        // Fills nArray with the # of elements in (*Array)[] (512 bytes / TPC)
        // returns 0 if OK.
        // returns negative if call fails


  int getGain(int Sector, int PadRow, int Pad, TPCGain *&gain);
        // sets (*gain) to a valid gain structure pointer
        // returns 0 if OK
        // returns negative if call fails


//  int getMeanGain();
      // returns mean gain

//  int getGainEvents();
        // returns the number of events the calculation is based upon

  int getClusters(int Sector, int PadRow, int Pad, int &nClusters, 
                          TPCCluster *&clusters);
        // sets (*clusters) to beginning of array of clusters
        // sets nClusters to the length of the array
        // returns 0 if OK
        // returns negative if call fails

  int IsBad(int Sector, int PadRow, int Pad);
        // returns true if the pad is bad.  
        // returns false if the pad is not bad.

  int Update();

  void SetSequenceMerging (char);

protected:
  int setSector(int sector);

  StDAQReader           *fDAQReader;
  DetectorReader        *fTPCImpReader;
  ZeroSuppressedReader  *fZeroSuppressedReader;
  ADCRawReader          *fADCRawReader;
  PedestalReader        *fPedestalReader;
  PedestalRMSReader     *fPedestalRMSReader;
  GainReader            *fGainReader;
  CPPReader             *fCPPReader;
  BadChannelReader      *fBadChannelReader;

private:
  char mMergeSequences;
  void *ptrTPCP; // Herb Oct 2002 for DAQ100.

  int fSector;
};

#endif