ml::OrderedSingleInputProcessAllPagesHandler Class Reference

A ProcessAllPages handler that offers ordered tile delivery on a single input image. More...

#include <mlProcessAllPagesHandler.h>

Inheritance diagram for ml::OrderedSingleInputProcessAllPagesHandler:

Public Member Functions
	OrderedSingleInputProcessAllPagesHandler (int inputIndex=0)
void	calculateOutputImageProperties (PagedImage *image) override
	Re-implement this method to specify the virtual output image's datatype/size/page extent.
virtual MLErrorCode	processTile (const SubImage &image)=0
	Re-implement this method to do the processing, return ML_RESULT_OK if processing should go on, otherwise return the appropriate error code.
virtual SubImageBox	calculateInputSubImageBox (const SubImageBox &outputSubImageBox)
	Re-implement 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 re-implement
void	calculateOutputSubImage (SubImage *outputSubImage, SubImage *inputSubImages, UserThreadData *) override
	internal method, do not re-implement
Public Member Functions inherited from ml::ProcessAllPagesHandler
virtual bool	wantsProgressUpdates ()
	Returns if the handler want to receive progress updates via updateProgress()
virtual void	updateProgress (double)
	Called in regular intervals when 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 ()
	Create 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]

virtual SubImageBox ml::OrderedSingleInputProcessAllPagesHandler::calculateInputSubImageBox ( const SubImageBox & outputSubImageBox )

inlinevirtual

Re-implement 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.

References mlrange_cast().

calculateInputSubImageBox() [2/2]

SubImageBox ml::OrderedSingleInputProcessAllPagesHandler::calculateInputSubImageBox ( int inputIndex, const SubImageBox & outputSubImageBox )

overridevirtual

internal method, do not re-implement

Reimplemented from ml::CalculateOutputImageHandler.

calculateOutputImageProperties()

void ml::OrderedSingleInputProcessAllPagesHandler::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.

calculateOutputSubImage()

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

overridevirtual

internal method, do not re-implement

Implements ml::CalculateOutputImageHandler.

processTile()

virtual MLErrorCode ml::OrderedSingleInputProcessAllPagesHandler::processTile ( const SubImage & image )

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.

Member Data Documentation

_image

PagedImage* ml::OrderedSingleInputProcessAllPagesHandler::_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