vtkGridTransform.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef vtkGridTransform_h
#define vtkGridTransform_h
 
#include "vtkFiltersHybridModule.h" // For export macro
#include "vtkWarpTransform.h"
 
VTK_ABI_NAMESPACE_BEGIN
class vtkAlgorithmOutput;
class vtkGridTransformConnectionHolder;
class vtkImageData;
 
#define VTK_GRID_NEAREST VTK_NEAREST_INTERPOLATION
#define VTK_GRID_LINEAR VTK_LINEAR_INTERPOLATION
#define VTK_GRID_CUBIC VTK_CUBIC_INTERPOLATION
 
class VTKFILTERSHYBRID_EXPORT vtkGridTransform : public vtkWarpTransform
{
public:
  static vtkGridTransform* New();
  vtkTypeMacro(vtkGridTransform, vtkWarpTransform);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  virtual void SetDisplacementGridConnection(vtkAlgorithmOutput*);
  virtual void SetDisplacementGridData(vtkImageData*);
  virtual vtkImageData* GetDisplacementGrid();


  vtkSetMacro(DisplacementScale, double);
  vtkGetMacro(DisplacementScale, double);


  vtkSetMacro(DisplacementShift, double);
  vtkGetMacro(DisplacementShift, double);


  void SetInterpolationMode(int mode);
  vtkGetMacro(InterpolationMode, int);
  void SetInterpolationModeToNearestNeighbor()
  {
    this->SetInterpolationMode(VTK_NEAREST_INTERPOLATION);
  }
  void SetInterpolationModeToLinear() { this->SetInterpolationMode(VTK_LINEAR_INTERPOLATION); }
  void SetInterpolationModeToCubic() { this->SetInterpolationMode(VTK_CUBIC_INTERPOLATION); }
  const char* GetInterpolationModeAsString();

  vtkAbstractTransform* MakeTransform() override;

  vtkMTimeType GetMTime() override;
 
protected:
  vtkGridTransform();
  ~vtkGridTransform() override;

  void InternalUpdate() override;

  void InternalDeepCopy(vtkAbstractTransform* transform) override;


  void ForwardTransformPoint(const float in[3], float out[3]) override;
  void ForwardTransformPoint(const double in[3], double out[3]) override;
 
  void ForwardTransformDerivative(const float in[3], float out[3], float derivative[3][3]) override;
  void ForwardTransformDerivative(
    const double in[3], double out[3], double derivative[3][3]) override;
 
  void InverseTransformPoint(const float in[3], float out[3]) override;
  void InverseTransformPoint(const double in[3], double out[3]) override;
 
  void InverseTransformDerivative(const float in[3], float out[3], float derivative[3][3]) override;
  void InverseTransformDerivative(
    const double in[3], double out[3], double derivative[3][3]) override;
 
  void (*InterpolationFunction)(double point[3], double displacement[3], double derivatives[3][3],
    void* gridPtr, int gridType, int inExt[6], vtkIdType inInc[3]);
 
  int InterpolationMode;
  double DisplacementScale;
  double DisplacementShift;
 
  void* GridPointer;
  int GridScalarType;
  double GridSpacing[3];
  double GridOrigin[3];
  int GridExtent[6];
  vtkIdType GridIncrements[3];
 
private:
  vtkGridTransform(const vtkGridTransform&) = delete;
  void operator=(const vtkGridTransform&) = delete;
 
  vtkGridTransformConnectionHolder* ConnectionHolder;
};
 
//----------------------------------------------------------------------------
inline const char* vtkGridTransform::GetInterpolationModeAsString()
{
  switch (this->InterpolationMode)
  {
    case VTK_GRID_NEAREST:
      return "NearestNeighbor";
    case VTK_GRID_LINEAR:
      return "Linear";
    case VTK_GRID_CUBIC:
      return "Cubic";
    default:
      return "";
  }
}
 
VTK_ABI_NAMESPACE_END
#endif