vtkTemporalStatistics Class Reference

#include <vtkTemporalStatistics.h>

Inheritance diagram for vtkTemporalStatistics:

[legend]

Collaboration diagram for vtkTemporalStatistics:

[legend]

List of all members.

Detailed Description

Compute statistics of point or cell data as it changes over time.

Given an input that changes over time, vtkTemporalStatistics looks at the data for each time step and computes some statistical information of how a point or cell variable changes over time. For example, vtkTemporalStatistics can compute the average value of "pressure" over time of each point.

Note that this filter will require the upstream filter to be run on every time step that it reports that it can compute. This may be a time consuming operation.

vtkTemporalStatistics ignores the temporal spacing. Each timestep will be weighted the same regardless of how long of an interval it is to the next timestep. Thus, the average statistic may be quite different from an integration of the variable if the time spacing varies.

Thanks:: This class was originally written by Kenneth Moreland (kmorel@sandia.gov) from Sandia National Laboratories.

Tests:: vtkTemporalStatistics (Tests)

Definition at line 64 of file vtkTemporalStatistics.h.


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

virtual int	GetComputeAverage ()
virtual void	SetComputeAverage (int)
virtual void	ComputeAverageOn ()
virtual void	ComputeAverageOff ()

virtual int	GetComputeMinimum ()
virtual void	SetComputeMinimum (int)
virtual void	ComputeMinimumOn ()
virtual void	ComputeMinimumOff ()

virtual int	GetComputeMaximum ()
virtual void	SetComputeMaximum (int)
virtual void	ComputeMaximumOn ()
virtual void	ComputeMaximumOff ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkTemporalStatistics *	SafeDownCast (vtkObject *o)
static vtkTemporalStatistics *	New ()
Protected Member Functions
	vtkTemporalStatistics ()
	~vtkTemporalStatistics ()
virtual int	FillInputPortInformation (int port, vtkInformation *info)
virtual int	RequestDataObject (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)
virtual int	RequestInformation (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)
virtual int	RequestUpdateExtent (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)
virtual int	RequestData (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)
virtual void	InitializeStatistics (vtkDataObject input, vtkDataObject output)
virtual void	InitializeStatistics (vtkDataSet input, vtkDataSet output)
virtual void	InitializeStatistics (vtkGraph input, vtkGraph output)
virtual void	InitializeStatistics (vtkCompositeDataSet input, vtkCompositeDataSet output)
virtual void	InitializeArrays (vtkFieldData inFd, vtkFieldData outFd)
virtual void	InitializeArray (vtkDataArray array, vtkFieldData outFd)
virtual void	AccumulateStatistics (vtkDataObject input, vtkDataObject output)
virtual void	AccumulateStatistics (vtkDataSet input, vtkDataSet output)
virtual void	AccumulateStatistics (vtkGraph input, vtkGraph output)
virtual void	AccumulateStatistics (vtkCompositeDataSet input, vtkCompositeDataSet output)
virtual void	AccumulateArrays (vtkFieldData inFd, vtkFieldData outFd)
virtual void	PostExecute (vtkDataObject input, vtkDataObject output)
virtual void	PostExecute (vtkDataSet input, vtkDataSet output)
virtual void	PostExecute (vtkGraph input, vtkGraph output)
virtual void	PostExecute (vtkCompositeDataSet input, vtkCompositeDataSet output)
virtual void	FinishArrays (vtkFieldData inFd, vtkFieldData outFd)
virtual vtkDataArray *	GetArray (vtkFieldData fieldData, vtkDataArray inArray, const char *nameSuffix)
Protected Attributes
int	ComputeAverage
int	ComputeMaximum
int	ComputeMinimum
int	ComputeStandardDeviation
int	CurrentTimeIndex

Member Typedef Documentation

typedef vtkPassInputTypeAlgorithm vtkTemporalStatistics::Superclass

Reimplemented from vtkPassInputTypeAlgorithm.

Definition at line 67 of file vtkTemporalStatistics.h.

