vtkOrientedImageDataResample.h

Go to the documentation of this file.

/*==============================================================================
 
  Copyright (c) Laboratory for Percutaneous Surgery (PerkLab)
  Queen's University, Kingston, ON, Canada. All Rights Reserved.
 
  See COPYRIGHT.txt
  or http://www.slicer.org/copyright/copyright.txt for details.
 
  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
 
  This file was originally developed by Csaba Pinter, PerkLab, Queen's University
  and was supported through the Applied Cancer Research Unit program of Cancer Care
  Ontario with funds provided by the Ontario Ministry of Health and Long-Term Care
 
==============================================================================*/
 
#ifndef __vtkOrientedImageDataResample_h
#define __vtkOrientedImageDataResample_h
 
// Segmentation includes
#include "vtkSegmentationCoreConfigure.h"
 
// VTK includes
#include "vtkObject.h"
 
// std includes
#include <vector>
#include <cmath> // for fabs
 
class vtkImageData;
class vtkMatrix4x4;
class vtkOrientedImageData;
class vtkTransform;
class vtkAbstractTransform;

class vtkSegmentationCore_EXPORT vtkOrientedImageDataResample : public vtkObject
{
public:
  static vtkOrientedImageDataResample* New();
  vtkTypeMacro(vtkOrientedImageDataResample, vtkObject);
 
  enum
  {
    OPERATION_MINIMUM,
    OPERATION_MAXIMUM,
    OPERATION_MASKING
  };

  static bool ResampleOrientedImageToReferenceGeometry(vtkOrientedImageData* inputImage,
                                                       vtkMatrix4x4* referenceGeometryMatrix,
                                                       vtkOrientedImageData* outputImage,
                                                       bool linearInterpolation = false);

  static bool ResampleOrientedImageToReferenceOrientedImage(vtkOrientedImageData* inputImage,
                                                            vtkOrientedImageData* referenceImage,
                                                            vtkOrientedImageData* outputImage,
                                                            bool linearInterpolation = false,
                                                            bool padImage = false,
                                                            vtkAbstractTransform* inputImageTransform = nullptr,
                                                            double backgroundValue = 0);

  static void TransformOrientedImage(vtkOrientedImageData* image,
                                     vtkAbstractTransform* transform,
                                     bool geometryOnly = false,
                                     bool alwaysResample = false,
                                     bool linearInterpolation = false,
                                     double backgroundColor[4] = nullptr);

  static bool MergeImage(vtkOrientedImageData* inputImage,
                         vtkOrientedImageData* imageToAppend,
                         vtkOrientedImageData* outputImage,
                         int operation,
                         const int extent[6] = nullptr,
                         double maskThreshold = 0,
                         double fillValue = 1,
                         bool* outputModified = nullptr);

  static bool ModifyImage(vtkOrientedImageData* inputImage,
                          vtkOrientedImageData* modifierImage,
                          int operation,
                          const int extent[6] = nullptr,
                          double maskThreshold = 0,
                          double fillValue = 1);

  static bool CopyImage(vtkOrientedImageData* imageToCopy, vtkOrientedImageData* outputImage, const int extent[6] = nullptr);

  static void PrintImageInformation(vtkImageData* imageData, ostream& os, vtkIndent indent);

  static void FillImage(vtkImageData* image, double fillValue, const int extent[6] = nullptr);
 
public:
  static bool CalculateEffectiveExtent(vtkOrientedImageData* image, int effectiveExtent[6], double threshold = 0.0);

  static void InvalidateExtent(int extent[6]);

  static bool DoGeometriesMatch(vtkOrientedImageData* image1, vtkOrientedImageData* image2);

  static bool DoExtentsMatch(vtkOrientedImageData* image1, vtkOrientedImageData* image2);

  static bool DoGeometriesMatchIgnoreOrigin(vtkOrientedImageData* image1, vtkOrientedImageData* image2);

  static void TransformExtent(const int inputExtent[6], vtkAbstractTransform* inputToOutputTransform, int outputExtent[6]);

  static void TransformBounds(const double inputBounds[6], vtkAbstractTransform* inputToOutputTransform, double outputBounds[6]);

  static void TransformOrientedImageDataBounds(vtkOrientedImageData* image, vtkAbstractTransform* transform, double transformedBounds[6]);

  static bool IsEqual(vtkMatrix4x4* lhs, vtkMatrix4x4* rhs);

  static bool AreEqualWithTolerance(double a, double b) { return fabs(a - b) < 0.0001; };

  static bool GetTransformBetweenOrientedImages(vtkOrientedImageData* image1, vtkOrientedImageData* image2, vtkTransform* image1ToImage2Transform);

  static bool PadImageToContainImage(vtkOrientedImageData* inputImage, vtkOrientedImageData* containedImage, vtkOrientedImageData* outputImage, const int extent[6]);
  static bool PadImageToContainImage(vtkOrientedImageData* inputImage, vtkOrientedImageData* containedImage, vtkOrientedImageData* outputImage);

  static bool IsTransformLinear(vtkAbstractTransform* transform, vtkTransform* linearTransform);

  static bool DoesTransformMatrixContainShear(vtkMatrix4x4* matrix);

  static bool ApplyImageMask(vtkOrientedImageData* input, vtkOrientedImageData* mask, double fillValue, bool notMask = false);

  static void GetLabelValuesInMask(std::vector<int>& labelValues,
                                   vtkOrientedImageData* binaryLabelmap,
                                   vtkOrientedImageData* mask,
                                   const int extent[6] = nullptr,
                                   int maskThreshold = 0);

  static bool IsLabelInMask(vtkOrientedImageData* binaryLabelmap, vtkOrientedImageData* mask, int extent[6] = nullptr, int maskThreshold = 0);
 
  enum ImageTypeCheckResult
  {
    TYPE_OK,
    TYPE_CONVERSION_NEEDED,
    TYPE_CONVERSION_TRUNCATION_NEEDED,
    TYPE_CONVERSION_CLAMPING_NEEDED,
    TYPE_ERROR
  };

  static int IsImageScalarTypeValid(vtkImageData* image);

  static int GetSmallestIntegerTypeForSegmentationScalarRange(double scalarRange[2]);

  static bool CastSegmentationToSmallestIntegerType(vtkImageData* image);

  static bool CastSegmentationToSmallestIntegerType(vtkImageData* image, double scalarRange[2]);

  static void CastImageForValue(vtkImageData* image, double value);
 
protected:
  vtkOrientedImageDataResample();
  ~vtkOrientedImageDataResample() override;
 
private:
  vtkOrientedImageDataResample(const vtkOrientedImageDataResample&) = delete;
  void operator=(const vtkOrientedImageDataResample&) = delete;
};
 
#endif