DGtal::ImageCacheWritePolicyWT< TImageContainer, TImageFactory > Class Template Reference

Aim: implements a 'WT (Write-through)' write policy cache. More...

#include <DGtal/images/ImageCachePolicies.h>

Public Types
typedef TImageFactory	ImageFactory
typedef TImageContainer	ImageContainer
typedef TImageContainer::Domain	Domain
typedef TImageContainer::Point	Point
typedef TImageContainer::Value	Value

Public Member Functions
	BOOST_CONCEPT_ASSERT ((concepts::CImage< TImageContainer >))
	Checking concepts.
	BOOST_CONCEPT_ASSERT ((concepts::CImageFactory< TImageFactory >))
	ImageCacheWritePolicyWT (Alias< ImageFactory > anImageFactory)
	~ImageCacheWritePolicyWT ()
void	writeInPage (ImageContainer *anImageContainer, const Point &aPoint, const Value &aValue)
void	flushPage (ImageContainer *anImageContainer)

Protected Attributes
ImageFactory *	myImageFactory
	Alias on the image factory.

Private Member Functions
	ImageCacheWritePolicyWT (const ImageCacheWritePolicyWT &other)
ImageCacheWritePolicyWT &	operator= (const ImageCacheWritePolicyWT &other)

Detailed Description

template<typename TImageContainer, typename TImageFactory>
class DGtal::ImageCacheWritePolicyWT< TImageContainer, TImageFactory >

Aim: implements a 'WT (Write-through)' write policy cache.

Description of template class 'ImageCacheWritePolicyWT'

Write is done synchronously both to the cache and to the disk.

Template Parameters

TImageContainer	an image container type (model of CImage).
TImageFactory	an image factory.

The policy is done with 2 functions:

• writeInPage : for setting a value on an image at a given position given by a point
• flushPage : for flushing the image on disk according to the cache policy

Examples

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

Definition at line 286 of file ImageCachePolicies.h.

Member Typedef Documentation

Domain

template<typename TImageContainer , typename TImageFactory >

TImageContainer::Domain DGtal::ImageCacheWritePolicyWT< TImageContainer, TImageFactory >::Domain

Definition at line 297 of file ImageCachePolicies.h.

ImageContainer

template<typename TImageContainer , typename TImageFactory >

TImageContainer DGtal::ImageCacheWritePolicyWT< TImageContainer, TImageFactory >::ImageContainer

Definition at line 296 of file ImageCachePolicies.h.

ImageFactory

template<typename TImageContainer , typename TImageFactory >

TImageFactory DGtal::ImageCacheWritePolicyWT< TImageContainer, TImageFactory >::ImageFactory

Definition at line 294 of file ImageCachePolicies.h.

Point

template<typename TImageContainer , typename TImageFactory >

TImageContainer::Point DGtal::ImageCacheWritePolicyWT< TImageContainer, TImageFactory >::Point

Definition at line 298 of file ImageCachePolicies.h.

Value

template<typename TImageContainer , typename TImageFactory >

TImageContainer::Value DGtal::ImageCacheWritePolicyWT< TImageContainer, TImageFactory >::Value

Definition at line 299 of file ImageCachePolicies.h.

Constructor & Destructor Documentation

ImageCacheWritePolicyWT() [1/2]

template<typename TImageContainer , typename TImageFactory >

DGtal::ImageCacheWritePolicyWT< TImageContainer, TImageFactory >::ImageCacheWritePolicyWT ( Alias< ImageFactory > anImageFactory )

inline

Definition at line 301 of file ImageCachePolicies.h.

                                                               :
      myImageFactory(&anImageFactory)
    {
    }

~ImageCacheWritePolicyWT()

template<typename TImageContainer , typename TImageFactory >

DGtal::ImageCacheWritePolicyWT< TImageContainer, TImageFactory >::~ImageCacheWritePolicyWT ( )

inline

Destructor. Does nothing

Definition at line 310 of file ImageCachePolicies.h.

{}

ImageCacheWritePolicyWT() [2/2]

template<typename TImageContainer , typename TImageFactory >

DGtal::ImageCacheWritePolicyWT< TImageContainer, TImageFactory >::ImageCacheWritePolicyWT ( const ImageCacheWritePolicyWT< TImageContainer, TImageFactory > & other )

private

Member Function Documentation

BOOST_CONCEPT_ASSERT() [1/2]

template<typename TImageContainer , typename TImageFactory >

DGtal::ImageCacheWritePolicyWT< TImageContainer, TImageFactory >::BOOST_CONCEPT_ASSERT

(

(concepts::CImage< TImageContainer >)

)

Checking concepts.

BOOST_CONCEPT_ASSERT() [2/2]

template<typename TImageContainer , typename TImageFactory >

DGtal::ImageCacheWritePolicyWT< TImageContainer, TImageFactory >::BOOST_CONCEPT_ASSERT

(

(concepts::CImageFactory< TImageFactory >)

)

flushPage()

template<typename TImageContainer , typename TImageFactory >

void DGtal::ImageCacheWritePolicyWT< TImageContainer, TImageFactory >::flushPage

(

ImageContainer *

anImageContainer

)

Flush the image on disk according to the cache policy.

Parameters

anImageContainer

the image.

operator=()

template<typename TImageContainer , typename TImageFactory >

ImageCacheWritePolicyWT & DGtal::ImageCacheWritePolicyWT< TImageContainer, TImageFactory >::operator= ( const ImageCacheWritePolicyWT< TImageContainer, TImageFactory > & other )

private

writeInPage()

template<typename TImageContainer , typename TImageFactory >

void DGtal::ImageCacheWritePolicyWT< TImageContainer, TImageFactory >::writeInPage	(	ImageContainer *	anImageContainer,
		const Point &	aPoint,
		const Value &	aValue )

Set a value on an image at a given position given by aPoint.

Parameters

anImageContainer	the image.
aPoint	the point.
aValue	the value.

Field Documentation

myImageFactory

template<typename TImageContainer , typename TImageFactory >

ImageFactory* DGtal::ImageCacheWritePolicyWT< TImageContainer, TImageFactory >::myImageFactory

protected

Alias on the image factory.

Definition at line 340 of file ImageCachePolicies.h.

---

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

• ImageCachePolicies.h