DGtal::CanonicSCellEmbedder< TKSpace > Struct Template Reference

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

#include <DGtal/topology/CanonicSCellEmbedder.h>

Public Types
typedef CanonicSCellEmbedder< TKSpace >	Self
typedef TKSpace	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::CPreCellularGridSpaceND< TKSpace >))
	~CanonicSCellEmbedder ()
	CanonicSCellEmbedder ()
	CanonicSCellEmbedder (ConstAlias< KSpace > aKSpace)
	CanonicSCellEmbedder (const Self &other)
Self &	operator= (const Self &other)
const KSpace &	space () const
RealPoint	embed (const SCell &cell) const
RealPoint	operator() (const SCell &cell) const
bool	isValid () const

Protected Attributes
const KSpace *	myKSpace

Detailed Description

template<typename TKSpace>
struct DGtal::CanonicSCellEmbedder< TKSpace >

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

Description of class 'CanonicSCellEmbedder'

Model of CSCellEmbedder.

Template Parameters

TKSpace

the type of cellular grid space where the embedder works, a model of CPreCellularGridSpaceND.

Examples

dec/exampleHeatLaplace.cpp, and graph/volDistanceTraversal.cpp.

Definition at line 65 of file CanonicSCellEmbedder.h.

Member Typedef Documentation

Argument

template<typename TKSpace >

typedef SCell DGtal::CanonicSCellEmbedder< TKSpace >::Argument

Definition at line 75 of file CanonicSCellEmbedder.h.

Integer

template<typename TKSpace >

typedef Space::Integer DGtal::CanonicSCellEmbedder< TKSpace >::Integer

Definition at line 78 of file CanonicSCellEmbedder.h.

KSpace

template<typename TKSpace >

typedef TKSpace DGtal::CanonicSCellEmbedder< TKSpace >::KSpace

Definition at line 71 of file CanonicSCellEmbedder.h.

Point

template<typename TKSpace >

typedef Space::Point DGtal::CanonicSCellEmbedder< TKSpace >::Point

Definition at line 79 of file CanonicSCellEmbedder.h.

RealPoint

template<typename TKSpace >

typedef Space::RealPoint DGtal::CanonicSCellEmbedder< TKSpace >::RealPoint

Definition at line 74 of file CanonicSCellEmbedder.h.

SCell

template<typename TKSpace >

typedef KSpace::SCell DGtal::CanonicSCellEmbedder< TKSpace >::SCell

Definition at line 72 of file CanonicSCellEmbedder.h.

Self

template<typename TKSpace >

typedef CanonicSCellEmbedder<TKSpace> DGtal::CanonicSCellEmbedder< TKSpace >::Self

Definition at line 68 of file CanonicSCellEmbedder.h.

Space

template<typename TKSpace >

typedef KSpace::Space DGtal::CanonicSCellEmbedder< TKSpace >::Space

Definition at line 73 of file CanonicSCellEmbedder.h.

Value

template<typename TKSpace >

typedef RealPoint DGtal::CanonicSCellEmbedder< TKSpace >::Value

Definition at line 76 of file CanonicSCellEmbedder.h.

Constructor & Destructor Documentation

~CanonicSCellEmbedder()

template<typename TKSpace >

DGtal::CanonicSCellEmbedder< TKSpace >::~CanonicSCellEmbedder

(

)

Destructor. Nothing special.

CanonicSCellEmbedder() [1/3]

template<typename TKSpace >

DGtal::CanonicSCellEmbedder< TKSpace >::CanonicSCellEmbedder

(

)

Default constructor. The object is not valid.

CanonicSCellEmbedder() [2/3]

template<typename TKSpace >

DGtal::CanonicSCellEmbedder< TKSpace >::CanonicSCellEmbedder

(

ConstAlias< KSpace >

aKSpace

)

Constructor from space.

CanonicSCellEmbedder() [3/3]

template<typename TKSpace >

DGtal::CanonicSCellEmbedder< TKSpace >::CanonicSCellEmbedder

(

const Self &

other

)

Copy constructor.

Parameters

other

the object to clone.

Member Function Documentation

BOOST_CONCEPT_ASSERT()

template<typename TKSpace >

DGtal::CanonicSCellEmbedder< TKSpace >::BOOST_CONCEPT_ASSERT

(

(concepts::CPreCellularGridSpaceND< TKSpace >)

)

embed()

template<typename TKSpace >

RealPoint DGtal::CanonicSCellEmbedder< TKSpace >::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 canonical embedding in the Euclidean space.

isValid()

template<typename TKSpace >

bool DGtal::CanonicSCellEmbedder< TKSpace >::isValid

(

)

const

Checks the validity/consistency of the object.

Returns

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

operator()()

template<typename TKSpace >

RealPoint DGtal::CanonicSCellEmbedder< TKSpace >::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 canonical embedding in the Euclidean space.

operator=()

template<typename TKSpace >

Self & DGtal::CanonicSCellEmbedder< TKSpace >::operator=

(

const Self &

other

)

Assignment.

Parameters

other

the object to clone.

Returns

a reference to 'this'.

space()

template<typename TKSpace >

const KSpace & DGtal::CanonicSCellEmbedder< TKSpace >::space

(

)

const

Returns

the cellular grid space.

Field Documentation

myKSpace

template<typename TKSpace >

const KSpace* DGtal::CanonicSCellEmbedder< TKSpace >::myKSpace

protected

Definition at line 151 of file CanonicSCellEmbedder.h.

---

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

• CanonicSCellEmbedder.h