Public Types | Public Member Functions | Private Member Functions | Private Attributes

DGtal::CImageContainer< ImageContainer > Struct Template Reference
[DGtal concepts]

#include <CImageContainer.h>

Public Types

typedef ImageContainer::ValueType ValueType
typedef ImageContainer::Iterator Iterator
typedef
ImageContainer::ConstIterator 
ConstIterator
typedef ImageContainer::Point Point

Public Member Functions

 BOOST_CONCEPT_ASSERT ((boost::BidirectionalIterator< Iterator >))
 BOOST_CONCEPT_ASSERT ((CValueType< ValueType >))
 BOOST_CONCEPT_USAGE (CImageContainer)

Private Member Functions

template<typename T >
void same_type (T const &, T const &)

Private Attributes

ImageContainer i
Iterator it
ConstIterator itconst
ValueType v
Point a
Point b

Detailed Description

template<typename ImageContainer>
struct DGtal::CImageContainer< ImageContainer >

Description of concept 'CImageContainer'

Aim: Defines the concept describing an image container.

Refinement of

Associated types :

Notation

Definitions

Valid expressions and semantics

Name Expression Type requirements Return type Precondition Semantics Postcondition Complexity
Image extent extent = x.extent() X::Space::Vector returns the extent of the image O(dimension)
Set a value at a position x.setValue(point, val) point is of type X::Space::Point, val is of type X::ValueType the point is in the domain associted to the image associate a value to a point Depends on the model
Set a value at a position x.setValue(it, val) it is of type X::Iterator or X::ConstIterator, val is of type X::ValueType the iterator is in the image range associate a value to a point given by an iterator Depends on the model
Get the value at a position val = x(point) point is of type X::Space::Point, val is of type X::ValueType X::ValueType the point is in the domain associted to the image get the value associated to a point Depends on the model
Get the value at a position val = x(it) it is of type X::Iterator, val is of type X::ValueType X::ValueType the iterator is in the image range get the value associated to a point Depends on the model
Get the value at a position val = x(constIt) constIt is of type X::ConstIterator, val is of type X::ValueType X::ValueType the const iterator is in the image range get the value associated to a point Depends on the model

Invariants

Models

Notes

Todo:
Complete ImageContainer checking.

Member Typedef Documentation

template<typename ImageContainer >
typedef ImageContainer::ConstIterator DGtal::CImageContainer< ImageContainer >::ConstIterator
template<typename ImageContainer >
typedef ImageContainer::Iterator DGtal::CImageContainer< ImageContainer >::Iterator
template<typename ImageContainer >
typedef ImageContainer::Point DGtal::CImageContainer< ImageContainer >::Point
template<typename ImageContainer >
typedef ImageContainer::ValueType DGtal::CImageContainer< ImageContainer >::ValueType

Member Function Documentation

template<typename ImageContainer >
DGtal::CImageContainer< ImageContainer >::BOOST_CONCEPT_ASSERT ( (boost::BidirectionalIterator< Iterator >)   ) 
template<typename ImageContainer >
DGtal::CImageContainer< ImageContainer >::BOOST_CONCEPT_ASSERT ( (CValueType< ValueType >)   ) 
template<typename ImageContainer >
DGtal::CImageContainer< ImageContainer >::BOOST_CONCEPT_USAGE ( CImageContainer< ImageContainer >   )  [inline]
template<typename ImageContainer >
template<typename T >
void DGtal::CImageContainer< ImageContainer >::same_type ( T const &  ,
T const &   
) [private]

Field Documentation

template<typename ImageContainer >
Point DGtal::CImageContainer< ImageContainer >::a [private]
template<typename ImageContainer >
Point DGtal::CImageContainer< ImageContainer >::b [private]
template<typename ImageContainer >
ImageContainer DGtal::CImageContainer< ImageContainer >::i [private]
template<typename ImageContainer >
Iterator DGtal::CImageContainer< ImageContainer >::it [private]
template<typename ImageContainer >
ConstIterator DGtal::CImageContainer< ImageContainer >::itconst [private]
template<typename ImageContainer >
ValueType DGtal::CImageContainer< ImageContainer >::v [private]

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