VTK
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends | List of all members
vtkStreamer Class Reference

abstract object implements integration of massless particle through vector field More...

#include <vtkStreamer.h>

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

Classes

class  StreamArray
 
class  StreamPoint
 

Public Types

typedef vtkPolyDataAlgorithm Superclass
 
- 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
 

Public Member Functions

virtual int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkStreamerNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetStartLocation (vtkIdType cellId, int subId, double pcoords[3])
 Specify the start of the streamline in the cell coordinate system. More...
 
void SetStartLocation (vtkIdType cellId, int subId, double r, double s, double t)
 Specify the start of the streamline in the cell coordinate system. More...
 
vtkIdType GetStartLocation (int &subId, double pcoords[3])
 Get the starting location of the streamline in the cell coordinate system. More...
 
void SetStartPosition (double x[3])
 Specify the start of the streamline in the global coordinate system. More...
 
void SetStartPosition (double x, double y, double z)
 Specify the start of the streamline in the global coordinate system. More...
 
doubleGetStartPosition ()
 Get the start position in global x-y-z coordinates. More...
 
void SetSourceData (vtkDataSet *source)
 Specify the source object used to generate starting points. More...
 
vtkDataSetGetSource ()
 
void SetSourceConnection (vtkAlgorithmOutput *algOutput)
 Specify the source object used to generate starting points by making a pipeline connection. More...
 
virtual void SetMaximumPropagationTime (double)
 Specify the maximum length of the Streamer expressed in elapsed time. More...
 
virtual double GetMaximumPropagationTime ()
 
virtual void SetIntegrationDirection (int)
 Specify the direction in which to integrate the Streamer. More...
 
virtual int GetIntegrationDirection ()
 
void SetIntegrationDirectionToForward ()
 
void SetIntegrationDirectionToBackward ()
 
void SetIntegrationDirectionToIntegrateBothDirections ()
 
const char * GetIntegrationDirectionAsString ()
 Return the integration direction as a character string. More...
 
virtual void SetIntegrationStepLength (double)
 Specify a nominal integration step size (expressed as a fraction of the size of each cell). More...
 
virtual double GetIntegrationStepLength ()
 
virtual void SetSpeedScalars (int)
 Turn on/off the creation of scalar data from velocity magnitude. More...
 
virtual int GetSpeedScalars ()
 
virtual void SpeedScalarsOn ()
 
virtual void SpeedScalarsOff ()
 
virtual void SetOrientationScalars (int)
 Turn on/off the creation of scalar data from vorticity information. More...
 
virtual int GetOrientationScalars ()
 
virtual void OrientationScalarsOn ()
 
virtual void OrientationScalarsOff ()
 
virtual void SetTerminalSpeed (double)
 Set/get terminal speed (i.e., speed is velocity magnitude). More...
 
virtual double GetTerminalSpeed ()
 
virtual void SetVorticity (int)
 Turn on/off the computation of vorticity. More...
 
virtual int GetVorticity ()
 
virtual void VorticityOn ()
 
virtual void VorticityOff ()
 
virtual void SetNumberOfThreads (int)
 
virtual int GetNumberOfThreads ()
 
virtual void SetSavePointInterval (double)
 
virtual double GetSavePointInterval ()
 
void SetIntegrator (vtkInitialValueProblemSolver *)
 Set/get the integrator type to be used in the stream line calculation. More...
 
virtual vtkInitialValueProblemSolverGetIntegrator ()
 
virtual void SetEpsilon (double)
 A positive value, as small as possible for numerical comparison. More...
 
virtual double GetEpsilon ()
 
- Public Member Functions inherited from vtkPolyDataAlgorithm
vtkPolyDataAlgorithmNewInstance () const
 
vtkPolyDataGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkPolyDataGetOutput (int)
 
virtual void SetOutput (vtkDataObject *d)
 
int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 see vtkAlgorithm for details More...
 
vtkDataObjectGetInput ()
 
vtkDataObjectGetInput (int port)
 
vtkPolyDataGetPolyDataInput (int port)
 
void SetInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataObject *)
 
void AddInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void AddInputData (int, vtkDataObject *)
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
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. More...
 
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. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Decrease the reference count (release by another object). More...
 
virtual void SetAbortExecute (int)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual int GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual void SetProgress (double)
 Set/Get the execution progress of a process object. More...
 
virtual double GetProgress ()
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
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)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 
virtual int 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). More...
 
virtual int Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=0)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=0)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
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. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
int SetUpdateExtentToWholeExtent (int port)
 If the whole output extent is required, this method can be called to set the output update extent to the whole extent. More...
 
int SetUpdateExtentToWholeExtent ()
 Convenience function equivalent to SetUpdateExtentToWholeExtent(0) This method assumes that the whole extent is known (that UpdateInformation has been called). More...
 
void SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)
 Set the output update extent in terms of piece and ghost levels. More...
 
void SetUpdateExtent (int piece, int numPieces, int ghostLevel)
 Convenience function equivalent to SetUpdateExtent(0, piece, numPieces, ghostLevel) More...
 
void SetUpdateExtent (int port, int extent[6])
 Set the output update extent for data objects that use 3D extents. More...
 
void SetUpdateExtent (int extent[6])
 Convenience function equivalent to SetUpdateExtent(0, extent) More...
 
intGetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
intGetUpdateExtent (int port)
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int extent[6])
 
void GetUpdateExtent (int port, int extent[6])
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
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. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkStreamerSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkPolyDataAlgorithm
static vtkPolyDataAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPolyDataAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements. More...
 
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. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
 
- 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. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkStreamer ()
 Construct object to start from position (0,0,0); integrate forward; terminal speed 0.0; vorticity computation off; integrations step length 0.2; and maximum propagation time 100.0. More...
 
 ~vtkStreamer ()
 
void Integrate (vtkDataSet *input, vtkDataSet *source)
 
virtual vtkIdType GetNumberOfStreamers ()
 These methods were added to allow access to these variables from the threads. More...
 
StreamArrayGetStreamers ()
 
void InitializeThreadedIntegrate ()
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 Fill the input port information objects for this algorithm. More...
 
- Protected Member Functions inherited from vtkPolyDataAlgorithm
 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. More...
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass. More...
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm. More...
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
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. More...
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 
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. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
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)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
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)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
- 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=NULL)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Static Protected Member Functions

static VTK_THREAD_RETURN_TYPE ThreadedIntegrate (void *arg)
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 

Protected Attributes

int StartFrom
 
vtkIdType StartCell
 
int StartSubId
 
double StartPCoords [3]
 
double StartPosition [3]
 
StreamArrayStreamers
 
vtkIdType NumberOfStreamers
 
double MaximumPropagationTime
 
int IntegrationDirection
 
double IntegrationStepLength
 
int Vorticity
 
double TerminalSpeed
 
int SpeedScalars
 
int OrientationScalars
 
vtkInitialValueProblemSolverIntegrator
 
double Epsilon
 
double SavePointInterval
 
vtkMultiThreaderThreader
 
int NumberOfThreads
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
unsigned long ErrorCode
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Friends

class StreamArray
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

abstract object implements integration of massless particle through vector field

vtkStreamer is a filter that integrates a massless particle through a vector field. The integration is performed using second order Runge-Kutta method. vtkStreamer often serves as a base class for other classes that perform numerical integration through a vector field (e.g., vtkStreamLine).

Note that vtkStreamer can integrate both forward and backward in time, or in both directions. The length of the streamer is controlled by specifying an elapsed time. (The elapsed time is the time each particle travels.) Otherwise, the integration terminates after exiting the dataset or if the particle speed is reduced to a value less than the terminal speed.

vtkStreamer integrates through any type of dataset. As a result, if the dataset contains 2D cells such as polygons or triangles, the integration is constrained to lie on the surface defined by the 2D cells.

