DGtal  1.5.beta
DGtal::concepts::CImageFactory< T > Struct Template Reference

Aim: Defines the concept describing an image factory. More...

#include <DGtal/images/CImageFactory.h>

Public Types

typedef T::OutputImage OutputImage

Public Member Functions

 BOOST_CONCEPT_ASSERT ((CImage< OutputImage >))
void checkConstConstraints () const

Private Attributes

T::Domain myDomain

Detailed Description

template<typename T>
struct DGtal::concepts::CImageFactory< T >

Aim: Defines the concept describing an image factory.

Description of concept 'CImageFactory'

Refinement of

Associated types

  • OutputImage : type of the image created by the factory, model of concept CImage
  • Domain : type of the image domain, model of concept CDomain


  • X : A type that is a model of CImageFactory
  • x : object of type X
  • d : object of type Domain
  • o : object of type OutputImage


Valid expressions and semantics

Name Expression Type requirements Return type Precondition Semantics Post condition Complexity
Request image x.requestImage(d) d of type Domain OutputImage returns a pointer of an OutputImage created with the Domain d
Flush image x.flushImage(o) o of type OutputImage flush (i.e. write/synchronize) an OutputImage o
Detach image x.detachImage(o) o of type OutputImage free (i.e. delete) an OutputImage o



ImageFactoryFromImage ImageFactoryFromHDF5


Template Parameters
Tthe type that should be a model of CImageFactory.

Definition at line 90 of file CImageFactory.h.

Member Typedef Documentation

◆ OutputImage

template<typename T >
typedef T::OutputImage DGtal::concepts::CImageFactory< T >::OutputImage

Definition at line 95 of file CImageFactory.h.

Member Function Documentation


template<typename T >
DGtal::concepts::CImageFactory< T >::BOOST_CONCEPT_ASSERT ( (CImage< OutputImage >)  )


◆ checkConstConstraints()

template<typename T >
void DGtal::concepts::CImageFactory< T >::checkConstConstraints ( ) const

Definition at line 108 of file CImageFactory.h.

109  {
110  }

Referenced by DGtal::concepts::CImageFactory< T >::BOOST_CONCEPT_USAGE().

Field Documentation

◆ myDomain

template<typename T >
T::Domain DGtal::concepts::CImageFactory< T >::myDomain

◆ myOI

template<typename T >
OutputImage* DGtal::concepts::CImageFactory< T >::myOI

◆ myT

template<typename T >
T DGtal::concepts::CImageFactory< T >::myT

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