ml::BackgroundTaskTileProcessorBase Class Reference

BackgroundTaskTileProcessorBase is the base class for processors that request an input image tile-by-tile. More...

#include <mlBackgroundTaskTileProcessor.h>

Inheritance diagram for ml::BackgroundTaskTileProcessorBase:

Public Member Functions
	BackgroundTaskTileProcessorBase ()
virtual	~BackgroundTaskTileProcessorBase ()
	Destructor. More...
Interface to reimplement.
virtual SubImageBox	getNextTileBox ()=0
	Reimplement to return the next tile's SubImageBox. More...
virtual bool	processTile (ManagedSubImage &image)=0
	Reimplement to process the given tile, return true if everything was ok. More...
virtual ManagedSubImage *	createExternalBuffer (const SubImageBox &box)
	Only needs to be reimplemented to allocate the memory for your tiles yourself, is only called if setAllocationPolicy() is called with TileRequest::ExternalBuffer. More...
Tile properties to setup.
void	setDataType (MLDataType dt)
	Set the datatype (if it is not set, it will use the input image datatype). More...
MLDataType	getDataType () const
	Get the datatype. More...
void	setInputImageIndex (int index)
	Set the input image from which data is requested (the default is 0). More...
int	getInputImageIndex () const
	Get the input image index. More...
void	setAllocationPolicy (TileRequest::AllocationPolicy policy)
	Set the allocation policy of the tiles that are passed to processTile() (The default is to use the MemoryManager). More...
void	setMaximumQueuedTiles (int size)
	Set the number of tiles that are allowed to be requested on the request queue. More...
Running the processing.
virtual bool	doProcessing (ModuleBackgroundTask &task)
	Start the processing, returns true if everything went fine. More...

Protected Member Functions
virtual bool	setupProcessing (ModuleBackgroundTask &)
	Needs to be reimplemented to setup things before doProcessing() requests tiles. More...
virtual bool	cleanupProcessing (ModuleBackgroundTask &)
	Needs to be reimplemented to cleanup things after doProcessing() finished processing tiles. More...
void	setNumTiles (MLint tiles)
	Set the number of tiles that will be processed. More...

Detailed Description

BackgroundTaskTileProcessorBase is the base class for processors that request an input image tile-by-tile.

Definition at line 34 of file mlBackgroundTaskTileProcessor.h.

Constructor & Destructor Documentation

BackgroundTaskTileProcessorBase()

ml::BackgroundTaskTileProcessorBase::BackgroundTaskTileProcessorBase

(

)

~BackgroundTaskTileProcessorBase()

virtual ml::BackgroundTaskTileProcessorBase::~BackgroundTaskTileProcessorBase ( )

inlinevirtual

Destructor.

Definition at line 40 of file mlBackgroundTaskTileProcessor.h.

Member Function Documentation

cleanupProcessing()

virtual bool ml::BackgroundTaskTileProcessorBase::cleanupProcessing ( ModuleBackgroundTask &  )

inlineprotectedvirtual

Needs to be reimplemented to cleanup things after doProcessing() finished processing tiles.

Definition at line 103 of file mlBackgroundTaskTileProcessor.h.

createExternalBuffer()

virtual ManagedSubImage* ml::BackgroundTaskTileProcessorBase::createExternalBuffer ( const SubImageBox &  box )

virtual

Only needs to be reimplemented to allocate the memory for your tiles yourself, is only called if setAllocationPolicy() is called with TileRequest::ExternalBuffer.

doProcessing()

virtual bool ml::BackgroundTaskTileProcessorBase::doProcessing ( ModuleBackgroundTask &  task )

virtual

Start the processing, returns true if everything went fine.

getDataType()

MLDataType ml::BackgroundTaskTileProcessorBase::getDataType ( ) const

inline

Get the datatype.

Definition at line 71 of file mlBackgroundTaskTileProcessor.h.

getInputImageIndex()

int ml::BackgroundTaskTileProcessorBase::getInputImageIndex ( ) const

inline

Get the input image index.

Definition at line 76 of file mlBackgroundTaskTileProcessor.h.

getNextTileBox()

virtual SubImageBox ml::BackgroundTaskTileProcessorBase::getNextTileBox ( )

pure virtual

Reimplement to return the next tile's SubImageBox.

Implemented in ml::BackgroundTaskTileProcessor.

processTile()

virtual bool ml::BackgroundTaskTileProcessorBase::processTile ( ManagedSubImage &  image )

pure virtual

Reimplement to process the given tile, return true if everything was ok.

setAllocationPolicy()

void ml::BackgroundTaskTileProcessorBase::setAllocationPolicy ( TileRequest::AllocationPolicy  policy )

inline

Set the allocation policy of the tiles that are passed to processTile() (The default is to use the MemoryManager).

Definition at line 79 of file mlBackgroundTaskTileProcessor.h.

setDataType()

void ml::BackgroundTaskTileProcessorBase::setDataType ( MLDataType  dt )

inline

Set the datatype (if it is not set, it will use the input image datatype).

Definition at line 69 of file mlBackgroundTaskTileProcessor.h.

setInputImageIndex()

void ml::BackgroundTaskTileProcessorBase::setInputImageIndex ( int  index )

inline

Set the input image from which data is requested (the default is 0).

Definition at line 74 of file mlBackgroundTaskTileProcessor.h.

setMaximumQueuedTiles()

void ml::BackgroundTaskTileProcessorBase::setMaximumQueuedTiles ( int  size )

inline

Set the number of tiles that are allowed to be requested on the request queue.

Definition at line 82 of file mlBackgroundTaskTileProcessor.h.

setNumTiles()

void ml::BackgroundTaskTileProcessorBase::setNumTiles ( MLint  tiles )

inlineprotected

Set the number of tiles that will be processed.

Definition at line 106 of file mlBackgroundTaskTileProcessor.h.

setupProcessing()

virtual bool ml::BackgroundTaskTileProcessorBase::setupProcessing ( ModuleBackgroundTask &  )

inlineprotectedvirtual

Needs to be reimplemented to setup things before doProcessing() requests tiles.

Reimplemented in ml::BackgroundTaskTileProcessor.

Definition at line 100 of file mlBackgroundTaskTileProcessor.h.

---

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

• MeVis/Foundation/Sources/MLBackgroundTasks/mlBackgroundTaskTileProcessor.h