GETHitMaskXY.hh

Go to the documentation of this file.

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

#ifndef GET_HIT_MASK_XY_HH
#define GET_HIT_MASK_XY_HH

//----------------------------------------------------------------------
#include "GETHitMask.hh"

#include <TH2.h>

//======================================================================
/*! \class GETHitMaskXY
 *
 *  This class defines a XY (2 dimension) hit mask for pad plane
 *  detectors.
 *
 *  The lloup-table of the GET system must be defined before
 *  defining a pads (XY) hit mask for the system.
 */
class GETHitMaskXY : public GETHitMask
{
  //------------------------------------------------------------
  /*! \object_doc */
  GObject(GETHitMaskXY);
  //------------------------------------------------------------

  using GETHitMask::IsHit;
  using GETHitMask::IsValid;
  using GETHitMask::IsValidHit;
  using GETHitMask::SetHit;
  using GETHitMask::SetValid;

  protected:
    u_int nhit_pads;      ///< Number of valid pads hit

    int   ixmin;          ///< Lower bin on X axis
    int   ixmax;          ///< Upper bin on X axis
    int   iymin;          ///< Lower bin on Y axis
    int   iymax;          ///< Upper bin on Y axis
    int   itmin;          ///< Lower bin on T axis
    int   itmax;          ///< Upper bin on T axis

    int   ic_chmax;       ///< Electronic channel index of channel with max. signal
    int   ix_chmax;       ///< X pad index of channel with max. signal
    int   iy_chmax;       ///< Y pad index of channel with max. signal
    int   it_chmax;       ///< Time bucket of channel with max. signal

  public:
  //----------------------------------------------------------
  /** @name Constructors, affectation, destructor */
  //@{
    GETHitMaskXY ( GETSystem * get = NULL );
    GETHitMaskXY ( const GETHitMaskXY & mask );
    GETHitMaskXY & operator = ( const GETHitMaskXY & mask );
    virtual ~GETHitMaskXY ( );

    virtual void CopyData ( const GETHitMaskXY & mask );
  //@}

  //----------------------------------------------------------
  /** @name Hit mask data */
  //@{
    virtual void  ClearHitMask   ( );
    virtual u_int UpdateMask     ( );

    virtual u_int GetNhitPads  ( ) const;     // inline

    virtual bool  IsHit      ( u_int ix, u_int iy ) const;
    virtual bool  IsValid    ( u_int ix, u_int iy ) const;
    virtual bool  IsValidHit ( u_int ix, u_int iy ) const;
    virtual void  SetHit     ( u_int ix, u_int iy, bool b = true );
    virtual void  SetValid   ( u_int ix, u_int iy, bool b = true );
    virtual void  SetBorder  ( u_int n = 1, bool b = false );
    virtual void  MaskBorder ( u_int n = 1 );     // inline

    virtual GETHitMaskXY & ExpandHits ( u_int n = 1 );

    int     GetIXmin ( ) const;   // inline
    int     GetIXmax ( ) const;   // inline
    int     GetIYmin ( ) const;   // inline
    int     GetIYmax ( ) const;   // inline
    int     GetITmin ( ) const;   // inline
    int     GetITmax ( ) const;   // inline

    u_int   GetBoundaries ( int & ix0, int & ix1,
                            int & iy0, int & iy1,
                            int & it0, int & it1 );

    GETChannel  * GetMaxSignalChannel ( ) const;
    int           GetMaxSignalIndex   ( ) const;    // inline
    int           GetMaxSignalIX      ( ) const;    // inline
    int           GetMaxSignalIY      ( ) const;    // inline
    int           GetMaxSignalIT      ( ) const;    // inline
  //@}

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

    int   Fill2DMaskHisto ( TH2 * hptr );

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


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


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