DGtal  0.9.4beta
Public Types | Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
DGtal::Ball2D< TSpace > Class Template Reference

#include <DGtal/shapes/parametric/Ball2D.h>

Inheritance diagram for DGtal::Ball2D< TSpace >:
[legend]
Collaboration diagram for DGtal::Ball2D< TSpace >:
[legend]

Public Types

typedef TSpace Space
 
typedef Space::Point Point
 
typedef Space::RealPoint RealPoint2D
 
typedef Space::RealVector RealVector2D
 
- Public Types inherited from DGtal::StarShaped2D< TSpace >
typedef TSpace Space
 
typedef Space::Point Point
 
typedef Space::RealPoint RealPoint
 

Public Member Functions

 ~Ball2D ()
 
 Ball2D (const double x0, const double y0, const double r)
 
 Ball2D (const RealPoint2D &aPoint, const double r)
 
 Ball2D (const Point &aPoint, const double r)
 
RealPoint2D getLowerBound () const
 
RealPoint2D getUpperBound () const
 
RealPoint2D center () const
 
double parameter (const RealPoint2D &p) const
 
RealPoint2D x (const double t) const
 
RealVector2D xp (const double t) const
 
RealVector2D xpp (const double t) const
 
void selfDisplay (std::ostream &out) const
 
bool isValid () const
 
- Public Member Functions inherited from DGtal::StarShaped2D< TSpace >
 StarShaped2D ()
 
 ~StarShaped2D ()
 
virtual RealPoint interiorPoint () const
 
Orientation orientation (const RealPoint &p) const
 
RealPoint tangent (double t) const
 
RealPoint normal (double t) const
 
double curvature (double t) const
 
double arclength (double t1, double t2, unsigned int nb) const
 
void selfDisplay (std::ostream &out) const
 
bool isValid () const
 

Protected Member Functions

 Ball2D ()
 

Private Member Functions

Ball2Doperator= (const Ball2D &other)
 

Private Attributes

double myRadius
 
RealPoint2D myCenter
 

Detailed Description

template<typename TSpace>
class DGtal::Ball2D< TSpace >

Aim: Model of the concept StarShaped represents any circle in the plane.

Description of template class 'Ball2D'

Examples:
geometry/curves/estimation/exampleCurvature.cpp, geometry/tools/exampleAlphaShape.cpp, and geometry/tools/exampleConvexHull2D.cpp.

Definition at line 60 of file Ball2D.h.

Member Typedef Documentation

template<typename TSpace>
typedef Space::Point DGtal::Ball2D< TSpace >::Point

Definition at line 66 of file Ball2D.h.

template<typename TSpace>
typedef Space::RealPoint DGtal::Ball2D< TSpace >::RealPoint2D

Definition at line 67 of file Ball2D.h.

template<typename TSpace>
typedef Space::RealVector DGtal::Ball2D< TSpace >::RealVector2D

Definition at line 68 of file Ball2D.h.

template<typename TSpace>
typedef TSpace DGtal::Ball2D< TSpace >::Space

Definition at line 65 of file Ball2D.h.

Constructor & Destructor Documentation

template<typename TSpace>
DGtal::Ball2D< TSpace >::~Ball2D ( )

Destructor.

template<typename TSpace>
DGtal::Ball2D< TSpace >::Ball2D ( const double  x0,
const double  y0,
const double  r 
)

Constructor.

Parameters
x0the x-coordinate of the circle center.
y0the y-coordinate of the circle center.
rthe radius of the circle.
template<typename TSpace>
DGtal::Ball2D< TSpace >::Ball2D ( const RealPoint2D aPoint,
const double  r 
)

Constructor.

Parameters
aPointthe circle center.
rthe radius of the circle.
template<typename TSpace>
DGtal::Ball2D< TSpace >::Ball2D ( const Point aPoint,
const double  r 
)

Constructor.

Parameters
aPointthe circle center.
rthe radius of the circle.
template<typename TSpace>
DGtal::Ball2D< TSpace >::Ball2D ( )
protected

Constructor. Forbidden by default (protected to avoid g++ warnings).

Member Function Documentation

