MeVis/Foundation/Sources/ML/include/mlTypedHandlers.h File Reference

#include "mlInitSystemML.h"
#include "mlCarrierTypes.h"
#include "mlTSubImage.h"
#include "mlModuleInterfaces.h"
#include "mlTypeTraits.h"
#include "mlProcessAllPagesHandler.h"
#include "mlPagedImage.h"

Go to the source code of this file.

Classes
class	ml::VariableType
	Base class for all variable types, mainly for doxygen documentation purpose. More...
class	ml::internal::TypedHandlerBase< BaseClass, Derived, NumberOfInputImages >
	The base class for TypedCalculateOutputImageHandler and TypedProcessAllPagesHandler. More...
class	ml::TypedProcessAllPagesHandler< Derived, NumberOfInputImages, VariableType0, VariableType1, VariableType2, VariableType3 >
	TypedProcessAllPagesHandler can be used as a base class for an own ProcessAllPages handler and supports up to 4 type variable types. More...
class	ml::TypedCalculateOutputImageHandler< Derived, NumberOfInputImages, VariableType0, VariableType1, VariableType2, VariableType3 >
	TypedCalculateOutputImageHandler can be used as a base class for an own CalculateOutputImageHandler and supports up to 4 variable types. More...
Namespaces
namespace	ml
	Define the namespace name like in the ML. Default is ml.
namespace	ml::internal
Defines
#define	_ML_COLLECT_ENUMS
Variable Types for Typed Handlers
#define	ML_IMPLEMENT_VARIABLE_TYPE_BEGIN(NAME)
	Macro to declare a variable type, needs to be followed by 0-N ML_IMPLEMENT_VARIABLE_TYPE_CASE or ML_IMPLEMENT_VARIABLE_TYPE_CASE_CARRIERTYPE macros and finished with a ML_IMPLEMENT_VARIABLE_TYPE_END macro.
#define	ML_IMPLEMENT_VARIABLE_TYPE_END
	Macro to end declaration of a variable type.
#define	ML_IMPLEMENT_VARIABLE_TYPE_CASE(TYPE)
	Macro to implement standard type case in a variable type.
#define	ML_IMPLEMENT_VARIABLE_TYPE_CASE_CARRIERTYPE(TYPE)
	Macro to implement carrier type case in a variable type (Automatically maps to CarrierXIn types for variable types 1-3).
#define	ML_IMPLEMENT_VARIABLE_TYPE_CASES_FLOAT
	Defines a variable type case block for all float types.
#define	ML_IMPLEMENT_VARIABLE_TYPE_CASES_INTEGER
	Defines a variable type case block for all integer types.
#define	ML_IMPLEMENT_VARIABLE_TYPE_CASES_CARRIERTYPE
	Defines a variable type case block for all carrier types.
Values to be used in the setup of a TypedCalculateOutputImageHandler/TypedProcessAllPagesHandler
#define	ML_N_INPUTS   0x4000
	Special value that can be passed as number of inputs to the typed handlers.
#define	_ML_SWITCH_SELECT_OFFSET   1024
	Defines offset for switch types (internal).
#define	_ML_OUTPUTINDEX   -1
	Defines special index that means to use the output image.
const int	ml::MLVariableType0 = _ML_SWITCH_SELECT_OFFSET
	Defines to use the result type of variable type 0.
const int	ml::MLVariableType1 = _ML_SWITCH_SELECT_OFFSET+1
	Defines to use the result type of variable type 1.
const int	ml::MLVariableType2 = _ML_SWITCH_SELECT_OFFSET+2
	Defines to use the result type of variable type 2.
const int	ml::MLVariableType3 = _ML_SWITCH_SELECT_OFFSET+3
	Defines to use the result type of variable type 3.

---

Detailed Description

Author:

Florian Link

Date:

09/2009

Definition in file mlTypedHandlers.h.

---

Define Documentation

#define _ML_COLLECT_ENUMS

Value:

const int inputTypes[10] = {                                                                                                     \
    Derived::InputSubImage0_Type, Derived::InputSubImage1_Type, Derived::InputSubImage2_Type, Derived::InputSubImage3_Type, Derived::InputSubImage4_Type,                       \
    Derived::InputSubImage5_Type, Derived::InputSubImage6_Type, Derived::InputSubImage7_Type, Derived::InputSubImage8_Type, Derived::InputSubImage9_Type };                     \
  const int inputReadOnly[10] = {                                                                                                  \
    Derived::InputSubImage0_ReadOnly, Derived::InputSubImage1_ReadOnly, Derived::InputSubImage2_ReadOnly, Derived::InputSubImage3_ReadOnly, Derived::InputSubImage4_ReadOnly,   \
    Derived::InputSubImage5_ReadOnly, Derived::InputSubImage6_ReadOnly, Derived::InputSubImage7_ReadOnly, Derived::InputSubImage8_ReadOnly, Derived::InputSubImage9_ReadOnly }; \
  int variableTypes[4]; \
  setupVariableTypes(variableTypes);

Definition at line 501 of file mlTypedHandlers.h.

Referenced by ml::internal::TypedHandlerBase< ProcessAllPagesHandler, Derived, NumberOfInputImages >::setupKnownProperties(), and ml::internal::TypedHandlerBase< ProcessAllPagesHandler, Derived, NumberOfInputImages >::verifyProperties().

#define _ML_OUTPUTINDEX   -1

Defines special index that means to use the output image.

Definition at line 39 of file mlTypedHandlers.h.

Referenced by ml::internal::TypedHandlerBase< ProcessAllPagesHandler, Derived, NumberOfInputImages >::calculateOutputSubImage(), and ml::internal::TypedHandlerBase< ProcessAllPagesHandler, Derived, NumberOfInputImages >::verifyProperties().

#define _ML_SWITCH_SELECT_OFFSET   1024

Defines offset for switch types (internal).

Definition at line 36 of file mlTypedHandlers.h.

#define ML_N_INPUTS   0x4000

Special value that can be passed as number of inputs to the typed handlers.

It will cause the typed handlers to call a typedCalculateOutputSubImage(TSubImage<OUTTYPE>& outImg, TSubImage<INTYPE>* inImages) method, all input images will have the same type.

Definition at line 33 of file mlTypedHandlers.h.