DGtal::CSCellEmbedder< T > Struct Template Reference

#include <CSCellEmbedder.h>

Inheritance diagram for DGtal::CSCellEmbedder< T >:

Collaboration diagram for DGtal::CSCellEmbedder< T >:

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

Private Attributes
T	myX
SCell	myP
RealPoint	myRP

---

Detailed Description

template<typename T>
struct DGtal::CSCellEmbedder< T >

Aim: A cell embedder is a mapping from signed cells to Euclidean points. It adds inner types to functor.

Description of concept 'CSCellEmbedder'

Refinement of

• CUnaryFunctor<T, T::SCell, T::RealPoint>

Associated types :

• KSpace: the cellular grid space
• SCell: same as KSpace::SCell
• RealPoint: the type of Euclidean point
• Argument: type of the argument, same as KSpace::SCell
• Value: type of value, same as RealPoint

Notation

• X : A type that is a model of CSCellEmbedder
• 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

Invariants

Models

• CanonicSCellEmbedder, CanonicDigitalSurfaceEmbedder, DigitalSurfaceEmbedderWithNormalVectorEstimator

Notes

Template Parameters:

T	the type that should be a model of CSCellEmbedder.

Definition at line 95 of file CSCellEmbedder.h.

---

Member Typedef Documentation

template<typename T >

typedef T::Argument DGtal::CSCellEmbedder< T >::Argument

Reimplemented in DGtal::CDigitalSurfaceEmbedder< T >.

Definition at line 102 of file CSCellEmbedder.h.

template<typename T >

typedef T::KSpace DGtal::CSCellEmbedder< T >::KSpace

Reimplemented in DGtal::CDigitalSurfaceEmbedder< T >.

Definition at line 99 of file CSCellEmbedder.h.

template<typename T >

typedef T::RealPoint DGtal::CSCellEmbedder< T >::RealPoint

Reimplemented in DGtal::CDigitalSurfaceEmbedder< T >.

Definition at line 101 of file CSCellEmbedder.h.

template<typename T >

typedef T::SCell DGtal::CSCellEmbedder< T >::SCell

Reimplemented in DGtal::CDigitalSurfaceEmbedder< T >.

Definition at line 100 of file CSCellEmbedder.h.

template<typename T >

typedef T::Value DGtal::CSCellEmbedder< T >::Value

Reimplemented in DGtal::CDigitalSurfaceEmbedder< T >.

Definition at line 103 of file CSCellEmbedder.h.

---

Member Function Documentation

template<typename T >

DGtal::CSCellEmbedder< T >::BOOST_CONCEPT_ASSERT

(

(CCellularGridSpaceND< KSpace >)

)

template<typename T >

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

inline

Definition at line 109 of file CSCellEmbedder.h.

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

  {
    checkConstConstraints();
  }

template<typename T >

DGtal::CSCellEmbedder< T >::BOOST_STATIC_ASSERT

(

(ConceptUtils::SameType< SCell, typename KSpace::SCell >::value)

)

template<typename T >

DGtal::CSCellEmbedder< T >::BOOST_STATIC_ASSERT

(

(ConceptUtils::SameType< SCell, Argument >::value)

)

template<typename T >

DGtal::CSCellEmbedder< T >::BOOST_STATIC_ASSERT

(

(ConceptUtils::SameType< RealPoint, Value >::value)

)

template<typename T >

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

inline

Reimplemented in DGtal::CDigitalSurfaceEmbedder< T >.

Definition at line 114 of file CSCellEmbedder.h.

References DGtal::CSCellEmbedder< T >::myP, DGtal::CSCellEmbedder< T >::myRP, DGtal::CSCellEmbedder< T >::myX, and DGtal::ConceptUtils::sameType().

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

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

---

Field Documentation

template<typename T >

SCell DGtal::CSCellEmbedder< T >::myP

private

Definition at line 121 of file CSCellEmbedder.h.

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

template<typename T >

RealPoint DGtal::CSCellEmbedder< T >::myRP

private

Definition at line 122 of file CSCellEmbedder.h.

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

template<typename T >

T DGtal::CSCellEmbedder< T >::myX

private

Reimplemented in DGtal::CDigitalSurfaceEmbedder< T >.

Definition at line 120 of file CSCellEmbedder.h.

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

---

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

• CSCellEmbedder.h