VTK
vtkTemporalInterpolator.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkTemporalInterpolator.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 =========================================================================*/
58 #ifndef vtkTemporalInterpolator_h
59 #define vtkTemporalInterpolator_h
60 
61 #include "vtkFiltersHybridModule.h" // For export macro
63 
64 class vtkDataSet;
65 class VTKFILTERSHYBRID_EXPORT vtkTemporalInterpolator : public vtkMultiTimeStepAlgorithm
66 {
67 public:
70  void PrintSelf(ostream& os, vtkIndent indent) override;
71 
73 
82  vtkSetMacro(DiscreteTimeStepInterval, double);
83  vtkGetMacro(DiscreteTimeStepInterval, double);
85 
87 
96  vtkSetMacro(ResampleFactor, int);
97  vtkGetMacro(ResampleFactor, int);
99 
101 
105  vtkSetMacro(CacheData, bool);
106  vtkGetMacro(CacheData, bool);
108 
109 protected:
112 
113 
116 
118  int FillOutputPortInformation(int vtkNotUsed(port), vtkInformation* info) override;
119 
120 
123  vtkInformationVector *) override;
124 
127  vtkInformationVector *) override;
130  vtkInformationVector *) override;
131 
134  vtkInformationVector *) override;
135 
141  vtkDataObject *in2,
142  double ratio);
143 
150  vtkDataSet *in2,
151  double ratio);
152 
157  virtual vtkDataArray *InterpolateDataArray(double ratio,
158  vtkDataArray **arrays,
159  vtkIdType N);
160 
165  virtual bool VerifyArrays(vtkDataArray **arrays, int N);
166 
167  // internally used : Ratio is {0,1} between two time steps
168  // DeltaT is time between current 2 steps.
169  // These are only valid when 2 time steps are interpolated
170  // Higher order schemes will require changes to the API
171  double Ratio;
172  double DeltaT;
173  double Tfrac;
174 
175 private:
177  void operator=(const vtkTemporalInterpolator&) = delete;
178 };
179 
180 
181 
182 #endif
183 
184 
185 
vtkTemporalInterpolator::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkTemporalInterpolator::RequestUpdateExtent
int RequestUpdateExtent(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called by the superclass.
vtkIdType
int vtkIdType
Definition: vtkType.h:347
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:42
vtkMultiTimeStepAlgorithm.h
vtkTemporalInterpolator::New
static vtkTemporalInterpolator * New()
vtkTemporalInterpolator::DiscreteTimeStepInterval
double DiscreteTimeStepInterval
Definition: vtkTemporalInterpolator.h:114
vtkDataArray
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:55
vtkTemporalInterpolator::InterpolateDataSet
virtual vtkDataSet * InterpolateDataSet(vtkDataSet *in1, vtkDataSet *in2, double ratio)
Root level interpolation for a concrete dataset object.
vtkTemporalInterpolator::Ratio
double Ratio
Definition: vtkTemporalInterpolator.h:171
vtkTemporalInterpolator::vtkTemporalInterpolator
vtkTemporalInterpolator()
vtkTemporalInterpolator::InterpolateDataObject
vtkDataObject * InterpolateDataObject(vtkDataObject *in1, vtkDataObject *in2, double ratio)
General interpolation routine for any type on input data.
vtkTemporalInterpolator::VerifyArrays
virtual bool VerifyArrays(vtkDataArray **arrays, int N)
Called just before interpolation of each dataset to ensure each data array has the same number of tup...
vtkX3D::port
@ port
Definition: vtkX3D.h:447
vtkTemporalInterpolator::FillInputPortInformation
int FillInputPortInformation(int port, vtkInformation *info) override
Fill the input port information objects for this algorithm.
vtkTemporalInterpolator::DeltaT
double DeltaT
Definition: vtkTemporalInterpolator.h:172
vtkTemporalInterpolator::Tfrac
double Tfrac
Definition: vtkTemporalInterpolator.h:173
vtkTemporalInterpolator::FillOutputPortInformation
int FillOutputPortInformation(int vtkNotUsed(port), vtkInformation *info) override
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkTemporalInterpolator::RequestInformation
int RequestInformation(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called by the superclass.
vtkDataSet
abstract class to specify dataset behavior
Definition: vtkDataSet.h:63
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:87
vtkX3D::info
@ info
Definition: vtkX3D.h:376
vtkTemporalInterpolator
interpolate datasets between time steps to produce a new dataset
Definition: vtkTemporalInterpolator.h:66
vtkTemporalInterpolator::InterpolateDataArray
virtual vtkDataArray * InterpolateDataArray(double ratio, vtkDataArray **arrays, vtkIdType N)
Interpolate a single vtkDataArray.
vtkTemporalInterpolator::RequestDataObject
int RequestDataObject(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called by the superclass.
vtkDataObject
general representation of visualization data
Definition: vtkDataObject.h:65
vtkTemporalInterpolator::~vtkTemporalInterpolator
~vtkTemporalInterpolator() override
vtkTemporalInterpolator::RequestData
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called by the superclass.
vtkTemporalInterpolator::ResampleFactor
int ResampleFactor
Definition: vtkTemporalInterpolator.h:115
vtkMultiTimeStepAlgorithm
Superclass for algorithms that would like to make multiple time requests.
Definition: vtkMultiTimeStepAlgorithm.h:40