Base class for handlers that are used for the Module::processAllPages facility. More...
#include <mlProcessAllPagesHandler.h>
Public Member Functions | |
| virtual void | calculateOutputImageProperties (PagedImage *) |
| Calculates the (temporary and virtual) output image's properties, which by default has the properties of input image 0. More... | |
| virtual bool | wantsProgressUpdates () |
| Returns whether the handler wants to receive progress updates via updateProgress(). More... | |
| virtual void | updateProgress (double) |
| Called in regular intervals if wantsProgressUpdates() == true. More... | |
| void | install (PagedImage *outImg) |
| Installs the handler on the PagedImage, which is typically called by the ML Host; do not call it yourself! More... | |
| virtual const char * | getName () |
| Returns the name of the handler. More... | |
 Public Member Functions inherited from ml::CalculateOutputImageHandler | |
| virtual | ~CalculateOutputImageHandler () |
| Destructor. More... | |
| virtual SubImageBox | calculateInputSubImageBox (int, const SubImageBox &outputSubImageBox) |
Called by the host to determine which input image region (tile) of input inputIndex is required to calculate a certain output image region (page) of output image. More... | |
| virtual void | calculateOutputSubImage (SubImage *outputSubImage, SubImage *inputSubImages, UserThreadData *userThreadData)=0 |
Calculates page outputSubImage of output image given the input image tiles in array inputSubImages. More... | |
| virtual UserThreadData * | createUserThreadData () |
| Creates the thread local user data for a thread. More... | |
Detailed Description
Base class for handlers that are used for the Module::processAllPages facility.
The main difference from the CalculateOutputImageHandler base class is that it adds the calculateOutputImageProperties() virtual method, which you can reimplement to set up the properties of the temporary output image generated by Module::processAllPages(yourHandler). This allows to adjust the properties of the output image, e.g., its page extent.
- Note
- If you are looking for a way to implement this handler with typed subimages (TSubImage), please have a look at the TypedProcessAllPagesHandler template!
Definition at line 37 of file mlProcessAllPagesHandler.h.
Member Function Documentation
◆ calculateOutputImageProperties()
|
inlinevirtual |
Calculates the (temporary and virtual) output image's properties, which by default has the properties of input image 0.
- Note
- Since this handler is called from Module::processAllPages(), the output image will not allocate any page data. It is merely used to define the properties of the input subimages and the page tiling seen in calculateOutputSubImage().
Reimplemented in ml::OrderedProcessAllPagesHandler, and ml::OrderedSingleInputProcessAllPagesHandler.
Definition at line 46 of file mlProcessAllPagesHandler.h.
◆ getName()
|
inlinevirtual |
Returns the name of the handler.
Reimplement this function to see the name of the handler in the Profiling.
Definition at line 61 of file mlProcessAllPagesHandler.h.
◆ install()
| void ml::ProcessAllPagesHandler::install | ( | PagedImage * | outImg | ) |
Installs the handler on the PagedImage, which is typically called by the ML Host; do not call it yourself!
◆ updateProgress()
|
inlinevirtual |
Called in regular intervals if wantsProgressUpdates() == true.
It is guaranteed that this method is called with progress == 1. This method is only called by the new ML host.
Definition at line 54 of file mlProcessAllPagesHandler.h.
◆ wantsProgressUpdates()
|
inlinevirtual |
Returns whether the handler wants to receive progress updates via updateProgress().
Definition at line 49 of file mlProcessAllPagesHandler.h.
The documentation for this class was generated from the following file:
- MeVis/Foundation/Sources/ML/include/mlProcessAllPagesHandler.h
