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

Aim: Defines the concept describing a read-only image, which is a refinement of CPointFunctor. More...

#include <DGtal/images/CConstImage.h>

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

Public Types
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 ((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)

Private Attributes
I	i
Domain	d
ConstRange	r

Detailed Description

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

Aim: Defines the concept describing a read-only image, which is a refinement of CPointFunctor.

Description of concept 'CConstImage'

Refinement of CTrivialConstImage

Associated types

• Domain: type of the image domain, model of concept CDomain
• ConstRange: type of range of image values, model of concept CConstBidirectionalRangeFromPoint

Notation

• X : A type that is a model of CConstImage
• x, y : Object of type X

Definitions

Valid expressions and semantics

Name	Expression	Type requirements	Return type	Precondition	Semantics	Post condition	Complexity
Accessor to the domain	x.domain()		const Domain &		returns a const reference to the image domain		O(1)
Accessor to the range of the image values	x.constRange()		ConstRange		returns a constant range		O(1)

Invariants

Model

ImageContainerBySTLVector, ImageContainerBySTLMap, ImageContainerByITKImage, ImageContainerByHashTree

Notes

Definition at line 94 of file CConstImage.h.

Member Typedef Documentation

ConstRange

template<typename I >

typedef I::ConstRange DGtal::concepts::CConstImage< I >::ConstRange

Definition at line 103 of file CConstImage.h.

Domain

template<typename I >

typedef I::Domain DGtal::concepts::CConstImage< I >::Domain

Definition at line 100 of file CConstImage.h.

Member Function Documentation

BOOST_CONCEPT_ASSERT() [1/2]

template<typename I >

DGtal::concepts::CConstImage< I >::BOOST_CONCEPT_ASSERT

(

(CConstBidirectionalRangeFromPoint< ConstRange >)

)

BOOST_CONCEPT_ASSERT() [2/2]

template<typename I >

DGtal::concepts::CConstImage< I >::BOOST_CONCEPT_ASSERT

(

(concepts::CDomain< Domain >)

)

BOOST_CONCEPT_USAGE()

template<typename I >

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

inline

Definition at line 106 of file CConstImage.h.

    {
      ConceptUtils::sameType(i.domain(), d);
      ConceptUtils::sameType(i.constRange(), r);
    }

References DGtal::concepts::CConstImage< I >::d, DGtal::concepts::CConstImage< I >::i, and DGtal::concepts::ConceptUtils::sameType().

Field Documentation

d

template<typename I >

Domain DGtal::concepts::CConstImage< I >::d

private

Definition at line 114 of file CConstImage.h.

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

i

template<typename I >

I DGtal::concepts::CConstImage< I >::i

private

Definition at line 113 of file CConstImage.h.

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

r

template<typename I >

ConstRange DGtal::concepts::CConstImage< I >::r

private

Definition at line 115 of file CConstImage.h.

---

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

• CConstImage.h