DGtal  1.4.beta
Public Types | Public Member Functions | Private Attributes
DGtal::concepts::CDigitalSurfaceEmbedder< T > Struct Template Reference

Aim: A digital surface embedder is a specialized mapping from signed cells to Euclidean points. It adds inner types to functor as well as a method to access the digital surface. More...

#include <DGtal/topology/CDigitalSurfaceEmbedder.h>

Inheritance diagram for DGtal::concepts::CDigitalSurfaceEmbedder< T >:
[legend]

Public Types

typedef T::KSpace KSpace
 
typedef T::Surface Surface
 
typedef T::SCell SCell
 
typedef T::RealPoint RealPoint
 
typedef T::Argument Argument
 
typedef T::Value Value
 
- Public Types inherited from DGtal::concepts::CSCellEmbedder< T >
typedef T::KSpace KSpace
 
typedef T::SCell SCell
 
typedef T::RealPoint RealPoint
 
typedef T::Argument Argument
 
typedef T::Value Value
 

Public Member Functions

 BOOST_CONCEPT_USAGE (CDigitalSurfaceEmbedder)
 
void checkConstConstraints () const
 
- Public Member Functions inherited from DGtal::concepts::CSCellEmbedder< T >
 BOOST_CONCEPT_ASSERT ((concepts::CCellularGridSpaceND< KSpace >))
 
 BOOST_STATIC_ASSERT ((ConceptUtils::SameType< SCell, typename KSpace::SCell >::value))
 
 BOOST_STATIC_ASSERT ((ConceptUtils::SameType< SCell, Argument >::value))
 
 BOOST_STATIC_ASSERT ((ConceptUtils::SameType< RealPoint, Value >::value))
 
 BOOST_CONCEPT_USAGE (CSCellEmbedder)
 
void checkConstConstraints () const
 
- Public Member Functions inherited from DGtal::concepts::CUnaryFunctor< T, T::SCell, T::RealPoint >
 BOOST_CONCEPT_USAGE (CUnaryFunctor)
 

Private Attributes

myX
 
Surface mySurface
 

Detailed Description

template<typename T>
struct DGtal::concepts::CDigitalSurfaceEmbedder< T >

Aim: A digital surface embedder is a specialized mapping from signed cells to Euclidean points. It adds inner types to functor as well as a method to access the digital surface.

Description of concept 'CDigitalSurfaceEmbedder'

Refinement of

Associated types

Notation

Definitions

Valid expressions and semantics

Name Expression Type requirements Return type Precondition Semantics Post condition Complexity
Apply function x(p) Value return the value of the function x on argument p
Accessor to surface x.surface() Surface return the associated digital surface

Invariants

Models

Notes

Template Parameters
Tthe type that should be a model of CDigitalSurfaceEmbedder.

Definition at line 96 of file CDigitalSurfaceEmbedder.h.

Member Typedef Documentation

◆ Argument

template<typename T >
typedef T::Argument DGtal::concepts::CDigitalSurfaceEmbedder< T >::Argument

Definition at line 104 of file CDigitalSurfaceEmbedder.h.

◆ KSpace

template<typename T >
typedef T::KSpace DGtal::concepts::CDigitalSurfaceEmbedder< T >::KSpace

Definition at line 100 of file CDigitalSurfaceEmbedder.h.

◆ RealPoint

template<typename T >
typedef T::RealPoint DGtal::concepts::CDigitalSurfaceEmbedder< T >::RealPoint

Definition at line 103 of file CDigitalSurfaceEmbedder.h.

◆ SCell

template<typename T >
typedef T::SCell DGtal::concepts::CDigitalSurfaceEmbedder< T >::SCell

Definition at line 102 of file CDigitalSurfaceEmbedder.h.

◆ Surface

template<typename T >
typedef T::Surface DGtal::concepts::CDigitalSurfaceEmbedder< T >::Surface

Definition at line 101 of file CDigitalSurfaceEmbedder.h.

◆ Value

template<typename T >
typedef T::Value DGtal::concepts::CDigitalSurfaceEmbedder< T >::Value

Definition at line 105 of file CDigitalSurfaceEmbedder.h.

Member Function Documentation

◆ BOOST_CONCEPT_USAGE()

template<typename T >
DGtal::concepts::CDigitalSurfaceEmbedder< T >::BOOST_CONCEPT_USAGE ( CDigitalSurfaceEmbedder< T >  )
inline

◆ checkConstConstraints()

template<typename T >
void DGtal::concepts::CDigitalSurfaceEmbedder< T >::checkConstConstraints ( ) const
inline

Field Documentation

◆ mySurface

template<typename T >
Surface DGtal::concepts::CDigitalSurfaceEmbedder< T >::mySurface
private

◆ myX

template<typename T >
T DGtal::concepts::CDigitalSurfaceEmbedder< T >::myX
private

The documentation for this struct was generated from the following file:
DGtal::concepts::ConceptUtils::sameType
void sameType(const T &, const T &)
Definition: ConceptUtils.h:117
DGtal::concepts::CDigitalSurfaceEmbedder::checkConstConstraints
void checkConstConstraints() const
Definition: CDigitalSurfaceEmbedder.h:118
DGtal::concepts::CDigitalSurfaceEmbedder::mySurface
Surface mySurface
Definition: CDigitalSurfaceEmbedder.h:128
DGtal::concepts::CDigitalSurfaceEmbedder::myX
T myX
Definition: CDigitalSurfaceEmbedder.h:125