ml::BackgroundTaskTileProcessorBase Class Reference
BackgroundTaskTileProcessorBase is the base class for processors that request an input image tile-by-tile. More...
#include <mlBackgroundTaskTileProcessor.h>
Public Member Functions | |
| BackgroundTaskTileProcessorBase () | |
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 ok. | |
| 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. | |
Tile properties to setup. | |
| void | setDataType (MLDataType dt) |
| Set the datatype (if it is not set, it will use the input image datatype). | |
| MLDataType | getDataType () const |
| Get the datatype. | |
| void | setInputImageIndex (int index) |
| Set the input image from which data is requested (the default is 0). | |
| int | getInputImageIndex () const |
| Get the input image index. | |
| void | setAllocationPolicy (TileRequest::AllocationPolicy policy) |
| Set the allocation policy of the tiles that are passed to processTile() (The default is to use the MemoryManager). | |
| void | setMaximumQueuedTiles (int size) |
| Set the number of tiles that are allowed to be requested on the request queue. | |
Running the processing. | |
| virtual bool | doProcessing (ModuleBackgroundTask &task) |
| Start the processing, returns true if everything went fine. | |
Protected Member Functions | |
| virtual bool | setupProcessing (ModuleBackgroundTask &) |
| Needs to be reimplemented to setup things before doProcessing() requests tiles. | |
| virtual bool | cleanupProcessing (ModuleBackgroundTask &) |
| Needs to be reimplemented to cleanup things after doProcessing() finished processing tiles. | |
| void | setNumTiles (MLint tiles) |
| Set the number of tiles that will be processed. | |
Detailed Description
BackgroundTaskTileProcessorBase is the base class for processors that request an input image tile-by-tile.
Definition at line 32 of file mlBackgroundTaskTileProcessor.h.
Constructor & Destructor Documentation
| ml::BackgroundTaskTileProcessorBase::BackgroundTaskTileProcessorBase | ( | ) |
Member Function Documentation
| virtual bool ml::BackgroundTaskTileProcessorBase::cleanupProcessing | ( | ModuleBackgroundTask & | ) | [inline, protected, virtual] |
Needs to be reimplemented to cleanup things after doProcessing() finished processing tiles.
Definition at line 98 of file mlBackgroundTaskTileProcessor.h.
| 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.
| virtual bool ml::BackgroundTaskTileProcessorBase::doProcessing | ( | ModuleBackgroundTask & | task | ) | [virtual] |
Start the processing, returns true if everything went fine.
| MLDataType ml::BackgroundTaskTileProcessorBase::getDataType | ( | ) | const [inline] |
| int ml::BackgroundTaskTileProcessorBase::getInputImageIndex | ( | ) | const [inline] |
| virtual SubImageBox ml::BackgroundTaskTileProcessorBase::getNextTileBox | ( | ) | [pure virtual] |
| virtual bool ml::BackgroundTaskTileProcessorBase::processTile | ( | ManagedSubImage & | image | ) | [pure virtual] |
Reimplement to process the given tile, return true if everything was ok.
| 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 74 of file mlBackgroundTaskTileProcessor.h.
| 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 64 of file mlBackgroundTaskTileProcessor.h.
| void ml::BackgroundTaskTileProcessorBase::setInputImageIndex | ( | int | index | ) | [inline] |
Set the input image from which data is requested (the default is 0).
Definition at line 69 of file mlBackgroundTaskTileProcessor.h.
| 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 77 of file mlBackgroundTaskTileProcessor.h.
| void ml::BackgroundTaskTileProcessorBase::setNumTiles | ( | MLint | tiles | ) | [inline, protected] |
Set the number of tiles that will be processed.
Definition at line 101 of file mlBackgroundTaskTileProcessor.h.
| virtual bool ml::BackgroundTaskTileProcessorBase::setupProcessing | ( | ModuleBackgroundTask & | ) | [inline, protected, virtual] |
Needs to be reimplemented to setup things before doProcessing() requests tiles.
Reimplemented in ml::BackgroundTaskTileProcessor.
Definition at line 95 of file mlBackgroundTaskTileProcessor.h.
The documentation for this class was generated from the following file:
- MeVis/Foundation/Sources/MLBackgroundTasks/mlBackgroundTaskTileProcessor.h
