DGtal::CanonicDigitalSurfaceEmbedder< TDigitalSurface > Struct Template Reference

Aim: A trivial embedder for digital surfaces, which corresponds to the canonic injection of cell centroids into Rn. More...

#include <DGtal/topology/CanonicDigitalSurfaceEmbedder.h>

Public Types
typedef CanonicDigitalSurfaceEmbedder< TDigitalSurface >	Self
typedef TDigitalSurface	Surface
typedef Surface::KSpace	KSpace
typedef KSpace::SCell	SCell
typedef KSpace::Space	Space
typedef Space::RealPoint	RealPoint
typedef SCell	Argument
typedef RealPoint	Value
typedef Space::Integer	Integer
typedef Space::Point	Point

Public Member Functions
	BOOST_CONCEPT_ASSERT ((concepts::CCellularGridSpaceND< KSpace >))
	~CanonicDigitalSurfaceEmbedder ()
	CanonicDigitalSurfaceEmbedder ()
	CanonicDigitalSurfaceEmbedder (ConstAlias< Surface > aSurface)
	CanonicDigitalSurfaceEmbedder (const Self &other)
Self &	operator= (const Self &other)
const KSpace &	space () const
const Surface &	surface () const
RealPoint	embed (const SCell &cell) const
RealPoint	operator() (const SCell &cell) const
void	selfDisplay (std::ostream &out) const
bool	isValid () const

Protected Attributes
const Surface *	mySurface

Detailed Description

template<typename TDigitalSurface>
struct DGtal::CanonicDigitalSurfaceEmbedder< TDigitalSurface >

Aim: A trivial embedder for digital surfaces, which corresponds to the canonic injection of cell centroids into Rn.

Description of class 'CanonicDigitalSurfaceEmbedder'

Model of CCanonicDigitalSurfaceEmbedder (and thus of CSCellEmbedder).

Template Parameters

TDigitalSurface

the type of digital surface where the embedder works.

Definition at line 65 of file CanonicDigitalSurfaceEmbedder.h.

Member Typedef Documentation

Argument

template<typename TDigitalSurface >

typedef SCell DGtal::CanonicDigitalSurfaceEmbedder< TDigitalSurface >::Argument

Definition at line 76 of file CanonicDigitalSurfaceEmbedder.h.

Integer

template<typename TDigitalSurface >

typedef Space::Integer DGtal::CanonicDigitalSurfaceEmbedder< TDigitalSurface >::Integer

Definition at line 79 of file CanonicDigitalSurfaceEmbedder.h.

KSpace

template<typename TDigitalSurface >

typedef Surface::KSpace DGtal::CanonicDigitalSurfaceEmbedder< TDigitalSurface >::KSpace

Definition at line 71 of file CanonicDigitalSurfaceEmbedder.h.

Point

template<typename TDigitalSurface >

typedef Space::Point DGtal::CanonicDigitalSurfaceEmbedder< TDigitalSurface >::Point

Definition at line 80 of file CanonicDigitalSurfaceEmbedder.h.

RealPoint

template<typename TDigitalSurface >

typedef Space::RealPoint DGtal::CanonicDigitalSurfaceEmbedder< TDigitalSurface >::RealPoint

Definition at line 75 of file CanonicDigitalSurfaceEmbedder.h.

SCell

template<typename TDigitalSurface >

typedef KSpace::SCell DGtal::CanonicDigitalSurfaceEmbedder< TDigitalSurface >::SCell

Definition at line 73 of file CanonicDigitalSurfaceEmbedder.h.

Self

template<typename TDigitalSurface >

typedef CanonicDigitalSurfaceEmbedder<TDigitalSurface> DGtal::CanonicDigitalSurfaceEmbedder< TDigitalSurface >::Self

Definition at line 68 of file CanonicDigitalSurfaceEmbedder.h.

Space

template<typename TDigitalSurface >

typedef KSpace::Space DGtal::CanonicDigitalSurfaceEmbedder< TDigitalSurface >::Space

Definition at line 74 of file CanonicDigitalSurfaceEmbedder.h.

Surface

template<typename TDigitalSurface >

typedef TDigitalSurface DGtal::CanonicDigitalSurfaceEmbedder< TDigitalSurface >::Surface

Definition at line 70 of file CanonicDigitalSurfaceEmbedder.h.

