DGtal::CConstImage< I > Struct Template Reference

#include <CConstImage.h>

Inheritance diagram for DGtal::CConstImage< I >:

Collaboration diagram for DGtal::CConstImage< I >:

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

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

Private Attributes
I	i
Domain	d
ConstRange	r

---

Detailed Description

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

 DescriptionDescription of \b concept '\b CConstImage' <p>


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

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

Name	Expression	Type requirements	Return type	Precondition	Semantics	Postcondition	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 122 of file CConstImage.h.

---

Member Typedef Documentation

template<typename I >

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

Definition at line 131 of file CConstImage.h.

template<typename I >

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

Reimplemented from DGtal::CTrivialConstImage< I >.

Definition at line 128 of file CConstImage.h.

---

Member Function Documentation

template<typename I >

DGtal::CConstImage< I >::BOOST_CONCEPT_ASSERT

(

(CDomain< Domain >)

)

Reimplemented from DGtal::CTrivialConstImage< I >.

template<typename I >

DGtal::CConstImage< I >::BOOST_CONCEPT_ASSERT

(

(CConstBidirectionalRangeFromPoint< ConstRange >)

)

template<typename I >

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

inline

Definition at line 134 of file CConstImage.h.

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

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

---

Field Documentation

template<typename I >

Domain DGtal::CConstImage< I >::d

private

Reimplemented from DGtal::CTrivialConstImage< I >.

Definition at line 142 of file CConstImage.h.

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

template<typename I >

I DGtal::CConstImage< I >::i

private

Reimplemented from DGtal::CTrivialConstImage< I >.

Definition at line 141 of file CConstImage.h.

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

template<typename I >

ConstRange DGtal::CConstImage< I >::r

private

Definition at line 143 of file CConstImage.h.

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

---

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

• CConstImage.h