ImageAppend

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

Introduction

vtkImageAppend appends one or more images into a single image, along a chosen axis.

When preserveExtents is false (default), inputs are stacked back-to-back along appendAxis. When preserveExtents is true, each input keeps its own native extent and the output becomes the union of all input extents, leaving any uncovered region zero-filled.

Methods

extend

Method used to decorate a given object (publicAPI+model) with vtkImageAppend 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	IImageAppendInitialValues	No	(default: {})

getAppendAxis

Get the axis along which inputs are appended. Only used when preserveExtents is false.

getPreserveExtents

Get whether each input's native extent is preserved.

If false (default), inputs are shifted so that they sit back-to-back along appendAxis, in the order they were added, ignoring each input's original extent along that axis.

If true, every input keeps its own native extent. The output extent becomes the union (bounding box) of all input extents, and any output region not covered by an input is left zero-filled.

newInstance

Method used to create a new instance of vtkImageAppend.

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

requestData

Argument	Type	Required	Description
inData		Yes
outData		Yes

setAppendAxis

Set the axis along which inputs are appended. Only used when preserveExtents is false. Initial value is 0.

Argument	Type	Required	Description
appendAxis	Number	Yes	The appendAxis value (0 = X, 1 = Y, 2 = Z).

setPreserveExtents

Set whether each input's native extent is preserved instead of shifting inputs to sit back-to-back along appendAxis. Initial value is false.

Argument	Type	Required	Description
preserveExtents	Boolean	Yes	The preserveExtents value.