RHoughTransform.hh

Go to the documentation of this file.

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

#ifndef R_HOUGH_TRANSFORM_HH
#define R_HOUGH_TRANSFORM_HH

//======================================================================

// GRootTools includes
#include "RBaseFunctions.hh"

// ROOT includes
#include "TH2.h"
#include "TPoint.h"
#include "TMath.h"
#include "TLine.h"


//======================================================================
/*! \class RHoughTransform
 *
 *  This class performs Hough transform analysis of the image given
 *  by a 2D histogram.
 *
 *  The Hough transform is used to search for lines in an image.
 *
 *  It is supposed to work on points cloud;
 *  here, the analysis is done by weighting the contribution of
 *  each pixel with the histogram content.
 *  The X and Y dimensions of the image histogram should be in the
 *  dimension units.
 *
 *  The source image histogram is defined by a pointer to an histogram
 *  that is defined outside the RHoughTransform object.
 *
 */
class RHoughTransform
{
  //------------------------------------------------------------
  /*! \object_doc{RHoughTransform} */
  GObject(RHoughTransform);
  //------------------------------------------------------------

  /*! Option for reference point at the center of the image histogram*/
  static const u_int  optCenter     = 0x00000001;

  /*! Option for threshold on histogram amplitude for contributing to the analysis*/
  static const u_int  optThreshold  = 0x00000002;

  /*! Option for amplitude as weight of histogram point*/
  static const u_int  optAmplitude  = 0x00000004;

  /*! Option for smoothing the Hough transform histogram*/
  static const u_int  optSmooth     = 0x00000008;

  /*! Mode for line suppression: sharp cut*/
  static const u_short  modeCut     = 0x0000;

  /*! Mode for line suppression: gauss shape reduction*/
  static const u_short  modeGaus    = 0x0001;


  protected:
    TH2     * src_histo;      ///< Pointer to the histogram to analyse
    TPoint    src_center;     ///< Image histogram center
    double    threshold;      ///< Threshold value

    TH2     * hough_histo;    ///< Pointer to the Hough transform histogram
    string    hough_id;       ///< Name for the transform (histogram name)

    TAttLine  line_att;       ///< Lines draw attributes (ROOT)

    u_int     options;        ///< Transform options

    u_short   suppress_mode;    ///< Mode for line suppression
    double    suppress_width;   ///< Line width for suppression

  public:

  //------------------------------------------------------------
  /** @name Constructors, affectation, destructor */
  //@{
    RHoughTransform ( TH2 * hptr = NULL,
                      u_int nth = 0, u_int nr = 0, double rmax = 0.,
                      double thr = 0., const string & id = "" );
    virtual ~RHoughTransform ( );
  //@}

  //------------------------------------------------------------
  /** @name Transform analysis options */
  //@{
    u_int GetOptions                   ( ) const;   // inline
    bool  GetOptionCenterRef           ( ) const;   // inline
    bool  GetOptionCornerRef           ( ) const;   // inline
    bool  GetOptionThreshold           ( ) const;   // inline
    bool  GetOptionAmplWeight          ( ) const;   // inline
    bool  GetOptionThresholdAmplWeight ( ) const;   // inline
    bool  GetOptionSmooth              ( ) const;   // inline

    virtual void  SetOptionCenterRef ( );
    virtual void  SetOptionCornerRef ( );

    virtual void  SetOptionAmplWeight ( bool thr = false );
    virtual void  SetOptionUnitWeight ( );

    virtual void  SetOptionSmooth   ( );    // inline
    virtual void  SetOptionNoSmooth ( );    // inline
  //@}

  //------------------------------------------------------------
  /** @name Transform analysis functions */
  //@{
    TH2       * GetSourceHisto ( ) const;     // inline
    const TH2 * GetHoughHisto  ( ) const;     // inline
          TH2 * GetHoughHisto  ( );           // inline
    TH2       * GetWeightHisto ( const string & hname = "" ) const;


    const TPoint  & GetSourceCenter ( ) const;    // inline
          TPoint  & GetSourceCenter ( );          // inline

    virtual int   SetSourceHisto ( TH2 * hptr, double thr = 0. );
    virtual void  SetThreshold ( double thr );      // inline

    virtual void    ResetTransform ( );
    virtual TH2   * SetTransform   ( u_int nth, u_int nr, double rmax, const string & id = "", bool calc = false );
    virtual int     ComputeTransform ( );
    virtual double  GetWeight ( double pval ) const;

    double        GetHoughMaximum ( double & theta, double & dist ) const;
    virtual void  SuppressSourceLine ( double theta, double dist, double width,
                                       u_short mode = modeCut, u_short sdiv = 1 );

    virtual void  SetSuppressMode ( u_short mode, double width ); // inline
    virtual u_int SearchLineSuppress ( double hthr, u_int nlmax = 1,
                                       double * thtab = NULL, double * rtab = NULL, double * htab = NULL,
                                       u_short sdiv = 1 );
  //@}

  //------------------------------------------------------------
  /** @name ROOT related functions */
  //@{
    virtual void  SetLineColor ( Color_t c );         // inline
    virtual void  SetLineWidth ( Width_t w );         // inline
    virtual void  SetLineStyle ( Style_t s );         // inline
    virtual void  SetLineAtt   ( TAttLine & att );    // inline

    const TAttLine & GetLineAtt ( ) const;            // inline
          TAttLine & GetLineAtt ( );                  // inline

    TLine * CreateLine   ( ) const;
    TLine * CreateLine   ( double theta, double dist ) const;
    TLine * CreateNormal ( ) const;
    TLine * CreateNormal ( double theta, double dist ) const;

    /*! For ROOT dictionary.*/
    ClassDef(RHoughTransform,0);
  //@}
};

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


//======================================================================

#endif