GETAGet.hh

Go to the documentation of this file.

//======================================================================
/*! \file GETAGet.hh
 *
 *  Include file for the GETAGet class.
 */
//======================================================================

#ifndef GET_AGET_HH
#define GET_AGET_HH

//----------------------------------------------------------------------

#include "GETChannel.hh"
#include "GETCfgAGet.hh"
class GETAsAd;

//! Number of channels (signal + FPN) of AGET chip
#define   AGET_SIZE       68

//! Number of channels (signal of AGET chip
#define   AGET_CHANNELS   64

//======================================================================
/*! \class GETAGet
 *
 *  This class describes the AGET chip.
 *  It contains 68 data channels (ASIC channels):
 *  - 64 signal channels
 *  - 4 Fix Pattern Noise (FPN) channels.
 *
 *  The correspondance between ASIC channels and signal channels is
 *  stored in static conversion arrays.
 */
class GETAGet : public GETObject
{
  //------------------------------------------------------------
  /*! \object_doc */
  GObject(GETAGet);
  //------------------------------------------------------------

  friend class GETSystem;
  friend class GETAsAd;
  friend class GETCfgAGet;

  protected:
    // Indexes information
    static  bool    index_init;                 ///< Test if index initialization is done
    static  u_int   index_asic   [AGET_SIZE];   ///< ASIC index from channel number
    static  u_int   index_channel[AGET_SIZE];   ///< Channel number from ASIC I/O index
    static  u_int   index_fpn    [4];           ///< FPN channels indexes in ASIC
    static  u_int   closer_fpn   [AGET_SIZE];   ///< Closer FPN channel

    // GET architecture
    GETChannel  channel[AGET_SIZE];   ///< ASIC channels
    u_short     last_cell;            ///< Index of last cell read in circular memory buffer

    // GET configuration
    GETCfgAGet  * config;             ///< Configuration data

  public:
  //----------------------------------------------------------
  /** @name Constructors, affectation, destructor */
  //@{
    GETAGet ( u_int n = 0, double dt = 0.01L );
    virtual ~GETAGet ( );
  //@}

  //----------------------------------------------------------
  /** @name GET configuration */
  //@{
    virtual int         ResetConfig ( );

    const GETCfgAGet  * GetConfig ( ) const;    // inline
          GETCfgAGet  * GetConfig ( );          // inline

    static u_int  GetFPNIndex     ( u_int ifpn );     // inline
    static u_int  CloserFPNIndex  ( u_int channel );  // inline

  //@}

  //----------------------------------------------------------
  /** @name Initialization functions */
  //@{
    virtual void  Reset ( );
    virtual void  Init ( u_int n, double dt );
    virtual void  ClearEvent ( );
  //@}

  //----------------------------------------------------------
  /** @name GET system core objects functions */
  //@{
    virtual string        GetObjectId           ( ) const;        // inline
    virtual u_int         GetSignalChannelCount ( ) const;        // inline
    virtual u_int         GetTotalChannelCount  ( ) const;        // inline
    virtual GETChannel  * GetSignalChannel      ( u_int n );      // inline
    virtual GETChannel  * GetTotalChannel       ( u_int n );      // inline

    virtual GETChannel  * GetFPNChannel         ( u_int n );      // inline

    virtual u_int   GetChildrenNumber ( ) const;            // inline
    virtual const   GETObject * GetChild ( u_int i ) const; // inline
    virtual         GETObject * GetChild ( u_int i );       // inline

    virtual double  GetSignalSum ( u_short info = GET::signalOut );

    // redefined from GET object base class to check for FPN channels
    virtual void SetResponse         ( GETResponse       * ptr, bool recur = true, bool fpn = false );
    virtual void SetResponse         ( GETResponse       & obj, bool recur = true, bool fpn = false );
    virtual void SetFilter           ( GETFilter         * ptr, bool recur = true, bool fpn = false );
    virtual void SetFilter           ( GETFilter         & obj, bool recur = true, bool fpn = false );
    virtual void SetNoiseIn          ( GETSignalModifier * ptr, bool recur = true, bool fpn = false );
    virtual void SetNoiseIn          ( GETSignalModifier & obj, bool recur = true, bool fpn = false );
    virtual void SetNoiseOut         ( GETSignalModifier * ptr, bool recur = true, bool fpn = false );
    virtual void SetNoiseOut         ( GETSignalModifier & obj, bool recur = true, bool fpn = false );
    virtual void SetOutputCorrection ( GETSignalModifier * ptr, bool recur = true, bool fpn = false );
    virtual void SetOutputCorrection ( GETSignalModifier & obj, bool recur = true, bool fpn = false );
  //@}

  //----------------------------------------------------------
  /** @name Access to class data */
  //@{
    const GETChannel & operator [] ( u_int n ) const; // inline
          GETChannel & operator [] ( u_int n );       // inline

    bool  IsFPN    ( u_int n ) const;
    bool  IsSignal ( u_int n ) const;

    u_short GetLastCell ( ) const;          // inline
    void    SetLastCell ( u_short cell );   // inline
  //@}


  //------------------------------------------------------------
  /** @name AGet data funtions */
  //@{
  void      FillAverageFPN ( GETSample & mean );
  GETSample GetAverageFPN ( );
  //@}

  //------------------------------------------------------------
  /** @name Read / write of custom objects scheme */
  //@{

  //@}


  //----------------------------------------------------------
  /** @name Functions for internal use */
  //@{
  protected:
    static void   InitIndexes ( );
  //@}

  //----------------------------------------------------------
  /** @name ROOT related functions */
  //@{
  public:

    /*! for use within ROOT.*/
    ClassDef(GETAGet,0);
  //@}
};


//----------------------------------------------------------------------
//  Inline functions
#include "icc/GETAGet.icc"


//======================================================================
#endif