template<typename TSpace>
RealPoint2D DGtal::Ball2D< TSpace >::center ( ) const
inlinevirtual
Returns
the center of the star-shaped object.

Implements DGtal::StarShaped2D< TSpace >.

Definition at line 122 of file Ball2D.h.

References DGtal::Ball2D< TSpace >::myCenter.

123  {
124  return myCenter;
125  }
RealPoint2D myCenter
Definition: Ball2D.h:171
template<typename TSpace>
RealPoint2D DGtal::Ball2D< TSpace >::getLowerBound ( ) const
inlinevirtual
Returns
the lower bound of the shape bounding box.

Implements DGtal::StarShaped2D< TSpace >.

Definition at line 105 of file Ball2D.h.

References DGtal::Ball2D< TSpace >::myCenter, and DGtal::Ball2D< TSpace >::myRadius.

106  {
107  return RealPoint2D(myCenter[0] - myRadius, myCenter[1] - myRadius);
108  }
RealPoint2D myCenter
Definition: Ball2D.h:171
Space::RealPoint RealPoint2D
Definition: Ball2D.h:67
double myRadius
Definition: Ball2D.h:166
template<typename TSpace>
RealPoint2D DGtal::Ball2D< TSpace >::getUpperBound ( ) const
inlinevirtual
Returns
the upper bound of the shape bounding box.

Implements DGtal::StarShaped2D< TSpace >.

Definition at line 114 of file Ball2D.h.

References DGtal::Ball2D< TSpace >::myCenter, and DGtal::Ball2D< TSpace >::myRadius.

115  {
116  return RealPoint2D(myCenter[0] + myRadius, myCenter[1] + myRadius);
117  }
RealPoint2D myCenter
Definition: Ball2D.h:171
Space::RealPoint RealPoint2D
Definition: Ball2D.h:67
double myRadius
Definition: Ball2D.h:166
template<typename TSpace>
bool DGtal::Ball2D< TSpace >::isValid ( ) const

Checks the validity/consistency of the object.

Returns
'true' if the object is valid, 'false' otherwise.
template<typename TSpace>
Ball2D& DGtal::Ball2D< TSpace >::operator= ( const Ball2D< TSpace > &  other)
private

Copy constructor.

Parameters
otherthe object to clone. Forbidden by default. Assignment.
otherthe object to copy.
Returns
a reference on 'this'. Forbidden by default.
template<typename TSpace>
double DGtal::Ball2D< TSpace >::parameter ( const RealPoint2D p) const
virtual
Parameters
pany point in the plane.
Returns
the angle parameter between 0 and 2*Pi corresponding to this point for the shape.

Implements DGtal::StarShaped2D< TSpace >.

template<typename TSpace>
void DGtal::Ball2D< TSpace >::selfDisplay ( std::ostream &  out) const

Writes/Displays the object on an output stream.

Parameters
outthe output stream where the object is written.
template<typename TSpace>
RealPoint2D DGtal::Ball2D< TSpace >::x ( const double  t) const
virtual
Parameters
tany angle between 0 and 2*Pi.
Returns
the vector (x(t),y(t)) which is the position on the shape boundary.

Implements DGtal::StarShaped2D< TSpace >.

template<typename TSpace>
RealVector2D DGtal::Ball2D< TSpace >::xp ( const double  t) const
virtual
Parameters
tany angle between 0 and 2*Pi.
Returns
the vector (x'(t),y'(t)) which is the tangent to the shape boundary.

Implements DGtal::StarShaped2D< TSpace >.

template<typename TSpace>
RealVector2D DGtal::Ball2D< TSpace >::xpp ( const double  t) const
virtual
Parameters
tany angle between 0 and 2*Pi.
Returns
the vector (x''(t),y''(t)).

Implements DGtal::StarShaped2D< TSpace >.

Field Documentation

template<typename TSpace>
RealPoint2D DGtal::Ball2D< TSpace >::myCenter
private
template<typename TSpace>
double DGtal::Ball2D< TSpace >::myRadius
private

Radius of the circle.

Definition at line 166 of file Ball2D.h.

Referenced by DGtal::Ball2D< TSpace >::getLowerBound(), and DGtal::Ball2D< TSpace >::getUpperBound().


The documentation for this class was generated from the following file: