#include <Flower2D.h>

Inheritance diagram for DGtal::Flower2D< TSpace >:

Collaboration diagram for DGtal::Flower2D< TSpace >:

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 Space::RealPoint	RealPoint

Public Member Functions
	~Flower2D ()
	Flower2D (const double x0, const double y0, const double r, const double smallr, const unsigned int k, const double phi)
	Flower2D (const RealPoint2D &aPoint, const double r, const double smallr, const unsigned int k, const double phi)
	Flower2D (const Point &aPoint, const double r, const double smallr, const unsigned int k, const double phi)
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
bool	isInside (const RealPoint &p) const
bool	isInside (const Point &p) 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

Protected Member Functions
	Flower2D ()

Private Member Functions
Flower2D &	operator= (const Flower2D &other)

Private Attributes
RealPoint2D	myCenter
double	myRadius
double	myVarRadius
unsigned int	myK
double	myPhi

Detailed Description

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

Aim: Model of the concept StarShaped represents any flower with k-petals in the plane.

Description of template class 'Flower2D'

NB: A backport from ImaGene.

Definition at line 64 of file Flower2D.h.

Member Typedef Documentation

template<typename TSpace>

typedef Space::Point DGtal::Flower2D< TSpace >::Point

Reimplemented from DGtal::StarShaped2D< TSpace >.

Definition at line 70 of file Flower2D.h.

template<typename TSpace>

typedef Space::RealPoint DGtal::Flower2D< TSpace >::RealPoint2D

Definition at line 71 of file Flower2D.h.

template<typename TSpace>

typedef Space::RealVector DGtal::Flower2D< TSpace >::RealVector2D

Definition at line 72 of file Flower2D.h.

template<typename TSpace>

typedef TSpace DGtal::Flower2D< TSpace >::Space

Reimplemented from DGtal::StarShaped2D< TSpace >.

Definition at line 69 of file Flower2D.h.

Constructor & Destructor Documentation

template<typename T >

DGtal::Flower2D< T >::~Flower2D ( )

inline

Destructor.

Definition at line 48 of file Flower2D.ih.

{

}

template<typename T >

DGtal::Flower2D< T >::Flower2D	(	const double	x0,
		const double	y0,
		const double	r,
		const double	smallr,
		const unsigned int	k,
		const double	phi
	)

inline

Constructor.

Parameters:

x0	the x-coordinate of the flower center.
y0	the y-coordinate of the flower center.
r	the radius of the flower.
varRadius	the variable small radius of the flower.
k	the number of flower extremeties.
phi	the phase of the flower (in radian).

Definition at line 54 of file Flower2D.ih.

: myCenter(x0,y0), myRadius(radius), myVarRadius(varRadius), myK(k),myPhi(phi)

{}

template<typename T >

DGtal::Flower2D< T >::Flower2D	(	const RealPoint2D &	aPoint,
		const double	r,
		const double	smallr,
		const unsigned int	k,
		const double	phi
	)

inline

Constructor.

Parameters:

aPoint	the flower center.
r	the radius of the flower.
smallr	the variable small radius of the flower.
k	the number of flower extremeties.
phi	the phase of the flower (in radian).

Definition at line 63 of file Flower2D.ih.

  : myCenter(aPoint), myRadius(radius), myVarRadius(varRadius), 
    myK(k), myPhi(phi)
{}

template<typename T >

DGtal::Flower2D< T >::Flower2D	(	const Point &	aPoint,
		const double	r,
		const double	smallr,
		const unsigned int	k,
		const double	phi
	)

inline

Constructor.

Parameters:

aPoint	the flower center.
r	the radius of the flower.
smallr	the variable small radius of the flower.
k	the number of flower extremeties.
phi	the phase of the flower (in radian).

Definition at line 72 of file Flower2D.ih.

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

  : myRadius(radius),myVarRadius(varRadius),myK(k),myPhi(phi)
{
  myCenter = aPoint;
}

template<typename TSpace>

DGtal::Flower2D< TSpace >::Flower2D ( )

protected

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

Member Function Documentation

template<typename TSpace>

RealPoint2D DGtal::Flower2D< TSpace >::center ( ) const

inlinevirtual

Returns:: the center of the star-shaped object.

Implements DGtal::StarShaped2D< TSpace >.

Definition at line 146 of file Flower2D.h.

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

    {
      return myCenter;
    }

template<typename TSpace>

RealPoint2D DGtal::Flower2D< TSpace >::getLowerBound ( ) const

inlinevirtual

Returns:: the lower bound of the shape bounding box.

Implements DGtal::StarShaped2D< TSpace >.

Definition at line 129 of file Flower2D.h.

References DGtal::Flower2D< TSpace >::myCenter, DGtal::Flower2D< TSpace >::myRadius, and DGtal::Flower2D< TSpace >::myVarRadius.

    {
      return RealPoint2D(myCenter[0] - myRadius - myVarRadius, myCenter[1] - myRadius - myVarRadius);
    }

template<typename TSpace>

RealPoint2D DGtal::Flower2D< TSpace >::getUpperBound ( ) const

inlinevirtual

Returns:: the upper bound of the shape bounding box.

Implements DGtal::StarShaped2D< TSpace >.

Definition at line 138 of file Flower2D.h.

References DGtal::Flower2D< TSpace >::myCenter, DGtal::Flower2D< TSpace >::myRadius, and DGtal::Flower2D< TSpace >::myVarRadius.

    {
      return RealPoint2D(myCenter[0] + myRadius + myVarRadius, myCenter[1] + myRadius + myVarRadius);
    }

