VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkTemporalInterpolator Class Reference

interpolate datasets between time steps to produce a new dataset More...

#include <vtkTemporalInterpolator.h>

Inheritance diagram for vtkTemporalInterpolator:
[legend]
Collaboration diagram for vtkTemporalInterpolator:
[legend]

List of all members.

Public Types

typedef vtkTemporalDataSetAlgorithm Superclass
- Public Types inherited from vtkTemporalDataSetAlgorithm
- Public Types inherited from vtkAlgorithm
- Public Types inherited from vtkObject

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetDiscreteTimeStepInterval (double)
virtual double GetDiscreteTimeStepInterval ()
virtual void SetResampleFactor (int)
virtual int GetResampleFactor ()
- Public Member Functions inherited from vtkTemporalDataSetAlgorithm
vtkTemporalDataSetGetOutput ()
vtkTemporalDataSetGetOutput (int)
void SetInput (vtkDataObject *)
void SetInput (int, vtkDataObject *)
virtual int ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
vtkExecutiveGetExecutive ()
virtual void SetExecutive (vtkExecutive *executive)
virtual int ModifyRequest (vtkInformation *request, int when)
vtkInformationGetInputPortInformation (int port)
vtkInformationGetOutputPortInformation (int port)
int GetNumberOfInputPorts ()
int GetNumberOfOutputPorts ()
void UpdateProgress (double amount)
vtkInformationGetInputArrayInformation (int idx)
void RemoveAllInputs ()
vtkDataObjectGetOutputDataObject (int port)
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
int GetNumberOfInputConnections (int port)
int GetTotalNumberOfInputConnections ()
vtkAlgorithmOutputGetInputConnection (int port, int index)
virtual void Update ()
virtual void UpdateInformation ()
virtual void UpdateWholeExtent ()
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
virtual double ComputePriority ()
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformationGetInformation ()
virtual void SetInformation (vtkInformation *)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
virtual void SetAbortExecute (int)
virtual int GetAbortExecute ()
virtual void AbortExecuteOn ()
virtual void AbortExecuteOff ()
virtual void SetProgress (double)
virtual double GetProgress ()
void SetProgressText (const char *ptext)
virtual char * GetProgressText ()
virtual unsigned long GetErrorCode ()
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
vtkDataObjectGetInputDataObject (int port, int connection)
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void SetInputConnection (vtkAlgorithmOutput *input)
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void AddInputConnection (vtkAlgorithmOutput *input)
vtkAlgorithmOutputGetOutputPort (int index)
vtkAlgorithmOutputGetOutputPort ()
virtual void SetReleaseDataFlag (int)
virtual int GetReleaseDataFlag ()
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
int UpdateExtentIsEmpty (vtkDataObject *output)
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
virtual unsigned long GetMTime ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommandGetCommand (unsigned long tag)
void RemoveObserver (vtkCommand *)
void RemoveObservers (unsigned long event, vtkCommand *)
void RemoveObservers (const char *event, vtkCommand *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
void RemoveObserver (unsigned long tag)
void RemoveObservers (unsigned long event)
void RemoveObservers (const char *event)
void RemoveAllObservers ()
int HasObserver (unsigned long event)
int HasObserver (const char *event)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
int InvokeEvent (const char *event, void *callData)
int InvokeEvent (unsigned long event)
int InvokeEvent (const char *event)
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static vtkTemporalInterpolatorNew ()
static int IsTypeOf (const char *type)
static vtkTemporalInterpolatorSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkTemporalInterpolator ()
 ~vtkTemporalInterpolator ()
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual bool VerifyArrays (vtkDataArray **arrays, int N)
vtkDataObjectInterpolateDataObject (vtkDataObject *in1, vtkDataObject *in2, double ratio)
virtual vtkDataSetInterpolateDataSet (vtkDataSet *in1, vtkDataSet *in2, double ratio)
virtual vtkDataArrayInterpolateDataArray (double ratio, vtkDataArray **arrays, vtkIdType N)
- Protected Member Functions inherited from vtkTemporalDataSetAlgorithm
 vtkTemporalDataSetAlgorithm ()
 ~vtkTemporalDataSetAlgorithm ()
virtual vtkExecutiveCreateDefaultExecutive ()
virtual int FillOutputPortInformation (int port, vtkInformation *info)
virtual int FillInputPortInformation (int port, vtkInformation *info)
vtkDataObjectGetInput (int port)
virtual int RequestDataObject (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 ~vtkAlgorithm ()
virtual void SetNumberOfInputPorts (int n)
virtual void SetNumberOfOutputPorts (int n)
int InputPortIndexInRange (int index, const char *action)
int OutputPortIndexInRange (int index, const char *action)
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
virtual void ReportReferences (vtkGarbageCollector *)
virtual void SetNumberOfInputConnections (int port, int n)
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
virtual void SetErrorCode (unsigned long)
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

double DiscreteTimeStepInterval
int ResampleFactor
double Ratio
double DeltaT
double Tfrac

Detailed Description

interpolate datasets between time steps to produce a new dataset

vtkTemporalInterpolator interpolates between two time steps to produce new data for an arbitrary T. vtkTemporalInterpolator has three modes of operation. The default mode is to produce a continuous range of time values as output, which enables a filter downstream to request any value of T within the range. The second mode of operation is enabled by setting DiscreteTimeStepInterval to a non zero value. When this mode is activated, the filter will report a finite number of Time steps separated by deltaT between the original range of values. This mode is useful when a dataset of N time steps has one (or more) missing datasets for certain T values and you simply wish to smooth over the missing steps but otherwise use the original data. The third mode of operation is enabled by setting ResampleFactor to a non zero positive integer value. When this mode is activated, the filter will report a finite number of Time steps which contain the original steps, plus N new values between each original step 1/ResampleFactor time units apart. Note that if the input time steps are irregular, then using ResampleFactor will produce an irregular sequence of regular steps between each of the original irregular steps (clear enough, yes?).

Higher order interpolation schemes will require changes to the API as most calls assume only two timesteps are used.

Thanks:
Ken Martin (Kitware) and John Bidiscombe of CSCS - Swiss National Supercomputing Centre for creating and contributing this class. For related material, please refer to : John Biddiscombe, Berk Geveci, Ken Martin, Kenneth Moreland, David Thompson, "Time Dependent Processing in a Parallel Pipeline Architecture", IEEE Visualization 2007.
Tests:
vtkTemporalInterpolator (Tests)

Definition at line 64 of file vtkTemporalInterpolator.h.


Member Typedef Documentation

Reimplemented from vtkTemporalDataSetAlgorithm.

Definition at line 68 of file vtkTemporalInterpolator.h.


Constructor & Destructor Documentation

vtkTemporalInterpolator::vtkTemporalInterpolator ( )
protected
vtkTemporalInterpolator::~vtkTemporalInterpolator ( )
protected

Member Function Documentation

static vtkTemporalInterpolator* vtkTemporalInterpolator::New ( )
static

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkTemporalDataSetAlgorithm.

virtual const char* vtkTemporalInterpolator::GetClassName ( )
virtual

Reimplemented from vtkTemporalDataSetAlgorithm.

static int vtkTemporalInterpolator::IsTypeOf ( const char *  name)
static

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkTemporalDataSetAlgorithm.

virtual int vtkTemporalInterpolator::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkTemporalDataSetAlgorithm.

static vtkTemporalInterpolator* vtkTemporalInterpolator::SafeDownCast ( vtkObject o)
static

Reimplemented from vtkTemporalDataSetAlgorithm.

void vtkTemporalInterpolator::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkTemporalDataSetAlgorithm.

virtual void vtkTemporalInterpolator::SetDiscreteTimeStepInterval ( double  )
virtual

If you require a discrete number of outputs steps, to be generated from an input source - for example, you required N steps separated by T, then set DiscreteTimeStepInterval to T and you will get TIME_RANGE/DiscreteTimeStepInterval steps This is a useful option to use if you have a dataset with one missing time step and wish to 'fill-in' the missing data with an interpolated value from the steps either side

virtual double vtkTemporalInterpolator::GetDiscreteTimeStepInterval ( )
virtual

If you require a discrete number of outputs steps, to be generated from an input source - for example, you required N steps separated by T, then set DiscreteTimeStepInterval to T and you will get TIME_RANGE/DiscreteTimeStepInterval steps This is a useful option to use if you have a dataset with one missing time step and wish to 'fill-in' the missing data with an interpolated value from the steps either side

virtual void vtkTemporalInterpolator::SetResampleFactor ( int  )
virtual

When ResampleFactor is a non zero positive integer, each pair of input time steps will be interpolated between with the number of steps specified. For example an input of 1,2,3,4,5 and a resample factor of 10, will produce steps 0f 1.0, 1.1, 1.2.....1.9, 2.0 etc NB. Irregular input steps will produce irregular output steps. Resample factor wuill only be used if DiscreteTimeStepInterval is zero otherwise the DiscreteTimeStepInterval takes precedence

virtual int vtkTemporalInterpolator::GetResampleFactor ( )
virtual

When ResampleFactor is a non zero positive integer, each pair of input time steps will be interpolated between with the number of steps specified. For example an input of 1,2,3,4,5 and a resample factor of 10, will produce steps 0f 1.0, 1.1, 1.2.....1.9, 2.0 etc NB. Irregular input steps will produce irregular output steps. Resample factor wuill only be used if DiscreteTimeStepInterval is zero otherwise the DiscreteTimeStepInterval takes precedence

virtual int vtkTemporalInterpolator::RequestUpdateExtent ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
protectedvirtual

This is called by the superclass. This is the method you should override.

Reimplemented from vtkTemporalDataSetAlgorithm.

virtual int vtkTemporalInterpolator::RequestInformation ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
protectedvirtual

This is called by the superclass. This is the method you should override.

Reimplemented from vtkTemporalDataSetAlgorithm.

virtual int vtkTemporalInterpolator::RequestData ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
protectedvirtual

This is called by the superclass. This is the method you should override.

Reimplemented from vtkTemporalDataSetAlgorithm.

vtkDataObject* vtkTemporalInterpolator::InterpolateDataObject ( vtkDataObject in1,
vtkDataObject in2,
double  ratio 
)
protected

General interpolation routine for any type on input data. This is called recursively when heirarchical/multiblock data is encountered

virtual vtkDataSet* vtkTemporalInterpolator::InterpolateDataSet ( vtkDataSet in1,
vtkDataSet in2,
double  ratio 
)
protectedvirtual

Root level interpolation for a concrete dataset object. Point/Cell data and points are interpolated. Needs improving if connectivity is to be handled

virtual vtkDataArray* vtkTemporalInterpolator::InterpolateDataArray ( double  ratio,
vtkDataArray **  arrays,
vtkIdType  N 
)
protectedvirtual

Interpolate a single vtkDataArray. Called from the Interpolation routine on the points and pointdata/celldata

virtual bool vtkTemporalInterpolator::VerifyArrays ( vtkDataArray **  arrays,
int  N 
)
protectedvirtual

Called just before interpolation of each dataset to ensure each data array has the same number of tuples/components etc


Member Data Documentation

double vtkTemporalInterpolator::DiscreteTimeStepInterval
protected

Definition at line 99 of file vtkTemporalInterpolator.h.

int vtkTemporalInterpolator::ResampleFactor
protected

Definition at line 100 of file vtkTemporalInterpolator.h.

double vtkTemporalInterpolator::Ratio
protected

Definition at line 152 of file vtkTemporalInterpolator.h.

double vtkTemporalInterpolator::DeltaT
protected

Definition at line 153 of file vtkTemporalInterpolator.h.

double vtkTemporalInterpolator::Tfrac
protected

Definition at line 154 of file vtkTemporalInterpolator.h.


The documentation for this class was generated from the following file: