#include <ImplicitHyperCube.h>

Public Types
typedef ImplicitHyperCube< TSpace >	Self
typedef TSpace	Space
typedef Space::RealPoint	RealPoint
typedef double	Value

Public Member Functions
	ImplicitHyperCube (const RealPoint &aCenter, const double &aHalfWidth)
	~ImplicitHyperCube ()
double	operator() (const RealPoint &aPoint) const
bool	isInside (const RealPoint &aPoint) const
Orientation	orientation (const RealPoint &aPoint) const
RealPoint	getLowerBound () const
RealPoint	getUpperBound () const
void	selfDisplay (std::ostream &out) const
bool	isValid () const

Protected Member Functions
	ImplicitHyperCube ()

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

Private Attributes
RealPoint	myCenter
double	myHalfWidth

Detailed Description

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

Aim: model of CEuclideanOrientedShape and CEuclideanBoundedShape concepts to create an hypercube in nD..

Description of template class 'ImplicitHyperCube'

Template Parameters:

TSpace the Digital space definition.

Definition at line 59 of file ImplicitHyperCube.h.

Member Typedef Documentation

template<typename TSpace>

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

Definition at line 65 of file ImplicitHyperCube.h.

template<typename TSpace>

typedef ImplicitHyperCube<TSpace> DGtal::ImplicitHyperCube< TSpace >::Self

Definition at line 63 of file ImplicitHyperCube.h.

template<typename TSpace>

typedef TSpace DGtal::ImplicitHyperCube< TSpace >::Space

Definition at line 64 of file ImplicitHyperCube.h.

template<typename TSpace>

typedef double DGtal::ImplicitHyperCube< TSpace >::Value

Definition at line 66 of file ImplicitHyperCube.h.

Constructor & Destructor Documentation

template<typename TSpace>

DGtal::ImplicitHyperCube< TSpace >::ImplicitHyperCube	(	const RealPoint &	aCenter,
		const double &	aHalfWidth
	)

inline

Constructor. Contructs a ball with center aCenter and width aWidth.

Parameters:

aCenter	the cube center.
aHalfWidth	the cube half-width.

Definition at line 75 of file ImplicitHyperCube.h.

                                                                         : 
      myCenter(aCenter),
      myHalfWidth(aHalfWidth)
    {};

template<typename T >

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

inline

Destructor.

Definition at line 46 of file ImplicitHyperCube.ih.

{

}

template<typename TSpace>

DGtal::ImplicitHyperCube< TSpace >::ImplicitHyperCube ( )

protected

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

Member Function Documentation

template<typename TSpace>

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

inline

Returns the lower bound of the Shape bounding box.

Returns:: the lower bound point.

Definition at line 137 of file ImplicitHyperCube.h.

References DGtal::ImplicitHyperCube< TSpace >::myCenter, and DGtal::ImplicitHyperCube< TSpace >::myHalfWidth.

    {
      return (myCenter - RealPoint::diagonal(myHalfWidth));
    }

template<typename TSpace>

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

inline

Returns the upper bound of the Shape bounding box.

Returns:: the upper bound point.

Definition at line 149 of file ImplicitHyperCube.h.

References DGtal::ImplicitHyperCube< TSpace >::myCenter, and DGtal::ImplicitHyperCube< TSpace >::myHalfWidth.

    {
      return (myCenter + RealPoint::diagonal(myHalfWidth)); 
    }

template<typename TSpace>

bool DGtal::ImplicitHyperCube< TSpace >::isInside ( const RealPoint & aPoint ) const

inline

Return true if the given point belongs to the shape.

Parameters:

aPoint the point to evalute the function at.

Returns:: the distance of aPoint to the ball center.

Definition at line 112 of file ImplicitHyperCube.h.

References DGtal::ImplicitHyperCube< TSpace >::operator()().

    {
      return this->operator()(aPoint) >0.0;
    }

template<typename T >

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

inline

Checks the validity/consistency of the object.

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

Definition at line 72 of file ImplicitHyperCube.ih.

{
    return true;
}

template<typename TSpace>

double DGtal::ImplicitHyperCube< TSpace >::operator() ( const RealPoint & aPoint ) const

inline

Operator() of the implicit function. Given a point, it returns the function value at p. In Shapes, positive values are used to construct a set.

Parameters:

aRealPoint the point to evalute the function at.

Returns:: the distance of aPoint to the ball center.

Definition at line 99 of file ImplicitHyperCube.h.

References DGtal::ImplicitHyperCube< TSpace >::myCenter, and DGtal::ImplicitHyperCube< TSpace >::myHalfWidth.

Referenced by DGtal::ImplicitHyperCube< TSpace >::isInside().

    {
      return  myHalfWidth - (aPoint - myCenter ).norm(RealPoint::L_infty);
    }

template<typename TSpace>

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

private

Assignment.

Parameters:

other the object to copy.

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

template<typename TSpace>

Orientation DGtal::ImplicitHyperCube< TSpace >::orientation ( const RealPoint & aPoint ) const

inline

Definition at line 119 of file ImplicitHyperCube.h.

References DGtal::INSIDE, DGtal::ON, and DGtal::OUTSIDE.

    {
      if (this->operator()(aPoint) > 0.0)
        return INSIDE;
      else
        if (this->operator()(aPoint) < 0.0)
          return OUTSIDE;
        else
          return ON;
    }

template<typename T >

void DGtal::ImplicitHyperCube< 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.

Definition at line 60 of file ImplicitHyperCube.ih.

{
  out << "[ImplicitHyperCube] center="<<myCenter<<" halfwidth="<<myHalfWidth;
}

Field Documentation

template<typename TSpace>

RealPoint DGtal::ImplicitHyperCube< TSpace >::myCenter

private

Ball center.

Definition at line 176 of file ImplicitHyperCube.h.

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

template<typename TSpace>

double DGtal::ImplicitHyperCube< TSpace >::myHalfWidth

private

Ball HalfWidth.

Definition at line 179 of file ImplicitHyperCube.h.

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

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::ImplicitHyperCube< TSpace >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation

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