The AlgorithmModuleExampleWithOutputImageOutputImageHandler handles the page calculation of an output image of AlgorithmModuleExampleWithOutputImage. More...

#include <mlAlgorithmModuleExampleWithOutputImageOutputImageHandler.h>

Inheritance diagram for ml::AlgorithmModuleExampleWithOutputImageOutputImageHandler:

Public Types
enum	{ OutputSubImage_Type = MLVariableType0 , InputSubImage0_Type = MLVariableType0 , InputSubImage0_ReadOnly = true }
	Template configuration of the output/input sub-images. More...

Public Types inherited from ml::internal::TypedHandlerBase< BaseClass, Derived, NumberOfInputImages >
enum	{ OutputSubImage_Type = MLVariableType0 , InputSubImage0_Type = MLVariableType1 , InputSubImage1_Type = MLVariableType2 , InputSubImage2_Type = MLVariableType3 , InputSubImage3_Type = MLVariableType3 , InputSubImage4_Type = MLVariableType3 , InputSubImage5_Type = MLVariableType3 , InputSubImage6_Type = MLVariableType3 , InputSubImage7_Type = MLVariableType3 , InputSubImage8_Type = MLVariableType3 , InputSubImage9_Type = MLVariableType3 , InputSubImage0_ReadOnly = true , InputSubImage1_ReadOnly = true , InputSubImage2_ReadOnly = true , InputSubImage3_ReadOnly = true , InputSubImage4_ReadOnly = true , InputSubImage5_ReadOnly = true , InputSubImage6_ReadOnly = true , InputSubImage7_ReadOnly = true , InputSubImage8_ReadOnly = true , InputSubImage9_ReadOnly = true }

Public Member Functions
	AlgorithmModuleExampleWithOutputImageOutputImageHandler ()

	~AlgorithmModuleExampleWithOutputImageOutputImageHandler () override final

SubImageBox	calculateInputSubImageBox (int inputIndex, const SubImageBox &outputSubImageBox) override final

template<typename OUTTYPE >
void	typedCalculateOutputSubImage (TSubImage< OUTTYPE > &outputSubImage, const TSubImage< OUTTYPE > &inputSubImage, UserThreadData *)

Public Member Functions inherited from ml::internal::TypedHandlerBase< BaseClass, Derived, NumberOfInputImages >
	TypedHandlerBase ()

void	calculateOutputSubImage (SubImage outImg, SubImage inImgs, UserThreadData *userThreadData) override
	Overrides the calculateOutputSubImage of CalculateOutputImageHandler.

Additional Inherited Members
Static Public Member Functions inherited from ml::internal::TypedHandlerBase< BaseClass, Derived, NumberOfInputImages >
static void	setupKnownProperties (PagedImage *outImg)
	Sets up the properties of the `outImg` and its input subimages according to the settings of OutputSubImage_Type, InputSubImage[0-9]_Type, ... and InputSubImage[0-9]_ReadOnly.

static bool	verifyProperties (PagedImage *outImg)
	Verifies the properties of outImg (its data type and the datatypes of the input subimages, comparing them with the static properties of the variable types and fixed datatypes).

Detailed Description

The AlgorithmModuleExampleWithOutputImageOutputImageHandler handles the page calculation of an output image of AlgorithmModuleExampleWithOutputImage.

It should receive all required state from its caller in its constructor and should not keep a reference to the output image nor the module itself. This facilitates to implement a thread safe handler, which does not access non-thread safe shared data, and which can be easily reused by other modules or within other contexts.

Definition at line 18 of file mlAlgorithmModuleExampleWithOutputImageOutputImageHandler.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Template configuration of the output/input sub-images.

Enumerator
OutputSubImage_Type
InputSubImage0_Type
InputSubImage0_ReadOnly

Definition at line 25 of file mlAlgorithmModuleExampleWithOutputImageOutputImageHandler.h.

Constructor & Destructor Documentation

◆ AlgorithmModuleExampleWithOutputImageOutputImageHandler()

ml::AlgorithmModuleExampleWithOutputImageOutputImageHandler::AlgorithmModuleExampleWithOutputImageOutputImageHandler ( )

◆ ~AlgorithmModuleExampleWithOutputImageOutputImageHandler()

ml::AlgorithmModuleExampleWithOutputImageOutputImageHandler::~AlgorithmModuleExampleWithOutputImageOutputImageHandler ( )

finaloverride

Member Function Documentation

◆ calculateInputSubImageBox()

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

finaloverride

◆ typedCalculateOutputSubImage()

template<typename OUTTYPE >

void ml::AlgorithmModuleExampleWithOutputImageOutputImageHandler::typedCalculateOutputSubImage	(	TSubImage< OUTTYPE > &	outputSubImage,
		const TSubImage< OUTTYPE > &	inputSubImage,
		UserThreadData *	)

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

FMEstable/ReleaseMeVis/Projects/AlgorithmModule/MLAlgorithmModuleExamples/Sources/mlAlgorithmModuleExampleWithOutputImageOutputImageHandler.h

Public Types

Public Member Functions

Additional Inherited Members