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
21 #ifndef vtkSampleFunction_h
22 #define vtkSampleFunction_h
23 
24 #include "vtkImageAlgorithm.h"
25 #include "vtkImagingHybridModule.h" // For export macro
26 
27 VTK_ABI_NAMESPACE_BEGIN
29 class vtkDataArray;
30 
31 class VTKIMAGINGHYBRID_EXPORT vtkSampleFunction : public vtkImageAlgorithm
32 {
33 public:
35  void PrintSelf(ostream& os, vtkIndent indent) override;
36 
42 
44 
48  vtkGetObjectMacro(ImplicitFunction, vtkImplicitFunction);
50 
52 
55  vtkSetMacro(OutputScalarType, int);
56  vtkGetMacro(OutputScalarType, int);
57  void SetOutputScalarTypeToDouble() { this->SetOutputScalarType(VTK_DOUBLE); }
58  void SetOutputScalarTypeToFloat() { this->SetOutputScalarType(VTK_FLOAT); }
59  void SetOutputScalarTypeToLong() { this->SetOutputScalarType(VTK_LONG); }
60  void SetOutputScalarTypeToUnsignedLong() { this->SetOutputScalarType(VTK_UNSIGNED_LONG); }
61  void SetOutputScalarTypeToInt() { this->SetOutputScalarType(VTK_INT); }
62  void SetOutputScalarTypeToUnsignedInt() { this->SetOutputScalarType(VTK_UNSIGNED_INT); }
63  void SetOutputScalarTypeToShort() { this->SetOutputScalarType(VTK_SHORT); }
64  void SetOutputScalarTypeToUnsignedShort() { this->SetOutputScalarType(VTK_UNSIGNED_SHORT); }
65  void SetOutputScalarTypeToChar() { this->SetOutputScalarType(VTK_CHAR); }
66  void SetOutputScalarTypeToUnsignedChar() { this->SetOutputScalarType(VTK_UNSIGNED_CHAR); }
68 
72  void SetSampleDimensions(int i, int j, int k);
73 
75 
78  void SetSampleDimensions(int dim[3]);
79  vtkGetVectorMacro(SampleDimensions, int, 3);
81 
83 
87  void SetModelBounds(const double bounds[6]);
88  void SetModelBounds(double xMin, double xMax, double yMin, double yMax, double zMin, double zMax);
89  vtkGetVectorMacro(ModelBounds, double, 6);
91 
93 
98  vtkSetMacro(Capping, vtkTypeBool);
99  vtkGetMacro(Capping, vtkTypeBool);
100  vtkBooleanMacro(Capping, vtkTypeBool);
102 
104 
107  vtkSetMacro(CapValue, double);
108  vtkGetMacro(CapValue, double);
110 
112 
115  vtkSetMacro(ComputeNormals, vtkTypeBool);
116  vtkGetMacro(ComputeNormals, vtkTypeBool);
117  vtkBooleanMacro(ComputeNormals, vtkTypeBool);
119 
121 
125  vtkSetStringMacro(ScalarArrayName);
126  vtkGetStringMacro(ScalarArrayName);
128 
130 
134  vtkSetStringMacro(NormalArrayName);
135  vtkGetStringMacro(NormalArrayName);
137 
141  vtkMTimeType GetMTime() override;
142 
143 protected:
152 
153  ~vtkSampleFunction() override;
154 
156 
159  void Cap(vtkDataArray* s);
160 
162  int SampleDimensions[3];
163  double ModelBounds[6];
165  double CapValue;
170 
171 private:
172  vtkSampleFunction(const vtkSampleFunction&) = delete;
173  void operator=(const vtkSampleFunction&) = delete;
174 };
175 
176 VTK_ABI_NAMESPACE_END
177 #endif
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:45
general representation of visualization data
Definition: vtkDataObject.h:55
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:29
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