VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkTemporalStatistics Class Reference

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

#include <vtkTemporalStatistics.h>

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

Public Types

typedef vtkPassInputTypeAlgorithm Superclass
- Public Types inherited from vtkPassInputTypeAlgorithm
typedef vtkAlgorithm Superclass
- Public Types inherited from vtkAlgorithm
typedef vtkObject Superclass
- Public Types inherited from vtkObject
typedef vtkObjectBase 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 ()
- Public Member Functions inherited from vtkPassInputTypeAlgorithm
vtkPolyDataGetPolyDataOutput ()
vtkStructuredPointsGetStructuredPointsOutput ()
vtkImageDataGetImageDataOutput ()
vtkStructuredGridGetStructuredGridOutput ()
vtkUnstructuredGridGetUnstructuredGridOutput ()
vtkRectilinearGridGetRectilinearGridOutput ()
vtkTableGetTableOutput ()
vtkGraphGetGraphOutput ()
vtkDataObjectGetInput ()
vtkDataObjectGetOutput ()
vtkDataObjectGetOutput (int)
void SetInput (vtkDataObject *)
void SetInput (int, vtkDataObject *)
void AddInput (vtkDataObject *)
void AddInput (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 int IsTypeOf (const char *type)
static vtkTemporalStatisticsSafeDownCast (vtkObject *o)
static vtkTemporalStatisticsNew ()

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 vtkDataArrayGetArray (vtkFieldData *fieldData, vtkDataArray *inArray, const char *nameSuffix)
- Protected Member Functions inherited from vtkPassInputTypeAlgorithm
 vtkPassInputTypeAlgorithm ()
 ~vtkPassInputTypeAlgorithm ()
virtual int FillOutputPortInformation (int port, vtkInformation *info)
vtkDataObjectGetInput (int port)
- 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 vtkExecutiveCreateDefaultExecutive ()
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

int ComputeAverage
int ComputeMaximum
int ComputeMinimum
int ComputeStandardDeviation
int CurrentTimeIndex

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
- Friends inherited from vtkObject

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 (kmore.nosp@m.l@sa.nosp@m.ndia..nosp@m.gov) from Sandia National Laboratories.
Tests:
vtkTemporalStatistics (Tests)

Definition at line 64 of file vtkTemporalStatistics.h.

Member Typedef Documentation

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 
)
protectedvirtual

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 
)
protectedvirtual

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  
)
protectedvirtual

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  
)
protectedvirtual

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  
)
protectedvirtual

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 
)
protectedvirtual
virtual void vtkTemporalStatistics::InitializeStatistics ( vtkDataSet input,
vtkDataSet output 
)
protectedvirtual
virtual void vtkTemporalStatistics::InitializeStatistics ( vtkGraph input,
vtkGraph output 
)
protectedvirtual
virtual void vtkTemporalStatistics::InitializeStatistics ( vtkCompositeDataSet input,
vtkCompositeDataSet output 
)
protectedvirtual
virtual void vtkTemporalStatistics::InitializeArrays ( vtkFieldData inFd,
vtkFieldData outFd 
)
protectedvirtual
virtual void vtkTemporalStatistics::InitializeArray ( vtkDataArray array,
vtkFieldData outFd 
)
protectedvirtual
virtual void vtkTemporalStatistics::AccumulateStatistics ( vtkDataObject input,
vtkDataObject output 
)
protectedvirtual
virtual void vtkTemporalStatistics::AccumulateStatistics ( vtkDataSet input,
vtkDataSet output 
)
protectedvirtual
virtual void vtkTemporalStatistics::AccumulateStatistics ( vtkGraph input,
vtkGraph output 
)
protectedvirtual
virtual void vtkTemporalStatistics::AccumulateStatistics ( vtkCompositeDataSet input,
vtkCompositeDataSet output 
)
protectedvirtual
virtual void vtkTemporalStatistics::AccumulateArrays ( vtkFieldData inFd,
vtkFieldData outFd 
)
protectedvirtual
virtual void vtkTemporalStatistics::PostExecute ( vtkDataObject input,
vtkDataObject output 
)
protectedvirtual
virtual void vtkTemporalStatistics::PostExecute ( vtkDataSet input,
vtkDataSet output 
)
protectedvirtual
virtual void vtkTemporalStatistics::PostExecute ( vtkGraph input,
vtkGraph output 
)
protectedvirtual
virtual void vtkTemporalStatistics::PostExecute ( vtkCompositeDataSet input,
vtkCompositeDataSet output 
)
protectedvirtual
virtual void vtkTemporalStatistics::FinishArrays ( vtkFieldData inFd,
vtkFieldData outFd 
)
protectedvirtual
virtual vtkDataArray* vtkTemporalStatistics::GetArray ( vtkFieldData fieldData,
vtkDataArray inArray,
const char *  nameSuffix 
)
protectedvirtual

Member Data Documentation

int vtkTemporalStatistics::ComputeAverage
protected

Definition at line 107 of file vtkTemporalStatistics.h.

int vtkTemporalStatistics::ComputeMaximum
protected

Definition at line 108 of file vtkTemporalStatistics.h.

int vtkTemporalStatistics::ComputeMinimum
protected

Definition at line 109 of file vtkTemporalStatistics.h.

int vtkTemporalStatistics::ComputeStandardDeviation
protected

Definition at line 110 of file vtkTemporalStatistics.h.

int vtkTemporalStatistics::CurrentTimeIndex
protected

Definition at line 113 of file vtkTemporalStatistics.h.


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