VTK  9.1.0
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 Flush ()
 Flush will wipe any existing data so that traces can be restarted from whatever time step is next supplied.
 
void SetSelectionConnection (vtkAlgorithmOutput *algOutput)
 Set a second input which is a selection.
 
void SetSelectionData (vtkDataSet *input)
 Set a second input which is a selection.
 
virtual void SetMaskPoints (int)
 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 GetMaskPoints ()
 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 SetMaxTrackLength (unsigned int)
 If the Particles being traced animate for a long time, the trails or traces will become long and stringy.
 
virtual unsigned int GetMaxTrackLength ()
 If the Particles being traced animate for a long time, the trails or traces will become long and stringy.
 
virtual void SetIdChannelArray (const char *)
 Specify the name of a scalar array which will be used to fetch the index of each point.
 
virtual char * GetIdChannelArray ()
 Specify the name of a scalar array which will be used to fetch the index of each point.
 
virtual void SetMaxStepDistance (double, double, double)
 If a particle disappears from one end of a simulation and reappears on the other side, the track left will be unrepresentative.
 
virtual void SetMaxStepDistance (double[3])
 If a particle disappears from one end of a simulation and reappears on the other side, the track left will be unrepresentative.
 
virtual double * GetMaxStepDistance ()
 If a particle disappears from one end of a simulation and reappears on the other side, the track left will be unrepresentative.
 
virtual void GetMaxStepDistance (double &, double &, double &)
 If a particle disappears from one end of a simulation and reappears on the other side, the track left will be unrepresentative.
 
virtual void GetMaxStepDistance (double[3])
 If a particle disappears from one end of a simulation and reappears on the other side, the track left will be unrepresentative.
 
virtual void SetKeepDeadTrails (bool)
 When a particle 'disappears', the trail belonging to it is removed from the list.
 
virtual bool GetKeepDeadTrails ()
 When a particle 'disappears', the trail belonging to it is removed from the list.
 
virtual void SetBackwardTime (bool backward)
 Set / Get if the filter is configured to work in backward time going mode.
 
virtual bool GetBackwardTime ()
 Set / Get if the filter is configured to work in backward time going mode.
 
- Public Member Functions inherited from vtkPolyDataAlgorithm
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkPolyDataAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
vtkTypeBool ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 see vtkAlgorithm for details
 
vtkDataObjectGetInput ()
 
vtkDataObjectGetInput (int port)
 
vtkPolyDataGetPolyDataInput (int port)
 
vtkPolyDataGetOutput ()
 Get the output data object for a port on this algorithm.
 
vtkPolyDataGetOutput (int)
 Get the output data object for a port on this algorithm.
 
virtual void SetOutput (vtkDataObject *d)
 Get the output data object for a port on this algorithm.
 
void SetInputData (vtkDataObject *)
 Assign a data object as input.
 
void SetInputData (int, vtkDataObject *)
 Assign a data object as input.
 
void AddInputData (vtkDataObject *)
 Assign a data object as input.
 
void AddInputData (int, vtkDataObject *)
 Assign a data object as input.
 
- Public Member Functions inherited from vtkAlgorithm
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive.
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive.
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive.
 
virtual vtkTypeBool ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
 Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped.
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 A special version of ProcessRequest meant specifically for the pipeline modified time request.
 
virtual int ModifyRequest (vtkInformation *request, int when)
 This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded.
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port.
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port.
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm.
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm.
 
void SetProgress (double)
 SetProgress is deprecated.
 
void UpdateProgress (double amount)
 Update the progress of the process object.
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess().
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm.
 
void RemoveAllInputs ()
 Remove all the input data.
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port.
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection.
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index.
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx.
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections.
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index.
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port.
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm.
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port.
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm.
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port.
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair.
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair.
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0).
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection.
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0)
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection.
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0)
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port.
 
virtual vtkTypeBool Update (int port, vtkInformationVector *requests)
 This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date).
 
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port.
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port.
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port.
 
virtual int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port.
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date.
 
virtual void UpdateDataObject ()
 Create output object(s).
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream.
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date.
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair.
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm.
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this algorithm.
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection.
 
