DGtal  0.9.3beta
Public Types | Public Member Functions | Protected Attributes
DGtal::CanonicCellEmbedder< TKSpace > Struct Template Reference

#include <DGtal/topology/CanonicCellEmbedder.h>

Public Types

typedef CanonicCellEmbedder< TKSpace > Self
 
typedef TKSpace KSpace
 
typedef KSpace::Cell Cell
 
typedef KSpace::Space Space
 
typedef Space::RealPoint RealPoint
 
typedef Cell Argument
 
typedef RealPoint Value
 
typedef Space::Integer Integer
 
typedef Space::Point Point
 

Public Member Functions

 BOOST_CONCEPT_ASSERT ((concepts::CPreCellularGridSpaceND< TKSpace >))
 
 ~CanonicCellEmbedder ()
 
 CanonicCellEmbedder ()
 
 CanonicCellEmbedder (ConstAlias< KSpace > aKSpace)
 
 CanonicCellEmbedder (const Self &other)
 
Selfoperator= (const Self &other)
 
const KSpacespace () const
 
RealPoint embed (const Cell &cell) const
 
RealPoint operator() (const Cell &cell) const
 
void selfDisplay (std::ostream &out) const
 
bool isValid () const
 

Protected Attributes

const KSpacemyKSpace
 

Detailed Description

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

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

Description of class 'CanonicCellEmbedder'

Model of CCellEmbedder.

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

Definition at line 65 of file CanonicCellEmbedder.h.

Member Typedef Documentation

template<typename TKSpace >
typedef Cell DGtal::CanonicCellEmbedder< TKSpace >::Argument

Definition at line 75 of file CanonicCellEmbedder.h.

template<typename TKSpace >
typedef KSpace::Cell DGtal::CanonicCellEmbedder< TKSpace >::Cell

Definition at line 72 of file CanonicCellEmbedder.h.

template<typename TKSpace >
typedef Space::Integer DGtal::CanonicCellEmbedder< TKSpace >::Integer

Definition at line 78 of file CanonicCellEmbedder.h.

template<typename TKSpace >
typedef TKSpace DGtal::CanonicCellEmbedder< TKSpace >::KSpace

Definition at line 71 of file CanonicCellEmbedder.h.

template<typename TKSpace >
typedef Space::Point DGtal::CanonicCellEmbedder< TKSpace >::Point

Definition at line 79 of file CanonicCellEmbedder.h.

template<typename TKSpace >
typedef Space::RealPoint DGtal::CanonicCellEmbedder< TKSpace >::RealPoint

Definition at line 74 of file CanonicCellEmbedder.h.

template<typename TKSpace >
typedef CanonicCellEmbedder<TKSpace> DGtal::CanonicCellEmbedder< TKSpace >::Self

Definition at line 68 of file CanonicCellEmbedder.h.

template<typename TKSpace >
typedef KSpace::Space DGtal::CanonicCellEmbedder< TKSpace >::Space

Definition at line 73 of file CanonicCellEmbedder.h.

template<typename TKSpace >
typedef RealPoint DGtal::CanonicCellEmbedder< TKSpace >::Value

Definition at line 76 of file CanonicCellEmbedder.h.

Constructor & Destructor Documentation

template<typename TKSpace >
DGtal::CanonicCellEmbedder< TKSpace >::~CanonicCellEmbedder ( )

Destructor. Nothing special.

template<typename TKSpace >
DGtal::CanonicCellEmbedder< TKSpace >::CanonicCellEmbedder ( )

Default constructor. The object is not valid.

template<typename TKSpace >
DGtal::CanonicCellEmbedder< TKSpace >::CanonicCellEmbedder ( ConstAlias< KSpace aKSpace)

Constructor from space.

template<typename TKSpace >
DGtal::CanonicCellEmbedder< TKSpace >::CanonicCellEmbedder ( const Self other)

Copy constructor.

Parameters
otherthe object to clone.

Member Function Documentation

template<typename TKSpace >
DGtal::CanonicCellEmbedder< TKSpace >::BOOST_CONCEPT_ASSERT ( (concepts::CPreCellularGridSpaceND< TKSpace >)  )
template<typename TKSpace >
RealPoint DGtal::CanonicCellEmbedder< TKSpace >::embed ( const Cell cell) const

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

Parameters
cellany unsigned cell in the digital space.
Returns
its canonical embedding in the Euclidean space.
template<typename TKSpace >
bool DGtal::CanonicCellEmbedder< TKSpace >::isValid ( ) const

Checks the validity/consistency of the object.

Returns
'true' if the object is valid, 'false' otherwise.
template<typename TKSpace >
RealPoint DGtal::CanonicCellEmbedder< TKSpace >::operator() ( const Cell cell) const

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

Parameters
cellany unsigned cell in the digital space.
Returns
its canonical embedding in the Euclidean space.
template<typename TKSpace >
Self& DGtal::CanonicCellEmbedder< TKSpace >::operator= ( const Self other)

Assignment.

Parameters
otherthe object to clone.
Returns
a reference to 'this'.
template<typename TKSpace >
void DGtal::CanonicCellEmbedder< TKSpace >::selfDisplay ( std::ostream &  out) const

Writes/Displays the object on an output stream.

Parameters
outthe output stream where the object is written.
template<typename TKSpace >
const KSpace& DGtal::CanonicCellEmbedder< TKSpace >::space ( ) const
Returns
the cellular grid space.

Field Documentation

template<typename TKSpace >
const KSpace* DGtal::CanonicCellEmbedder< TKSpace >::myKSpace
protected

Definition at line 151 of file CanonicCellEmbedder.h.


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