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

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

Inheritance diagram for DGtal::Flower2D< TSpace >:

Public Types
typedef TSpace	Space

typedef Space::RealPoint	RealPoint

typedef Space::RealVector	RealVector

Public Types inherited from DGtal::StarShaped2D< TSpace >
typedef TSpace	Space

typedef Space::RealPoint	RealPoint

Public Member Functions
	Flower2D ()=delete

	Flower2D (const double x0, const double y0, const double r, const double smallr, const unsigned int k, const double phi)

	Flower2D (const RealPoint &aPoint, const double r, const double smallr, const unsigned int k, const double phi)

	Flower2D (const Flower2D &other)

Flower2D &	operator= (const Flower2D &other)=delete

	~Flower2D ()=default

RealPoint	getLowerBound () const

RealPoint	getUpperBound () const

RealPoint	center () const

void	moveTo (const RealPoint &newCenter)

double	parameter (const RealPoint &p) const

RealPoint	x (const double t) const

RealVector	xp (const double t) const

RealVector	xpp (const double t) const

void	selfDisplay (std::ostream &out) const

bool	isValid () const

Public Member Functions inherited from DGtal::StarShaped2D< TSpace >
	StarShaped2D ()=default

	StarShaped2D (const StarShaped2D &other)=delete

StarShaped2D &	operator= (const StarShaped2D &other)=delete

virtual	~StarShaped2D ()=default

virtual RealPoint	interiorPoint () const

Orientation	orientation (const RealPoint &p) const

RealPoint	tangent (const double t) const

RealPoint	normal (const double t) const

double	curvature (const double t) const

double	arclength (const double t1, double t2, const unsigned int nb) const

RealPoint	findIntersection (const RealPoint &inner, const RealPoint &outer, const double epsilon) const

RealPoint	closestPointWithWitnesses (const RealPoint &p, const RealPoint &left, const RealPoint &right, const int step) const

void	selfDisplay (std::ostream &out) const

bool	isValid () const

Private Attributes
RealPoint	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.

Examples: geometry/curves/estimation/exampleCurvature.cpp, and topology/digitalSetToCubicalComplexes2D.cpp.

Definition at line 64 of file Flower2D.h.

Member Typedef Documentation

◆ RealPoint

template<typename TSpace >

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

Definition at line 70 of file Flower2D.h.

◆ RealVector

template<typename TSpace >

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

Definition at line 71 of file Flower2D.h.

◆ Space

template<typename TSpace >

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

Definition at line 69 of file Flower2D.h.

Constructor & Destructor Documentation

◆ Flower2D() [1/4]

template<typename TSpace >

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

delete

Constructor. Forbidden by default.

◆ Flower2D() [2/4]

template<typename TSpace >

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

Constructor.

Parameters

x0	the x-coordinate of the flower center.
y0	the y-coordinate of 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).

◆ Flower2D() [3/4]

template<typename TSpace >

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

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).

◆ Flower2D() [4/4]

template<typename TSpace >

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

Copy constructor.

Parameters

other the object to clone.

◆ ~Flower2D()

template<typename TSpace >

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

default

Destructor.

Member Function Documentation

◆ center()

template<typename TSpace >

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

inlinevirtual

Returns: the center of the star-shaped object.

Implements DGtal::StarShaped2D< TSpace >.

Definition at line 152 of file Flower2D.h.

    {
      return myCenter;
    }

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

◆ getLowerBound()

template<typename TSpace >

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

inlinevirtual

Returns: the lower bound of the shape bounding box.

Implements DGtal::StarShaped2D< TSpace >.

Definition at line 135 of file Flower2D.h.

    {
      return myCenter - (myRadius + myVarRadius);
    }

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

◆ getUpperBound()

template<typename TSpace >

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

inlinevirtual

Returns: the upper bound of the shape bounding box.

Implements DGtal::StarShaped2D< TSpace >.

Definition at line 144 of file Flower2D.h.

    {
      return myCenter + (myRadius + myVarRadius);
    }

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

◆ isValid()

template<typename TSpace >

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

Checks the validity/consistency of the object.

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

◆ moveTo()

template<typename TSpace >

void DGtal::Flower2D< TSpace >::moveTo ( const RealPoint & newCenter )

inlinevirtual

Modify the shape center

Parameters

newCenter the new center position

Implements DGtal::StarShaped2D< TSpace >.

Definition at line 162 of file Flower2D.h.

    {
      myCenter = newCenter;
    }

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

◆ operator=()

template<typename TSpace >

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

delete

Assignment.

Parameters

other the object to copy.

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

◆ parameter()

template<typename TSpace >

double DGtal::Flower2D< TSpace >::parameter ( const RealPoint & p ) const

virtual

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

◆ selfDisplay()

template<typename TSpace >

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

Writes/Displays the object on an output stream.

Parameters

out	the output stream where the object is written.

◆ x()

template<typename TSpace >

RealPoint DGtal::Flower2D< TSpace >::x ( const double t ) const

virtual

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

◆ xp()

template<typename TSpace >

RealVector DGtal::Flower2D< TSpace >::xp ( const double t ) const

virtual

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

◆ xpp()

template<typename TSpace >

RealVector DGtal::Flower2D< TSpace >::xpp ( const double t ) const

virtual

Parameters

t	any angle between 0 and 2*Pi.

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

Implements DGtal::StarShaped2D< TSpace >.

Field Documentation

◆ myCenter

template<typename TSpace >

RealPoint DGtal::Flower2D< TSpace >::myCenter

private

Center of the flower.

Definition at line 206 of file Flower2D.h.

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

◆ myK

template<typename TSpace >

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

private

the number of flower extremeties.

Definition at line 221 of file Flower2D.h.

◆ myPhi

template<typename TSpace >

double DGtal::Flower2D< TSpace >::myPhi

private

the phase of the flower (in radian).

Definition at line 226 of file Flower2D.h.

◆ myRadius

template<typename TSpace >

double DGtal::Flower2D< TSpace >::myRadius

private

Radius of the flower.

Definition at line 211 of file Flower2D.h.

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

◆ myVarRadius

template<typename TSpace >

double DGtal::Flower2D< TSpace >::myVarRadius

private

the variable small radius of the flower.

Definition at line 216 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 file:

Flower2D.h

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ RealPoint

◆ RealVector

◆ Space

Constructor & Destructor Documentation

◆ Flower2D() [1/4]

◆ Flower2D() [2/4]

◆ Flower2D() [3/4]

◆ Flower2D() [4/4]

◆ ~Flower2D()

Member Function Documentation

◆ center()

◆ getLowerBound()

◆ getUpperBound()

◆ isValid()

◆ moveTo()

◆ operator=()

◆ parameter()

◆ selfDisplay()

◆ x()

◆ xp()

◆ xpp()

Field Documentation

◆ myCenter

◆ myK

◆ myPhi

◆ myRadius

◆ myVarRadius