GETLookupTable.hh

Go to the documentation of this file.

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

#ifndef GET_LOOKUP_TABLE_HH
#define GET_LOOKUP_TABLE_HH

//----------------------------------------------------------------------
#include "GETCommon.hh"

class GETSystem;

//======================================================================
/*! \class GETLookupTable
 *
 *  This class defines a lookup table for a detector using the
 *  GET electronics.
 *
 *  The lookup table allows to relate the electronic channel
 *  identification to the detector physical channel.
 *  The FPN channels are not part of the detector physical channels.
 *
 *  The electronics channels are defined by their CoBo, AsAd, AGet and
 *  channel (in AGet) indexes.
 *  The physical channels are defined by their pad number and X/Y
 *  position index (for a pad plane detector).
 *
 */
class GETLookupTable
{
  //------------------------------------------------------------
  /*! \object_doc */
  GObject(GETLookupTable);
  //------------------------------------------------------------

  protected:
    u_int   size;         ///< Number of GET channels
    u_int   pads_number;  ///< Number of pads

    u_int   npad_x;       ///< Number of pads along X
    u_int   npad_y;       ///< Number of pads along Y

    int   * pad;        ///< Pad identifier (effective signal channel)
    int   * cobo;       ///< CoBo identifier
    int   * asad;       ///< AsAd identifier
    int   * aget;       ///< AGet identifier
    int   * channel;    ///< AGet channel identifier
    int   * ipx;        ///< Pad X number
    int   * ipy;        ///< Pad Y number

    int   * chan_xy;    ///< Array identifying channel from ix and iy indexes

    bool    defined;    ///< Whether the table data has been set

  public:
  //----------------------------------------------------------
  /** @name Constructors, affectation, destructor */
  //@{
    GETLookupTable ( u_int nch = 0, u_int nx = 0, u_int ny = 0 );
    virtual ~GETLookupTable ( );
  //@}

  //----------------------------------------------------------
  /** @name Table building */
  //@{
    virtual void  EraseTables ( );
    virtual int   InitTables  ( u_int nch, u_int nx, u_int ny );
    virtual int   InitTables  ( GETSystem & get, u_int nx, u_int ny );

    virtual bool  IsTableSet ( ) const;     // inline

    virtual int   SetDefaultTable ( GETSystem & get, u_int nx, u_int ny );
    virtual int   SetHVpad64Table ( GETSystem & get, u_int ny );

  //@}

  //----------------------------------------------------------
  /** @name Table data */
  //@{
    virtual u_int GetSize ( ) const;                // inline
    virtual int   GetPad      ( u_int nch ) const;  // inline
    virtual int   GetCoBo     ( u_int nch ) const;  // inline
    virtual int   GetAsAd     ( u_int nch ) const;  // inline
    virtual int   GetAGet     ( u_int nch ) const;  // inline
    virtual int   GetChannel  ( u_int nch ) const;  // inline
    virtual int   GetIpx      ( u_int nch ) const;  // inline
    virtual int   GetIpy      ( u_int nch ) const;  // inline

    virtual int   GetChannel  ( u_int ix, u_int iy ) const;  // inline
    virtual u_int GetNpadX    ( ) const;                     // inline
    virtual u_int GetNpadY    ( ) const;                     // inline

    virtual void  DumpTable ( const string & fname, bool head = true ) const;
    virtual void  DumpTable ( FILE * fp, bool head = true ) const;

    virtual void  DumpXY ( const string & fname, bool head = true ) const;
    virtual void  DumpXY ( FILE * fp, bool head = true ) const;

    virtual int   Read ( const string & fname, bool rpad = true, bool invxy = false );
    virtual int   Read ( FILE * fp, bool rpad = true, bool invxy = false );

  //@}

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

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


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


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