The starting point of streamers may be defined in three different ways. Starting from global x-y-z "position" allows you to start a single streamer at a specified x-y-z coordinate. Starting from "location" allows you to start at a specified cell, subId, and parametric coordinate. Finally, you may specify a source object to start multiple streamers. If you start streamers using a source object, for each point in the source that is inside the dataset a streamer is created.

vtkStreamer implements the integration process in the Integrate() method. Because vtkStreamer does not implement the Execute() method that its superclass (i.e., Filter) requires, it is an abstract class. Its subclasses implement the execute method and use the Integrate() method, and then build their own representation of the integration path (i.e., lines, dashed lines, points, etc.).

See also
vtkStreamLine vtkDashedStreamLine vtkStreamPoints

Definition at line 68 of file vtkStreamer.h.

Member Typedef Documentation

◆ Superclass

Definition at line 71 of file vtkStreamer.h.

Constructor & Destructor Documentation

◆ vtkStreamer()

vtkStreamer::vtkStreamer ( )
protected

Construct object to start from position (0,0,0); integrate forward; terminal speed 0.0; vorticity computation off; integrations step length 0.2; and maximum propagation time 100.0.

◆ ~vtkStreamer()

vtkStreamer::~vtkStreamer ( )
protected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented in vtkStreamLine, vtkDashedStreamLine, and vtkStreamPoints.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkStreamer::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented in vtkStreamLine, vtkDashedStreamLine, and vtkStreamPoints.

◆ NewInstance()

vtkStreamer* vtkStreamer::NewInstance ( ) const

◆ PrintSelf()

void vtkStreamer::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 vtkPolyDataAlgorithm.

Reimplemented in vtkStreamLine, and vtkStreamPoints.

◆ SetStartLocation() [1/2]

void vtkStreamer::SetStartLocation ( vtkIdType  cellId,
int  subId,
double  pcoords[3] 
)

Specify the start of the streamline in the cell coordinate system.

That is, cellId and subId (if composite cell), and parametric coordinates.

◆ SetStartLocation() [2/2]

void vtkStreamer::SetStartLocation ( vtkIdType  cellId,
int  subId,
double  r,
double  s,
double  t 
)

Specify the start of the streamline in the cell coordinate system.

That is, cellId and subId (if composite cell), and parametric coordinates.

◆ GetStartLocation()

vtkIdType vtkStreamer::GetStartLocation ( int subId,
double  pcoords[3] 
)

Get the starting location of the streamline in the cell coordinate system.

◆ SetStartPosition() [1/2]

void vtkStreamer::SetStartPosition ( double  x[3])

Specify the start of the streamline in the global coordinate system.

Search must be performed to find initial cell to start integration from.

◆ SetStartPosition() [2/2]

void vtkStreamer::SetStartPosition ( double  x,
double  y,
double  z 
)

Specify the start of the streamline in the global coordinate system.

Search must be performed to find initial cell to start integration from.

◆ GetStartPosition()

double* vtkStreamer::GetStartPosition ( )

Get the start position in global x-y-z coordinates.

◆ SetSourceData()

void vtkStreamer::SetSourceData ( vtkDataSet source)

Specify the source object used to generate starting points.

◆ GetSource()

vtkDataSet* vtkStreamer::GetSource ( )

◆ SetSourceConnection()

void vtkStreamer::SetSourceConnection ( vtkAlgorithmOutput algOutput)

Specify the source object used to generate starting points by making a pipeline connection.

◆ SetMaximumPropagationTime()

virtual void vtkStreamer::SetMaximumPropagationTime ( double  )
virtual

Specify the maximum length of the Streamer expressed in elapsed time.

◆ GetMaximumPropagationTime()

virtual double vtkStreamer::GetMaximumPropagationTime ( )
virtual

◆ SetIntegrationDirection()

virtual void vtkStreamer::SetIntegrationDirection ( int  )
virtual

Specify the direction in which to integrate the Streamer.

◆ GetIntegrationDirection()

virtual int vtkStreamer::GetIntegrationDirection ( )
virtual

◆ SetIntegrationDirectionToForward()

void vtkStreamer::SetIntegrationDirectionToForward ( )
inline

Definition at line 140 of file vtkStreamer.h.

◆ SetIntegrationDirectionToBackward()

void vtkStreamer::SetIntegrationDirectionToBackward ( )
inline

Definition at line 142 of file vtkStreamer.h.

◆ SetIntegrationDirectionToIntegrateBothDirections()

void vtkStreamer::SetIntegrationDirectionToIntegrateBothDirections ( )
inline

Definition at line 144 of file vtkStreamer.h.

◆ GetIntegrationDirectionAsString()

const char * vtkStreamer::GetIntegrationDirectionAsString ( )
inline

Return the integration direction as a character string.

Definition at line 367 of file vtkStreamer.h.

◆ SetIntegrationStepLength()

virtual void vtkStreamer::SetIntegrationStepLength ( double  )
virtual

Specify a nominal integration step size (expressed as a fraction of the size of each cell).

This value can be larger than 1.

◆ GetIntegrationStepLength()

virtual double vtkStreamer::GetIntegrationStepLength ( )
virtual

◆ SetSpeedScalars()

virtual void vtkStreamer::SetSpeedScalars ( int  )
virtual

Turn on/off the creation of scalar data from velocity magnitude.

If off, and input dataset has scalars, input dataset scalars are used.

◆ GetSpeedScalars()

virtual int vtkStreamer::GetSpeedScalars ( )
virtual

◆ SpeedScalarsOn()

virtual void vtkStreamer::SpeedScalarsOn ( )
virtual

◆ SpeedScalarsOff()

virtual void vtkStreamer::SpeedScalarsOff ( )
virtual

◆ SetOrientationScalars()

virtual void vtkStreamer::SetOrientationScalars ( int  )
virtual

Turn on/off the creation of scalar data from vorticity information.

The scalar information is currently the orientation value "theta" used in rotating stream tubes. If off, and input dataset has scalars, then input dataset scalars are used, unless SpeedScalars is also on. SpeedScalars takes precedence over OrientationScalars.

◆ GetOrientationScalars()

virtual int vtkStreamer::GetOrientationScalars ( )
virtual

◆ OrientationScalarsOn()

virtual void vtkStreamer::OrientationScalarsOn ( )
virtual

◆ OrientationScalarsOff()

virtual void vtkStreamer::OrientationScalarsOff ( )
virtual

◆ SetTerminalSpeed()

virtual void vtkStreamer::SetTerminalSpeed ( double  )
virtual

Set/get terminal speed (i.e., speed is velocity magnitude).

Terminal speed is speed at which streamer will terminate propagation.

◆ GetTerminalSpeed()

virtual double vtkStreamer::GetTerminalSpeed ( )
virtual

◆ SetVorticity()

virtual void vtkStreamer::SetVorticity ( int  )
virtual

Turn on/off the computation of vorticity.

Vorticity is an indication of the rotation of the flow. In combination with vtkStreamLine and vtkTubeFilter can be used to create rotated tubes. If vorticity is turned on, in the output, the velocity vectors are replaced by vorticity vectors.

◆ GetVorticity()

virtual int vtkStreamer::GetVorticity ( )
virtual

◆ VorticityOn()

virtual void vtkStreamer::VorticityOn ( )
virtual

◆ VorticityOff()

virtual void vtkStreamer::VorticityOff ( )
virtual

◆ SetNumberOfThreads()

virtual void vtkStreamer::SetNumberOfThreads ( int  )
virtual

◆ GetNumberOfThreads()

virtual int vtkStreamer::GetNumberOfThreads ( )
virtual

◆ SetSavePointInterval()

virtual void vtkStreamer::SetSavePointInterval ( double  )
virtual

◆ GetSavePointInterval()

virtual double vtkStreamer::GetSavePointInterval ( )
virtual

◆ SetIntegrator()

void vtkStreamer::SetIntegrator ( vtkInitialValueProblemSolver )

Set/get the integrator type to be used in the stream line calculation.

The object passed is not actually used but is cloned with NewInstance by each thread/process in the process of integration (prototype pattern). The default is 2nd order Runge Kutta.

◆ GetIntegrator()

virtual vtkInitialValueProblemSolver* vtkStreamer::GetIntegrator ( )
virtual

◆ SetEpsilon()

virtual void vtkStreamer::SetEpsilon ( double  )
virtual

A positive value, as small as possible for numerical comparison.

The initial value is 1E-12.

◆ GetEpsilon()

virtual double vtkStreamer::GetEpsilon ( )
virtual

◆ Integrate()

void vtkStreamer::Integrate ( vtkDataSet input,
vtkDataSet source 
)
protected

◆ ThreadedIntegrate()

static VTK_THREAD_RETURN_TYPE vtkStreamer::ThreadedIntegrate ( void *  arg)
staticprotected

◆ GetNumberOfStreamers()

virtual vtkIdType vtkStreamer::GetNumberOfStreamers ( )
protectedvirtual

These methods were added to allow access to these variables from the threads.

◆ GetStreamers()

StreamArray* vtkStreamer::GetStreamers ( )
inlineprotected

Definition at line 349 of file vtkStreamer.h.

◆ InitializeThreadedIntegrate()

void vtkStreamer::InitializeThreadedIntegrate ( )
protected

◆ FillInputPortInformation()

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

Friends And Related Function Documentation

◆ StreamArray

friend class StreamArray
friend

Definition at line 273 of file vtkStreamer.h.

Member Data Documentation

◆ StartFrom

int vtkStreamer::StartFrom
protected

Definition at line 245 of file vtkStreamer.h.

◆ StartCell

vtkIdType vtkStreamer::StartCell
protected

Definition at line 248 of file vtkStreamer.h.

◆ StartSubId

int vtkStreamer::StartSubId
protected

Definition at line 249 of file vtkStreamer.h.

◆ StartPCoords

double vtkStreamer::StartPCoords[3]
protected

Definition at line 250 of file vtkStreamer.h.

◆ StartPosition

double vtkStreamer::StartPosition[3]
protected

Definition at line 253 of file vtkStreamer.h.

◆ Streamers

StreamArray* vtkStreamer::Streamers
protected

Definition at line 305 of file vtkStreamer.h.

◆ NumberOfStreamers

vtkIdType vtkStreamer::NumberOfStreamers
protected

Definition at line 306 of file vtkStreamer.h.

◆ MaximumPropagationTime

double vtkStreamer::MaximumPropagationTime
protected

Definition at line 309 of file vtkStreamer.h.

◆ IntegrationDirection

int vtkStreamer::IntegrationDirection
protected

Definition at line 312 of file vtkStreamer.h.

◆ IntegrationStepLength

double vtkStreamer::IntegrationStepLength
protected

Definition at line 315 of file vtkStreamer.h.

◆ Vorticity

int vtkStreamer::Vorticity
protected

Definition at line 318 of file vtkStreamer.h.

◆ TerminalSpeed

double vtkStreamer::TerminalSpeed
protected

Definition at line 321 of file vtkStreamer.h.

◆ SpeedScalars

int vtkStreamer::SpeedScalars
protected

Definition at line 324 of file vtkStreamer.h.

◆ OrientationScalars

int vtkStreamer::OrientationScalars
protected

Definition at line 327 of file vtkStreamer.h.

◆ Integrator

vtkInitialValueProblemSolver* vtkStreamer::Integrator
protected

Definition at line 330 of file vtkStreamer.h.

◆ Epsilon

double vtkStreamer::Epsilon
protected

Definition at line 334 of file vtkStreamer.h.

◆ SavePointInterval

double vtkStreamer::SavePointInterval
protected

Definition at line 339 of file vtkStreamer.h.

◆ Threader

vtkMultiThreader* vtkStreamer::Threader
protected

Definition at line 353 of file vtkStreamer.h.

◆ NumberOfThreads

int vtkStreamer::NumberOfThreads
protected

Definition at line 354 of file vtkStreamer.h.


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