SampleFunction

Source (.js)Source (.d.ts)

Introduction

vtkSampleFunction samples an implicit function over a volume. For example, a vtkPlane or vtkSphere can be defined, along with a volume extent (dimensions and geometric bounds), and the filter will then sample the implicit function over all voxels, producing a vtkImageData.

Methods

extend

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

Argument	Type	Required	Description
publicAPI		Yes	object on which methods will be bounds (public)
model		Yes	object on which data structure will be bounds (protected)
initialValues	ISampleFunctionInitialValues	No	(default: {})

getMTime

The modified time is the maximum of this object's own modified time and that of the implicit function being sampled.

getModelBounds

Get the bounds of the volume in 3D space.

getModelBoundsByReference

getSampleDimensions

Get the dimensions of the volume in the x-y-z directions.

getSampleDimensionsByReference

newInstance

Method used to create a new instance of vtkSampleFunction

Argument	Type	Required	Description
initialValues	ISampleFunctionInitialValues	No	for pre-setting some of its content

requestData

Argument	Type	Required	Description
inData		Yes
outData		Yes

setModelBounds

Set the bounds of the volume in 3D space.

setModelBounds

Set the bounds of the volume in 3D space.

Argument	Type	Required	Description
modelBounds	Bounds	Yes

setModelBoundsFrom

Argument	Type	Required	Description
modelBounds	Bounds	Yes

setSampleDimensions

Set the dimensions of the volume in the x-y-z directions.

Argument	Type	Required	Description
x	Number	Yes
y	Number	Yes
z	Number	Yes

setSampleDimensions

Set the dimensions of the volume in the x-y-z directions.

Argument	Type	Required	Description
sampleDimensions	Vector3	Yes

setSampleDimensionsFrom

Argument	Type	Required	Description
sampleDimensions	Vector3	Yes