Class: abstract BaseVolumeViewport

Viewport.canvasToWorld

Inherited from

Defined in

packages/core/src/RenderingEngine/Viewport.ts:169

customRenderViewportToCanvas()

customRenderViewportToCanvas: () => unknown

Returns

unknown

Inherited from

Viewport.customRenderViewportToCanvas

Defined in

packages/core/src/RenderingEngine/Viewport.ts:171

defaultOptions

readonly defaultOptions: ViewportInputOptions

Default options for the viewport which includes orientation, viewPlaneNormal and backgroundColor

Inherited from

Viewport.defaultOptions

Defined in

packages/core/src/RenderingEngine/Viewport.ts:122

element

readonly element: HTMLDivElement

HTML element in DOM that is used for rendering the viewport

Inherited from

Viewport.element

Defined in

packages/core/src/RenderingEngine/Viewport.ts:91

fitToCanvasCamera

protected fitToCanvasCamera: ICamera

The camera that is defined for resetting displayArea to ensure absolute displayArea settings

Inherited from

Viewport.fitToCanvasCamera

Defined in

packages/core/src/RenderingEngine/Viewport.ts:138

flipHorizontal

protected flipHorizontal: boolean = false

Inherited from

Viewport.flipHorizontal

Defined in

packages/core/src/RenderingEngine/Viewport.ts:103

flipVertical

protected flipVertical: boolean = false

Inherited from

Viewport.flipVertical

Defined in

packages/core/src/RenderingEngine/Viewport.ts:104

getNumberOfSlices()

getNumberOfSlices: () => number

Returns

number

Inherited from

Viewport.getNumberOfSlices

Defined in

packages/core/src/RenderingEngine/Viewport.ts:175

hasPixelSpacing

protected hasPixelSpacing: boolean = true

Inherited from

Viewport.hasPixelSpacing

Defined in

packages/core/src/RenderingEngine/Viewport.ts:129

id

readonly id: string

unique identifier for the viewport

Inherited from

Viewport.id

Defined in

packages/core/src/RenderingEngine/Viewport.ts:89

initialCamera

protected initialCamera: ICamera

The camera that is initially defined on the reset for the relative pan/zoom

Inherited from

Viewport.initialCamera

Defined in

packages/core/src/RenderingEngine/Viewport.ts:134

initialTransferFunctionNodes

protected initialTransferFunctionNodes: TransferFunctionNodes

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:95

initialViewUp

protected initialViewUp: Point3

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:103

insetImageMultiplier

protected insetImageMultiplier: number = 1.1

The amount by which the images are inset in a viewport by default.

Inherited from

Viewport.insetImageMultiplier

Defined in

packages/core/src/RenderingEngine/Viewport.ts:101

isDisabled

isDisabled: boolean

Inherited from

Viewport.isDisabled

Defined in

packages/core/src/RenderingEngine/Viewport.ts:105

options

options: ViewportInputOptions

options for the viewport which includes orientation axis, backgroundColor and displayArea

Inherited from

Viewport.options

Defined in

packages/core/src/RenderingEngine/Viewport.ts:124

renderingEngineId

readonly renderingEngineId: string

RenderingEngine id that the viewport belongs to

Inherited from

Viewport.renderingEngineId

Defined in

packages/core/src/RenderingEngine/Viewport.ts:95

renderingPipelineFunctions

protected renderingPipelineFunctions: object

canvasToWorld

canvasToWorld: object

canvasToWorld.contextPool()

contextPool: (canvasPos) => Point3

Parameters

• canvasPos: Point2

Returns

canvasToWorld.tiled()

tiled: (canvasPos) => Point3

canvasToWorld Returns the world coordinates of the given canvasPos projected onto the plane defined by the Viewport's vtkCamera's focal point and the direction of projection.

Parameters

• canvasPos: Point2

The position in canvas coordinates.

Returns

The corresponding world coordinates.

getRenderer

getRenderer: object

getRenderer.contextPool()

contextPool: () => vtkRenderer

Get the renderer for this viewport - handles ContextPoolRenderingEngine

Returns

vtkRenderer

getRenderer.tiled()

tiled: () => vtkRenderer

Returns the vtkRenderer responsible for rendering the Viewport.

Returns

vtkRenderer

The vtkRenderer for the Viewport.

getVtkDisplayCoords

getVtkDisplayCoords: object

getVtkDisplayCoords.contextPool()

contextPool: (canvasPos) => Point3

Parameters

• canvasPos: Point2

Returns

getVtkDisplayCoords.tiled()

tiled: (canvasPos) => Point3

Returns the VTK.js display coordinates of the given canvasPos projected onto the Viewport's vtkCamera's focal point and the direction of projection.

Parameters

• canvasPos: Point2

The position in canvas coordinates.

Returns

The corresponding display coordinates.

worldToCanvas

worldToCanvas: object

worldToCanvas.contextPool()

contextPool: (worldPos) => Point2

Parameters

• worldPos: Point3

Returns

worldToCanvas.tiled()

tiled: (worldPos) => Point2

Returns the canvas coordinates of the given worldPos projected onto the Viewport's canvas.

Parameters

• worldPos: Point3

The position in world coordinates.

Returns

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:2302

The corresponding canvas coordinates.

Defined in

resize()

resize: () => void

Returns

void

Inherited from

Viewport.resize

Defined in

packages/core/src/RenderingEngine/Viewport.ts:172

sHeight

sHeight: number

