mitkHeightFieldSurfaceClipImageFilter.h

Go to the documentation of this file.

/*============================================================================

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.

Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.

============================================================================*/

#ifndef MITKHEIGHTFIELDSURFACECLIPIMAGEFILTER_H_HEADER_INCLUDED
#define MITKHEIGHTFIELDSURFACECLIPIMAGEFILTER_H_HEADER_INCLUDED

#include "MitkAlgorithmsExtExports.h"
#include "mitkCommon.h"
#include "mitkGeometry3D.h"
#include "mitkImageTimeSelector.h"
#include "mitkImageToImageFilter.h"
#include "mitkSurface.h"

namespace itk
{
  template <class TPixel, unsigned int VImageDimension>
  class ITK_EXPORT Image;
}

namespace mitk
{
  class MITKALGORITHMSEXT_EXPORT HeightFieldSurfaceClipImageFilter : public ImageToImageFilter
  {
  public:
    typedef std::vector<mitk::Surface *> ClippingPlaneList;

    mitkClassMacro(HeightFieldSurfaceClipImageFilter, ImageToImageFilter);

    itkFactorylessNewMacro(Self);

    itkCloneMacro(Self);

      void SetClippingSurface(Surface *clippingSurface);

    void SetClippingSurfaces(ClippingPlaneList planeList);

    const Surface *GetClippingSurface() const;

    enum
    {
      CLIPPING_MODE_CONSTANT = 0,
      CLIPPING_MODE_MULTIPLYBYFACTOR,
      CLIPPING_MODE_MULTIPLANE
    };

    void SetClippingMode(int mode);

    int GetClippingMode();

    void SetClippingModeToConstant();

    void SetClippingModeToMultiplyByFactor();

    void SetClippingModeToMultiPlaneValue();

    itkSetMacro(ClippingConstant, ScalarType);

    itkGetConstMacro(ClippingConstant, ScalarType);

    itkSetMacro(MultiplicationFactor, ScalarType);

    itkGetConstMacro(MultiplicationFactor, ScalarType);

    itkSetMacro(HeightFieldResolutionX, unsigned int);

    itkGetConstMacro(HeightFieldResolutionX, unsigned int);

    itkSetMacro(HeightFieldResolutionY, unsigned int);

    itkGetConstMacro(HeightFieldResolutionY, unsigned int);

  protected:
    HeightFieldSurfaceClipImageFilter();

    ~HeightFieldSurfaceClipImageFilter() override;

    void GenerateInputRequestedRegion() override;

    void GenerateOutputInformation() override;

    void GenerateData() override;

    template <typename TPixel, unsigned int VImageDimension>
    void _InternalComputeClippedImage(itk::Image<TPixel, VImageDimension> *itkImage,
                                      HeightFieldSurfaceClipImageFilter *clipImageFilter,
                                      vtkPolyData *clippingPolyData,
                                      AffineTransform3D *imageToPlaneTransform);

    ImageTimeSelector::Pointer m_InputTimeSelector;
    ImageTimeSelector::Pointer m_OutputTimeSelector;

    int m_ClippingMode;

    ScalarType m_ClippingConstant;
    ScalarType m_MultiplicationFactor;
    unsigned m_MultiPlaneValue;

    unsigned int m_HeightFieldResolutionX;
    unsigned int m_HeightFieldResolutionY;

    double m_MaxHeight;

    itk::TimeStamp m_TimeOfHeaderInitialization;
  };

} // namespace mitk

#endif /* MITKHEIGHTFIELDSURFACECLIPIMAGEFILTER_H_HEADER_INCLUDED */