VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
vtkExtractArraysOverTime Class Reference

extracts a selection over time. More...

#include <vtkExtractArraysOverTime.h>

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

Public Types

typedef
vtkMultiBlockDataSetAlgorithm 
Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkExtractArraysOverTimeNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int GetNumberOfTimeSteps ()
 
void SetSelectionConnection (vtkAlgorithmOutput *algOutput)
 
virtual void SetSelectionExtractor (vtkExtractSelection *)
 
virtual vtkExtractSelectionGetSelectionExtractor ()
 
virtual void SetReportStatisticsOnly (int)
 
virtual int GetReportStatisticsOnly ()
 
virtual void ReportStatisticsOnlyOn ()
 
virtual void ReportStatisticsOnlyOff ()
 

Static Public Member Functions

static vtkExtractArraysOverTimeNew ()
 
static int IsTypeOf (const char *type)
 
static vtkExtractArraysOverTimeSafeDownCast (vtkObjectBase *o)
 

Protected Types

enum  Errors { NoError, MoreThan1Indices }
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkExtractArraysOverTime ()
 
 ~vtkExtractArraysOverTime ()
 
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 PostExecute (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
int DetermineSelectionType (vtkSelection *)
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 
void CopyFastPathDataToOutput (vtkDataSet *input, vtkTable *output)
 
void ExecuteAtTimeStep (vtkInformationVector **inputV, vtkInformation *outInfo)
 
bool UpdateFastPathIDs (vtkInformationVector **inputV, vtkInformation *outInfo)
 

Protected Attributes

int CurrentTimeIndex
 
int NumberOfTimeSteps
 
int FieldType
 
int ContentType
 
bool WaitingForFastPathData
 
bool IsExecuting
 
bool UseFastPath
 
int ReportStatisticsOnly
 
int Error
 
vtkExtractSelectionSelectionExtractor
 

Detailed Description

extracts a selection over time.

vtkExtractArraysOverTime extracts a selection over time. The output is a multiblock dataset. If selection content type is vtkSelection::Locations, then each output block corresponds to each probed location. Otherwise, each output block corresponds to an extracted cell/point depending on whether the selection field type is CELL or POINT. Each block is a vtkTable with a column named Time (or TimeData if Time exists in the input). When extracting point data, the input point coordinates are copied to a column named Point Coordinates or Points (if Point Coordinates exists in the input). This algorithm does not produce a TIME_STEPS or TIME_RANGE information because it works across time.

Caveat:
This algorithm works only with source that produce TIME_STEPS(). Continuous time range is not yet supported.

Definition at line 47 of file vtkExtractArraysOverTime.h.

Member Typedef Documentation

typedef vtkMultiBlockDataSetAlgorithm vtkExtractArraysOverTime::Superclass

Definition at line 51 of file vtkExtractArraysOverTime.h.

Member Enumeration Documentation

Enumerator
NoError 
MoreThan1Indices 

Definition at line 147 of file vtkExtractArraysOverTime.h.

Constructor & Destructor Documentation

vtkExtractArraysOverTime::vtkExtractArraysOverTime ( )
protected
vtkExtractArraysOverTime::~vtkExtractArraysOverTime ( )
protected

Member Function Documentation

static vtkExtractArraysOverTime* vtkExtractArraysOverTime::New ( )
static
static int vtkExtractArraysOverTime::IsTypeOf ( const char *  type)
static
virtual int vtkExtractArraysOverTime::IsA ( const char *  type)
virtual

Reimplemented in vtkPExtractArraysOverTime.

static vtkExtractArraysOverTime* vtkExtractArraysOverTime::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkExtractArraysOverTime::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented in vtkPExtractArraysOverTime.

vtkExtractArraysOverTime* vtkExtractArraysOverTime::NewInstance ( ) const
void vtkExtractArraysOverTime::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual int vtkExtractArraysOverTime::GetNumberOfTimeSteps ( )
virtual

Get the number of time steps

void vtkExtractArraysOverTime::SetSelectionConnection ( vtkAlgorithmOutput *  algOutput)
inline

Convenience method to specify the selection connection (2nd input port)

Definition at line 62 of file vtkExtractArraysOverTime.h.

virtual void vtkExtractArraysOverTime::SetSelectionExtractor ( vtkExtractSelection )
virtual

Set/get the vtkExtractSelection instance used to obtain array values at each time step. An instance of vtkExtractSelection is created on demand when the filter is first executed. This is used by ParaView to override the default extractor with one that supports Python-based QUERY selection.

virtual vtkExtractSelection* vtkExtractArraysOverTime::GetSelectionExtractor ( )
virtual

Set/get the vtkExtractSelection instance used to obtain array values at each time step. An instance of vtkExtractSelection is created on demand when the filter is first executed. This is used by ParaView to override the default extractor with one that supports Python-based QUERY selection.

virtual void vtkExtractArraysOverTime::SetReportStatisticsOnly ( int  )
virtual

Instead of breaking a selection into a separate time-history table for each (block,ID)-tuple, you may call ReportStatisticsOnlyOn(). Then a single table per block of the input dataset will report the minimum, maximum, quartiles, and (for numerical arrays) the average and standard deviation of the selection over time. The default is off to preserve backwards-compatibility.

virtual int vtkExtractArraysOverTime::GetReportStatisticsOnly ( )
virtual

Instead of breaking a selection into a separate time-history table for each (block,ID)-tuple, you may call ReportStatisticsOnlyOn(). Then a single table per block of the input dataset will report the minimum, maximum, quartiles, and (for numerical arrays) the average and standard deviation of the selection over time. The default is off to preserve backwards-compatibility.

virtual void vtkExtractArraysOverTime::ReportStatisticsOnlyOn ( )
virtual

Instead of breaking a selection into a separate time-history table for each (block,ID)-tuple, you may call ReportStatisticsOnlyOn(). Then a single table per block of the input dataset will report the minimum, maximum, quartiles, and (for numerical arrays) the average and standard deviation of the selection over time. The default is off to preserve backwards-compatibility.

virtual void vtkExtractArraysOverTime::ReportStatisticsOnlyOff ( )
virtual

Instead of breaking a selection into a separate time-history table for each (block,ID)-tuple, you may call ReportStatisticsOnlyOn(). Then a single table per block of the input dataset will report the minimum, maximum, quartiles, and (for numerical arrays) the average and standard deviation of the selection over time. The default is off to preserve backwards-compatibility.

virtual int vtkExtractArraysOverTime::RequestInformation ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
protectedvirtual
virtual int vtkExtractArraysOverTime::RequestUpdateExtent ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
protectedvirtual
virtual int vtkExtractArraysOverTime::RequestData ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
protectedvirtual
virtual void vtkExtractArraysOverTime::PostExecute ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
protectedvirtual

Reimplemented in vtkPExtractArraysOverTime.

int vtkExtractArraysOverTime::DetermineSelectionType ( vtkSelection *  )
protected

Determines the FieldType and ContentType for the selection. If the selection is a vtkSelection::SELECTIONS selection, then this method ensures that all child nodes have the same field type and content type otherwise, it returns 0.

virtual int vtkExtractArraysOverTime::FillInputPortInformation ( int  port,
vtkInformation *  info 
)
protectedvirtual
bool vtkExtractArraysOverTime::UpdateFastPathIDs ( vtkInformationVector **  inputV,
vtkInformation *  outInfo 
)
protected

This method doesn't care about the content type of the selection, just grabs the value.

void vtkExtractArraysOverTime::CopyFastPathDataToOutput ( vtkDataSet *  input,
vtkTable *  output 
)
protected

This looks at the arrays in the vtkFieldData of input and copies those whose names are in the form "XXXOverTime" to the output point data.

void vtkExtractArraysOverTime::ExecuteAtTimeStep ( vtkInformationVector **  inputV,
vtkInformation *  outInfo 
)
protected

Member Data Documentation

int vtkExtractArraysOverTime::CurrentTimeIndex
protected

Definition at line 133 of file vtkExtractArraysOverTime.h.

int vtkExtractArraysOverTime::NumberOfTimeSteps
protected

Definition at line 134 of file vtkExtractArraysOverTime.h.

int vtkExtractArraysOverTime::FieldType
protected

Definition at line 136 of file vtkExtractArraysOverTime.h.

int vtkExtractArraysOverTime::ContentType
protected

Definition at line 137 of file vtkExtractArraysOverTime.h.

bool vtkExtractArraysOverTime::WaitingForFastPathData
protected

Definition at line 139 of file vtkExtractArraysOverTime.h.

bool vtkExtractArraysOverTime::IsExecuting
protected

Definition at line 140 of file vtkExtractArraysOverTime.h.

bool vtkExtractArraysOverTime::UseFastPath
protected

Definition at line 141 of file vtkExtractArraysOverTime.h.

int vtkExtractArraysOverTime::ReportStatisticsOnly
protected

Definition at line 143 of file vtkExtractArraysOverTime.h.

int vtkExtractArraysOverTime::Error
protected

Definition at line 145 of file vtkExtractArraysOverTime.h.

vtkExtractSelection* vtkExtractArraysOverTime::SelectionExtractor
protected

Definition at line 153 of file vtkExtractArraysOverTime.h.


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