void UnRegister (vtkObjectBase *o) override
 Participate in garbage collection.
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object.
 
virtual vtkTypeBool GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object.
 
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object.
 
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object.
 
virtual double GetProgress ()
 Get the execution progress of a process object.
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
 
virtual double GetProgressShift ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
 
virtual double GetProgressScale ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state.
 
virtual char * GetProgressText ()
 Set the current text message associated with the progress state.
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file.
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process.
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 Set the input data arrays that this algorithm will process.
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 Set the input data arrays that this algorithm will process.
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index.
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 Set the connection for the given input port index.
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index.
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 Add a connection to the given input port index.
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date.
 
virtual void Update ()
 Bring this algorithm's outputs up-to-date.
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports.
 
virtual int GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports.
 
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports.
 
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports.
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.
 
int * GetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents.
 
int * GetUpdateExtent (int port)
 These functions return the update extent for output ports that use 3D extents.
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents.
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents.
 
void GetUpdateExtent (int extent[6])
 These functions return the update extent for output ports that use 3D extents.
 
void GetUpdateExtent (int port, int extent[6])
 These functions return the update extent for output ports that use 3D extents.
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdatePiece (int port)
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdateNumberOfPieces ()
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdateNumberOfPieces (int port)
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdateGhostLevel ()
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdateGhostLevel (int port)
 These functions return the update extent for output ports that use piece extents.
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
 
virtual vtkProgressObserverGetProgressObserver ()
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method.
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 

Protected Member Functions

 vtkTemporalPathLineFilter ()
 
 ~vtkTemporalPathLineFilter () override
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm.
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm.
 
TrailPointer GetTrail (vtkIdType i)
 
void IncrementTrail (TrailPointer trail, vtkDataSet *input, vtkIdType i)
 
int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 The necessary parts of the standard pipeline update mechanism.
 
int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 The necessary parts of the standard pipeline update mechanism.
 
- Protected Member Functions inherited from vtkPolyDataAlgorithm
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkPolyDataAlgorithm ()
 
 ~vtkPolyDataAlgorithm () override
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 This is called by the superclass.
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass.
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm.
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm.
 
- Protected Member Functions inherited from vtkAlgorithm
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 Fill the input port information objects for this algorithm.
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 Fill the output port information objects for this algorithm.
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm.
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm.
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector.
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive.
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port.
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port.
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input.
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature.
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature.
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file.
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

int NumberOfTimeSteps = 0
 
int MaskPoints = 200
 
unsigned int MaxTrackLength = 10
 
unsigned int LastTrackLength = 10
 
int FirstTime = 1
 
char * IdChannelArray = nullptr
 
double MaxStepDistance [3] = { 1, 1, 1 }
 
double LatestTime
 
bool KeepDeadTrails = false
 
bool UsingSelection = false
 
bool BackwardTime = false
 
vtkSmartPointer< vtkCellArrayPolyLines
 
vtkSmartPointer< vtkCellArrayVertices
 
vtkSmartPointer< vtkPointsLineCoordinates
 
vtkSmartPointer< vtkPointsVertexCoordinates
 
vtkSmartPointer< vtkFloatArrayTrailId
 
vtkSmartPointer< vtkTemporalPathLineFilterInternals > Internals
 
std::set< vtkIdTypeSelectionIds
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
unsigned long ErrorCode
 The error code contains a possible error that occurred while reading or writing the file.
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
typedef vtkPolyDataAlgorithm Superclass
 Standard Type-Macro.
 
static vtkTemporalPathLineFilterNew ()
 Standard Type-Macro.
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard Type-Macro.
 
static vtkTemporalPathLineFilterSafeDownCast (vtkObjectBase *o)
 Standard Type-Macro.
 
virtual vtkTypeBool IsA (const char *type)
 Standard Type-Macro.
 
vtkTemporalPathLineFilterNewInstance () const
 Standard Type-Macro.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard Type-Macro.
 
virtual vtkObjectBaseNewInstanceInternal () const
 Standard Type-Macro.
 