Constructor & Destructor Documentation

vtkTemporalStatistics::vtkTemporalStatistics ( ) [protected]

vtkTemporalStatistics::~vtkTemporalStatistics ( ) [protected]

Member Function Documentation

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

Reimplemented from vtkPassInputTypeAlgorithm.

static int vtkTemporalStatistics::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 vtkPassInputTypeAlgorithm.

virtual int vtkTemporalStatistics::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 vtkPassInputTypeAlgorithm.

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

Reimplemented from vtkPassInputTypeAlgorithm.

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

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

Reimplemented from vtkPassInputTypeAlgorithm.

virtual void vtkTemporalStatistics::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 vtkPassInputTypeAlgorithm.

virtual int vtkTemporalStatistics::GetComputeAverage ( ) [virtual]

Turn on/off the computation of the average values over time. On by default. The resulting array names have "_average" appended to them.

virtual void vtkTemporalStatistics::SetComputeAverage ( int ) [virtual]

Turn on/off the computation of the average values over time. On by default. The resulting array names have "_average" appended to them.

virtual void vtkTemporalStatistics::ComputeAverageOn ( ) [virtual]

Turn on/off the computation of the average values over time. On by default. The resulting array names have "_average" appended to them.

virtual void vtkTemporalStatistics::ComputeAverageOff ( ) [virtual]

Turn on/off the computation of the average values over time. On by default. The resulting array names have "_average" appended to them.

virtual int vtkTemporalStatistics::GetComputeMinimum ( ) [virtual]

Turn on/off the computation of the minimum values over time. On by default. The resulting array names have "_minimum" appended to them.

virtual void vtkTemporalStatistics::SetComputeMinimum ( int ) [virtual]

Turn on/off the computation of the minimum values over time. On by default. The resulting array names have "_minimum" appended to them.

virtual void vtkTemporalStatistics::ComputeMinimumOn ( ) [virtual]

Turn on/off the computation of the minimum values over time. On by default. The resulting array names have "_minimum" appended to them.

virtual void vtkTemporalStatistics::ComputeMinimumOff ( ) [virtual]

Turn on/off the computation of the minimum values over time. On by default. The resulting array names have "_minimum" appended to them.

virtual int vtkTemporalStatistics::GetComputeMaximum ( ) [virtual]

Turn on/off the computation of the maximum values over time. On by default. The resulting array names have "_maximum" appended to them.

virtual void vtkTemporalStatistics::SetComputeMaximum ( int ) [virtual]

Turn on/off the computation of the maximum values over time. On by default. The resulting array names have "_maximum" appended to them.

virtual void vtkTemporalStatistics::ComputeMaximumOn ( ) [virtual]

Turn on/off the computation of the maximum values over time. On by default. The resulting array names have "_maximum" appended to them.

virtual void vtkTemporalStatistics::ComputeMaximumOff ( ) [virtual]

Turn on/off the computation of the maximum values over time. On by default. The resulting array names have "_maximum" appended to them.

virtual int vtkTemporalStatistics::GetComputeStandardDeviation ( ) [virtual]

virtual void vtkTemporalStatistics::SetComputeStandardDeviation ( int ) [virtual]

virtual void vtkTemporalStatistics::ComputeStandardDeviationOn ( ) [virtual]

virtual void vtkTemporalStatistics::ComputeStandardDeviationOff ( ) [virtual]

virtual int vtkTemporalStatistics::FillInputPortInformation	(	int	port,
		vtkInformation *	info
	)			`[protected, virtual]`

Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkPassInputTypeAlgorithm.

virtual int vtkTemporalStatistics::RequestDataObject	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)			`[protected, virtual]`

This is called within ProcessRequest to when a request asks the algorithm to create empty output data objects. This typically happens early on in the execution of the pipeline. The default behavior is to create an output DataSet of the same type as the input for each output port. This method can be overridden to change the output data type of an algorithm. This happens in the third pass of the pipeline execution.

