vtkTemporalShiftScale Class Reference

#include <vtkTemporalShiftScale.h>

Inheritance diagram for vtkTemporalShiftScale:

[legend]

Collaboration diagram for vtkTemporalShiftScale:

[legend]

List of all members.

Detailed Description

modify the time range/steps of temporal data

vtkTemporalShiftScale modify the time range or time steps of the data without changing the data itself. The data is not resampled by this filter, only the information accompanying the data is modified.

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:: vtkTemporalShiftScale (Tests)

Definition at line 40 of file vtkTemporalShiftScale.h.


Public Types
typedef vtkTemporalDataSetAlgorithm	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	SetPreShift (double)
virtual double	GetPreShift ()

virtual void	SetPostShift (double)
virtual double	GetPostShift ()

virtual void	SetScale (double)
virtual double	GetScale ()

virtual void	SetPeriodic (int)
virtual int	GetPeriodic ()
virtual void	PeriodicOn ()
virtual void	PeriodicOff ()

virtual void	SetPeriodicEndCorrection (int)
virtual int	GetPeriodicEndCorrection ()
virtual void	PeriodicEndCorrectionOn ()
virtual void	PeriodicEndCorrectionOff ()

virtual void	SetMaximumNumberOfPeriods (double)
virtual double	GetMaximumNumberOfPeriods ()
Static Public Member Functions
static vtkTemporalShiftScale *	New ()
static int	IsTypeOf (const char *type)
static vtkTemporalShiftScale *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkTemporalShiftScale ()
	~vtkTemporalShiftScale ()
virtual int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector )
virtual int	RequestInformation (vtkInformation , vtkInformationVector , vtkInformationVector )
virtual int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )
double	ForwardConvert (double T0)
double	BackwardConvert (double T1)
Protected Attributes
double	PreShift
double	PostShift
double	Scale
int	Periodic
int	PeriodicEndCorrection
double	MaximumNumberOfPeriods
double	InRange [2]
double	OutRange [2]
double	PeriodicRange [2]
int	PeriodicN
double	TempMultiplier

Member Typedef Documentation

typedef vtkTemporalDataSetAlgorithm vtkTemporalShiftScale::Superclass

Reimplemented from vtkTemporalDataSetAlgorithm.

Definition at line 44 of file vtkTemporalShiftScale.h.

Constructor & Destructor Documentation

vtkTemporalShiftScale::vtkTemporalShiftScale ( ) [protected]

vtkTemporalShiftScale::~vtkTemporalShiftScale ( ) [protected]

Member Function Documentation

static vtkTemporalShiftScale* vtkTemporalShiftScale::New ( ) [static]

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

Reimplemented from vtkTemporalDataSetAlgorithm.

virtual const char* vtkTemporalShiftScale::GetClassName ( ) [virtual]

Reimplemented from vtkTemporalDataSetAlgorithm.

static int vtkTemporalShiftScale::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkTemporalDataSetAlgorithm.

virtual int vtkTemporalShiftScale::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkTemporalDataSetAlgorithm.

static vtkTemporalShiftScale* vtkTemporalShiftScale::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkTemporalDataSetAlgorithm.

void vtkTemporalShiftScale::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 vtkTemporalShiftScale::SetPreShift ( double ) [virtual]

Apply a translation to the data before scaling. To convert T{5,100} to T{0,1} use Preshift=-5, Scale=1/95, PostShift=0 To convert T{5,105} to T{5,10} use Preshift=-5, Scale=5/100, PostShift=5

virtual double vtkTemporalShiftScale::GetPreShift ( ) [virtual]

Apply a translation to the data before scaling. To convert T{5,100} to T{0,1} use Preshift=-5, Scale=1/95, PostShift=0 To convert T{5,105} to T{5,10} use Preshift=-5, Scale=5/100, PostShift=5

virtual void vtkTemporalShiftScale::SetPostShift ( double ) [virtual]

Apply a translation to the time

virtual double vtkTemporalShiftScale::GetPostShift ( ) [virtual]

Apply a translation to the time

virtual void vtkTemporalShiftScale::SetScale ( double ) [virtual]

Apply a scale to the time.

virtual double vtkTemporalShiftScale::GetScale ( ) [virtual]

Apply a scale to the time.

virtual void vtkTemporalShiftScale::SetPeriodic ( int ) [virtual]

If Periodic is true, requests for time will be wrapped around so that the source appears to be a periodic time source. If data exists for times {0,N-1}, setting periodic to true will cause time 0 to be produced when time N, 2N, 2N etc is requested. This effectively gives the source the ability to generate time data indefinitely in a loop. When combined with Shift/Scale, the time becomes periodic in the shifted and scaled time frame of reference. Note: Since the input time may not start at zero, the wrapping of time from the end of one period to the start of the next, will subtract the initial time - a source with T{5..6} repeated periodicaly will have output time {5..6..7..8} etc.