sHeight of viewport on the offscreen canvas

Inherited from

Viewport.sHeight

Defined in

packages/core/src/RenderingEngine/Viewport.ts:118

suppressEvents

readonly suppressEvents: boolean

A flag representing if viewport methods should fire events or not

Inherited from

Viewport.suppressEvents

Defined in

packages/core/src/RenderingEngine/Viewport.ts:128

sWidth

sWidth: number

sWidth of viewport on the offscreen canvas

Inherited from

Viewport.sWidth

Defined in

packages/core/src/RenderingEngine/Viewport.ts:116

sx

sx: number

sx of viewport on the offscreen canvas

Inherited from

Viewport.sx

Defined in

packages/core/src/RenderingEngine/Viewport.ts:112

sy

sy: number

sy of viewport on the offscreen canvas

Inherited from

Viewport.sy

Defined in

packages/core/src/RenderingEngine/Viewport.ts:114

type

readonly type: ViewportType

Type of viewport

Inherited from

Viewport.type

Defined in

packages/core/src/RenderingEngine/Viewport.ts:97

updateRenderingPipeline()

updateRenderingPipeline: () => void

Returns

void

Inherited from

Viewport.updateRenderingPipeline

Defined in

packages/core/src/RenderingEngine/Viewport.ts:174

useCPURendering

useCPURendering: boolean = false

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:92

viewportProperties

protected viewportProperties: VolumeViewportProperties = {}

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:104

viewportStatus

viewportStatus: ViewportStatus = ViewportStatus.NO_DATA

Record the rendering status, mostly for testing purposes, but can also be useful for knowing things like whether the viewport is initialized

Inherited from

Viewport.viewportStatus

Defined in

packages/core/src/RenderingEngine/Viewport.ts:109

worldToCanvas()

worldToCanvas: (worldPos) => Point2

Parameters

• worldPos: Point3

Returns

Viewport.worldToCanvas

Inherited from

Defined in

packages/core/src/RenderingEngine/Viewport.ts:170

CameraViewPresentation

readonly static CameraViewPresentation: ViewPresentationSelector

CameraViewPresentation is a view presentation selector that has all the camera related presentation selections, and would typically be used for choosing presentation information between two viewports showing the same type of orientation of a view, such as the CT, PT and fusion views in the same orientation view.

Inherited from

Viewport.CameraViewPresentation

Defined in

packages/core/src/RenderingEngine/Viewport.ts:70

TransferViewPresentation

readonly static TransferViewPresentation: ViewPresentationSelector

TransferViewPresentation is a view presentation selector that selects all the transfer function related attributes. It would typically be used for synchronizing different orientations of the same series, or for synchronizing two views of the same type of series such as a CT.

Inherited from

Viewport.TransferViewPresentation

Defined in

packages/core/src/RenderingEngine/Viewport.ts:83

Accessors

useCustomRenderingPipeline

get static useCustomRenderingPipeline(): boolean

Returns

boolean

Overrides

Viewport.useCustomRenderingPipeline

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:142

Methods

_getAcquisitionPlaneOrientation()

protected _getAcquisitionPlaneOrientation(): OrientationVectors

Returns

OrientationVectors

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:2103

_getCorners()

_getCorners(bounds): number[][]

Parameters

• bounds: number[]

Returns

number[][]

Inherited from

Viewport._getCorners

Defined in

packages/core/src/RenderingEngine/Viewport.ts:2036

_getEdges()

_getEdges(bounds): [number[], number[]][]

Returns a list of edges for the imageData bounds, which are the cube edges in the case of volumeViewport edges. p1: front, bottom, left p2: front, top, left p3: back, bottom, left p4: back, top, left p5: front, bottom, right p6: front, top, right p7: back, bottom, right p8: back, top, right

Parameters

• bounds: number[]

Bounds of the renderer

Returns

[number[], number[]][]

Edges of the containing bounds

Inherited from

Viewport._getEdges

Defined in

packages/core/src/RenderingEngine/Viewport.ts:2132

_getFocalPointForResetCamera()

_getFocalPointForResetCamera(centeredFocalPoint, previousCamera, __namedParameters): Point3

Parameters

• centeredFocalPoint: Point3

• previousCamera: ICamera

• __namedParameters

• __namedParameters.resetPan: boolean = true

• __namedParameters.resetToCenter: boolean = true

Returns

Viewport._getFocalPointForResetCamera

Inherited from

Defined in

packages/core/src/RenderingEngine/Viewport.ts:2049

_getOrientationVectors()

protected _getOrientationVectors(orientation): OrientationVectors

Parameters

• orientation: OrientationAxis | OrientationVectors

Returns

OrientationVectors

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:2065

_getViewUp()

protected _getViewUp(viewPlaneNormal): Point3

Gets a view up given a view plane normal and the current orientation Chooses the current view up if orthogonal, otherwise the default view ups for axial, sagittal and coronal Otherwise runs the Gram-Schmidt algorithm with the current viewUp

Parameters

• viewPlaneNormal: any

Returns

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:2042

Defined in

_isInBounds()

_isInBounds(point, bounds): boolean

Determines whether or not the 3D point position is inside the boundaries of the 3D imageData.

Parameters

• point: Point3

3D coordinate

• bounds: number[]

Bounds of the image

Returns

boolean

boolean

Inherited from

Viewport._isInBounds

Defined in

packages/core/src/RenderingEngine/Viewport.ts:2109

_removeActor()

_removeActor(actorUID): ActorEntry

