Skip to main content

StackViewport

An object representing a single stack viewport, which is a camera looking into an internal viewport, and an associated target output canvas.

StackViewports can be rendered using both GPU and a fallback CPU is the GPU is not available (or low performance). Read more about StackViewports in the documentation section of this website.

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Constructor for the StackViewport class

    Parameters

    • props: ViewportInput

      ViewportInput

    Returns StackViewport

Properties

_actors

_actors: Map<string, any>

a Map containing the actor uid and actors

publicaddActor

addActor: (actorEntry: ActorEntry) => void

Type declaration

    • If the renderer is CPU based, throw an error. Otherwise, add the actor to the viewport

      Parameters

      • actorEntry: ActorEntry

        The ActorEntry object that was created by the user.

      Returns void

publicaddActors

addActors: (actors: ActorEntry[]) => void

Type declaration

    • If the renderer is CPU based, throw an error. Otherwise, add a list of actors to the viewport

      Parameters

      • actors: ActorEntry[]

        An array of ActorEntry objects.

      Returns void

readonlycanvas

canvas: HTMLCanvasElement

an internal canvas that is created on the provided HTML element

publiccanvasToWorld

canvasToWorld: (canvasPos: Point2) => Point3

Type declaration

    • canvasToWorld Returns the world coordinates of the given canvasPos projected onto the plane defined by the Viewport‘s camera.

      Parameters

      • canvasPos: Point2

        The position in canvas coordinates.

      Returns Point3

      The corresponding world coordinates.

readonlydefaultOptions

defaultOptions: any

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

readonlyelement

element: HTMLDivElement

HTML element in DOM that is used for rendering the viewport

publicgetActor

getActor: (actorUID: string) => ActorEntry

Type declaration

    • If the renderer is CPU based, throw an error. Otherwise, it returns the actor entry for the given actor UID.

      Parameters

      • actorUID: string

        The unique ID of the actor you want to get.

      Returns ActorEntry

      An ActorEntry object.

publicgetActors

getActors: () => ActorEntry[]

Type declaration

    • If the renderer is CPU based, throw an error. Otherwise, return the actors in the viewport

      Returns ActorEntry[]

      An array of ActorEntry objects.

publicgetCamera

getCamera: () => ICamera

Type declaration

    • If the user has selected CPU rendering, return the CPU camera, otherwise return the default camera

      Returns ICamera

      The camera object.

publicgetDefaultActor

getDefaultActor: () => ActorEntry

Type declaration

    • If the renderer is CPU based, throw an error. Otherwise, return the default actor which is the first actor in the renderer.

      Returns ActorEntry

      An actor entry.

publicgetImageData

getImageData: () => IImageData | CPUIImageData

Type declaration

    • 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)

      Returns IImageData | CPUIImageData

      IImageData: dimensions, direction, scalarData, vtkImageData, metadata, scaling

publicgetRenderer

getRenderer: () => any

Type declaration

    • (): any

    • If the renderer is CPU based, throw an error. Otherwise, returns the vtkRenderer responsible for rendering the Viewport.

      Returns any

      The vtkRenderer for the Viewport.

publicgetRotation

getRotation: () => number

Type declaration

    • (): number

    • Returns number

readonlyid

id: string

unique identifier for the viewport

publicisDisabled

isDisabled: boolean

if the viewport has been disabled

publicmodality

modality: string

options

options: ViewportInputOptions

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

publicremoveAllActors

removeAllActors: () => void

Type declaration

    • (): void

    • It throws an error if the renderer is CPU based. Otherwise, it removes the actors from the viewport.

      Returns void

readonlyrenderingEngineId

renderingEngineId: string

RenderingEngine id that the viewport belongs to

publicresetCamera

resetCamera: (resetPan?: boolean, resetZoom?: boolean) => boolean

Type declaration

    • (resetPan?: boolean, resetZoom?: boolean): boolean

    • Centers Pan and resets the zoom for stack viewport.

      Parameters

      • optionalresetPan: boolean
      • optionalresetZoom: boolean

      Returns boolean

sHeight

sHeight: number

sHeight of viewport on the offscreen canvas

sWidth

sWidth: number

sWidth of viewport on the offscreen canvas

publicscaling

scaling: Scaling

Scaling parameters

publicsetActors

setActors: (actors: ActorEntry[]) => void

Type declaration

    • If the renderer is CPU-based, throw an error; otherwise, set the actors in the viewport.

      Parameters

      • actors: ActorEntry[]

        An array of ActorEntry objects.

      Returns void

publicsetCamera

setCamera: (cameraInterface: ICamera, storeAsInitialCamera?: boolean) => void