template<typename T >

bool DGtal::Flower2D< T >::isValid ( ) const

inline

Checks the validity/consistency of the object.

Returns:: 'true' if the object is valid, 'false' otherwise.

Reimplemented from DGtal::StarShaped2D< TSpace >.

Definition at line 199 of file Flower2D.ih.

{
    return true;
}

template<typename TSpace>

Flower2D& DGtal::Flower2D< TSpace >::operator= ( const Flower2D< TSpace > & other )

private

Copy constructor.

Parameters:

other	the object to clone. Forbidden by default. Assignment.
other	the object to copy.

Returns:: a reference on 'this'. Forbidden by default.

template<typename T >

double DGtal::Flower2D< T >::parameter ( const RealPoint2D & pp ) const

inlinevirtual

Parameters:

p	any point in the plane.

Returns:: the angle parameter between 0 and 2*Pi corresponding to this point for the shape.

Implements DGtal::StarShaped2D< TSpace >.

Definition at line 92 of file Flower2D.ih.

References M_PI.

{
  RealPoint2D p( pp );
  p -= myCenter;
  
  double angle = 0.0;
  if ( ( p.at( 0 ) == 0.0 ) && ( p.at( 1 ) == 0.0 ) )
    return angle;
/*
  if ( p.at( 0 ) >= p.at( 1 ) )
    {
      if ( p.at( 0 ) >= -p.at( 1 ) )
  angle = atan( p.at( 1 ) / p.at( 0 ) );
      else
  angle = 1.5* M_PI + atan( - p.at( 0 ) / p.at( 1 ) );
    }
  else // ( p.at( 0 ) >= p.at( 1 ) )
    {
      if ( p.at( 0 ) >= -p.at( 1 ) )
  angle = 0.5*M_PI - atan( p.at( 0 ) / p.at( 1 ) );
      else
  angle = M_PI + atan( p.at( 1 ) / p.at( 0 ) );
    }
  angle = ( angle < 0.0 ) ? angle + 2*M_PI : angle;
*/
  angle = atan2( p.at( 1 ), p.at( 0 ) ) + M_PI; 
  return angle;
}

template<typename T >

void DGtal::Flower2D< T >::selfDisplay ( std::ostream & out ) const

inline

Writes/Displays the object on an output stream.

Parameters:

out	the output stream where the object is written.

Reimplemented from DGtal::StarShaped2D< TSpace >.

Definition at line 186 of file Flower2D.ih.

{
  out << "[Flower2D] center= "<<myCenter<<" radius="<<myRadius<<" varRadius="<<myVarRadius
      <<" myK="<<myK<<" phase-shift="<<myPhi;
}

template<typename T >

DGtal::Flower2D< T >::RealPoint2D DGtal::Flower2D< T >::x ( const double t ) const

inlinevirtual

Parameters:

t	any 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 >.

Definition at line 131 of file Flower2D.ih.

{
  double r= myRadius+ myVarRadius*cos(myK*t + myPhi);
  RealPoint2D c( r*cos(t), r*sin(t) );
  c += myCenter;
  return c;
}

template<typename T >

DGtal::Flower2D< T >::RealVector2D DGtal::Flower2D< T >::xp ( const double t ) const

inlinevirtual

Parameters:

t	any 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 >.

Definition at line 149 of file Flower2D.ih.

{
  double r= myRadius+ myVarRadius*cos(myK*t + myPhi);
  double rp = - myVarRadius * sin( myK * t + myPhi ) * myK;
  RealVector2D c( rp*cos(t) - r*sin(t),rp*sin(t) + r*cos(t) );
  return c;
}

template<typename T >

DGtal::Flower2D< T >::RealVector2D DGtal::Flower2D< T >::xpp ( const double t ) const

inlinevirtual

Parameters:

t	any angle between 0 and 2*Pi.

Returns:: the vector (x''(t),y''(t)).

Implements DGtal::StarShaped2D< TSpace >.

Definition at line 165 of file Flower2D.ih.

{
  double r= myRadius+ myVarRadius*cos(myK*t + myPhi);
  double rp = - myVarRadius * sin( myK * t + myPhi ) * myK;
  double rpp = - myVarRadius * cos( myK * t + myPhi ) * myK * myK;
  RealVector2D c(rpp * cos( t ) - 2 * rp * sin( t ) - r * cos( t ),
     rpp * sin( t ) + 2 * rp * cos( t ) - r * sin( t ) );
  return c;
}

Field Documentation

template<typename TSpace>

RealPoint2D DGtal::Flower2D< TSpace >::myCenter

private

Center of the flower.

Definition at line 190 of file Flower2D.h.

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

template<typename TSpace>

unsigned int DGtal::Flower2D< TSpace >::myK

private

the number of flower extremeties.

Definition at line 205 of file Flower2D.h.

template<typename TSpace>

double DGtal::Flower2D< TSpace >::myPhi

private

the phase of the flower (in radian).

Definition at line 210 of file Flower2D.h.

template<typename TSpace>

double DGtal::Flower2D< TSpace >::myRadius

private

Radius of the flower.

Definition at line 195 of file Flower2D.h.

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

template<typename TSpace>

double DGtal::Flower2D< TSpace >::myVarRadius

private

the variable small radius of the flower.

Definition at line 200 of file Flower2D.h.

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

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

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation

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