Remove the actor from the viewport

Parameters

• actorUID: string

The unique identifier for the actor.

Returns

Viewport._removeActor

The removed actor entry or undefined if it didn't exist

Inherited from

Defined in

packages/core/src/RenderingEngine/Viewport.ts:573

addActor()

addActor(actorEntry): void

Add an actor to the viewport including its id, its actor and slabThickness if defined

Parameters

• actorEntry: ActorEntry

ActorEntry

actorEntry.uid - The unique identifier for the actor.
actorEntry.actor - The volume actor.
actorEntry.slabThickness - The slab thickness.

Returns

void

Inherited from

Viewport.addActor

Defined in

packages/core/src/RenderingEngine/Viewport.ts:663

addActors()

addActors(actors, options): void

Add a list of actors (actor entries) to the viewport

Parameters

• actors: ActorEntry[]

An array of ActorEntry objects.

• options = {}

• options.resetCamera?: boolean

Returns

void

Inherited from

Viewport.addActors

Defined in

packages/core/src/RenderingEngine/Viewport.ts:619

addVolumes()

addVolumes(volumeInputArray, immediate, suppressEvents): Promise<void>

Creates and adds volume actors for all volumes defined in the volumeInputArray. For each entry, if a callback is supplied, it will be called with the new volume actor as input.

Parameters

• volumeInputArray: IVolumeInput[]

The array of VolumeInputs which define the volumes to add.

• immediate: boolean = false

Whether the Viewport should be rendered as soon as volumes are added.

• suppressEvents: boolean = false

Returns

Promise<void>

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:1336

addWidget()

addWidget(widgetId, widget): void

Parameters

• widgetId: any

• widget: any

Returns

void

Inherited from

Viewport.addWidget

Defined in

packages/core/src/RenderingEngine/Viewport.ts:187

applyViewOrientation()

protected applyViewOrientation(orientation, resetCamera): void

Parameters

• orientation: OrientationAxis | OrientationVectors

• resetCamera: boolean = true

Returns

void

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:157

canvasToWorldContextPool()

canvasToWorldContextPool(canvasPos): Point3

Parameters

• canvasPos: Point2

Returns

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:1742

Defined in

canvasToWorldTiled()

canvasToWorldTiled(canvasPos): Point3

canvasToWorld Returns the world coordinates of the given canvasPos projected onto the plane defined by the Viewport's vtkCamera's focal point and the direction of projection.

Parameters

• canvasPos: Point2

The position in canvas coordinates.

Returns

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:1697

The corresponding world coordinates.

Defined in

clearDefaultProperties()

clearDefaultProperties(volumeId?): void

Remove the global default properties of the viewport or remove default properties for a volumeId if specified

Parameters

• volumeId?: string

If given, we remove the default properties only for this volumeId, if not the global default properties will be removed

Returns

void

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:606

flip()

flip(flipDirection): void

Flip the viewport along the desired axis

Parameters

• flipDirection: FlipDirection

FlipDirection

Returns

void

Overrides

Viewport.flip

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:1568

getActor()

getActor(actorUID): ActorEntry

Get an actor by its UID

Parameters

• actorUID: string

The unique ID of the actor.

Returns

packages/core/src/RenderingEngine/Viewport.ts:502

An ActorEntry object.

Inherited from

Viewport.getActor

Defined in

getActorByIndex()

getActorByIndex(index): ActorEntry

Get an actor by its index

Parameters

• index: number

array index.

Returns

Viewport.getActorByIndex

actorUID

Inherited from

Defined in

packages/core/src/RenderingEngine/Viewport.ts:545

getActors()

getActors(): ActorEntry[]

Get all the actors in the viewport

Returns

ActorEntry[]

An array of ActorEntry objects.

Inherited from

Viewport.getActors

Defined in

packages/core/src/RenderingEngine/Viewport.ts:485

getActorUIDByIndex()

getActorUIDByIndex(index): string

Get an actor UID by its index

Parameters

• index: number

array index.

Returns

string

actorUID

Inherited from

Viewport.getActorUIDByIndex

Defined in

packages/core/src/RenderingEngine/Viewport.ts:533

getActorUIDs()

getActorUIDs(): string[]

Returns an array of unique identifiers for all the actors in the viewport.

Returns

string[]

An array of strings

Inherited from

Viewport.getActorUIDs

Defined in

packages/core/src/RenderingEngine/Viewport.ts:493

getAllVolumeIds()

getAllVolumeIds(): string[]

Returns an array of all volumeIds currently in the viewport.

Returns

string[]

An array of strings representing all volumeIds.

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:2281

getBounds()

getBounds(): number[]

gets the visible bounds of the viewport in the world coordinate system

Returns

number[]

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:1558

getCamera()

getCamera(): ICamera

Get the camera's current state

Returns

ICamera

The camera object.

Inherited from

Viewport.getCamera

Defined in

packages/core/src/RenderingEngine/Viewport.ts:1466

getCameraNoRotation()

protected getCameraNoRotation(): ICamera

Returns

ICamera

Inherited from

Viewport.getCameraNoRotation

Defined in

packages/core/src/RenderingEngine/Viewport.ts:1423

getCanvas()

getCanvas(): HTMLCanvasElement

Gets the target output canvas for the Viewport.

Returns

HTMLCanvasElement

an HTMLCanvasElement.

Inherited from

Viewport.getCanvas

Defined in

packages/core/src/RenderingEngine/Viewport.ts:1404

