RContourBaseEllipse.hh

Go to the documentation of this file.

//======================================================================
/*! \file RContourBaseEllipse.hh
 *
 *  Include file for class RContourBaseEllipse
 */
//======================================================================

#ifndef R_CONTOUR_BASE_ELLIPSE_HH
#define R_CONTOUR_BASE_ELLIPSE_HH

#include "RContourBase2D.hh"
#include "RAffine2D.hh"
#include "RContour.hh"

//======================================================================
/*! \class RContourBaseEllipse
 *
 *  Class for ellipse contour parameters.
 *  An ellipse is defined here as a circle in a frame transformation.
 *  Then the condition for beeing inside is simply x*x + y*y <= 1 in the
 *  modified frame (see \ref groot_ellipse).
 *
 *  Center and axis are defined with the RAffine2D transform base class.
 */

class RContourBaseEllipse : public RContourBase2D, public RAffine2D
{
  //------------------------------------------------------------
  /*! \object_doc{RContourBaseEllipse} */
  GObject(RContourBaseEllipse);
  //------------------------------------------------------------

  protected:

  public:

  //------------------------------------------------------------
  //  Constructors / affectation / destructor

    // center (0,0) and radius 1
    RContourBaseEllipse ( );

    // ellipse with center (0,0) and radii a and b along X and Y
    RContourBaseEllipse ( const Double_t a,
                          const Double_t b );

    // ellipse with center 'ctr' and radii a and b along X and Y
    RContourBaseEllipse ( const RPoint2D ctr,
                          const Double_t a,
                          const Double_t b );

     // ellipse with center (0,0) and radii a and b along rotated axis
    RContourBaseEllipse ( const Double_t a,
                          const Double_t b,
                          const Double_t angle );

    // ellipse with center 'ctr' and radii a and b along rotated axis
    RContourBaseEllipse ( const RPoint2D ctr,
                          const Double_t a,
                          const Double_t b,
                          const Double_t angle );

    // ellipse corresponding to a circle in the frame (ctr, xa, yb)
    RContourBaseEllipse ( const RPoint2D  ctr,
                          const RVector2D xa,
                          const RVector2D yb );

    // copy
    RContourBaseEllipse ( const RContourBaseEllipse & ct );

    // affectation
    RContourBaseEllipse & operator = ( const RContourBaseEllipse & ct );

    // destructor
    virtual ~RContourBaseEllipse ( );

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

    // contour comparison
    virtual bool  Compare ( const RContourBase * ct_ptr ) const;

    // creation of associated ROOT objects list
    virtual TList * CreateObjectList ( ) const;

  //------------------------------------------------------------
  // Read / write functions
  
    virtual bool WriteData ( ostream &os ) const;
    virtual bool WriteData ( FILE *fptr ) const;

    static RContourBaseEllipse * ReadNew ( istream &is );
    static RContourBaseEllipse * ReadNew ( FILE *fptr );

  //------------------------------------------------------------
    virtual bool    CheckPoint  ( const Double_t x, const Double_t y ) const;
    virtual bool    CheckPoint  ( const RPoint2D &p ) const;
    virtual Int_t   Type        ( ) const;
    virtual string  TypeName    ( ) const;

    // Retourne une distance normalisée entre le centre et un point
    // dans le repère transformé (0 au centre, 1 sur le cercle, ...)
    virtual Double_t  NormalisedDistance ( const RPoint2D &p ) const;

    virtual Double_t  GetAngle   () const;
    virtual RVector2D GetAxisA   () const;
    virtual RVector2D GetAxisB   () const;
    virtual RPoint2D  GetCenter  () const;
    virtual Double_t  GetRadiusA () const;
    virtual Double_t  GetRadiusB () const;

    virtual void      SetCenter ( const RPoint2D ctr );

  public:
  //------------------------------------------------------------
  /*! For ROOT dictionary.*/
    ClassDef(RContourBaseEllipse,0);
};

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

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