VTK
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkTemporalPathLineFilter Class Reference

Generate a Polydata Pointset from any Dataset. More...

#include <vtkTemporalPathLineFilter.h>

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

Public Member Functions

void SetScalarArray (const char *)
 
const char * GetScalarArray ()
 
void Flush ()
 
void SetSelectionConnection (vtkAlgorithmOutput *algOutput)
 
void SetSelection (vtkDataSet *input)
 
virtual void SetMaskPoints (int)
 
virtual int GetMaskPoints ()
 
virtual void SetMaxTrackLength (unsigned int)
 
virtual unsigned int GetMaxTrackLength ()
 
virtual void SetIdChannelArray (const char *)
 
virtual char * GetIdChannelArray ()
 
virtual void SetMaxStepDistance (double, double, double)
 
virtual void SetMaxStepDistance (double[3])
 
virtual double * GetMaxStepDistance ()
 
virtual void GetMaxStepDistance (double &, double &, double &)
 
virtual void GetMaxStepDistance (double[3])
 
virtual void SetKeepDeadTrails (int)
 
virtual int GetKeepDeadTrails ()
 
- Public Member Functions inherited from vtkPolyDataAlgorithm
vtkDataObjectGetInput ()
 
vtkDataObjectGetInput (int port)
 
vtkPolyDataGetPolyDataInput (int port)
 
vtkPolyDataGetOutput ()
 
vtkPolyDataGetOutput (int)
 
virtual void SetOutput (vtkDataObject *d)
 
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
void SetInput (vtkDataObject *)
 
void SetInput (int, vtkDataObject *)
 
void AddInput (vtkDataObject *)
 
void AddInput (int, vtkDataObject *)
 
- 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 ()
 

Protected Member Functions

 vtkTemporalPathLineFilter ()
 
 ~vtkTemporalPathLineFilter ()
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 
TrailPointer GetTrail (vtkIdType i)
 
void IncrementTrail (TrailPointer trail, vtkDataSet *input, vtkIdType i)
 
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
- Protected Member Functions inherited from vtkPolyDataAlgorithm
 vtkPolyDataAlgorithm ()
 
 ~vtkPolyDataAlgorithm ()
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual void ExecuteData (vtkDataObject *output)
 
virtual void Execute ()
 
- 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 NumberOfTimeSteps
 
int MaskPoints
 
unsigned int MaxTrackLength
 
unsigned int LastTrackLength
 
int FirstTime
 
char * IdChannelArray
 
double MaxStepDistance [3]
 
double LatestTime
 
int KeepDeadTrails
 
int UsingSelection
 
vtkSmartPointer< vtkCellArrayPolyLines
 
vtkSmartPointer< vtkCellArrayVertices
 
vtkSmartPointer< vtkPointsLineCoordinates
 
vtkSmartPointer< vtkPointsVertexCoordinates
 
vtkSmartPointer< vtkFloatArrayTrailId
 
vtkSmartPointer
< vtkTemporalPathLineFilterInternals > 
Internals
 
vtkstd::set< vtkIdTypeSelectionIds
 
typedef vtkPolyDataAlgorithm Superclass
 
static vtkTemporalPathLineFilterNew ()
 
static int IsTypeOf (const char *type)
 
static vtkTemporalPathLineFilterSafeDownCast (vtkObject *o)
 
virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 

Additional Inherited Members

- Public Types inherited from vtkPolyDataAlgorithm
typedef vtkAlgorithm Superclass
 
- Static Public Member Functions inherited from vtkPolyDataAlgorithm
static vtkPolyDataAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPolyDataAlgorithmSafeDownCast (vtkObject *o)
 
- 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

Generate a Polydata Pointset from any Dataset.

vtkTemporalPathLineFilter takes any dataset as input, it extracts the point locations of all cells over time to build up a polyline trail. The point number (index) is used as the 'key' if the points are randomly changing their respective order in the points list, then you should specify a scalar that represents the unique ID. This is intended to handle the output of a filter such as the TemporalStreamTracer.

See Also
vtkTemporalStreamTracer
Thanks:
John Bidiscombe of CSCS - Swiss National Supercomputing Centre for creating and contributing this class.

Definition at line 53 of file vtkTemporalPathLineFilter.h.

Member Typedef Documentation

Standard Type-Macro

Definition at line 58 of file vtkTemporalPathLineFilter.h.

Constructor & Destructor Documentation

vtkTemporalPathLineFilter::vtkTemporalPathLineFilter ( )
protected
vtkTemporalPathLineFilter::~vtkTemporalPathLineFilter ( )
protected

Member Function Documentation

static vtkTemporalPathLineFilter* vtkTemporalPathLineFilter::New ( )
static

Standard Type-Macro

