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
 Re-implement this method to specify the virtual output image's datatype/size/page extent. More...
 
virtual MLErrorCode processTiles (SubImage *images)=0
 Re-implement this method to do the processing, return ML_RESULT_OK if processing should go on, otherwise return the appropriate error code. More...
 
SubImageBox calculateInputSubImageBox (int, const SubImageBox &outputSubImageBox) override
 Re-implement this method to specify the input image box for the input images By default, it returns outputSubImageBox for all inputs. More...
 
void calculateOutputSubImage (SubImage *outputSubImage, SubImage *inputSubImages, UserThreadData *) override
 internal method, do not re-implement More...
 
- Public Member Functions inherited from ml::ProcessAllPagesHandler
virtual bool wantsProgressUpdates ()
 Returns if the handler want to receive progress updates via updateProgress() More...
 
virtual void updateProgress (double)
 Called in regular intervals when 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 UserThreadDatacreateUserThreadData ()
 Create the thread local user data for a thread. More...
 

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

Re-implement this method to specify the input image box for the input images By default, it returns outputSubImageBox for all inputs.

Reimplemented from ml::CalculateOutputImageHandler.

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

◆ calculateOutputImageProperties()

void ml::OrderedProcessAllPagesHandler::calculateOutputImageProperties ( PagedImage image)
overridevirtual

Re-implement this method to specify the virtual output image's datatype/size/page extent.

Make sure to call the base class method at the beginning of your method.

Reimplemented from ml::ProcessAllPagesHandler.

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

◆ calculateOutputSubImage()

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

internal method, do not re-implement

Implements ml::CalculateOutputImageHandler.

◆ processTiles()

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

Re-implement this method to do 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: