DGtal::CDigitalSurfaceEmbedder< T > Struct Template Reference

#include <CDigitalSurfaceEmbedder.h>

Inheritance diagram for DGtal::CDigitalSurfaceEmbedder< T >:

Collaboration diagram for DGtal::CDigitalSurfaceEmbedder< T >:

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::CSCellEmbedder< T >

Public Member Functions
	BOOST_CONCEPT_USAGE (CDigitalSurfaceEmbedder)
void	checkConstConstraints () const
Public Member Functions inherited from DGtal::CSCellEmbedder< T >
	BOOST_CONCEPT_ASSERT ((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)
Public Member Functions inherited from DGtal::CUnaryFunctor< T, T::SCell, T::RealPoint >
	BOOST_CONCEPT_USAGE (CUnaryFunctor)

Private Attributes
T	myX
Surface	mySurface

---

Detailed Description

template<typename T>
struct DGtal::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

• CSCellEmbedder<T>

Associated types :

• KSpace: the cellular grid space
• SCell: same as KSpace::SCell
• RealPoint: the type of Euclidean point
• Surface: a digital surface, some concrete DigitalSurface<X>.
• Argument: type of the argument, same as SCell
• Value: type of value, same as RealPoint

Notation

• X : A type that is a model of CDigitalSurfaceEmbedder
• x : object of type X
• p : object of type SCell

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:

T	the type that should be a model of CDigitalSurfaceEmbedder.

Definition at line 95 of file CDigitalSurfaceEmbedder.h.

---

Member Typedef Documentation

template<typename T >

typedef T::Argument DGtal::CDigitalSurfaceEmbedder< T >::Argument

Reimplemented from DGtal::CSCellEmbedder< T >.

Definition at line 103 of file CDigitalSurfaceEmbedder.h.

template<typename T >

typedef T::KSpace DGtal::CDigitalSurfaceEmbedder< T >::KSpace

Reimplemented from DGtal::CSCellEmbedder< T >.

Definition at line 99 of file CDigitalSurfaceEmbedder.h.

template<typename T >

typedef T::RealPoint DGtal::CDigitalSurfaceEmbedder< T >::RealPoint

Reimplemented from DGtal::CSCellEmbedder< T >.

Definition at line 102 of file CDigitalSurfaceEmbedder.h.

template<typename T >

typedef T::SCell DGtal::CDigitalSurfaceEmbedder< T >::SCell

Reimplemented from DGtal::CSCellEmbedder< T >.

Definition at line 101 of file CDigitalSurfaceEmbedder.h.

template<typename T >

typedef T::Surface DGtal::CDigitalSurfaceEmbedder< T >::Surface

Definition at line 100 of file CDigitalSurfaceEmbedder.h.

template<typename T >

typedef T::Value DGtal::CDigitalSurfaceEmbedder< T >::Value

Reimplemented from DGtal::CSCellEmbedder< T >.

Definition at line 104 of file CDigitalSurfaceEmbedder.h.

---

Member Function Documentation

template<typename T >

DGtal::CDigitalSurfaceEmbedder< T >::BOOST_CONCEPT_USAGE ( CDigitalSurfaceEmbedder< T >  )

inline

Definition at line 112 of file CDigitalSurfaceEmbedder.h.

References DGtal::CDigitalSurfaceEmbedder< T >::checkConstConstraints().

  {
    checkConstConstraints();
  }

template<typename T >

void DGtal::CDigitalSurfaceEmbedder< T >::checkConstConstraints ( ) const

inline

Reimplemented from DGtal::CSCellEmbedder< T >.

Definition at line 117 of file CDigitalSurfaceEmbedder.h.

References DGtal::CDigitalSurfaceEmbedder< T >::mySurface, DGtal::CDigitalSurfaceEmbedder< T >::myX, and DGtal::ConceptUtils::sameType().

Referenced by DGtal::CDigitalSurfaceEmbedder< T >::BOOST_CONCEPT_USAGE().

  { // operator()
    // ConceptUtils::sameType( myRP, myX( myP ) );
    ConceptUtils::sameType( mySurface, myX.surface() );
  }

---

Field Documentation

template<typename T >

Surface DGtal::CDigitalSurfaceEmbedder< T >::mySurface

private

Definition at line 127 of file CDigitalSurfaceEmbedder.h.

Referenced by DGtal::CDigitalSurfaceEmbedder< T >::checkConstConstraints().

template<typename T >

T DGtal::CDigitalSurfaceEmbedder< T >::myX

private

Reimplemented from DGtal::CSCellEmbedder< T >.

Definition at line 124 of file CDigitalSurfaceEmbedder.h.

Referenced by DGtal::CDigitalSurfaceEmbedder< T >::checkConstConstraints().

---

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

• CDigitalSurfaceEmbedder.h