VTK  9.0.1
vtkSampleFunction.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkSampleFunction.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
30 #ifndef vtkSampleFunction_h
31 #define vtkSampleFunction_h
32 
33 #include "vtkImageAlgorithm.h"
34 #include "vtkImagingHybridModule.h" // For export macro
35 
37 class vtkDataArray;
38 
39 class VTKIMAGINGHYBRID_EXPORT vtkSampleFunction : public vtkImageAlgorithm
40 {
41 public:
43  void PrintSelf(ostream& os, vtkIndent indent) override;
44 
50 
52 
56  vtkGetObjectMacro(ImplicitFunction, vtkImplicitFunction);
58 
60 
63  vtkSetMacro(OutputScalarType, int);
64  vtkGetMacro(OutputScalarType, int);
65  void SetOutputScalarTypeToDouble() { this->SetOutputScalarType(VTK_DOUBLE); }
66  void SetOutputScalarTypeToFloat() { this->SetOutputScalarType(VTK_FLOAT); }
67  void SetOutputScalarTypeToLong() { this->SetOutputScalarType(VTK_LONG); }
68  void SetOutputScalarTypeToUnsignedLong() { this->SetOutputScalarType(VTK_UNSIGNED_LONG); }
69  void SetOutputScalarTypeToInt() { this->SetOutputScalarType(VTK_INT); }
70  void SetOutputScalarTypeToUnsignedInt() { this->SetOutputScalarType(VTK_UNSIGNED_INT); }
71  void SetOutputScalarTypeToShort() { this->SetOutputScalarType(VTK_SHORT); }
72  void SetOutputScalarTypeToUnsignedShort() { this->SetOutputScalarType(VTK_UNSIGNED_SHORT); }
73  void SetOutputScalarTypeToChar() { this->SetOutputScalarType(VTK_CHAR); }
74  void SetOutputScalarTypeToUnsignedChar() { this->SetOutputScalarType(VTK_UNSIGNED_CHAR); }
76 
80  void SetSampleDimensions(int i, int j, int k);
81 
83 
86  void SetSampleDimensions(int dim[3]);
87  vtkGetVectorMacro(SampleDimensions, int, 3);
89 
91 
95  void SetModelBounds(const double bounds[6]);
96  void SetModelBounds(double xMin, double xMax, double yMin, double yMax, double zMin, double zMax);
97  vtkGetVectorMacro(ModelBounds, double, 6);
99 
101 
106  vtkSetMacro(Capping, vtkTypeBool);
107  vtkGetMacro(Capping, vtkTypeBool);
108  vtkBooleanMacro(Capping, vtkTypeBool);
110 
112 
115  vtkSetMacro(CapValue, double);
116  vtkGetMacro(CapValue, double);
118 
120 
123  vtkSetMacro(ComputeNormals, vtkTypeBool);
124  vtkGetMacro(ComputeNormals, vtkTypeBool);
125  vtkBooleanMacro(ComputeNormals, vtkTypeBool);
127 
129 
133  vtkSetStringMacro(ScalarArrayName);
134  vtkGetStringMacro(ScalarArrayName);
136 
138 
142  vtkSetStringMacro(NormalArrayName);
143  vtkGetStringMacro(NormalArrayName);
145 
149  vtkMTimeType GetMTime() override;
150 
151 protected:
160 
161  ~vtkSampleFunction() override;
162 
164 
167  void Cap(vtkDataArray* s);
168 
170  int SampleDimensions[3];
171  double ModelBounds[6];
173  double CapValue;
178 
179 private:
180  vtkSampleFunction(const vtkSampleFunction&) = delete;
181  void operator=(const vtkSampleFunction&) = delete;
182 };
183 
184 #endif
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:50
general representation of visualization data
Definition: vtkDataObject.h:60
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:34
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()
void SetOutputScalarTypeToUnsignedInt()
void SetOutputScalarTypeToUnsignedLong()
void SetOutputScalarTypeToUnsignedShort()
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()
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)
void ReportReferences(vtkGarbageCollector *) override
void SetOutputScalarTypeToLong()
~vtkSampleFunction() override
void SetOutputScalarTypeToDouble()
vtkTypeBool ComputeNormals
int RequestInformation(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
Subclasses can reimplement this method to collect information from their inputs and set information f...
void SetOutputScalarTypeToFloat()
void Cap(vtkDataArray *s)
void SetModelBounds(const double bounds[6])
Specify the region in space over which the sampling occurs.
void SetOutputScalarTypeToUnsignedChar()
int vtkTypeBool
Definition: vtkABI.h:69
#define VTK_SHORT
Definition: vtkType.h:46
#define VTK_UNSIGNED_INT
Definition: vtkType.h:49
#define VTK_DOUBLE
Definition: vtkType.h:53
#define VTK_UNSIGNED_CHAR
Definition: vtkType.h:45
#define VTK_UNSIGNED_SHORT
Definition: vtkType.h:47
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:293
#define VTK_INT
Definition: vtkType.h:48
#define VTK_FLOAT
Definition: vtkType.h:52
#define VTK_CHAR
Definition: vtkType.h:43
#define VTK_UNSIGNED_LONG
Definition: vtkType.h:51
#define VTK_LONG
Definition: vtkType.h:50