vtkEncodedGradientEstimator.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 vtkEncodedGradientEstimator_h
#define vtkEncodedGradientEstimator_h
 
#include "vtkObject.h"
#include "vtkRenderingVolumeModule.h" // For export macro
#include "vtkThreads.h"               // for VTK_MAX_THREADS
 
VTK_ABI_NAMESPACE_BEGIN
class vtkImageData;
class vtkDirectionEncoder;
class vtkMultiThreader;
 
class VTKRENDERINGVOLUME_EXPORT vtkEncodedGradientEstimator : public vtkObject
{
public:
  vtkTypeMacro(vtkEncodedGradientEstimator, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  virtual void SetInputData(vtkImageData*);
  vtkGetObjectMacro(InputData, vtkImageData);


  vtkSetMacro(GradientMagnitudeScale, float);
  vtkGetMacro(GradientMagnitudeScale, float);
  vtkSetMacro(GradientMagnitudeBias, float);
  vtkGetMacro(GradientMagnitudeBias, float);


  vtkSetClampMacro(BoundsClip, vtkTypeBool, 0, 1);
  vtkGetMacro(BoundsClip, vtkTypeBool);
  vtkBooleanMacro(BoundsClip, vtkTypeBool);


  vtkSetVector6Macro(Bounds, int);
  vtkGetVectorMacro(Bounds, int, 6);

  void Update();

  unsigned short* GetEncodedNormals();


  int GetEncodedNormalIndex(vtkIdType xyzIndex);
  int GetEncodedNormalIndex(int xIndex, int yIndex, int zIndex);

  unsigned char* GetGradientMagnitudes();


  vtkSetClampMacro(NumberOfThreads, int, 1, VTK_MAX_THREADS);
  vtkGetMacro(NumberOfThreads, int);


  void SetDirectionEncoder(vtkDirectionEncoder* direnc);
  vtkGetObjectMacro(DirectionEncoder, vtkDirectionEncoder);


  vtkSetMacro(ComputeGradientMagnitudes, vtkTypeBool);
  vtkGetMacro(ComputeGradientMagnitudes, vtkTypeBool);
  vtkBooleanMacro(ComputeGradientMagnitudes, vtkTypeBool);


  vtkSetMacro(CylinderClip, vtkTypeBool);
  vtkGetMacro(CylinderClip, vtkTypeBool);
  vtkBooleanMacro(CylinderClip, vtkTypeBool);


  vtkGetMacro(LastUpdateTimeInSeconds, float);
  vtkGetMacro(LastUpdateTimeInCPUSeconds, float);
 
  vtkGetMacro(UseCylinderClip, int);
  int* GetCircleLimits() { return this->CircleLimits; }


  void SetZeroNormalThreshold(float v);
  vtkGetMacro(ZeroNormalThreshold, float);


  vtkSetClampMacro(ZeroPad, vtkTypeBool, 0, 1);
  vtkGetMacro(ZeroPad, vtkTypeBool);
  vtkBooleanMacro(ZeroPad, vtkTypeBool);
 
  // These variables should be protected but are being
  // made public to be accessible to the templated function.
  // We used to have the templated function as a friend, but
  // this does not work with all compilers
 
  // The input scalar data on which the normals are computed
  vtkImageData* InputData;
 
  // The encoded normals (2 bytes) and the size of the encoded normals
  unsigned short* EncodedNormals;
  int EncodedNormalsSize[3];
 
  // The magnitude of the gradient array and the size of this array
  unsigned char* GradientMagnitudes;
 
  // The time at which the normals were last built
  vtkTimeStamp BuildTime;
 
  vtkGetVectorMacro(InputSize, int, 3);
  vtkGetVectorMacro(InputAspect, float, 3);
 
protected:
  vtkEncodedGradientEstimator();
  ~vtkEncodedGradientEstimator() override;
 
  void ReportReferences(vtkGarbageCollector*) override;
 
  // The number of threads to use when encoding normals
  int NumberOfThreads;
 
  vtkMultiThreader* Threader;
 
  vtkDirectionEncoder* DirectionEncoder;
 
  virtual void UpdateNormals() = 0;
 
  float GradientMagnitudeScale;
  float GradientMagnitudeBias;
 
  float LastUpdateTimeInSeconds;
  float LastUpdateTimeInCPUSeconds;
 
  float ZeroNormalThreshold;
 
  vtkTypeBool CylinderClip;
  int* CircleLimits;
  int CircleLimitsSize;
  int UseCylinderClip;
  void ComputeCircleLimits(int size);
 
  vtkTypeBool BoundsClip;
  int Bounds[6];
 
  int InputSize[3];
  float InputAspect[3];
 
  vtkTypeBool ComputeGradientMagnitudes;
 
  vtkTypeBool ZeroPad;
 
private:
  vtkEncodedGradientEstimator(const vtkEncodedGradientEstimator&) = delete;
  void operator=(const vtkEncodedGradientEstimator&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif