MeVisLab Toolbox Reference
ml::AlgorithmModuleExampleWithOutputImageOutputImageHandler Class Referencefinal

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

#include <mlAlgorithmModuleExampleWithOutputImageOutputImageHandler.h>

Inheritance diagram for ml::AlgorithmModuleExampleWithOutputImageOutputImageHandler:
ml::TypedCalculateOutputImageHandler< AlgorithmModuleExampleWithOutputImageOutputImageHandler, 1, ScalarTypes >

Public Types

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

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

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: