MeVisLab Toolbox Reference
ml::OrderedProcessAllPagesHandler Class Referenceabstract

A ProcessAllPages handler that offers ordered tile delivery on any number of input images. More...

#include <mlProcessAllPagesHandler.h>

Inheritance diagram for ml::OrderedProcessAllPagesHandler:
ml::ProcessAllPagesHandler ml::CalculateOutputImageHandler ml::ClusterHandler< CLUSTERVOXELTYPE, DerivedAlgorithm >

Public Member Functions

 OrderedProcessAllPagesHandler ()
 
void calculateOutputImageProperties (PagedImage *image) override
 Reimplement this method to specify the virtual output image's data type/size/page extent.
 
virtual MLErrorCode processTiles (SubImage *images)=0
 Reimplement this method to perform the processing, return ML_RESULT_OK if processing should go on; otherwise, return the appropriate error code.
 
SubImageBox calculateInputSubImageBox (int, const SubImageBox &outputSubImageBox) override
 Reimplement this method to specify the input image box for the input images.
 
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 chargetName ()
 Returns the name of the handler.
 
- Public Member Functions inherited from ml::CalculateOutputImageHandler
virtual ~CalculateOutputImageHandler ()
 Destructor.
 
virtual UserThreadDatacreateUserThreadData ()
 Creates the thread local user data for a thread.
 

Protected Attributes

PagedImage_image
 

Detailed Description

A ProcessAllPages handler that offers ordered tile delivery on any number of input images.

Definition at line 109 of file mlProcessAllPagesHandler.h.

Constructor & Destructor Documentation

◆ OrderedProcessAllPagesHandler()

ml::OrderedProcessAllPagesHandler::OrderedProcessAllPagesHandler ( )

Member Function Documentation

◆ calculateInputSubImageBox()

SubImageBox ml::OrderedProcessAllPagesHandler::calculateInputSubImageBox ( int ,
const SubImageBox & outputSubImageBox )
overridevirtual

Reimplement this method to specify the input image box for the input images.

By default, it returns outputSubImageBox for all inputs.

Reimplemented from ml::CalculateOutputImageHandler.

◆ calculateOutputImageProperties()

void ml::OrderedProcessAllPagesHandler::calculateOutputImageProperties ( PagedImage * image)
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()

void ml::OrderedProcessAllPagesHandler::calculateOutputSubImage ( SubImage * outputSubImage,
SubImage * inputSubImages,
UserThreadData *  )
overridevirtual

Internal method, do not reimplement!

Implements ml::CalculateOutputImageHandler.

◆ processTiles()

virtual MLErrorCode ml::OrderedProcessAllPagesHandler::processTiles ( SubImage * images)
pure virtual

Reimplement this method to perform the processing, return ML_RESULT_OK if processing should go on; otherwise, return the appropriate error code.

Implemented in ml::ClusterHandler< CLUSTERVOXELTYPE, DerivedAlgorithm >.

Member Data Documentation

◆ _image

PagedImage* ml::OrderedProcessAllPagesHandler::_image
protected

Definition at line 131 of file mlProcessAllPagesHandler.h.


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