MeVisLab Toolbox Reference
|
BackgroundTaskTileProcessorBase is the base class for processors that request an input image tile-by-tile. More...
#include <mlBackgroundTaskTileProcessor.h>
Public Member Functions | |
BackgroundTaskTileProcessorBase () | |
virtual | ~BackgroundTaskTileProcessorBase () |
Destructor. | |
Interface to reimplement. | |
virtual SubImageBox | getNextTileBox ()=0 |
Reimplement to return the next tile's SubImageBox. | |
virtual bool | processTile (ManagedSubImage &image)=0 |
Reimplement to process the given tile. Return true if everything was okay. | |
virtual ManagedSubImage * | createExternalBuffer (const SubImageBox &box) |
Only needs to be reimplemented to allocate the memory for your tiles yourself. | |
Tile properties to setup. | |
void | setDataType (MLDataType dt) |
Sets the data type. If it is not set, it will use the input image data type. | |
MLDataType | getDataType () const |
Returns the data type. | |
void | setInputImageIndex (int index) |
Sets the input image from which data is requested. The default is 0. | |
int | getInputImageIndex () const |
Returns the input image index. | |
void | setAllocationPolicy (TileRequest::AllocationPolicy policy) |
Sets the allocation policy of the tiles that are passed to processTile(). | |
void | setMaximumQueuedTiles (int size) |
Sets the number of tiles that are allowed to be requested on the request queue. | |
Running the processing. | |
virtual bool | doProcessing (ModuleBackgroundTask &task) |
Starts the processing and returns true if everything went fine. | |
Protected Member Functions | |
virtual bool | setupProcessing (ModuleBackgroundTask &) |
Needs to be reimplemented to set up necessary elements before doProcessing() is called to requests tiles. | |
virtual bool | cleanupProcessing (ModuleBackgroundTask &) |
Needs to be reimplemented to clean up elements after doProcessing() is called to finished processing tiles. | |
void | setNumTiles (MLint tiles) |
Sets the number of tiles that will be processed. | |
BackgroundTaskTileProcessorBase is the base class for processors that request an input image tile-by-tile.
Definition at line 34 of file mlBackgroundTaskTileProcessor.h.
ml::BackgroundTaskTileProcessorBase::BackgroundTaskTileProcessorBase | ( | ) |
|
inlinevirtual |
Destructor.
Definition at line 40 of file mlBackgroundTaskTileProcessor.h.
|
inlineprotectedvirtual |
Needs to be reimplemented to clean up elements after doProcessing() is called to finished processing tiles.
Definition at line 104 of file mlBackgroundTaskTileProcessor.h.
|
virtual |
Only needs to be reimplemented to allocate the memory for your tiles yourself.
It is only called if setAllocationPolicy() is called with TileRequest::ExternalBuffer.
|
virtual |
Starts the processing and returns true
if everything went fine.
|
inline |
Returns the data type.
Definition at line 71 of file mlBackgroundTaskTileProcessor.h.
|
inline |
Returns the input image index.
Definition at line 76 of file mlBackgroundTaskTileProcessor.h.
|
pure virtual |
Reimplement to return the next tile's SubImageBox.
Implemented in ml::BackgroundTaskTileProcessor.
|
pure virtual |
Reimplement to process the given tile. Return true
if everything was okay.
|
inline |
Sets the allocation policy of the tiles that are passed to processTile().
The default is to use the MemoryManager.
Definition at line 80 of file mlBackgroundTaskTileProcessor.h.
|
inline |
Sets the data type. If it is not set, it will use the input image data type.
Definition at line 69 of file mlBackgroundTaskTileProcessor.h.
References mlrange_cast().
Sets the input image from which data is requested. The default is 0.
Definition at line 74 of file mlBackgroundTaskTileProcessor.h.
Sets the number of tiles that are allowed to be requested on the request queue.
Definition at line 83 of file mlBackgroundTaskTileProcessor.h.
Sets the number of tiles that will be processed.
Definition at line 107 of file mlBackgroundTaskTileProcessor.h.
References mlrange_cast().
|
inlineprotectedvirtual |
Needs to be reimplemented to set up necessary elements before doProcessing() is called to requests tiles.
Reimplemented in ml::BackgroundTaskTileProcessor.
Definition at line 101 of file mlBackgroundTaskTileProcessor.h.