VTK  9.2.5
vtkPiecewiseFunction.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkPiecewiseFunction.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=========================================================================*/
15
43#ifndef vtkPiecewiseFunction_h
44#define vtkPiecewiseFunction_h
45
46#include "vtkCommonDataModelModule.h" // For export macro
47#include "vtkDataObject.h"
48
49class vtkPiecewiseFunctionInternals;
50
51class VTKCOMMONDATAMODEL_EXPORT vtkPiecewiseFunction : public vtkDataObject
52{
53public:
56 void PrintSelf(ostream& os, vtkIndent indent) override;
57
58 void DeepCopy(vtkDataObject* f) override;
59 void ShallowCopy(vtkDataObject* f) override;
60
64 int GetDataObjectType() override { return VTK_PIECEWISE_FUNCTION; }
65
69 int GetSize();
70
72
78 int AddPoint(double x, double y);
79 int AddPoint(double x, double y, double midpoint, double sharpness);
81
86 bool RemovePointByIndex(size_t id);
87
92 int RemovePoint(double x);
93
98 int RemovePoint(double x, double y);
99
104
110 void AddSegment(double x1, double y1, double x2, double y2);
111
116 double GetValue(double x);
117
119
125 int GetNodeValue(int index, double val[4]);
126 int SetNodeValue(int index, double val[4]);
128
130
137 double* GetDataPointer();
138 void FillFromDataPointer(int, double*);
140
142
145 vtkGetVector2Macro(Range, double);
147
153 int AdjustRange(double range[2]);
154
156
163 double x1, double x2, int size, float* table, int stride = 1, int logIncrements = 0);
165 double x1, double x2, int size, double* table, int stride = 1, int logIncrements = 0);
167
174 void BuildFunctionFromTable(double x1, double x2, int size, double* table, int stride = 1);
175
177
185 vtkSetMacro(Clamping, vtkTypeBool);
186 vtkGetMacro(Clamping, vtkTypeBool);
187 vtkBooleanMacro(Clamping, vtkTypeBool);
189
195 vtkSetMacro(UseLogScale, bool);
196 vtkGetMacro(UseLogScale, bool);
197 vtkBooleanMacro(UseLogScale, bool);
208 const char* GetType();
209
215
221 void Initialize() override;
222
224
230
232
236 vtkSetMacro(AllowDuplicateScalars, vtkTypeBool);
237 vtkGetMacro(AllowDuplicateScalars, vtkTypeBool);
238 vtkBooleanMacro(AllowDuplicateScalars, vtkTypeBool);
240
245 int EstimateMinNumberOfSamples(double const& x1, double const& x2);
246
247protected:
250
257
262
267
268 // The internal STL structures
269 vtkPiecewiseFunctionInternals* Internal;
270
271 // Determines the function value outside of defined points
272 // Zero = always return 0.0 outside of defined points
273 // One = clamp to the lowest value below defined points and
274 // highest value above defined points
276
277 // Array of points ((X,Y) pairs)
278 double* Function;
279
280 // Min and max range of function point locations
281 double Range[2];
282
284
286
287private:
289 void operator=(const vtkPiecewiseFunction&) = delete;
290};
291
292#endif
general representation of visualization data
Definition: vtkDataObject.h:66
a simple class to control print indentation
Definition: vtkIndent.h:40
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
Defines a 1D piecewise function.
int SetNodeValue(int index, double val[4])
For the node specified by index, set/get the location (X), value (Y), midpoint, and sharpness values ...
int AdjustRange(double range[2])
Remove all points out of the new range, and make sure there is a point at each end of that range.
double GetValue(double x)
Returns the value of the function at the specified location using the specified interpolation.
int AddPoint(double x, double y, double midpoint, double sharpness)
Add points to the function.
void GetTable(double x1, double x2, int size, float *table, int stride=1, int logIncrements=0)
Fills in an array of function values evaluated at regular intervals.
int RemovePoint(double x)
Remove the first point found at the given x location Return the index of the remove point if any,...
void GetTable(double x1, double x2, int size, double *table, int stride=1, int logIncrements=0)
Fills in an array of function values evaluated at regular intervals.
int AddPoint(double x, double y)
Add points to the function.
double GetFirstNonZeroValue()
Returns the first point location which precedes a non-zero segment of the function.
int RemovePoint(double x, double y)
Remove the first point found at the given x and y location Return the index of the remove point if an...
void SortAndUpdateRange()
Internal method to sort the vector and update the Range whenever a node is added, edited or removed.
vtkPiecewiseFunctionInternals * Internal
void FillFromDataPointer(int, double *)
Returns a pointer to the data stored in the table.
void BuildFunctionFromTable(double x1, double x2, int size, double *table, int stride=1)
Constructs a piecewise function from a table.
static vtkPiecewiseFunction * GetData(vtkInformationVector *v, int i=0)
Retrieve an instance of this class from an information object.
int GetSize()
Get the number of points used to specify the function.
~vtkPiecewiseFunction() override
void Initialize() override
Clears out the current function.
bool UpdateRange()
Returns true if the range has been updated and Modified() has been called.
void RemoveAllPoints()
Removes all points from the function.
void DeepCopy(vtkDataObject *f) override
Shallow and Deep copy.
double FindMinimumXDistance()
Traverses the nodes to find the minimum distance.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
const char * GetType()
Return the type of function: Function Types: 0 : Constant (No change in slope between end points) 1 :...
void AddSegment(double x1, double y1, double x2, double y2)
Add a line segment to the function.
static vtkPiecewiseFunction * GetData(vtkInformation *info)
Retrieve an instance of this class from an information object.
int EstimateMinNumberOfSamples(double const &x1, double const &x2)
Estimates the minimum size of a table such that it would correctly sample this function.
bool RemovePointByIndex(size_t id)
Remove a point from the function at a given id Return true if point has been found and removed,...
double * GetDataPointer()
Returns a pointer to the data stored in the table.
int GetNodeValue(int index, double val[4])
For the node specified by index, set/get the location (X), value (Y), midpoint, and sharpness values ...
int GetDataObjectType() override
Return what type of dataset this is.
void ShallowCopy(vtkDataObject *f) override
Shallow and Deep copy.
static vtkPiecewiseFunction * New()
int vtkTypeBool
Definition: vtkABI.h:69
#define VTK_PIECEWISE_FUNCTION
Definition: vtkType.h:82