Type declaration

    • (cameraInterface: ICamera, storeAsInitialCamera?: boolean): void

    • Set the camera based on the provided camera object.

      Parameters

      • cameraInterface: ICamera

        The camera interface that will be used to render the scene.

      • optionalstoreAsInitialCamera: boolean

      Returns void

publicsetColormap

setColormap: (colormap: CPUFallbackColormapData | ColormapRegistration) => void

Type declaration

readonlysuppressEvents

suppressEvents: boolean

A flag representing if viewport methods should fire events or not

sx

sx: number

sx of viewport on the offscreen canvas

sy

sy: number

sy of viewport on the offscreen canvas

readonlytype

type: ViewportType

Type of viewport

publicunsetColormap

unsetColormap: () => void

Type declaration

    • (): void

    • It sets the colormap to the default colormap.

      Returns void

publicworldToCanvas

worldToCanvas: (worldPos: Point3) => Point2

Type declaration

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

      Parameters

      • worldPos: Point3

        The position in world coordinates.

      Returns Point2

      The corresponding canvas coordinates.

Accessors

staticuseCustomRenderingPipeline

  • get useCustomRenderingPipeline(): boolean

  • Returns boolean

Methods

_getCorners

  • _getCorners(bounds: number[]): number[][]

  • Parameters

    • bounds: number[]

    Returns number[][]