Reimplemented from vtkPassInputTypeAlgorithm.

virtual int vtkTemporalStatistics::RequestInformation	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)			`[protected, virtual]`

This is called within ProcessRequest when a request asks for Information. Typically an algorithm provides whatever lightweight information about its output that it can here without doing any lengthy computations. This happens in the first pass of the pipeline execution.

Reimplemented from vtkPassInputTypeAlgorithm.

virtual int vtkTemporalStatistics::RequestUpdateExtent	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)			`[protected, virtual]`

This is called within ProcessRequest when each filter in the pipeline decides what portion of its input is needed to create the portion of its output that the downstream filter asks for. This happens during the second pass in the pipeline execution process.

Reimplemented from vtkPassInputTypeAlgorithm.

virtual int vtkTemporalStatistics::RequestData	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)			`[protected, virtual]`

This is called within ProcessRequest when a request asks the algorithm to do its work. This is the method you should override to do whatever the algorithm is designed to do. This happens during the fourth pass in the pipeline execution process.

Reimplemented from vtkPassInputTypeAlgorithm.

virtual void vtkTemporalStatistics::InitializeStatistics	(	vtkDataObject *	input,
		vtkDataObject *	output
	)			`[protected, virtual]`

virtual void vtkTemporalStatistics::InitializeStatistics	(	vtkDataSet *	input,
		vtkDataSet *	output
	)			`[protected, virtual]`

virtual void vtkTemporalStatistics::InitializeStatistics	(	vtkGraph *	input,
		vtkGraph *	output
	)			`[protected, virtual]`

virtual void vtkTemporalStatistics::InitializeStatistics	(	vtkCompositeDataSet *	input,
		vtkCompositeDataSet *	output
	)			`[protected, virtual]`

virtual void vtkTemporalStatistics::InitializeArrays	(	vtkFieldData *	inFd,
		vtkFieldData *	outFd
	)			`[protected, virtual]`

virtual void vtkTemporalStatistics::InitializeArray	(	vtkDataArray *	array,
		vtkFieldData *	outFd
	)			`[protected, virtual]`

virtual void vtkTemporalStatistics::AccumulateStatistics	(	vtkDataObject *	input,
		vtkDataObject *	output
	)			`[protected, virtual]`

virtual void vtkTemporalStatistics::AccumulateStatistics	(	vtkDataSet *	input,
		vtkDataSet *	output
	)			`[protected, virtual]`

virtual void vtkTemporalStatistics::AccumulateStatistics	(	vtkGraph *	input,
		vtkGraph *	output
	)			`[protected, virtual]`

virtual void vtkTemporalStatistics::AccumulateStatistics	(	vtkCompositeDataSet *	input,
		vtkCompositeDataSet *	output
	)			`[protected, virtual]`

virtual void vtkTemporalStatistics::AccumulateArrays	(	vtkFieldData *	inFd,
		vtkFieldData *	outFd
	)			`[protected, virtual]`

virtual void vtkTemporalStatistics::PostExecute	(	vtkDataObject *	input,
		vtkDataObject *	output
	)			`[protected, virtual]`

virtual void vtkTemporalStatistics::PostExecute	(	vtkDataSet *	input,
		vtkDataSet *	output
	)			`[protected, virtual]`

virtual void vtkTemporalStatistics::PostExecute	(	vtkGraph *	input,
		vtkGraph *	output
	)			`[protected, virtual]`

virtual void vtkTemporalStatistics::PostExecute	(	vtkCompositeDataSet *	input,
		vtkCompositeDataSet *	output
	)			`[protected, virtual]`

virtual void vtkTemporalStatistics::FinishArrays	(	vtkFieldData *	inFd,
		vtkFieldData *	outFd
	)			`[protected, virtual]`

virtual vtkDataArray* vtkTemporalStatistics::GetArray	(	vtkFieldData *	fieldData,
		vtkDataArray *	inArray,
		const char *	nameSuffix
	)			`[protected, virtual]`