mlITKKernelSupport.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 "mlInitSystemITKSupport.h"
 
// Include most ML specific things.
#include "mlModuleIncludes.h"
#include "mlITKSupport.h"
#include "mlITKFlatStructElement.h"
#include "mlKernel.h"
 
#include <itkNeighborhood.h>
#include <itkFlatStructuringElement.h>
#include <itkNumericTraits.h>
 
namespace itk {
 
//----------------------------------------------------------------------------------
//----------------------------------------------------------------------------------
template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>, class SuperClss = Neighborhood<TPixel, VDimension, TAllocator > >
class MLITKStructuringElementBase : public SuperClss
{
public:
  typedef MLITKStructuringElementBase Self;
 
  typedef Neighborhood<TPixel, VDimension, TAllocator> Superclass;
 
  typedef TAllocator AllocatorType;
 
  itkStaticConstMacro(NeighborhoodDimension, unsigned int, VDimension);
 
  typedef TPixel PixelType;
 
 
  typedef typename AllocatorType::iterator Iterator;
  typedef typename AllocatorType::const_iterator ConstIterator;
 
 
  typedef typename Superclass::SizeType SizeType;
  typedef typename Superclass::SizeValueType SizeValueType;
 
 
  typedef typename Superclass::OffsetType OffsetType;
  typedef typename OffsetType::OffsetValueType OffsetValueType;
 
  typedef typename Superclass::RadiusType RadiusType;
 
  typedef SliceIterator<TPixel, Self> SliceIteratorType;
 
  MLITKStructuringElementBase(){ }
 
  MLITKStructuringElementBase(const ML_NAMESPACE::Kernel &kernel)
  {
    // Initialize structure element from ML kernel.
    CreateStructuringElement(kernel);
  }
 
  virtual ~MLITKStructuringElementBase() {}
 
  MLITKStructuringElementBase(const Self& other)
    : SuperClss(other)
  {
  }
 
  Self &operator=(const Self& other)
  {
    Superclass::operator=(other);
    return *this;
  }
 
  virtual void setKernelFromString(const std::string &kernelStr)
  {
    // Create an ML kernel from from the passed string.
    ML_NAMESPACE::Kernel kernelFromStr;
    kernelFromStr.setKernel(kernelStr);
 
    // Initialize structure element from ML kernel.
    CreateStructuringElement(kernelFromStr);
  }
 
  virtual void CreateStructuringElement(const ML_NAMESPACE::Kernel &kernel)
  {
    // Reset size to be sure that previous settings are cleared.
    SizeType itkKExt;
    itkKExt.Fill(0);
    this->SetRadius(itkKExt);
 
    // Get extents of MK kernel.
    ML_NAMESPACE::ImageVector kExt = kernel.getExtent();
 
    // Get maximum extents of MK kernel.
    itkKExt = ML_NAMESPACE::ITKSizeFromMLVector<SizeType>(kExt);
    this->SetRadius(itkKExt);
 
    // Get half kernel extent. Note that we rely on odd kernel extents.
    ML_NAMESPACE::ImageVector shiftHalf(kernel.getNegativeExtent());
 
    // Scan all values of the ML kernel and set them in the itk kernel.
    ML_NAMESPACE::ImageVector pos(0);
    OffsetType offset;
    offset.Fill(0);
    for (size_t n=0; n < kernel.getTabSize(); n++){
      pos.set(kernel.getCoordTab()[n]);
      for (unsigned int i=0; i<offset.GetOffsetDimension(); i++){
        // ITK structure elements are symmetric to the origin. So shift
        // ML kernel element from (always positive) position half kernel left.
        offset[i] = pos[i]-shiftHalf[i];
      }
 
      // Set itk kernel element.
      (*this)[offset] = static_cast<TPixel>(kernel.getValueTab()[n]);
    }
  }
};
 
//----------------------------------------------------------------------------------
//----------------------------------------------------------------------------------
template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel> >
class MLITKStructuringElement : public MLITKStructuringElementBase<TPixel, VDimension, TAllocator, Neighborhood<TPixel, VDimension, TAllocator > >
{
public:
  typedef MLITKStructuringElement Self;
 
  typedef Neighborhood<TPixel, VDimension, TAllocator > NeighbourHoodClass;
 
  typedef MLITKStructuringElementBase<TPixel, VDimension, TAllocator, NeighbourHoodClass > Superclass;
 