_getEdges

  • _getEdges(bounds: number[]): [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

_getFocalPointForResetCamera

  • _getFocalPointForResetCamera(centeredFocalPoint: Point3, previousCamera: ICamera, __namedParameters: Object): Point3

  • Parameters

    • centeredFocalPoint: Point3
    • previousCamera: ICamera
    • __namedParameters: Object

    Returns Point3

_isInBounds

  • _isInBounds(point: Point3, bounds: number[]): 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

_removeActor

  • _removeActor(actorUID: string): void

  • Remove the actor from the viewport

    Parameters

    • actorUID: string

      The unique identifier for the actor.

    Returns void

publiccalibrateSpacing

  • calibrateSpacing(imageId: string): void

  • Calibrates the image with new metadata that has been added for imageId. To calibrate a viewport, you should add your calibration data manually to calibratedPixelSpacingMetadataProvider and call viewport.calibrateSpacing for it get applied.

    Parameters

    • imageId: string

      imageId to be calibrated

    Returns void

publiccustomRenderViewportToCanvas

  • customRenderViewportToCanvas(): { canvas: HTMLCanvasElement; element: HTMLDivElement; renderingEngineId: string; viewportId: string }

  • Custom rendering pipeline for the rendering for the CPU fallback

    Returns { canvas: HTMLCanvasElement; element: HTMLDivElement; renderingEngineId: string; viewportId: string }

    • canvas: HTMLCanvasElement
    • element: HTMLDivElement
    • renderingEngineId: string
    • viewportId: string

publicgetActorByIndex

  • Get an actor by its index

    Parameters

    • index: number

      array index.

    Returns ActorEntry

    actorUID

publicgetActorUIDByIndex

  • getActorUIDByIndex(index: number): string

  • Get an actor UID by its index

    Parameters

    • index: number

      array index.

    Returns string

    actorUID

publicgetCanvas

  • getCanvas(): HTMLCanvasElement

  • Gets the target output canvas for the Viewport.

    Returns HTMLCanvasElement

    an HTMLCanvasElement.

publicgetCornerstoneImage

  • Returns the raw/loaded image being shown inside the stack viewport.

    Returns IImage

publicgetCurrentImageId

  • getCurrentImageId(): string

  • Returns the currently rendered imageId

    Returns string

    string for imageId

publicgetCurrentImageIdIndex

  • getCurrentImageIdIndex(): number

  • Returns the index of the imageId being renderer

    Returns number

    currently shown imageId index

publicgetDisplayArea

  • returns the displayArea

    Returns DisplayArea

publicgetFrameOfReferenceUID

  • getFrameOfReferenceUID(): string

  • Returns the frame of reference UID, if the image doesn’t have imagePlaneModule metadata, it returns undefined, otherwise, frameOfReferenceUID is returned.

    Returns string

    frameOfReferenceUID : string representing frame of reference id

publicgetImageIds

  • getImageIds(): string[]

  • Returns the list of image Ids for the current viewport

    Returns string[]

    list of strings for image Ids

publicgetPan

  • Helper function to return the current canvas pan value.

    Returns Point2

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

publicgetProperties

  • Retrieve the viewport properties

    Returns StackViewportProperties

    viewport properties including voi, invert, interpolation type, rotation, flip

publicgetRenderingEngine

  • Returns the rendering engine driving the Viewport.

    Returns default

    The RenderingEngine instance.

publicgetTargetImageIdIndex

  • getTargetImageIdIndex(): number

  • Returns the imageIdIndex that is targeted to be loaded, in case of debounced loading (with scroll), the targetImageIdIndex is the latest imageId index that is requested to be loaded but debounced.

    Returns number

publicgetZoom

  • getZoom(): 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.

    Returns number

publichasImageId

  • hasImageId(imageId: string): boolean

  • Returns true if the viewport contains the given imageId

    Parameters

    • imageId: string

      imageId

    Returns boolean

    boolean if imageId is in viewport

publichasImageURI

  • hasImageURI(imageURI: string): boolean

  • Returns true if the viewport contains the given imageURI (no data loader scheme)

    Parameters

    • imageURI: string

      imageURI

    Returns boolean

    boolean if imageURI is in viewport

publicremoveActors

  • removeActors(actorUIDs: string[]): void

  • Remove the actors with the given UIDs from the viewport

    Parameters

    • actorUIDs: string[]

      An array of actor UIDs to remove.

    Returns void

publicrender

  • render(): void

  • Renders the Viewport using the RenderingEngine.

    Returns void

publicrenderImageObject

  • renderImageObject(image: any): void

  • Renders the given Cornerstone image object in the viewport. This method is intended to be used by utilities to render an individual image, rather than by applications that want to display a complete image stack. If you want to load and display a complete image stack, use the setStack method instead of this one.

    The rendered image will appear in the viewport’s element. Use this method if you have other means of loading and the cornerstone image object is already available.

    If you don’t understand the difference between this method and setStack, you probably want to use setStack.

    Parameters

    • image: any

      The Cornerstone image object to render.

    Returns void

publicreset

  • reset(immediate?: boolean): void

  • Resets the options the Viewport‘s defaultOptions

    Parameters

    • immediate: boolean = false

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

    Returns void

publicresetProperties

  • resetProperties(): void

  • Reset the viewport properties to the default values

    Returns void

publicresize

  • resize(): void

  • Resizes the viewport - only used in CPU fallback for StackViewport. The GPU resizing happens inside the RenderingEngine.

    Returns void

publicscroll

  • scroll(delta: number, debounce?: boolean, loop?: boolean): void

  • It scrolls the stack of imageIds by the delta amount provided. If the debounce flag is set, it will only scroll the stack if the delta is greater than the debounceThreshold which is 40 milliseconds by default.

    Parameters

    • delta: number

      number of indices to scroll, it can be positive or negative

    • debounce: boolean = true

      whether to debounce the scroll event

    • loop: boolean = false

      whether to loop the stack

    Returns void

publicsetDisplayArea

  • setDisplayArea(displayArea: DisplayArea, suppressEvents?: boolean): 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

publicsetImageIdIndex

  • setImageIdIndex(imageIdIndex: number): Promise<string>

  • Loads the image based on the provided imageIdIndex. It is an Async function which returns a promise that resolves to the imageId.

    Parameters

    • imageIdIndex: number

      number represents imageId index in the list of provided imageIds in setStack

    Returns Promise<string>

publicsetOptions

  • 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

publicsetOrientationOfClippingPlanes

  • setOrientationOfClippingPlanes(vtkPlanes: vtkPlane[], slabThickness: number, viewPlaneNormal: Point3, focalPoint: Point3): void

  • Parameters

    • vtkPlanes: vtkPlane[]
    • slabThickness: number
    • viewPlaneNormal: Point3
    • focalPoint: Point3

    Returns void

publicsetPan

  • setPan(pan: Point2, storeAsInitialCamera?: boolean): 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

publicsetProperties

  • Sets the properties for the viewport on the default actor. Properties include setting the VOI, inverting the colors and setting the interpolation type, rotation

    Parameters

    Returns void

publicsetStack

  • setStack(imageIds: string[], currentImageIdIndex?: number): Promise<string>

  • Sets the imageIds to be visualized inside the stack viewport. It accepts list of imageIds, the index of the first imageId to be viewed. It is a asynchronous function that returns a promise resolving to imageId being displayed in the stack viewport.

    Parameters

    • imageIds: string[]

      list of strings, that represents list of image Ids

    • currentImageIdIndex: number = 0

      number representing the index of the initial image to be displayed

    Returns Promise<string>

publicsetUseCPURendering

  • setUseCPURendering(value: boolean): void

  • Parameters

    • value: boolean

    Returns void

publicsetZoom

  • setZoom(value: number, storeAsInitialCamera?: boolean): 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

publictriggerCameraModifiedEventIfNecessary

  • triggerCameraModifiedEventIfNecessary(previousCamera: ICamera, updatedCamera: ICamera): void

  • Trigger camera modified event

    Parameters

    Returns void

publicupdateRenderingPipeline

  • updateRenderingPipeline(): void

  • Returns void