DGtal::concepts::CImage< I > Struct Template Reference

Aim: Defines the concept describing a read/write image, having an output iterator. More...

#include <DGtal/images/CImage.h>

Inheritance diagram for DGtal::concepts::CImage< I >:

Public Types
typedef I::Range	Range
Public Types inherited from DGtal::concepts::CConstImage< I >
typedef I::Domain	Domain
typedef I::ConstRange	ConstRange
Public Types inherited from DGtal::concepts::CTrivialConstImage< I >
typedef I::Domain	Domain
Public Types inherited from DGtal::concepts::CPointFunctor< I >
typedef I::Point	Point
typedef I::Value	Value

Public Member Functions
	BOOST_CONCEPT_ASSERT ((CConstBidirectionalRangeFromPoint< Range >))
	BOOST_CONCEPT_ASSERT ((CBidirectionalRangeWithWritableIteratorFromPoint< Range, typename I::Value >))
	BOOST_CONCEPT_USAGE (CImage)
Public Member Functions inherited from DGtal::concepts::CConstImage< I >
	BOOST_CONCEPT_ASSERT ((concepts::CDomain< Domain >))
	BOOST_CONCEPT_ASSERT ((CConstBidirectionalRangeFromPoint< ConstRange >))
	BOOST_CONCEPT_USAGE (CConstImage)
Public Member Functions inherited from DGtal::concepts::CTrivialConstImage< I >
	BOOST_CONCEPT_ASSERT ((CLabel< typename I::Value >))
	BOOST_CONCEPT_ASSERT ((concepts::CDomain< Domain >))
	BOOST_CONCEPT_USAGE (CTrivialConstImage)
Public Member Functions inherited from DGtal::concepts::CUnaryFunctor< I, I::Point, I::Value >
	BOOST_CONCEPT_USAGE (CUnaryFunctor)
Public Member Functions inherited from DGtal::concepts::CTrivialImage< I >
	BOOST_CONCEPT_USAGE (CTrivialImage)

Private Attributes
I	myI
Range	myR

Detailed Description

template<typename I>
struct DGtal::concepts::CImage< I >

Aim: Defines the concept describing a read/write image, having an output iterator.

Description of concept 'CImage'

Refinement of

CTrivialImage and CConstImage

Associated types:

• the same as CTrivialImage
• the same as CConstImage
• Range : type of the Range

Notation

• X : A type that is a model of CImage
• x : Object of type X
• aPoint : Object of type Point
• aValue : Object of type Value

Definitions

Valid expressions and semantics

Name	Expression	Type requirements	Return type	Precondition	Semantics	Post condition	Complexity
get range	x.range()		Range		Returns a range on the image values

Invariants

Models

ImageContainerBySTLVector, ImageContainerBySTLMap, ImageContainerByITKImage, ImageContainerByHashTree

Notes

Examples

images/exampleImageFactoryFromHDF5.cpp, and images/exampleTiledImage.cpp.

Definition at line 102 of file CImage.h.

Member Typedef Documentation

Range

template<typename I >

typedef I::Range DGtal::concepts::CImage< I >::Range

Definition at line 107 of file CImage.h.

Member Function Documentation

BOOST_CONCEPT_ASSERT() [1/2]

template<typename I >

DGtal::concepts::CImage< I >::BOOST_CONCEPT_ASSERT

(

(CBidirectionalRangeWithWritableIteratorFromPoint< Range, typename I::Value >)

)

BOOST_CONCEPT_ASSERT() [2/2]

template<typename I >

DGtal::concepts::CImage< I >::BOOST_CONCEPT_ASSERT

(

(CConstBidirectionalRangeFromPoint< Range >)

)

BOOST_CONCEPT_USAGE()

template<typename I >

DGtal::concepts::CImage< I >::BOOST_CONCEPT_USAGE ( CImage< I > )

inline

Definition at line 114 of file CImage.h.

    {
        ConceptUtils::sameType( myI.range(), myR);
    }

References DGtal::concepts::CImage< I >::myI, DGtal::concepts::CImage< I >::myR, and DGtal::concepts::ConceptUtils::sameType().

Field Documentation

myI

template<typename I >

I DGtal::concepts::CImage< I >::myI

private

Definition at line 121 of file CImage.h.

Referenced by DGtal::concepts::CImage< I >::BOOST_CONCEPT_USAGE().

myR

template<typename I >

Range DGtal::concepts::CImage< I >::myR

private

Definition at line 122 of file CImage.h.

Referenced by DGtal::concepts::CImage< I >::BOOST_CONCEPT_USAGE().

---

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

• CImage.h