virtual const char* vtkTemporalPathLineFilter::GetClassName ( )
virtual

Standard Type-Macro

Reimplemented from vtkPolyDataAlgorithm.

static int vtkTemporalPathLineFilter::IsTypeOf ( const char *  type)
static

Standard Type-Macro

virtual int vtkTemporalPathLineFilter::IsA ( const char *  type)
virtual

Standard Type-Macro

Reimplemented from vtkPolyDataAlgorithm.

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

Standard Type-Macro

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

Standard Type-Macro

Reimplemented from vtkPolyDataAlgorithm.

virtual void vtkTemporalPathLineFilter::SetMaskPoints ( int  )
virtual

Set the number of particles to track as a ratio of the input example: setting MaskPoints to 10 will track every 10th point

virtual int vtkTemporalPathLineFilter::GetMaskPoints ( )
virtual

Set the number of particles to track as a ratio of the input example: setting MaskPoints to 10 will track every 10th point

virtual void vtkTemporalPathLineFilter::SetMaxTrackLength ( unsigned  int)
virtual

If the Particles being traced animate for a long time, the trails or traces will become long and stringy. Setting the MaxTraceTimeLength will limit how much of the trace is displayed. Tracks longer then the Max will disappear and the trace will apppear like a snake of fixed length which progresses as the particle moves

virtual unsigned int vtkTemporalPathLineFilter::GetMaxTrackLength ( )
virtual

If the Particles being traced animate for a long time, the trails or traces will become long and stringy. Setting the MaxTraceTimeLength will limit how much of the trace is displayed. Tracks longer then the Max will disappear and the trace will apppear like a snake of fixed length which progresses as the particle moves

virtual void vtkTemporalPathLineFilter::SetIdChannelArray ( const char *  )
virtual

Specify the name of a scalar array which will be used to fetch the index of each point. This is necessary only if the particles change position (Id order) on each time step. The Id can be used to identify particles at each step and hence track them properly. If this array is NULL, the global point ids are used. If an Id array cannot otherwise be found, the point index is used as the ID.

virtual char* vtkTemporalPathLineFilter::GetIdChannelArray ( )
virtual

Specify the name of a scalar array which will be used to fetch the index of each point. This is necessary only if the particles change position (Id order) on each time step. The Id can be used to identify particles at each step and hence track them properly. If this array is NULL, the global point ids are used. If an Id array cannot otherwise be found, the point index is used as the ID.

void vtkTemporalPathLineFilter::SetScalarArray ( const char *  )
const char* vtkTemporalPathLineFilter::GetScalarArray ( )
virtual void vtkTemporalPathLineFilter::SetMaxStepDistance ( double  ,
double  ,
double   
)
virtual

If a particle disappears from one end of a simulation and reappears on the other side, the track left will be unrepresentative. Set a MaxStepDistance{x,y,z} which acts as a threshold above which if a step occurs larger than the value (for the dimension), the track will be dropped and restarted after the step. (ie the part before the wrap around will be dropped and the newer part kept).

virtual void vtkTemporalPathLineFilter::SetMaxStepDistance ( double  [3])
virtual

If a particle disappears from one end of a simulation and reappears on the other side, the track left will be unrepresentative. Set a MaxStepDistance{x,y,z} which acts as a threshold above which if a step occurs larger than the value (for the dimension), the track will be dropped and restarted after the step. (ie the part before the wrap around will be dropped and the newer part kept).

virtual double* vtkTemporalPathLineFilter::GetMaxStepDistance ( )
virtual

If a particle disappears from one end of a simulation and reappears on the other side, the track left will be unrepresentative. Set a MaxStepDistance{x,y,z} which acts as a threshold above which if a step occurs larger than the value (for the dimension), the track will be dropped and restarted after the step. (ie the part before the wrap around will be dropped and the newer part kept).

virtual void vtkTemporalPathLineFilter::GetMaxStepDistance ( double &  ,
double &  ,
double &   
)
virtual

If a particle disappears from one end of a simulation and reappears on the other side, the track left will be unrepresentative. Set a MaxStepDistance{x,y,z} which acts as a threshold above which if a step occurs larger than the value (for the dimension), the track will be dropped and restarted after the step. (ie the part before the wrap around will be dropped and the newer part kept).

virtual void vtkTemporalPathLineFilter::GetMaxStepDistance ( double  [3])
virtual

If a particle disappears from one end of a simulation and reappears on the other side, the track left will be unrepresentative. Set a MaxStepDistance{x,y,z} which acts as a threshold above which if a step occurs larger than the value (for the dimension), the track will be dropped and restarted after the step. (ie the part before the wrap around will be dropped and the newer part kept).

virtual void vtkTemporalPathLineFilter::SetKeepDeadTrails ( int  )
virtual

