ML Reference
Public Member Functions
ml::ProcessAllPagesHandler Class Reference
Image Processing

Base class for handlers that are used for the Module::processAllPages facility. More...

#include <mlProcessAllPagesHandler.h>

Inheritance diagram for ml::ProcessAllPagesHandler:
ml::CalculateOutputImageHandler ml::internal::TypedHandlerBase< ProcessAllPagesHandler, Derived, NumberOfInputImages > ml::TypedProcessAllPagesHandler< Derived, NumberOfInputImages, VariableType0, VariableType1, VariableType2, VariableType3 >

List of all members.

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.
void install (PagedImage *outImg)
 Installs the handler on the PagedImage (which is typically called by the ML Host, do not call it yourself!)

Detailed Description

Base class for handlers that are used for the Module::processAllPages facility.

The main difference to the CalculateOutputImageHandler base class is that it adds the calculateOutputImageProperties() virtual method, which you can reimplement to setup the properties of the temporary output image that Module::processAllPages(yourHandler) generates. 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 sub images (TSubImage), please have a look at the TypedProcessAllPagesHandler template.

Definition at line 30 of file mlProcessAllPagesHandler.h.

Member Function Documentation

virtual void ml::ProcessAllPagesHandler::calculateOutputImageProperties ( PagedImage *  ) [inline, virtual]

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 sub images and the page tiling that one sees in calculateOutputSubImage().

Definition at line 39 of file mlProcessAllPagesHandler.h.

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!)

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