  typedef TAllocator AllocatorType;
 
  itkStaticConstMacro(NeighborhoodDimension, unsigned int, VDimension);
 
  typedef TPixel PixelType;
 
 
  typedef typename AllocatorType::iterator Iterator;
  typedef typename AllocatorType::const_iterator ConstIterator;
 
 
  typedef typename Superclass::SizeType SizeType;
  typedef typename Superclass::SizeValueType SizeValueType;
 
 
  typedef typename Superclass::OffsetType OffsetType;
  typedef typename OffsetType::OffsetValueType OffsetValueType;
 
  typedef typename Superclass::RadiusType RadiusType;
 
  typedef SliceIterator<TPixel, Self> SliceIteratorType;
 
  MLITKStructuringElement() : Superclass() { }
 
  MLITKStructuringElement(const ML_NAMESPACE::Kernel &kernel) : Superclass(kernel){ }
 
  MLITKStructuringElement(const Self& other): Superclass(other){ }
 
  Self &operator=(const Self& other)
  {
    Superclass::operator=(other);
    return *this;
  }
};
 
} // namespace itk
 
//--------------------------------------------------------------------------------
//--------------------------------------------------------------------------------
#define ML_ITK_KERNEL_WRAPPER_TYPEDEFS_0(CLASS_NAME, NAMESPACE)                 \
                                                                                \
  /*--------------------------------------------------------------------*/      \
      \
  /*--------------------------------------------------------------------*/      \
  typedef itk::MLITKStructuringElement<ITK_INDATATYPE,DIM> MLITKKernelType;     \
                                                                                \
  /*--------------------------------------------------------------------*/      \
      \
  /*--------------------------------------------------------------------*/      \
  typedef NAMESPACE::CLASS_NAME<_TEMPLATE_INPUTS0, MLITKKernelType> FilterType; \
 
 
//--------------------------------------------------------------------------------
//--------------------------------------------------------------------------------
#define ML_ITK_KERNEL_WRAPPER_TYPEDEFS_1(CLASS_NAME, NAMESPACE)                 \
                                                                                \
  /*--------------------------------------------------------------------*/      \
      \
  /*--------------------------------------------------------------------*/      \
  typedef itk::MLITKStructuringElement<ITK_INDATATYPE,DIM> MLITKKernelType;     \
                                                                                \
  /*--------------------------------------------------------------------*/      \
      \
  /*--------------------------------------------------------------------*/      \
  typedef NAMESPACE::CLASS_NAME<_TEMPLATE_INPUTS1, MLITKKernelType> FilterType; \
 
 
 
//--------------------------------------------------------------------------------
//--------------------------------------------------------------------------------
#define ML_ITK_KERNEL_WRAPPER_TYPEDEFS_2(CLASS_NAME, NAMESPACE)                 \
                                                                                \
  /*--------------------------------------------------------------------*/      \
      \
  /*--------------------------------------------------------------------*/      \
  typedef itk::MLITKStructuringElement<ITK_INDATATYPE,DIM> MLITKKernelType;     \
                                                                                \
  /*--------------------------------------------------------------------*/      \
      \
  /*--------------------------------------------------------------------*/      \
  typedef NAMESPACE::CLASS_NAME<_TEMPLATE_INPUTS2, MLITKKernelType> FilterType; \
 
 
 
//--------------------------------------------------------------------------------
//--------------------------------------------------------------------------------
#define ML_ITK_FLAT_KERNEL_WRAPPER_TYPEDEFS_0(CLASS_NAME, NAMESPACE)                \
                                                                                    \
  /*--------------------------------------------------------------------*/          \
          \
  /*--------------------------------------------------------------------*/          \
  typedef itk::FlatStructuringElement<DIM> MLITKFLATKernelType;                     \
                                                                                    \
  /*--------------------------------------------------------------------*/          \
          \
  /*--------------------------------------------------------------------*/          \
  typedef NAMESPACE::CLASS_NAME<_TEMPLATE_INPUTS0, MLITKFLATKernelType > FilterType; \
 
 
//--------------------------------------------------------------------------------
//--------------------------------------------------------------------------------
#define ML_ITK_FLAT_KERNEL_WRAPPER_TYPEDEFS_1(CLASS_NAME, NAMESPACE)                \
                                                                                    \
  /*--------------------------------------------------------------------*/          \
          \
  /*--------------------------------------------------------------------*/          \
  typedef itk::FlatStructuringElement<DIM> MLITKFLATKernelType;                     \
                                                                                    \
  /*--------------------------------------------------------------------*/          \
          \
  /*--------------------------------------------------------------------*/          \
  typedef NAMESPACE::CLASS_NAME<_TEMPLATE_INPUTS1, MLITKFLATKernelType > FilterType; \
 
 
 