When a particle 'disappears', the trail belonging to it is removed from the list. When this flag is enabled, dead trails will persist until the next time the list is cleared. Use carefully as it may cause excessive memory consumption if left on by mistake.

virtual int vtkTemporalPathLineFilter::GetKeepDeadTrails ( )
virtual

When a particle 'disappears', the trail belonging to it is removed from the list. When this flag is enabled, dead trails will persist until the next time the list is cleared. Use carefully as it may cause excessive memory consumption if left on by mistake.

void vtkTemporalPathLineFilter::Flush ( )

Flush will wipe any existing data so that traces can be restarted from whatever time step is next supplied.

void vtkTemporalPathLineFilter::SetSelectionConnection ( vtkAlgorithmOutput algOutput)

Set a second input which is a selection. Particles with the same Id in the selection as the primary input will be chosen for pathlines Note that you must have the same IdChannelArray in the selection as the input

void vtkTemporalPathLineFilter::SetSelection ( vtkDataSet input)

Set a second input which is a selection. Particles with the same Id in the selection as the primary input will be chosen for pathlines Note that you must have the same IdChannelArray in the selection as the input

virtual int vtkTemporalPathLineFilter::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 vtkPolyDataAlgorithm.

virtual int vtkTemporalPathLineFilter::FillOutputPortInformation ( int  port,
vtkInformation info 
)
protectedvirtual

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

Reimplemented from vtkPolyDataAlgorithm.

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

The necessary parts of the standard pipeline update mechanism

Reimplemented from vtkPolyDataAlgorithm.

virtual int vtkTemporalPathLineFilter::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
protectedvirtual

The necessary parts of the standard pipeline update mechanism

Reimplemented from vtkPolyDataAlgorithm.

TrailPointer vtkTemporalPathLineFilter::GetTrail ( vtkIdType  i)
protected
void vtkTemporalPathLineFilter::IncrementTrail ( TrailPointer  trail,
vtkDataSet input,
vtkIdType  i 
)
protected

Member Data Documentation

int vtkTemporalPathLineFilter::NumberOfTimeSteps
protected

Definition at line 158 of file vtkTemporalPathLineFilter.h.

int vtkTemporalPathLineFilter::MaskPoints
protected

Definition at line 159 of file vtkTemporalPathLineFilter.h.

unsigned int vtkTemporalPathLineFilter::MaxTrackLength
protected

Definition at line 160 of file vtkTemporalPathLineFilter.h.

unsigned int vtkTemporalPathLineFilter::LastTrackLength
protected

Definition at line 161 of file vtkTemporalPathLineFilter.h.

int vtkTemporalPathLineFilter::FirstTime
protected

Definition at line 162 of file vtkTemporalPathLineFilter.h.

char* vtkTemporalPathLineFilter::IdChannelArray
protected

Definition at line 163 of file vtkTemporalPathLineFilter.h.

double vtkTemporalPathLineFilter::MaxStepDistance[3]
protected

Definition at line 164 of file vtkTemporalPathLineFilter.h.

double vtkTemporalPathLineFilter::LatestTime
protected

Definition at line 165 of file vtkTemporalPathLineFilter.h.

int vtkTemporalPathLineFilter::KeepDeadTrails
protected

Definition at line 166 of file vtkTemporalPathLineFilter.h.

int vtkTemporalPathLineFilter::UsingSelection
protected

Definition at line 167 of file vtkTemporalPathLineFilter.h.

vtkSmartPointer<vtkCellArray> vtkTemporalPathLineFilter::PolyLines
protected

Definition at line 170 of file vtkTemporalPathLineFilter.h.

vtkSmartPointer<vtkCellArray> vtkTemporalPathLineFilter::Vertices
protected

Definition at line 171 of file vtkTemporalPathLineFilter.h.

vtkSmartPointer<vtkPoints> vtkTemporalPathLineFilter::LineCoordinates
protected

Definition at line 172 of file vtkTemporalPathLineFilter.h.

vtkSmartPointer<vtkPoints> vtkTemporalPathLineFilter::VertexCoordinates
protected

Definition at line 173 of file vtkTemporalPathLineFilter.h.

vtkSmartPointer<vtkFloatArray> vtkTemporalPathLineFilter::TrailId
protected

Definition at line 174 of file vtkTemporalPathLineFilter.h.

vtkSmartPointer<vtkTemporalPathLineFilterInternals> vtkTemporalPathLineFilter::Internals
protected

Definition at line 175 of file vtkTemporalPathLineFilter.h.

vtkstd::set<vtkIdType> vtkTemporalPathLineFilter::SelectionIds
protected

Definition at line 176 of file vtkTemporalPathLineFilter.h.


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