Skip to content

ImageStreamline

Introduction

vtkImageStreamline - integrate streamlines in a vtkImageData

vtkImageStreamline is a filter that generates streamlines from a vtkImageData input over which a vector field is defined. This filter will look for vectors (i.e. getVectors()) in the input. It will then integrate these vectors, using Runge-Kutta 2, from a starting set of seeds defined by the points of the 2nd input until a specified maximum number of steps is reached or until the streamline leaves the domain.

The output will be a vtkPolyData which contains a polyline for each streamline. Currently, this filter does not interpolate any input fields to the points of the streamline.

Methods

computeNextStep

ArgumentTypeRequiredDescription
velArrayYes
imageYes
delTNumberYes
xyzArray[Number]Yes

computeStructuredCoordinates

ArgumentTypeRequiredDescription
xVector3Yes
ijkVector3Yes
pcoordsVector3Yes
extentExtentYes
spacingVector3Yes
originVector3Yes
boundsBoundsYes

extend

Method used to decorate a given object (publicAPI+model) with vtkImageStreamline characteristics.

ArgumentTypeRequiredDescription
publicAPIYesobject on which methods will be bounds (public)
modelYesobject on which data structure will be bounds (protected)
initialValuesIImageStreamlineInitialValuesNo(default: {})

getIntegrationStep

Get the step length (delT) used during integration.

getMaximumNumberOfSteps

Get the number of steps to be used in the integration.

getVoxelIndices

ArgumentTypeRequiredDescription
ijkVector3Yes
dimsVector2Yes
idsArray[Number]Yes

interpolationFunctions

ArgumentTypeRequiredDescription
pcoordsVector3Yes
sfArray[Number]Yes

newInstance

Method used to create a new instance of vtkImageStreamline

ArgumentTypeRequiredDescription
initialValuesIImageStreamlineInitialValuesNofor pre-setting some of its content

requestData

ArgumentTypeRequiredDescription
inDataYes
outDataYes

setIntegrationStep

Set the step length (delT) used during integration.

ArgumentTypeRequiredDescription
integrationStepNumberYes

setMaximumNumberOfSteps

Set the number of steps to be used in the integration. Integration can terminal earlier if the streamline leaves the domain.

ArgumentTypeRequiredDescription
maximumNumberOfStepsNumberYes

streamIntegrate

ArgumentTypeRequiredDescription
velArrayYes
imagevtkImageDataYes
seedArray[Number]Yes
offsetNumberYes

vectorAt

ArgumentTypeRequiredDescription
xyzArray[Number]Yes
velArrayYes
imagevtkImageDataYes
velAtArgYes