//--------------------------------------------------------------------------------
//--------------------------------------------------------------------------------
#define ML_ITK_KERNEL_WRAPPER_0_2D(PROJECT_PREFIX, CLASS_NAME, NAMESPACE) \
  _ML_ITK_WRAPPER(PROJECT_PREFIX, CLASS_NAME, NAMESPACE, _ML_ITK_DETERMINE_IN_REGION_N, \
                  ML_ITK_KERNEL_WRAPPER_TYPEDEFS_0, \
                  ML_IMPLEMENT_ALL_ITK_2D_CASES, _ML_ITK_DETERMINE_OUT_REGION_N)
 
//--------------------------------------------------------------------------------
//--------------------------------------------------------------------------------
#define ML_ITK_KERNEL_WRAPPER_0_3D(PROJECT_PREFIX, CLASS_NAME, NAMESPACE) \
  _ML_ITK_WRAPPER(PROJECT_PREFIX, CLASS_NAME, NAMESPACE, _ML_ITK_DETERMINE_IN_REGION_N, \
                  ML_ITK_KERNEL_WRAPPER_TYPEDEFS_0, \
                  ML_IMPLEMENT_ALL_ITK_3D_CASES, _ML_ITK_DETERMINE_OUT_REGION_N)
 
//--------------------------------------------------------------------------------
//--------------------------------------------------------------------------------
#define ML_ITK_KERNEL_WRAPPER_0_6D(PROJECT_PREFIX, CLASS_NAME, NAMESPACE) \
  _ML_ITK_WRAPPER(PROJECT_PREFIX, CLASS_NAME, NAMESPACE, _ML_ITK_DETERMINE_IN_REGION_N, \
                  ML_ITK_KERNEL_WRAPPER_TYPEDEFS_0, \
                  ML_IMPLEMENT_ALL_ITK_6D_CASES, _ML_ITK_DETERMINE_OUT_REGION_N)
 
 
//--------------------------------------------------------------------------------
//--------------------------------------------------------------------------------
#define ML_ITK_KERNEL_WRAPPER_1_2D(PROJECT_PREFIX, CLASS_NAME, NAMESPACE) \
  _ML_ITK_WRAPPER(PROJECT_PREFIX, CLASS_NAME, NAMESPACE, _ML_ITK_DETERMINE_IN_REGION_N, \
                  ML_ITK_KERNEL_WRAPPER_TYPEDEFS_1, \
                  ML_IMPLEMENT_ALL_ITK_2D_CASES, _ML_ITK_DETERMINE_OUT_REGION_N)
 
//--------------------------------------------------------------------------------
//--------------------------------------------------------------------------------
#define ML_ITK_KERNEL_WRAPPER_1_3D(PROJECT_PREFIX, CLASS_NAME, NAMESPACE) \
  _ML_ITK_WRAPPER(PROJECT_PREFIX, CLASS_NAME, NAMESPACE, _ML_ITK_DETERMINE_IN_REGION_N, \
                  ML_ITK_KERNEL_WRAPPER_TYPEDEFS_1, \
                  ML_IMPLEMENT_ALL_ITK_3D_CASES, _ML_ITK_DETERMINE_OUT_REGION_N)
 
//--------------------------------------------------------------------------------
//--------------------------------------------------------------------------------
#define ML_ITK_KERNEL_WRAPPER_1_6D(PROJECT_PREFIX, CLASS_NAME, NAMESPACE) \
  _ML_ITK_WRAPPER(PROJECT_PREFIX, CLASS_NAME, NAMESPACE, _ML_ITK_DETERMINE_IN_REGION_N, \
                  ML_ITK_KERNEL_WRAPPER_TYPEDEFS_1, \
                  ML_IMPLEMENT_ALL_ITK_6D_CASES, _ML_ITK_DETERMINE_OUT_REGION_N)
 
 