virtual int vtkTemporalShiftScale::GetPeriodic ( ) [virtual]

If Periodic is true, requests for time will be wrapped around so that the source appears to be a periodic time source. If data exists for times {0,N-1}, setting periodic to true will cause time 0 to be produced when time N, 2N, 2N etc is requested. This effectively gives the source the ability to generate time data indefinitely in a loop. When combined with Shift/Scale, the time becomes periodic in the shifted and scaled time frame of reference. Note: Since the input time may not start at zero, the wrapping of time from the end of one period to the start of the next, will subtract the initial time - a source with T{5..6} repeated periodicaly will have output time {5..6..7..8} etc.

virtual void vtkTemporalShiftScale::PeriodicOn ( ) [virtual]

If Periodic is true, requests for time will be wrapped around so that the source appears to be a periodic time source. If data exists for times {0,N-1}, setting periodic to true will cause time 0 to be produced when time N, 2N, 2N etc is requested. This effectively gives the source the ability to generate time data indefinitely in a loop. When combined with Shift/Scale, the time becomes periodic in the shifted and scaled time frame of reference. Note: Since the input time may not start at zero, the wrapping of time from the end of one period to the start of the next, will subtract the initial time - a source with T{5..6} repeated periodicaly will have output time {5..6..7..8} etc.

virtual void vtkTemporalShiftScale::PeriodicOff ( ) [virtual]

If Periodic is true, requests for time will be wrapped around so that the source appears to be a periodic time source. If data exists for times {0,N-1}, setting periodic to true will cause time 0 to be produced when time N, 2N, 2N etc is requested. This effectively gives the source the ability to generate time data indefinitely in a loop. When combined with Shift/Scale, the time becomes periodic in the shifted and scaled time frame of reference. Note: Since the input time may not start at zero, the wrapping of time from the end of one period to the start of the next, will subtract the initial time - a source with T{5..6} repeated periodicaly will have output time {5..6..7..8} etc.

virtual void vtkTemporalShiftScale::SetPeriodicEndCorrection ( int ) [virtual]

if Periodic time is enabled, this flag determines if the last time step is the same as the first. If PeriodicEndCorrection is true, then it is assumed that the input data goes from 0-1 (or whatever scaled/shifted actual time) and time 1 is the same as time 0 so that steps will be 0,1,2,3...N,1,2,3...N,1,2,3 where step N is the same as 0 and step 0 is not repeated. When this flag is false the data is assumed to be literal and output is of the form 0,1,2,3...N,0,1,2,3... By default this flag is ON

virtual int vtkTemporalShiftScale::GetPeriodicEndCorrection ( ) [virtual]

if Periodic time is enabled, this flag determines if the last time step is the same as the first. If PeriodicEndCorrection is true, then it is assumed that the input data goes from 0-1 (or whatever scaled/shifted actual time) and time 1 is the same as time 0 so that steps will be 0,1,2,3...N,1,2,3...N,1,2,3 where step N is the same as 0 and step 0 is not repeated. When this flag is false the data is assumed to be literal and output is of the form 0,1,2,3...N,0,1,2,3... By default this flag is ON

virtual void vtkTemporalShiftScale::PeriodicEndCorrectionOn ( ) [virtual]

if Periodic time is enabled, this flag determines if the last time step is the same as the first. If PeriodicEndCorrection is true, then it is assumed that the input data goes from 0-1 (or whatever scaled/shifted actual time) and time 1 is the same as time 0 so that steps will be 0,1,2,3...N,1,2,3...N,1,2,3 where step N is the same as 0 and step 0 is not repeated. When this flag is false the data is assumed to be literal and output is of the form 0,1,2,3...N,0,1,2,3... By default this flag is ON

virtual void vtkTemporalShiftScale::PeriodicEndCorrectionOff ( ) [virtual]

if Periodic time is enabled, this flag determines if the last time step is the same as the first. If PeriodicEndCorrection is true, then it is assumed that the input data goes from 0-1 (or whatever scaled/shifted actual time) and time 1 is the same as time 0 so that steps will be 0,1,2,3...N,1,2,3...N,1,2,3 where step N is the same as 0 and step 0 is not repeated. When this flag is false the data is assumed to be literal and output is of the form 0,1,2,3...N,0,1,2,3... By default this flag is ON

virtual void vtkTemporalShiftScale::SetMaximumNumberOfPeriods ( double ) [virtual]

if Periodic time is enabled, this controls how many time periods time is reported for. A filter cannot output an infinite number of time steps and therefore a finite number of periods is generated when reporting time.

virtual double vtkTemporalShiftScale::GetMaximumNumberOfPeriods ( ) [virtual]

if Periodic time is enabled, this controls how many time periods time is reported for. A filter cannot output an infinite number of time steps and therefore a finite number of periods is generated when reporting time.