SPATMOD::IMAGE::FILTER_CACHEIMAGE Class Reference

Filter to cache entire image. More...

#include <spatmod/imagefiltercacheimage.h>

Inheritance diagram for SPATMOD::IMAGE::FILTER_CACHEIMAGE:

[legend]

List of all members.

Public Member Functions
	FILTER_CACHEIMAGE (STAGE *pPreviousStage, bool TakeOwnership, double MemoryMaxUsage=4.0, UINT32 TileRows=0, UINT32 TileColumns=0)
virtual	~FILTER_CACHEIMAGE ()
void	SetKeepAfterPullEnd (bool KeepAfterPullEnd)

---

Detailed Description

Filter to cache entire image.

Will cache in memory if below memory threshold, or in temporary file if above threshold. Cache supports both line/strip and tile iteration sequences efficiently.

---

Constructor & Destructor Documentation

SPATMOD::IMAGE::FILTER_CACHEIMAGE::FILTER_CACHEIMAGE	(	STAGE *	pPreviousStage,
		bool	TakeOwnership,
		double	MemoryMaxUsage = 4.0,
		UINT32	TileRows = 0,
		UINT32	TileColumns = 0
	)

Resample using specified dimensions and georeference.

The decision whether to actually use memory is done during the Initialize() step.

Parameters:

	pPreviousStage	Pointer to previous stage
	TakeOwnership	Filter takes ownership of previous stage and will delete when needed
	MemoryMaxUsage	Memory usage threshold (0 = none, < .5 = fraction of available, > .5 = MB)
	TileRows	Preferred tile rows, 0 to match input
	TileColumns	Preferred tile columns, 0 to match input

virtual SPATMOD::IMAGE::FILTER_CACHEIMAGE::~FILTER_CACHEIMAGE

(

)

[virtual]

---

Member Function Documentation

void SPATMOD::IMAGE::FILTER_CACHEIMAGE::SetKeepAfterPullEnd

(

bool

KeepAfterPullEnd

)

[inline]

Set whether to retain cached image after PullEnd.

Normally the cache is discarded when PullEnd is done to avoid retaining resources that are no longer needed. However, for some pipelines there may be multiple PullBegin/PullEnd sequences on the same stage, in which case this method should be used to avoid repeated reloading of the cache.

---

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

• spatmod/imagefiltercacheimage.h