VTK  9.3.0
vtkSampleFunction.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
30 #ifndef vtkSampleFunction_h
31 #define vtkSampleFunction_h
32 
33 #include "vtkImageAlgorithm.h"
34 #include "vtkImagingHybridModule.h" // For export macro
35 
36 VTK_ABI_NAMESPACE_BEGIN
38 class vtkDataArray;
39 
40 class VTKIMAGINGHYBRID_EXPORT vtkSampleFunction : public vtkImageAlgorithm
41 {
42 public:
44  void PrintSelf(ostream& os, vtkIndent indent) override;
45 
51 
53 
57  vtkGetObjectMacro(ImplicitFunction, vtkImplicitFunction);
59 
61 
64  vtkSetMacro(OutputScalarType, int);
65  vtkGetMacro(OutputScalarType, int);
66  void SetOutputScalarTypeToDouble() { this->SetOutputScalarType(VTK_DOUBLE); }
67  void SetOutputScalarTypeToFloat() { this->SetOutputScalarType(VTK_FLOAT); }
68  void SetOutputScalarTypeToLong() { this->SetOutputScalarType(VTK_LONG); }
69  void SetOutputScalarTypeToUnsignedLong() { this->SetOutputScalarType(VTK_UNSIGNED_LONG); }
70  void SetOutputScalarTypeToInt() { this->SetOutputScalarType(VTK_INT); }
71  void SetOutputScalarTypeToUnsignedInt() { this->SetOutputScalarType(VTK_UNSIGNED_INT); }
72  void SetOutputScalarTypeToShort() { this->SetOutputScalarType(VTK_SHORT); }
73  void SetOutputScalarTypeToUnsignedShort() { this->SetOutputScalarType(VTK_UNSIGNED_SHORT); }
74  void SetOutputScalarTypeToChar() { this->SetOutputScalarType(VTK_CHAR); }
75  void SetOutputScalarTypeToUnsignedChar() { this->SetOutputScalarType(VTK_UNSIGNED_CHAR); }
77 
81  void SetSampleDimensions(int i, int j, int k);
82 
84 
87  void SetSampleDimensions(int dim[3]);
88  vtkGetVectorMacro(SampleDimensions, int, 3);
90 
92 
96  void SetModelBounds(const double bounds[6]);
97  void SetModelBounds(double xMin, double xMax, double yMin, double yMax, double zMin, double zMax);
98  vtkGetVectorMacro(ModelBounds, double, 6);
100 
102 
107  vtkSetMacro(Capping, vtkTypeBool);
108  vtkGetMacro(Capping, vtkTypeBool);
109  vtkBooleanMacro(Capping, vtkTypeBool);
111 
113 
116  vtkSetMacro(CapValue, double);
117  vtkGetMacro(CapValue, double);
119 
121 
124  vtkSetMacro(ComputeNormals, vtkTypeBool);
125  vtkGetMacro(ComputeNormals, vtkTypeBool);
126  vtkBooleanMacro(ComputeNormals, vtkTypeBool);
128 
130 
134  vtkSetStringMacro(ScalarArrayName);
135  vtkGetStringMacro(ScalarArrayName);
137 
139 
143  vtkSetStringMacro(NormalArrayName);
144  vtkGetStringMacro(NormalArrayName);
146 
150  vtkMTimeType GetMTime() override;
151 
152 protected:
161 
162  ~vtkSampleFunction() override;
163 
165 
168  void Cap(vtkDataArray* s);
169 
171  int SampleDimensions[3];
172  double ModelBounds[6];
174  double CapValue;
179 
180 private:
181  vtkSampleFunction(const vtkSampleFunction&) = delete;
182  void operator=(const vtkSampleFunction&) = delete;
183 };
184 
185 VTK_ABI_NAMESPACE_END
186 #endif
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:54
general representation of visualization data
Definition: vtkDataObject.h:64
Detect and break reference loops.
Generic algorithm superclass for image algs.
abstract interface for implicit functions
a simple class to control print indentation
Definition: vtkIndent.h:38
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
sample an implicit function over a structured point set
virtual void SetImplicitFunction(vtkImplicitFunction *)
Specify the implicit function to use to generate data.
void SetOutputScalarTypeToShort()
Set what type of scalar data this source should generate.
void SetOutputScalarTypeToUnsignedInt()
Set what type of scalar data this source should generate.
void SetOutputScalarTypeToUnsignedLong()
Set what type of scalar data this source should generate.
void SetOutputScalarTypeToUnsignedShort()
Set what type of scalar data this source should generate.
static vtkSampleFunction * New()
Construct with ModelBounds=(-1,1,-1,1,-1,1), SampleDimensions=(50,50,50), Capping turned off,...
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkMTimeType GetMTime() override
Return the MTime also considering the implicit function.
void SetSampleDimensions(int i, int j, int k)
Specify the dimensions of the data on which to sample.
void ExecuteDataWithInformation(vtkDataObject *, vtkInformation *) override
This is a convenience method that is implemented in many subclasses instead of RequestData.
vtkSampleFunction()
Default constructor.
void SetOutputScalarTypeToChar()
Set what type of scalar data this source should generate.
vtkImplicitFunction * ImplicitFunction
void SetSampleDimensions(int dim[3])
Specify the dimensions of the data on which to sample.
void SetModelBounds(double xMin, double xMax, double yMin, double yMax, double zMin, double zMax)
Specify the region in space over which the sampling occurs.
void ReportReferences(vtkGarbageCollector *) override
void SetOutputScalarTypeToLong()
Set what type of scalar data this source should generate.
~vtkSampleFunction() override
void SetOutputScalarTypeToDouble()
Set what type of scalar data this source should generate.
vtkTypeBool ComputeNormals
int RequestInformation(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
Subclasses can reimplement this method to collect information from their inputs and set information f...
void SetOutputScalarTypeToInt()
Set what type of scalar data this source should generate.
void SetOutputScalarTypeToFloat()
Set what type of scalar data this source should generate.
void Cap(vtkDataArray *s)
void SetModelBounds(const double bounds[6])
Specify the region in space over which the sampling occurs.
void SetOutputScalarTypeToUnsignedChar()
Set what type of scalar data this source should generate.
int vtkTypeBool
Definition: vtkABI.h:64
#define VTK_SHORT
Definition: vtkType.h:36
#define VTK_UNSIGNED_INT
Definition: vtkType.h:39
#define VTK_DOUBLE
Definition: vtkType.h:43
#define VTK_UNSIGNED_CHAR
Definition: vtkType.h:35
#define VTK_UNSIGNED_SHORT
Definition: vtkType.h:37
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:270
#define VTK_INT
Definition: vtkType.h:38
#define VTK_FLOAT
Definition: vtkType.h:42
#define VTK_CHAR
Definition: vtkType.h:33
#define VTK_UNSIGNED_LONG
Definition: vtkType.h:41
#define VTK_LONG
Definition: vtkType.h:40