MeVisLabToolboxReference
ml::BackgroundTaskTileProcessor Class Reference

A BackgroundTaskTileProcessor can be used as a base class for processing an input image tile-by-tile without handling the details of an asynchronous request queue yourself. More...

#include <mlBackgroundTaskTileProcessor.h>

Inheritance diagram for ml::BackgroundTaskTileProcessor:
ml::BackgroundTaskTileProcessorBase

List of all members.

Public Member Functions

 BackgroundTaskTileProcessor ()
virtual SubImageBox getNextTileBox ()
 Reimplemented to return the next tile's box as given by the iterator.
virtual bool setupProcessing (ModuleBackgroundTask &task)
 Reimplemented to setup things before doProcessing() requests tiles.
Specifying the tile extent and box to process.
void setRegion (const SubImageBox &box)
 Set the box that shall be processed tile-by-tile (default is the complete input image's box).
void setTileExtent (const ImageVector &extent)
 Set the desired extent of the individual tiles (a component value of -1 means to use the region's extent for that component).
void setClipTilesToRegion (bool clip)
 Set if the tiles are clipped to the requested region (default is true), which means that the tiles are smaller on borders if they do not fit the box to process.

Detailed Description

A BackgroundTaskTileProcessor can be used as a base class for processing an input image tile-by-tile without handling the details of an asynchronous request queue yourself.

Typically you will just reimplement processTile().

Definition at line 121 of file mlBackgroundTaskTileProcessor.h.


Constructor & Destructor Documentation

ml::BackgroundTaskTileProcessor::BackgroundTaskTileProcessor ( )

Member Function Documentation

virtual SubImageBox ml::BackgroundTaskTileProcessor::getNextTileBox ( ) [virtual]

Reimplemented to return the next tile's box as given by the iterator.

Implements ml::BackgroundTaskTileProcessorBase.

void ml::BackgroundTaskTileProcessor::setClipTilesToRegion ( bool  clip) [inline]

Set if the tiles are clipped to the requested region (default is true), which means that the tiles are smaller on borders if they do not fit the box to process.

Definition at line 141 of file mlBackgroundTaskTileProcessor.h.

void ml::BackgroundTaskTileProcessor::setRegion ( const SubImageBox box) [inline]

Set the box that shall be processed tile-by-tile (default is the complete input image's box).

Definition at line 134 of file mlBackgroundTaskTileProcessor.h.

void ml::BackgroundTaskTileProcessor::setTileExtent ( const ImageVector extent) [inline]

Set the desired extent of the individual tiles (a component value of -1 means to use the region's extent for that component).

Definition at line 137 of file mlBackgroundTaskTileProcessor.h.

virtual bool ml::BackgroundTaskTileProcessor::setupProcessing ( ModuleBackgroundTask task) [virtual]

Reimplemented to setup things before doProcessing() requests tiles.

Reimplemented from ml::BackgroundTaskTileProcessorBase.


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