#include <mlAlgorithmModuleExampleWithOutputImageOutputImageHandler.h>
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< CalculateOutputImageHandler, AlgorithmModuleExampleWithOutputImageOutputImageHandler, NumberOfInputImages > | |
| enum | |
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< CalculateOutputImageHandler, AlgorithmModuleExampleWithOutputImageOutputImageHandler, NumberOfInputImages > | |
| TypedHandlerBase () | |
| void | calculateOutputSubImage (SubImage *outImg, SubImage *inImgs, UserThreadData *userThreadData) override |
| Overrides the calculateOutputSubImage of CalculateOutputImageHandler. | |
| Public Member Functions inherited from ml::CalculateOutputImageHandler | |
| virtual | ~CalculateOutputImageHandler () |
| Destructor. | |
| virtual UserThreadData * | createUserThreadData () |
Additional Inherited Members | |
| Static Public Member Functions inherited from ml::internal::TypedHandlerBase< CalculateOutputImageHandler, AlgorithmModuleExampleWithOutputImageOutputImageHandler, NumberOfInputImages > | |
| static void | setupKnownProperties (PagedImage *outImg) |
| static bool | verifyProperties (PagedImage *outImg) |
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()
|
finaloverride |
Member Function Documentation
◆ calculateInputSubImageBox()
|
finaloverridevirtual |
Called by the host to determine which input image region (tile) of input inputIndex is required to calculate a certain output image region (page) of output image. Default is that a region with position and location of outputSubImageBox is requested from input image inputIndex.
Reimplemented from ml::CalculateOutputImageHandler.
References calculateInputSubImageBox().
Referenced by calculateInputSubImageBox().
◆ typedCalculateOutputSubImage()
| void ml::AlgorithmModuleExampleWithOutputImageOutputImageHandler::typedCalculateOutputSubImage | ( | TSubImage< OUTTYPE > & | outputSubImage, |
| const TSubImage< OUTTYPE > & | inputSubImage, | ||
| UserThreadData * | ) |
References typedCalculateOutputSubImage().
Referenced by typedCalculateOutputSubImage().
The documentation for this class was generated from the following file:
- FMEstable/ReleaseMeVis/Projects/AlgorithmModule/MLAlgorithmModuleExamples/Sources/mlAlgorithmModuleExampleWithOutputImageOutputImageHandler.h
