A ProcessAllPages handler that offers ordered tile delivery on a single input image. More...
#include <mlProcessAllPagesHandler.h>
Public Member Functions | |
| OrderedSingleInputProcessAllPagesHandler (int inputIndex=0) | |
| void | calculateOutputImageProperties (PagedImage *image) override |
| Reimplement this method to specify the virtual output image's data type/size/page extent. | |
| virtual MLErrorCode | processTile (const SubImage &image)=0 |
| Reimplement this method to perform the processing, return ML_RESULT_OK if processing should go on; otherwise, return the appropriate error code. | |
| virtual SubImageBox | calculateInputSubImageBox (const SubImageBox &outputSubImageBox) |
| Reimplement this method to specify the input image box for the input image with index == _inputIndex. | |
| SubImageBox | calculateInputSubImageBox (int inputIndex, const SubImageBox &outputSubImageBox) override |
| Internal method, do not reimplement! | |
| void | calculateOutputSubImage (SubImage *outputSubImage, SubImage *inputSubImages, UserThreadData *) override |
| Internal method, do not reimplement! | |
 Public Member Functions inherited from ml::ProcessAllPagesHandler | |
| virtual bool | wantsProgressUpdates () |
| Returns whether the handler wants to receive progress updates via updateProgress(). | |
| virtual void | updateProgress (double) |
| Called in regular intervals if wantsProgressUpdates() == true. | |
| void | install (PagedImage *outImg) |
| Installs the handler on the PagedImage, which is typically called by the ML Host; do not call it yourself! | |
| virtual const char * | getName () |
| Returns the name of the handler. | |
| Public Member Functions inherited from ml::CalculateOutputImageHandler | |
| virtual | ~CalculateOutputImageHandler () |
| Destructor. | |
| virtual UserThreadData * | createUserThreadData () |
| Creates the thread local user data for a thread. | |
Protected Attributes | |
| PagedImage * | _image |
Detailed Description
A ProcessAllPages handler that offers ordered tile delivery on a single input image.
Definition at line 72 of file mlProcessAllPagesHandler.h.
Constructor & Destructor Documentation
◆ OrderedSingleInputProcessAllPagesHandler()
| ml::OrderedSingleInputProcessAllPagesHandler::OrderedSingleInputProcessAllPagesHandler | ( | int | inputIndex = 0 | ) |
Member Function Documentation
◆ calculateInputSubImageBox() [1/2]
|
inlinevirtual |
Reimplement this method to specify the input image box for the input image with index == _inputIndex.
By default, it returns outputSubImageBox.
Definition at line 88 of file mlProcessAllPagesHandler.h.
◆ calculateInputSubImageBox() [2/2]
|
overridevirtual |
Internal method, do not reimplement!
Reimplemented from ml::CalculateOutputImageHandler.
◆ calculateOutputImageProperties()
|
overridevirtual |
Reimplement this method to specify the virtual output image's data type/size/page extent.
Make sure to call the base class method at the beginning of your method.
Reimplemented from ml::ProcessAllPagesHandler.
◆ calculateOutputSubImage()
|
overridevirtual |
Internal method, do not reimplement!
Implements ml::CalculateOutputImageHandler.
◆ processTile()
|
pure virtual |
Reimplement this method to perform the processing, return ML_RESULT_OK if processing should go on; otherwise, return the appropriate error code.
Member Data Documentation
◆ _image
|
protected |
Definition at line 97 of file mlProcessAllPagesHandler.h.
The documentation for this class was generated from the following file:
- MeVis/Foundation/Sources/ML/include/mlProcessAllPagesHandler.h