Value

template<typename TDigitalSurface >

typedef RealPoint DGtal::CanonicDigitalSurfaceEmbedder< TDigitalSurface >::Value

Definition at line 77 of file CanonicDigitalSurfaceEmbedder.h.

Constructor & Destructor Documentation

~CanonicDigitalSurfaceEmbedder()

template<typename TDigitalSurface >

DGtal::CanonicDigitalSurfaceEmbedder< TDigitalSurface >::~CanonicDigitalSurfaceEmbedder

(

)

Destructor. Nothing special.

CanonicDigitalSurfaceEmbedder() [1/3]

template<typename TDigitalSurface >

DGtal::CanonicDigitalSurfaceEmbedder< TDigitalSurface >::CanonicDigitalSurfaceEmbedder

(

)

Default constructor. The object is not valid.

CanonicDigitalSurfaceEmbedder() [2/3]

template<typename TDigitalSurface >

DGtal::CanonicDigitalSurfaceEmbedder< TDigitalSurface >::CanonicDigitalSurfaceEmbedder

(

ConstAlias< Surface >

aSurface

)

Constructor from surface.

CanonicDigitalSurfaceEmbedder() [3/3]

template<typename TDigitalSurface >

DGtal::CanonicDigitalSurfaceEmbedder< TDigitalSurface >::CanonicDigitalSurfaceEmbedder

(

const Self &

other

)

Copy constructor.

Parameters

other

the object to clone.

Member Function Documentation

BOOST_CONCEPT_ASSERT()

template<typename TDigitalSurface >

DGtal::CanonicDigitalSurfaceEmbedder< TDigitalSurface >::BOOST_CONCEPT_ASSERT

(

(concepts::CCellularGridSpaceND< KSpace >)

)

embed()

template<typename TDigitalSurface >

RealPoint DGtal::CanonicDigitalSurfaceEmbedder< TDigitalSurface >::embed

(

const SCell &

cell

)

const

Map a signed cell to its corresponding point in the Euclidean space.

Parameters

cell	any signed cell in the digital space.

Returns

its canconical embedding in the Euclidean space.

isValid()

template<typename TDigitalSurface >

bool DGtal::CanonicDigitalSurfaceEmbedder< TDigitalSurface >::isValid

(

)

const

Checks the validity/consistency of the object.

Returns

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

operator()()

template<typename TDigitalSurface >

RealPoint DGtal::CanonicDigitalSurfaceEmbedder< TDigitalSurface >::operator()

(

const SCell &

cell

)

const

Map a signed cell to its corresponding point in the Euclidean space.

Parameters

cell	any signed cell in the digital space.

Returns

its canconical embedding in the Euclidean space.

operator=()

template<typename TDigitalSurface >

Self & DGtal::CanonicDigitalSurfaceEmbedder< TDigitalSurface >::operator=

(

const Self &

other

)

Assignment.

Parameters

other

the object to clone.

Returns

a reference to 'this'.

selfDisplay()

template<typename TDigitalSurface >

void DGtal::CanonicDigitalSurfaceEmbedder< TDigitalSurface >::selfDisplay

(

std::ostream &

out

)

const

Writes/Displays the object on an output stream.

Parameters

out	the output stream where the object is written.

space()

template<typename TDigitalSurface >

const KSpace & DGtal::CanonicDigitalSurfaceEmbedder< TDigitalSurface >::space ( ) const

inline

Returns

the Khalimsky space.

Definition at line 115 of file CanonicDigitalSurfaceEmbedder.h.

    {
      return mySurface->container().space();
    }

References DGtal::CanonicDigitalSurfaceEmbedder< TDigitalSurface >::mySurface.

surface()

template<typename TDigitalSurface >

const Surface & DGtal::CanonicDigitalSurfaceEmbedder< TDigitalSurface >::surface

(

)

const

Returns

the digital surface.

Field Documentation

mySurface

template<typename TDigitalSurface >

const Surface* DGtal::CanonicDigitalSurfaceEmbedder< TDigitalSurface >::mySurface

protected

Definition at line 162 of file CanonicDigitalSurfaceEmbedder.h.

Referenced by DGtal::CanonicDigitalSurfaceEmbedder< TDigitalSurface >::space().

---

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

• CanonicDigitalSurfaceEmbedder.h