VTK  9.0.1
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 =========================================================================*/
55 #ifndef vtkTemporalInterpolator_h
56 #define vtkTemporalInterpolator_h
57 
58 #include "vtkFiltersHybridModule.h" // For export macro
60 
61 class vtkDataSet;
62 class VTKFILTERSHYBRID_EXPORT vtkTemporalInterpolator : public vtkMultiTimeStepAlgorithm
63 {
64 public:
65  static vtkTemporalInterpolator* New();
67  void PrintSelf(ostream& os, vtkIndent indent) override;
68 
70 
79  vtkSetMacro(DiscreteTimeStepInterval, double);
80  vtkGetMacro(DiscreteTimeStepInterval, double);
82 
84 
93  vtkSetMacro(ResampleFactor, int);
94  vtkGetMacro(ResampleFactor, int);
96 
98 
102  vtkSetMacro(CacheData, bool);
103  vtkGetMacro(CacheData, bool);
105 
106 protected:
108  ~vtkTemporalInterpolator() override;
109 
112 
113  int FillInputPortInformation(int port, vtkInformation* info) override;
114  int FillOutputPortInformation(int vtkNotUsed(port), vtkInformation* info) override;
115 
117 
120 
122 
127  vtkDataObject* InterpolateDataObject(vtkDataObject* in1, vtkDataObject* in2, double ratio);
128 
134  virtual vtkDataSet* InterpolateDataSet(vtkDataSet* in1, vtkDataSet* in2, double ratio);
135 
140  virtual vtkDataArray* InterpolateDataArray(double ratio, vtkDataArray** arrays, vtkIdType N);
141 
144  {
145  MATCHED = 0,
146  MISMATCHED_TUPLES = 1,
147  MISMATCHED_COMPS = 2
148  };
149 
154  virtual ArrayMatch VerifyArrays(vtkDataArray** arrays, int N);
155 
156  // internally used : Ratio is {0,1} between two time steps
157  // DeltaT is time between current 2 steps.
158  // These are only valid when 2 time steps are interpolated
159  // Higher order schemes will require changes to the API
160  double Ratio;
161  double DeltaT;
162  double Tfrac;
163 
164 private:
166  void operator=(const vtkTemporalInterpolator&) = delete;
167 };
168 
169 #endif
vtkMultiTimeStepAlgorithm::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkIdType
int vtkIdType
Definition: vtkType.h:338
vtkAlgorithm::FillInputPortInformation
virtual int FillInputPortInformation(int port, vtkInformation *info)
Fill the input port information objects for this algorithm.
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:35
vtkTemporalInterpolator::ArrayMatch
ArrayMatch
Return values for VerifyArrays().
Definition: vtkTemporalInterpolator.h:143
vtkMultiTimeStepAlgorithm.h
vtkTemporalInterpolator::DiscreteTimeStepInterval
double DiscreteTimeStepInterval
Definition: vtkTemporalInterpolator.h:110
vtkDataArray
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:49
vtkTemporalInterpolator::Ratio
double Ratio
Definition: vtkTemporalInterpolator.h:160
vtkMultiTimeStepAlgorithm::RequestData
virtual int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *)
This is called by the superclass.
Definition: vtkMultiTimeStepAlgorithm.h:82
vtkX3D::port
@ port
Definition: vtkX3D.h:453
vtkMultiTimeStepAlgorithm::RequestUpdateExtent
virtual int RequestUpdateExtent(vtkInformation *, vtkInformationVector **, vtkInformationVector *)
This is called by the superclass.
Definition: vtkMultiTimeStepAlgorithm.h:91
vtkTemporalInterpolator::DeltaT
double DeltaT
Definition: vtkTemporalInterpolator.h:161
vtkMultiTimeStepAlgorithm::New
static vtkMultiTimeStepAlgorithm * New()
vtkTemporalInterpolator::Tfrac
double Tfrac
Definition: vtkTemporalInterpolator.h:162
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkDataSet
abstract class to specify dataset behavior
Definition: vtkDataSet.h:56
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:73
vtkX3D::info
@ info
Definition: vtkX3D.h:382
vtkMultiTimeStepAlgorithm::RequestInformation
virtual int RequestInformation(vtkInformation *, vtkInformationVector **, vtkInformationVector *)
This is called by the superclass.
Definition: vtkMultiTimeStepAlgorithm.h:72
vtkTemporalInterpolator
interpolate datasets between time steps to produce a new dataset
Definition: vtkTemporalInterpolator.h:62
vtkDataObject
general representation of visualization data
Definition: vtkDataObject.h:59
vtkAlgorithm::FillOutputPortInformation
virtual int FillOutputPortInformation(int port, vtkInformation *info)
Fill the output port information objects for this algorithm.
vtkMultiTimeStepAlgorithm::RequestDataObject
virtual int RequestDataObject(vtkInformation *, vtkInformationVector **, vtkInformationVector *)
This is called by the superclass.
Definition: vtkMultiTimeStepAlgorithm.h:61
vtkTemporalInterpolator::ResampleFactor
int ResampleFactor
Definition: vtkTemporalInterpolator.h:111
vtkMultiTimeStepAlgorithm
Superclass for algorithms that would like to make multiple time requests.
Definition: vtkMultiTimeStepAlgorithm.h:39