Additional Inherited Members

- Public Types inherited from vtkPolyDataAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
enum  DesiredOutputPrecision { SINGLE_PRECISION , DOUBLE_PRECISION , DEFAULT_PRECISION }
 Values used for setting the desired output precision for various algorithms. More...
 
typedef vtkObject Superclass
 
- Static Public Member Functions inherited from vtkPolyDataAlgorithm
static vtkPolyDataAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPolyDataAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements.
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent.
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request.
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance().
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class.
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
 
- Public Attributes inherited from vtkAlgorithm
vtkTypeBool AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

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 vtkParticleTracer.

See also
vtkParticleTracer
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

◆ Superclass

Standard Type-Macro.

Definition at line 61 of file vtkTemporalPathLineFilter.h.

Constructor & Destructor Documentation

◆ vtkTemporalPathLineFilter()

vtkTemporalPathLineFilter::vtkTemporalPathLineFilter ( )
protected

◆ ~vtkTemporalPathLineFilter()

vtkTemporalPathLineFilter::~vtkTemporalPathLineFilter ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkTemporalPathLineFilter * vtkTemporalPathLineFilter::New ( )
static

Standard Type-Macro.

◆ IsTypeOf()

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

Standard Type-Macro.

◆ IsA()

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

Standard Type-Macro.

Reimplemented from vtkPolyDataAlgorithm.

◆ SafeDownCast()

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

Standard Type-Macro.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkTemporalPathLineFilter::NewInstanceInternal ( ) const
protectedvirtual

Standard Type-Macro.

Reimplemented from vtkPolyDataAlgorithm.

◆ NewInstance()

vtkTemporalPathLineFilter * vtkTemporalPathLineFilter::NewInstance ( ) const

Standard Type-Macro.

◆ PrintSelf()

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

Standard Type-Macro.

Reimplemented from vtkPolyDataAlgorithm.

◆ SetMaskPoints()

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.

◆ GetMaskPoints()

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.

◆ SetMaxTrackLength()

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 appear like a snake of fixed length which progresses as the particle moves

◆ GetMaxTrackLength()

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 appear like a snake of fixed length which progresses as the particle moves

◆ SetIdChannelArray()

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 nullptr, the global point ids are used. If an Id array cannot otherwise be found, the point index is used as the ID.

◆ GetIdChannelArray()

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 nullptr, the global point ids are used. If an Id array cannot otherwise be found, the point index is used as the ID.

◆ SetMaxStepDistance() [1/2]

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

◆ SetMaxStepDistance() [2/2]

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

◆ GetMaxStepDistance() [1/3]

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

◆ GetMaxStepDistance() [2/3]

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

◆ GetMaxStepDistance() [3/3]

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

◆ SetKeepDeadTrails()

virtual void vtkTemporalPathLineFilter::SetKeepDeadTrails ( bool  )
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.

◆ GetKeepDeadTrails()

virtual bool 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.

◆ SetBackwardTime()

virtual void vtkTemporalPathLineFilter::SetBackwardTime ( bool  backward)
virtual

Set / Get if the filter is configured to work in backward time going mode.

Default is false (time should go forward).

Time going forward means that for each call to RequestData, then the time step from vtkDataObject::DATA_TIME_STEP() is greater than the time step from the previous call. Time going backward means that the current time step is smaller than the previous one.

◆ GetBackwardTime()

virtual bool vtkTemporalPathLineFilter::GetBackwardTime ( )
virtual

Set / Get if the filter is configured to work in backward time going mode.

Default is false (time should go forward).

Time going forward means that for each call to RequestData, then the time step from vtkDataObject::DATA_TIME_STEP() is greater than the time step from the previous call. Time going backward means that the current time step is smaller than the previous one.

◆ Flush()

void vtkTemporalPathLineFilter::Flush ( )

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

◆ SetSelectionConnection()

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

◆ SetSelectionData()

