mlITKModuleAddOns.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2007, MeVis Medical Solutions AG
**
** The user may use this file in accordance with the license agreement provided with
** the Software or, alternatively, in accordance with the terms contained in a
** written agreement between the user and MeVis Medical Solutions AG.
**
** For further information use the contact form at https://www.mevislab.de/contact
**
**************************************************************************************/
 
#pragma once

// Include dll-specific settings.
#include "mlInitSystemITKSupport.h"

#include "mlModuleIncludes.h"
 
// Disable warning 4263 which complains about function overwrites which do not have same
// argument type(s) or same number of arguments, and which hides the base class function. 
// This happens often if a template function overwrites a non-template function as it is done
// in generated ITK modules typically. This should normally be no problem in the generated 
// code, and since it cannot be fixed easilyit is disabled therefore.
#if defined(_MSC_VER)
  #pragma warning(disable : 4263)
#endif
 
ML_START_NAMESPACE
 
// Forward declaration of the internally used structure to managed fields and members.
class AddOnState;
 
//----------------------------------------------------------------------------------
//----------------------------------------------------------------------------------
class MLITK_SUPPORT_EXPORT ITKModuleAddOns
{
 
public:

  enum ITKModuleAddOnConfigs1 {
    Empty                      = 0x00000000,
    DoNotCompile               = 0x00000001,
    IsInplace                  = 0x00000002,
    UseOnlySigned              = 0x00000004,
    UseOnlyDouble              = 0x00000008,
    UseOnlyFloat               = 0x00000010,
    UseOnlyInt                 = 0x00000020,
    IsKernelModule             = 0x00000040,
    IsLevelSetModule           = 0x00000080,
    HasFeatureImage            = 0x00000100,
    IsImageFilter              = 0x00000200,
    IsImageMetric              = 0x00000400,
    IsTransform                = 0x00000800,
    IsInterpolator             = 0x00001000,
    IsOptimizer                = 0x00002000,
    IsSource                   = 0x00004000,
    UseMemBufInput0            = 0x00008000,
    UseMemBufInput1            = 0x00010000,
    UseMemBufInput2            = 0x00020000,
    Only2D                     = 0x00040000,
    Only3D                     = 0x00080000,
    NonScalarInput             = 0x00100000,
    NonScalarOutput            = 0x00200000,
    ConvertsPointSet           = 0x00400000,
    UsesComplex                = 0x00800000,
    UsesSCSL                   = 0x01000000,
    SuppressGetParams          = 0x02000000,
    ClampOutputValues          = 0x04000000,
    AutoGetInputMinMax         = 0x08000000,
    SetOutputMinMax            = 0x10000000,
    UsesTensor                 = 0x20000000,
    UsesCVVectors              = 0x40000000,
    UnUsedMask01_01            = 0x80000000
  };

  enum ITKModuleAddOnConfigs2 {
    UsesImgDimVecOut           = 0x00000001,
    Uses2OutComps              = 0x00000002,
    Uses3OutComps              = 0x00000004,
    Uses4OutComps              = 0x00000008,
    Uses6OutComps              = 0x00000010,
    Uses8OutComps              = 0x00000020,
    Uses16OutComps             = 0x00000040,
    UsesITK                    = 0x00000080,
    UsesVTK                    = 0x00000100,
    UsesGlobalPageExt          = 0x00000200,
    UsesImgDimVecIn            = 0x00000400,
    UseFlatKernel              = 0x00000800,
    UsesNonScalarIntConversion = 0x00001000,
    IdSizedInBox0              = 0x00002000,
    IdSizedInBox1              = 0x00004000,
    IdSizedInBox2              = 0x00008000,
    UnknownMask2_16            = 0x00010000,
    UnknownMask2_17            = 0x00020000,
    UnknownMask2_18            = 0x00040000,
    UnknownMask2_29            = 0x00080000,
    UnknownMask2_20            = 0x00100000,
    UnknownMask2_21            = 0x00200000,
    UnknownMask2_22            = 0x00400000,
    UnknownMask2_23            = 0x00800000,
    UnknownMask2_24            = 0x01000000,
    UnknownMask2_25            = 0x02000000,
    UnknownMask2_26            = 0x04000000,
    UnknownMask2_27            = 0x08000000,
    UnknownMask2_28            = 0x10000000,
    UnknownMask2_39            = 0x20000000,
    UnknownMask2_30            = 0x40000000,
    UnknownMask2_31            = 0x80000000
  };

  ITKModuleAddOns(Module &module, unsigned int configMask1=Empty, unsigned int configMask2=Empty);

  ~ITKModuleAddOns();
 
 
  //-------------------------------
  //-------------------------------

  inline unsigned int getConfigMask1() { return _configMask1; }

  inline unsigned int getConfigMask2() { return _configMask2; }
 

  MLDataType getInputSubImageDataType();

  MLDataType getOutputSubImageDataType(int outIndex=0);
 

  MLTypeInfos *getInSubImageTypeInfos();

  MLTypeInfos *getOutSubImageTypeInfos(int outIndex=0);

  MLint getUsedFilteringDim();
 
 
  //----------------------------------------
  //----------------------------------------

  void      preConstructorStuff();

  void      postConstructorStuff();
 

  void      preActivateAttachments();

  void      postActivateAttachments();
 

  void      preHandleNotification(Field *field);

  void      postHandleNotification(Field *field);
 

  void      preCalcOutImageProps(int outIndex);

  void      postCalcOutImageProps(int outIndex);
 

  SubImageBox preCalcInSubImageBox(int inIndex, const SubImageBox& outSubImgBox, int outIndex);

  SubImageBox postCalcInSubImageBox(int inIndex, const SubImageBox& outSubImgBox, const SubImageBox& processedBox, int outIndex);
 

  void      setInSubImageProperties(int outIndex, PagedImage &outImg);
 

  void      preSetFilterParams();

  void      postSetFilterParams();
 

  void      preGetFilterParams();

  void      postGetFilterParams();
 

  void      preCalcOutSubImage(SubImage &outSubImg, int outIndex, SubImage *inSubImgs);

  void      postCalcOutSubImage(SubImage &outSubImg, int outIndex, SubImage *inSubImgs);
 
 
  //------------------------------------
  //------------------------------------

  static std::string GetStringFromInt(int intVal, unsigned int reservedSpaces=1);

  static int GetIntFromString(const std::string &str, bool &isValid);

  static bool isCompiledDim(MLint dim);

  static bool isCompiledType(MLDataType dt);

  static void printSubImgBox(const char *str, const SubImageBox &box);

  static void printVector(const char *str, const ImageVector &vec);

  static MLDataType getBestSignedType(MLDataType inDataType,
                                      MLdouble minVV,
                                      MLdouble maxVV,
                                      int preferDouble);

  static MLDataType getBestIntegerType(MLDataType inDataType,
                                       MLdouble minVV,
                                       MLdouble maxVV);

  static bool CheckNumberSizes(size_t s1, size_t s2, 
                               const std::string &funcName,
                               const std::string &str="Number of parameter should be ");

  static void packMemory(void *targetBuffer, void *srcBuffer, size_t setSize, size_t gapSize, size_t numSets);

  static void packSubImg(SubImage &subImg, const SubImageBox &imgBox);
 
 
private:
  ITKModuleAddOns(const ITKModuleAddOns &);

  ITKModuleAddOns &operator=(const ITKModuleAddOns &);

  Module      &_module;

  unsigned int _configMask1;

  unsigned int _configMask2;

  AddOnState  *_addOnState;
};
 
ML_END_NAMESPACE