//--------------------------------------------------------------------------------
//--------------------------------------------------------------------------------
#define ML_ITK_KERNEL_WRAPPER_2_6D(PROJECT_PREFIX, CLASS_NAME, NAMESPACE) \
  _ML_ITK_WRAPPER(PROJECT_PREFIX, CLASS_NAME, NAMESPACE, _ML_ITK_DETERMINE_IN_REGION_N, \
                  ML_ITK_KERNEL_WRAPPER_TYPEDEFS_2, \
                  ML_IMPLEMENT_ALL_ITK_6D_CASES, _ML_ITK_DETERMINE_OUT_REGION_N)
 
 
// For flat kernels:
 
//--------------------------------------------------------------------------------
//--------------------------------------------------------------------------------
#define ML_ITK_FLAT_KERNEL_WRAPPER_0_2D(PROJECT_PREFIX, CLASS_NAME, NAMESPACE) \
  _ML_ITK_WRAPPER(PROJECT_PREFIX, CLASS_NAME, NAMESPACE, _ML_ITK_DETERMINE_IN_REGION_N, \
                  ML_ITK_FLAT_KERNEL_WRAPPER_TYPEDEFS_0, \
                  ML_IMPLEMENT_ALL_ITK_2D_CASES, _ML_ITK_DETERMINE_OUT_REGION_N)
 
//--------------------------------------------------------------------------------
//--------------------------------------------------------------------------------
#define ML_ITK_FLAT_KERNEL_WRAPPER_0_3D(PROJECT_PREFIX, CLASS_NAME, NAMESPACE) \
  _ML_ITK_WRAPPER(PROJECT_PREFIX, CLASS_NAME, NAMESPACE, _ML_ITK_DETERMINE_IN_REGION_N, \
                  ML_ITK_FLAT_KERNEL_WRAPPER_TYPEDEFS_0, \
                  ML_IMPLEMENT_ALL_ITK_3D_CASES, _ML_ITK_DETERMINE_OUT_REGION_N)
 
//--------------------------------------------------------------------------------
//--------------------------------------------------------------------------------
#define ML_ITK_FLAT_KERNEL_WRAPPER_0_6D(PROJECT_PREFIX, CLASS_NAME, NAMESPACE) \
  _ML_ITK_WRAPPER(PROJECT_PREFIX, CLASS_NAME, NAMESPACE, _ML_ITK_DETERMINE_IN_REGION_N, \
                  ML_ITK_FLAT_KERNEL_WRAPPER_TYPEDEFS_0, \
                  ML_IMPLEMENT_ALL_ITK_6D_CASES, _ML_ITK_DETERMINE_OUT_REGION_N)
 
 
//--------------------------------------------------------------------------------
//--------------------------------------------------------------------------------
#define ML_ITK_FLAT_KERNEL_WRAPPER_1_2D(PROJECT_PREFIX, CLASS_NAME, NAMESPACE) \
  _ML_ITK_WRAPPER(PROJECT_PREFIX, CLASS_NAME, NAMESPACE, _ML_ITK_DETERMINE_IN_REGION_N, \
                  ML_ITK_FLAT_KERNEL_WRAPPER_TYPEDEFS_1, \
                  ML_IMPLEMENT_ALL_ITK_2D_CASES, _ML_ITK_DETERMINE_OUT_REGION_N)
 
//--------------------------------------------------------------------------------
//--------------------------------------------------------------------------------
#define ML_ITK_FLAT_KERNEL_WRAPPER_1_3D(PROJECT_PREFIX, CLASS_NAME, NAMESPACE) \
  _ML_ITK_WRAPPER(PROJECT_PREFIX, CLASS_NAME, NAMESPACE, _ML_ITK_DETERMINE_IN_REGION_N, \
                  ML_ITK_FLAT_KERNEL_WRAPPER_TYPEDEFS_1, \
                  ML_IMPLEMENT_ALL_ITK_3D_CASES, _ML_ITK_DETERMINE_OUT_REGION_N)
 
//--------------------------------------------------------------------------------
//--------------------------------------------------------------------------------
#define ML_ITK_FLAT_KERNEL_WRAPPER_1_6D(PROJECT_PREFIX, CLASS_NAME, NAMESPACE) \
  _ML_ITK_WRAPPER(PROJECT_PREFIX, CLASS_NAME, NAMESPACE, _ML_ITK_DETERMINE_IN_REGION_N, \
                  ML_ITK_FLAT_KERNEL_WRAPPER_TYPEDEFS_1, \
                  ML_IMPLEMENT_ALL_ITK_6D_CASES, _ML_ITK_DETERMINE_OUT_REGION_N)