Aim: Defines the concept describing a read-only image, which is a refinement of CPointFunctor. More...
#include <DGtal/images/CTrivialConstImage.h>
Public Types | |
| typedef I::Domain | Domain |
 Public Types inherited from DGtal::concepts::CPointFunctor< I > | |
| typedef T::Point | Point |
| typedef T::Value | Value |
Public Member Functions | |
| 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< X, A, R > | |
| BOOST_CONCEPT_USAGE (CUnaryFunctor) | |
Private Attributes | |
| I | i |
| Domain | d |
Detailed Description
template<typename I>
struct DGtal::concepts::CTrivialConstImage< I >
Aim: Defines the concept describing a read-only image, which is a refinement of CPointFunctor.
Description of concept 'CTrivialConstImage'
Refinement of
Associated types
- Domain: type of the image domain, model of concept CDomain
Notation
- X : A type that is a model of CTrivialConstImage
- 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) |
Invariants
Models
ImageContainerBySTLVector, ImageContainerBySTLMap, ImageContainerByITKImage, ImageContainerByHashTree
Definition at line 88 of file CTrivialConstImage.h.
Member Typedef Documentation
◆ Domain
| typedef I::Domain DGtal::concepts::CTrivialConstImage< I >::Domain |
Definition at line 95 of file CTrivialConstImage.h.
Member Function Documentation
◆ BOOST_CONCEPT_ASSERT() [1/2]
| DGtal::concepts::CTrivialConstImage< I >::BOOST_CONCEPT_ASSERT | ( | (CLabel< typename I::Value >) | ) |
◆ BOOST_CONCEPT_ASSERT() [2/2]
| DGtal::concepts::CTrivialConstImage< I >::BOOST_CONCEPT_ASSERT | ( | (concepts::CDomain< Domain >) | ) |
◆ BOOST_CONCEPT_USAGE()
|
inline |
Definition at line 99 of file CTrivialConstImage.h.
References DGtal::concepts::CTrivialConstImage< I >::d, DGtal::concepts::CTrivialConstImage< I >::i, and DGtal::concepts::ConceptUtils::sameType().
Field Documentation
◆ d
|
private |
Definition at line 106 of file CTrivialConstImage.h.
Referenced by DGtal::concepts::CTrivialConstImage< I >::BOOST_CONCEPT_USAGE().
◆ i
|
private |
Definition at line 105 of file CTrivialConstImage.h.
Referenced by DGtal::concepts::CTrivialConstImage< I >::BOOST_CONCEPT_USAGE().
The documentation for this struct was generated from the following file:
