Class StreamLineModule

Known Subclasses:

streamline.StreamLine

Class that defines the streamline module.

Instance Methods

[hide private]

__init__(self)
Initialise the streamline module.

__setInput(self)
Set the input for the streamline.

__setSource(self)
Set the source to generate the starting points for the streamline.

vtkPolyData @return Polygonal data

_getStreamLineModuleOutput(self)
Return the output of the streamline.

_setSpeedScalarsOff(self)
Turn off the creation of scalar data from velocity magnitude.

_setSpeedScalarsOn(self)
Turn on the creation of scalar data from velocity magnitude.

_setupStreamLineModule(self, object, source)
Setup the streamline.

setIntegrationStepLength(self, length)
Set the integration step size expressed as a fraction of the size of each cell.

setIntegrationToBothDirections(self)
Set the integration to occur both sides: forward (where the streamline goes) and backward (where the streamline came from).

setIntegrator(self, integrator)
Set the integrator to be used in the streamline calculation.

setMaximumPropagationTime(self, time)
Set the maximum length of the streamline expressed in elapsed time.

setStepLength(self, length)
Set the length of the streamline segment expressed in elapsed time.

Method Details

[hide private]

_setSpeedScalarsOff(self)

Turn off the creation of scalar data from velocity magnitude. If input dataset has scalars, input dataset scalars are used.

_setupStreamLineModule(self, object, source)

Setup the streamline.

Parameters:

object (vtkUnstructuredGrid, etc) - Input for the streamline
source (vtkPolyData) - Source to generate the starting points

setIntegrationStepLength(self, length)

Set the integration step size expressed as a fraction of the size of each cell. A smaller length results in a better image (but is more expensive).

Parameters:

length (Number) - Length of the integration step expressed as a fraction of the size of each cell

setIntegrator(self, integrator)

Set the integrator to be used in the streamline calculation.

Parameters:

integrator (vtkInitialValueProblemSolver) - Integrator type. i.e. vtkRungeKutta2, vtkRungeKutta4

setMaximumPropagationTime(self, time)

Set the maximum length of the streamline expressed in elapsed time.

Parameters:

time (Number) - Maximum length of the streamline expressed in elapsed time

setStepLength(self, length)

Set the length of the streamline segment expressed in elapsed time. A smaller value results in a smoother streamline (but is more expensive). Setting the step length usually goes hand-in-hand with setting the integration step length. Otherwise, errors such as "... can't compute normals" may arise. If such an error occurs try changing the values.

Parameters:

length (Number) - Length of the streamline segment expressed in elapsed time