void vtkTemporalPathLineFilter::SetSelectionData ( 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

◆ FillInputPortInformation()

int vtkTemporalPathLineFilter::FillInputPortInformation ( int  port,
vtkInformation info 
)
overrideprotectedvirtual

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.

◆ FillOutputPortInformation()

int vtkTemporalPathLineFilter::FillOutputPortInformation ( int  port,
vtkInformation info 
)
overrideprotectedvirtual

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.

◆ RequestInformation()

int vtkTemporalPathLineFilter::RequestInformation ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overrideprotectedvirtual

The necessary parts of the standard pipeline update mechanism.

Reimplemented from vtkPolyDataAlgorithm.

◆ RequestData()

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

The necessary parts of the standard pipeline update mechanism.

Reimplemented from vtkPolyDataAlgorithm.

◆ GetTrail()

TrailPointer vtkTemporalPathLineFilter::GetTrail ( vtkIdType  i)
protected

◆ IncrementTrail()

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

Member Data Documentation

◆ NumberOfTimeSteps

int vtkTemporalPathLineFilter::NumberOfTimeSteps = 0
protected

Definition at line 182 of file vtkTemporalPathLineFilter.h.

◆ MaskPoints

int vtkTemporalPathLineFilter::MaskPoints = 200
protected

Definition at line 183 of file vtkTemporalPathLineFilter.h.

◆ MaxTrackLength

unsigned int vtkTemporalPathLineFilter::MaxTrackLength = 10
protected

Definition at line 184 of file vtkTemporalPathLineFilter.h.

◆ LastTrackLength

unsigned int vtkTemporalPathLineFilter::LastTrackLength = 10
protected

Definition at line 185 of file vtkTemporalPathLineFilter.h.

◆ FirstTime

int vtkTemporalPathLineFilter::FirstTime = 1
protected

Definition at line 186 of file vtkTemporalPathLineFilter.h.

◆ IdChannelArray

char* vtkTemporalPathLineFilter::IdChannelArray = nullptr
protected

Definition at line 187 of file vtkTemporalPathLineFilter.h.

◆ MaxStepDistance

double vtkTemporalPathLineFilter::MaxStepDistance[3] = { 1, 1, 1 }
protected

Definition at line 188 of file vtkTemporalPathLineFilter.h.

◆ LatestTime

double vtkTemporalPathLineFilter::LatestTime
protected

Definition at line 189 of file vtkTemporalPathLineFilter.h.

◆ KeepDeadTrails

bool vtkTemporalPathLineFilter::KeepDeadTrails = false
protected

Definition at line 190 of file vtkTemporalPathLineFilter.h.

◆ UsingSelection

bool vtkTemporalPathLineFilter::UsingSelection = false
protected

Definition at line 191 of file vtkTemporalPathLineFilter.h.

◆ BackwardTime

bool vtkTemporalPathLineFilter::BackwardTime = false
protected

Definition at line 192 of file vtkTemporalPathLineFilter.h.

◆ PolyLines

vtkSmartPointer<vtkCellArray> vtkTemporalPathLineFilter::PolyLines
protected

Definition at line 195 of file vtkTemporalPathLineFilter.h.

◆ Vertices

vtkSmartPointer<vtkCellArray> vtkTemporalPathLineFilter::Vertices
protected

Definition at line 196 of file vtkTemporalPathLineFilter.h.

◆ LineCoordinates

vtkSmartPointer<vtkPoints> vtkTemporalPathLineFilter::LineCoordinates
protected

Definition at line 197 of file vtkTemporalPathLineFilter.h.

◆ VertexCoordinates

vtkSmartPointer<vtkPoints> vtkTemporalPathLineFilter::VertexCoordinates
protected

Definition at line 198 of file vtkTemporalPathLineFilter.h.

◆ TrailId

vtkSmartPointer<vtkFloatArray> vtkTemporalPathLineFilter::TrailId
protected

Definition at line 199 of file vtkTemporalPathLineFilter.h.

◆ Internals

vtkSmartPointer<vtkTemporalPathLineFilterInternals> vtkTemporalPathLineFilter::Internals
protected

Definition at line 200 of file vtkTemporalPathLineFilter.h.

◆ SelectionIds

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

Definition at line 201 of file vtkTemporalPathLineFilter.h.


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