getClippingPlanesForActor()

getClippingPlanesForActor(actorEntry?): vtkPlane[]

Method to get the clipping planes of a given actor

Parameters

• actorEntry?: ActorEntry

The actor entry (a specific type you'll define dependent on your code)

Returns

vtkPlane[]

vtkPlanes - An array of vtkPlane objects associated with the given actor

Inherited from

Viewport.getClippingPlanesForActor

Defined in

packages/core/src/RenderingEngine/Viewport.ts:1737

getCurrentImageId()

abstract getCurrentImageId(): string

Returns

string

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:2194

getCurrentImageIdIndex()

getCurrentImageIdIndex(): number

Returns

number

Inherited from

Viewport.getCurrentImageIdIndex

Defined in

packages/core/src/RenderingEngine/Viewport.ts:1268

getDefaultActor()

getDefaultActor(): ActorEntry

Get the default actor

Returns

Viewport.getDefaultActor

An actor entry.

Inherited from

Defined in

packages/core/src/RenderingEngine/Viewport.ts:477

getDefaultProperties()

getDefaultProperties(volumeId?): VolumeViewportProperties

Retrieve the viewport default properties

Parameters

• volumeId?: string

If given, we retrieve the default properties of a volumeId if it exists If not given,we return the global properties of the viewport

Returns

VolumeViewportProperties

default viewport properties including voi, invert, interpolation type, colormap

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:1136

getDisplayArea()

getDisplayArea(): DisplayArea

Returns

DisplayArea

Inherited from

Viewport.getDisplayArea

Defined in

packages/core/src/RenderingEngine/Viewport.ts:1021

getFrameOfReferenceUID()

getFrameOfReferenceUID(): string

Returns

string

Overrides

Viewport.getFrameOfReferenceUID

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:1572

getImageActor()

getImageActor(volumeId?): vtkImageSlice

Retrieves an image actor from the viewport actors.

Parameters

• volumeId?: string

Optional. The ID of the volume to find the corresponding image actor.

Returns

vtkImageSlice

The image actor if found, otherwise null.

Inherited from

Viewport.getImageActor

Defined in

packages/core/src/RenderingEngine/Viewport.ts:512

getImageData()

getImageData(volumeId?): IImageData

Returns the image and its properties that is being shown inside the stack viewport. It returns, the image dimensions, image direction, image scalar data, vtkImageData object, metadata, and scaling (e.g., PET suvbw) Note: since the volume viewport supports fusion, to get the image data for a specific volume, use the optional volumeId argument.

Parameters

• volumeId?: string

The volumeId of the volume to get the image for.

Returns

IImageData

IImageData

Overrides

Viewport.getImageData

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:1614

getImageIds()

getImageIds(volumeId?): string[]

Returns the list of image Ids for the current viewport

Parameters

• volumeId?: string

volumeId

Returns

string[]

list of strings for image Ids

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:2175

getIntensityFromWorld()

getIntensityFromWorld(point): number

Given a point in world coordinates, return the intensity at that point

Parameters

• point: Point3

The point in world coordinates to get the intensity from.

Returns

number

The intensity value of the voxel at the given point.

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:2154

getPan()

getPan(initialCamera): Point2

Helper function to return the current canvas pan value.

Parameters

• initialCamera: ICamera = ...

Returns

packages/core/src/RenderingEngine/Viewport.ts:1245

a Point2 containing the current pan values on the canvas, computed from the current camera, where the initial pan value is [0,0].

Inherited from

Viewport.getPan

Defined in

getProperties()

getProperties(volumeId?): VolumeViewportProperties

Retrieve the viewport properties

Parameters

• volumeId?: string

The volume id to get the properties for (if undefined, the first volume)

Returns

VolumeViewportProperties

viewport properties including voi, interpolation type: TODO: slabThickness, invert

Overrides

Viewport.getProperties

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:1158

getRenderer()

getRenderer(): vtkRenderer

Returns the vtkRenderer responsible for rendering the Viewport.

Returns

vtkRenderer

The vtkRenderer for the Viewport.

Inherited from

Viewport.getRenderer

Defined in

packages/core/src/RenderingEngine/Viewport.ts:273

getRendererContextPool()

getRendererContextPool(): vtkRenderer

Get the renderer for this viewport - handles ContextPoolRenderingEngine

Returns

vtkRenderer

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:1990

getRendererTiled()

getRendererTiled(): vtkRenderer

Returns the vtkRenderer responsible for rendering the Viewport.

Returns

vtkRenderer

The vtkRenderer for the Viewport.

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:2000

getRenderingEngine()

getRenderingEngine(): RenderingEngine

Returns the rendering engine driving the Viewport.

Returns

RenderingEngine

The RenderingEngine instance.

Inherited from

Viewport.getRenderingEngine

Defined in

packages/core/src/RenderingEngine/Viewport.ts:264

getRotation()

getRotation(): number

Gets the rotation resulting from the value set in setRotation AND taking into account any flips that occurred subsequently from the camera provided or the viewport.

Returns

number

the rotation resulting from the value set in setRotation AND taking into account any flips that occurred subsequently.

Overrides

Viewport.getRotation

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:1512

getSlabThickness()

getSlabThickness(): number

Gets the largest slab thickness from all actors in the viewport.

Returns

number

slabThickness - The slab thickness.

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:2137

getSliceIndex()

getSliceIndex(): number

Returns

number

Overrides

Viewport.getSliceIndex

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:1658

getSliceViewInfo()

getSliceViewInfo(): object

Returns

object

height

height: number

indexToSliceMatrix

indexToSliceMatrix: mat4

sliceIndex

sliceIndex: number

slicePlane

slicePlane: number

sliceToIndexMatrix

sliceToIndexMatrix: mat4

width

width: number

Overrides

Viewport.getSliceViewInfo

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:146

getViewPresentation()

getViewPresentation(viewPresSel): ViewPresentation

Gets a view presentation information specifying HOW a viewport displays something, but not what is being displayed. See getViewReference to get information on WHAT is being displayed.

This is intended to have information on how an image is presented to the user, without specifying what image s displayed. All of this information is available externally, but this method combines the parts of this that are appropriate for remember or applying to other views, without necessarily needing to know what all the attributes are. That differs from methods like getCamera which fetch exact view details that are not likely to be identical between viewports as they change sizes or apply to different images.

Note that the results of this can be used on different viewports, for example, the pan values can be applied to a volume viewport showing a CT, and a stack viewport showing an ultrasound.

The selector allows choosing which view presentation attributes to return. Some default values are available from Viewport.CameraViewPresentation and Viewport.TransferViewPresentation

Parameters

• viewPresSel: ViewPresentationSelector = ...

select which attributes to display.

Returns

ViewPresentation

Inherited from

Viewport.getViewPresentation

Defined in

packages/core/src/RenderingEngine/Viewport.ts:1947

getViewReference()

getViewReference(viewRefSpecifier): ViewReference

Gets a view target, allowing comparison between view positions as well as restoring views later.

Parameters

• viewRefSpecifier: ViewReferenceSpecifier = {}

Returns

ViewReference

Overrides

Viewport.getViewReference

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:620

getViewReferenceId()

getViewReferenceId(specifier): string

For a volume viewport, the reference id will be a URN starting with volumeId:<volumeId>, followed by additional arguments to specify the view orientation. This will end up being a unique string that identifies the view reference being shown. It is different from the view reference in that the values are all incorporated into a string to allow using it as a parameter key.

Parameters

• specifier: ViewReferenceSpecifier = {}

Returns

string

Overrides

Viewport.getViewReferenceId

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:2234

getVOIModifiedEventDetail()

protected getVOIModifiedEventDetail(volumeId): VoiModifiedEventDetail

Parameters

• volumeId: string

Returns

VoiModifiedEventDetail

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:397

getVolumeId()

getVolumeId(specifier?): string

Gets the volumeId to use for references. Returns undefined if the specified volume is NOT in this viewport.

Parameters

• specifier?: ViewReferenceSpecifier

Returns

string

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:2200

getVtkActiveCamera()

protected getVtkActiveCamera(): vtkCamera | vtkSlabCamera

Gets the active vtkCamera for the viewport.

Returns

vtkCamera | vtkSlabCamera

vtk driven camera

Inherited from

Viewport.getVtkActiveCamera

Defined in

packages/core/src/RenderingEngine/Viewport.ts:1412

getVtkDisplayCoordsContextPool()

getVtkDisplayCoordsContextPool(canvasPos): Point3

Parameters

• canvasPos: Point2

Returns

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:1838

Defined in

getVtkDisplayCoordsTiled()

getVtkDisplayCoordsTiled(canvasPos): Point3

Returns the VTK.js display coordinates of the given canvasPos projected onto the Viewport's vtkCamera's focal point and the direction of projection.

Parameters

• canvasPos: Point2

The position in canvas coordinates.

Returns

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:1817

The corresponding display coordinates.

Defined in

getWidget()

getWidget(id): any

Parameters

• id: any

Returns

any

Inherited from

Viewport.getWidget

Defined in

packages/core/src/RenderingEngine/Viewport.ts:191

getWidgets()

getWidgets(): any[]

Returns

any[]

Inherited from

Viewport.getWidgets

Defined in

packages/core/src/RenderingEngine/Viewport.ts:195

getZoom()

getZoom(compareCamera): number

Returns a current zoom level relative to the initial parallel scale originally applied to the image. That is, on initial display, the zoom level is 1. Computed as a function of the camera.

Parameters

• compareCamera: ICamera = ...

Returns

number

Inherited from

Viewport.getZoom

Defined in

packages/core/src/RenderingEngine/Viewport.ts:1328

hasImageURI()

hasImageURI(imageURI): boolean

Parameters

• imageURI: string

Returns

boolean

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:2017

hasVolumeId()

hasVolumeId(volumeId): boolean

Checks if the viewport has a volume actor with the given volumeId

Parameters

• volumeId: string

the volumeId to look for

Returns

boolean

Boolean indicating if the volume is present in the viewport

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:1581

hasVolumeURI()

hasVolumeURI(volumeURI): boolean

Checks if the viewport has a volume with the given volumeURI.

Parameters

• volumeURI: string

The URI of the volume to check for.

Returns

boolean

A boolean indicating whether the viewport contains a volume with the given URI.

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:1593

isInAcquisitionPlane()

abstract isInAcquisitionPlane(): boolean

Returns

boolean

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:720

isPlaneViewable()

isPlaneViewable(planeRestriction, options?): boolean

Parameters

• planeRestriction: PlaneRestriction

• options?: ReferenceCompatibleOptions

Returns

boolean

Inherited from

Viewport.isPlaneViewable

Defined in

packages/core/src/RenderingEngine/Viewport.ts:1853

isReferenceViewable()

isReferenceViewable(viewRef, options?): boolean

Find out if this viewport would show this view

Parameters

• viewRef: ViewReference

• options?: ReferenceCompatibleOptions

allows specifying whether the view COULD display this with some modification - either navigation or displaying as volume.

Returns

boolean

true if the target is compatible with this view

Overrides

Viewport.isReferenceViewable

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:662

removeActors()

removeActors(actorUIDs): void

Remove the actors with the given UIDs from the viewport

Parameters

• actorUIDs: string[]

An array of actor UIDs to remove.

Returns

void

Inherited from

Viewport.removeActors

Defined in

packages/core/src/RenderingEngine/Viewport.ts:594

removeAllActors()

removeAllActors(): void

Remove all actors from the renderer

Returns

void

Inherited from

Viewport.removeAllActors

Defined in

packages/core/src/RenderingEngine/Viewport.ts:703

removeVolumeActors()

removeVolumeActors(actorUIDs, immediate): void

It removes the volume actor from the Viewport. If the volume actor is not in the viewport, it does nothing.

Parameters

• actorUIDs: string[]

Array of actor UIDs to remove. In case of simple volume it will be the volume Id, but in case of Segmentation it will be {volumeId}-{representationType} since the same volume can be rendered in multiple representations.

• immediate: boolean = false

If true, the Viewport will be rendered immediately

Returns

void

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:1409

removeWidgets()

removeWidgets(): void

Returns

void

Inherited from

Viewport.removeWidgets

Defined in

packages/core/src/RenderingEngine/Viewport.ts:199

render()

render(): void

Renders the Viewport using the RenderingEngine.

Returns

void

Inherited from

Viewport.render

Defined in

packages/core/src/RenderingEngine/Viewport.ts:286

reset()

reset(immediate): void

Resets the options the Viewport's defaultOptions

Parameters

• immediate: boolean = false

If true, renders the viewport after the options are reset.

Returns

void

Inherited from

Viewport.reset

Defined in

packages/core/src/RenderingEngine/Viewport.ts:316

resetCamera()

resetCamera(options?): boolean

Resets the camera based on the rendering volume(s) bounds. If resetPan and resetZoom are true it places the focal point at the center of the volume (or slice); otherwise, only the camera zoom and camera Pan or Zoom is reset for the current view.

Parameters

• options?

The reset options

• options.resetPan?: boolean

If true, the camera focal point is reset to the center of the volume (slice)

• options.resetToCenter?: boolean

If true, the camera is reset to the center of the volume (slice)

• options.resetZoom?: boolean

If true, the camera zoom is reset to the default zoom

• options.storeAsInitialCamera?: boolean

If true, reset camera is stored as the initial camera (to allow differences to be detected for pan/zoom values)

Returns

boolean

boolean

Inherited from

Viewport.resetCamera

Defined in

packages/core/src/RenderingEngine/Viewport.ts:1038

resetCameraNoEvent()

protected resetCameraNoEvent(): void

Reset the camera to the default viewport camera without firing events

Returns

void

Inherited from

Viewport.resetCameraNoEvent

Defined in

packages/core/src/RenderingEngine/Viewport.ts:722

resetProperties()

abstract resetProperties(volumeId?): void

Parameters

• volumeId?: string

Returns

void

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:2274

resetSlabThickness()

abstract resetSlabThickness(): void

Returns

void

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:2272

resetToDefaultProperties()

resetToDefaultProperties(volumeId): void

Reset the viewport properties to the default values

Parameters

• volumeId: string

Returns

void

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:1045

scroll()

scroll(delta): void

Scrolls the viewport in the given direction/amount

Parameters

• delta: number = 1

Returns

void

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:689

setActors()

setActors(actors): void

It removes all actors from the viewport and then adds the actors from the array.

Parameters

• actors: ActorEntry[]

An array of ActorEntry objects.

Returns

void

Inherited from

Viewport.setActors

Defined in

packages/core/src/RenderingEngine/Viewport.ts:553

setBestOrentation()

setBestOrentation(inPlaneVector1, inPlaneVector2): void

This will apply a camera orientation that is compatible with inPlaneVector1 and 2

If inPlaneVector1 and inPlaneVector2 are compatible with, no change.
If dot products of the current view plane normal and inPlaneVector 1 and 2 are zero, no change

Parameters

• inPlaneVector1: any

• inPlaneVector2: any

Returns

void

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:729

setBlendMode()

abstract setBlendMode(blendMode, filterActorUIDs?, immediate?): void

Parameters

• blendMode: BlendModes

• filterActorUIDs?: string[]

• immediate?: boolean

Returns

void

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:2261

setCamera()

setCamera(cameraInterface, storeAsInitialCamera?): void

Set the camera parameters

Parameters

• cameraInterface: ICamera

ICamera

• storeAsInitialCamera?: boolean

to set the provided camera as the initial one, used to compute differences for things like pan and zoom.

Returns

void

Overrides

Viewport.setCamera

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:1662

setCameraClippingRange()

protected setCameraClippingRange(): void

Returns

void

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:1654

setCameraNoEvent()

protected setCameraNoEvent(camera): void

Sets the camera to the default viewport camera without firing events

Parameters

• camera: ICamera

The camera to use for the viewport.

Returns

void

Inherited from

Viewport.setCameraNoEvent

Defined in

packages/core/src/RenderingEngine/Viewport.ts:733

setColorTransform()

protected setColorTransform(voiRange, averageWhite): any

This applies a color transform as an svg filter to the output image.

Parameters

• voiRange: any

• averageWhite: any

Returns

any

Inherited from

Viewport.setColorTransform

Defined in

packages/core/src/RenderingEngine/Viewport.ts:234

setDataIds()

setDataIds(_imageIds, _options?): void

This is a wrapper for setStack/setVideo/etc

Parameters

• _imageIds: string[]

• _options?: ImageSetOptions

Returns

void

Inherited from

Viewport.setDataIds

Defined in

packages/core/src/RenderingEngine/Viewport.ts:2169

setDefaultProperties()

setDefaultProperties(ViewportProperties, volumeId?): void

Update the default properties for the volume viewport on the volume

Parameters

• ViewportProperties: VolumeViewportProperties

The properties to set

• volumeId?: string

The volume id to set the default properties for (if undefined, we set the global default viewport properties)

Returns

void

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:590

setDisplayArea()

setDisplayArea(displayArea, suppressEvents): void

Sets the camera to an initial bounds. If resetPan and resetZoom are true it places the focal point at the center of the volume (or slice); otherwise, only the camera zoom and camera Pan or Zoom is reset for the current view.

Parameters

• displayArea: DisplayArea

The display area of interest.

• suppressEvents: boolean = false

If true, don't fire displayArea event.

Returns

void

Inherited from

Viewport.setDisplayArea

Defined in

packages/core/src/RenderingEngine/Viewport.ts:803

setDisplayAreaFit()

protected setDisplayAreaFit(displayArea): void

This applies a display area with a fit of the provided area to the available area. The zoom level is controlled by the imageArea parameter, which is a pair of percentage width in the horizontal and vertical dimension is scaled to fit the displayable area. Both values are taken into account, and the scaling is set so that both fractions of the image area are visible.

The panning is controlled by the imageCanvasPoint, which has two values, teh imagePoint and the canvasPoint. They are fractional values of the image and canvas respectively, with the panning set to display the image pixel at the given fraction on top of the canvas at the given percentage. The default points are 0.5.

For example, if the zoom level is [2,1], then the image is displayed such that at least twice the width is visible, and the height is visible. That will result in the image width being black, divided up on the left and right according to the imageCanvasPoint

Then, if the imagePoint is [1,0] and the canvas point is [1,0], then the right most edge of the image, at the top of the image, will be displayed at the right most edge of the canvas, at the top.

Parameters

• displayArea: DisplayArea

Returns

void

Inherited from

Viewport.setDisplayAreaFit

Defined in

packages/core/src/RenderingEngine/Viewport.ts:940

setDisplayAreaScale()

protected setDisplayAreaScale(displayArea): void

Sets the viewport to pixel scaling mode. Pixel scaling displays 1 image pixel as 1 (or scale) physical screen pixels. That is, a 1024x512 image will be displayed with scale=2, as 2048x1024 physical image pixels.

Parameters

• displayArea: DisplayArea

display area to set

displayArea.scale - the number of physical pixels to display each image pixel in. Values < 1 mean smaller than physical, while values > 1 mean more than one pixel. Default is 1 Suggest using whole numbers or integer fractions (eg 1/3)

Returns

void

Inherited from

Viewport.setDisplayAreaScale

Defined in

packages/core/src/RenderingEngine/Viewport.ts:867

setFitToCanvasCamera()

protected setFitToCanvasCamera(camera): void

Sets the provided camera as the displayArea camera. This allows computing differences applied later as compared to the initial position, for things like zoom and pan.

Parameters

• camera: ICamera

to store as the initial value.

Returns

void

Inherited from

Viewport.setFitToCanvasCamera

Defined in

packages/core/src/RenderingEngine/Viewport.ts:1233

setInitialCamera()

protected setInitialCamera(camera): void

Sets the provided camera as the initial camera. This allows computing differences applied later as compared to the initial position, for things like zoom and pan.

Parameters

• camera: ICamera

to store as the initial value.

Returns

void

Inherited from

Viewport.setInitialCamera

Defined in

packages/core/src/RenderingEngine/Viewport.ts:1223

setInterpolationType()

protected setInterpolationType(interpolationType, volumeId?): void

Sets the interpolation type. No-op in the base.

Parameters

• interpolationType: InterpolationType

• volumeId?: string

Returns

void

Overrides

Viewport.setInterpolationType

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:455

setOptions()

setOptions(options, immediate): void

Sets new options and (TODO) applies them.

Parameters

• options: ViewportInputOptions

The viewport options to set.

• immediate: boolean = false

If true, renders the viewport after the options are set.

Returns

void

Inherited from

Viewport.setOptions

Defined in

packages/core/src/RenderingEngine/Viewport.ts:298

setOrientation()

setOrientation(_orientation, _immediate): void

It sets the orientation for the camera, the orientation can be one of the following: axial, sagittal, coronal, acquisition. Use the Enums.OrientationAxis to set the orientation. The "acquisition" orientation is the orientation that the volume was acquired in (scan axis).

Parameters

• _orientation: OrientationAxis | OrientationVectors

• _immediate: boolean = true

Returns

void

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:1427

setOrientationOfClippingPlanes()

setOrientationOfClippingPlanes(vtkPlanes, slabThickness, viewPlaneNormal, focalPoint): void

Parameters

• vtkPlanes: vtkPlane[]

• slabThickness: number

• viewPlaneNormal: Point3

• focalPoint: Point3

Returns

void

Inherited from

Viewport.setOrientationOfClippingPlanes

Defined in

packages/core/src/RenderingEngine/Viewport.ts:1700

setPan()

setPan(pan, storeAsInitialCamera): void

Sets the canvas pan value relative to the initial view position of 0,0 Modifies the camera to perform the pan.

Parameters

• pan: Point2

• storeAsInitialCamera: boolean = false

Returns

void

Inherited from

Viewport.setPan

Defined in

packages/core/src/RenderingEngine/Viewport.ts:1294

setProperties()

setProperties(VolumeViewportProperties, volumeId?, suppressEvents?): void

Sets the properties for the volume viewport on the volume and if setProperties is called for the first time, the properties will also become the default one. (if fusion, it sets it for the first volume in the fusion)

Parameters

• VolumeViewportProperties: VolumeViewportProperties = {}

The properties to set

• volumeId?: string

The volume id to set the properties for (if undefined, the first volume)

• suppressEvents?: boolean = false

If true, the viewport will not emit events

Returns

void

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:974

setRendered()

setRendered(): void

Indicate that the image has been rendered. This will set the viewportStatus to RENDERED if there is image data available to actually be rendered - otherwise, the rendering simply showed the background image.

Returns

void

Inherited from

Viewport.setRendered

Defined in

packages/core/src/RenderingEngine/Viewport.ts:221

setRotation()

protected setRotation(rotation): void

Parameters

• rotation: number

Returns

void

Overrides

Viewport.setRotation

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:536

setSampleDistanceMultiplier()

setSampleDistanceMultiplier(multiplier): void

Parameters

• multiplier: number

Returns

void

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:1128

setSlabThickness()

abstract setSlabThickness(slabThickness, filterActorUIDs?): void

Parameters

• slabThickness: number

• filterActorUIDs?: string[]

Returns

void

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:2267

setViewPlane()

setViewPlane(planeRestriction): void

Sets the view reference given a referenced plane and the current view plane normal being applied. This will use the existing normal if compatible, otherwise will calculate a new view plane normal as the referenced plane normal, or else the cross product of the existing view plane normal and the inPlaneVector1

Parameters

• planeRestriction: PlaneRestriction

Returns

void

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:783

setViewPresentation()

setViewPresentation(viewPres): void

Applies the display area, zoom, pan and rotation from the view presentation. No-op is viewPres isn't defined.

Parameters

• viewPres: ViewPresentation

Returns

void

Inherited from

Viewport.setViewPresentation

Defined in

packages/core/src/RenderingEngine/Viewport.ts:1998

setViewReference()

setViewReference(viewRef): void

Navigates to the specified view reference.

Parameters

• viewRef: ViewReference

Returns

void

Overrides

Viewport.setViewReference

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:799

setVolumes()

setVolumes(volumeInputArray, immediate, suppressEvents): Promise<void>

Creates volume actors for all volumes defined in the volumeInputArray. For each entry, if a callback is supplied, it will be called with the new volume actor as input. For each entry, if a blendMode and/or slabThickness is defined, this will be set on the actor's VolumeMapper.

Parameters

• volumeInputArray: IVolumeInput[]

The array of VolumeInputs which define the volumes to add.

• immediate: boolean = false

Whether the Viewport should be rendered as soon as volumes are added.

• suppressEvents: boolean = false

Returns

Promise<void>

Defined in

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:1262

setZoom()

setZoom(value, storeAsInitialCamera): void

Zooms the image using parallel scale by updating the camera value.

Parameters

• value: number

The relative parallel scale to apply. It is relative to the initial offsets value.

• storeAsInitialCamera: boolean = false

can be set to true to reset the camera after applying this zoom as the initial camera. A subsequent getZoom call will return "1", but the zoom will have been applied.

Returns

void

Inherited from

Viewport.setZoom

Defined in

packages/core/src/RenderingEngine/Viewport.ts:1345

triggerCameraModifiedEventIfNecessary()

triggerCameraModifiedEventIfNecessary(previousCamera, updatedCamera): void

Trigger camera modified event

Parameters

• previousCamera: ICamera

• updatedCamera: ICamera

Returns

void

Inherited from

Viewport.triggerCameraModifiedEventIfNecessary

Defined in

packages/core/src/RenderingEngine/Viewport.ts:1622

updateCameraClippingPlanesAndRange()

updateCameraClippingPlanesAndRange(): void

Updates the camera's clipping planes and range.

Returns

void

Inherited from

Viewport.updateCameraClippingPlanesAndRange

Defined in

packages/core/src/RenderingEngine/Viewport.ts:1642

updateClippingPlanesForActors()

protected updateClippingPlanesForActors(updatedCamera): Promise<void>

Updates the actors clipping planes orientation from the camera properties

Parameters

• updatedCamera: ICamera

ICamera

Returns

Promise<void>

Inherited from

Viewport.updateClippingPlanesForActors

Defined in

packages/core/src/RenderingEngine/Viewport.ts:1652

worldToCanvasContextPool()

worldToCanvasContextPool(worldPos): Point2

Parameters

• worldPos: Point3

Returns

packages/core/src/RenderingEngine/BaseVolumeViewport.ts:1919

Defined in

worldToCanvasTiled()

worldToCanvasTiled(worldPos): Point2

Returns the canvas coordinates of the given worldPos projected onto the Viewport's canvas.

Parameters

• worldPos: Point3

The position in world coordinates.

Returns