Skip to main content

Enums

Index

Enumerations

BlendModes

BlendModes:

Enums for blendModes for viewport images based on vtk.js

It should be noted that if crosshairs are enabled and can modify the slab thickness, then it will not show any difference unless MAXIMUM_INTENSITY_BLEND is set on the viewport as the blend.

AVERAGE_INTENSITY_BLEND

AVERAGE_INTENSITY_BLEND: 3

average intensity projection

COMPOSITE

COMPOSITE: 0

composite blending - suitable for compositing multiple images

MAXIMUM_INTENSITY_BLEND

MAXIMUM_INTENSITY_BLEND: 1

maximum intensity projection

MINIMUM_INTENSITY_BLEND

MINIMUM_INTENSITY_BLEND: 2

minimum intensity projection

Events

Events:

Cornerstone Core events

CACHE_SIZE_EXCEEDED

CACHE_SIZE_EXCEEDED: CACHE_SIZE_EXCEEDED

Error that is thrown when the ImageCache exceeds its max cache size. This can happen for both volumes and stack images.

CAMERA_MODIFIED

CAMERA_MODIFIED: CORNERSTONE_CAMERA_MODIFIED

Triggers on the HTML element when the viewport camera changes.

Make use of CameraModified Event Type for typing your event listeners for CAMERA_MODIFIED event, and see what event detail is included in CameraModified Event Detail

ELEMENT_DISABLED

ELEMENT_DISABLED: CORNERSTONE_ELEMENT_DISABLED

Triggers on the eventTarget when the element is disabled

Make use of ElementDisabled Event Type for typing your event listeners for ELEMENT_DISABLED event, and see what event detail is included in ElementDisabled Event Detail

ELEMENT_ENABLED

ELEMENT_ENABLED: CORNERSTONE_ELEMENT_ENABLED

Triggers on the eventTarget when the element is enabled

Make use of ElementEnabled Event Type for typing your event listeners for ELEMENT_ENABLED event, and see what event detail is included in ElementEnabled Event Detail

IMAGE_CACHE_IMAGE_ADDED

IMAGE_CACHE_IMAGE_ADDED: CORNERSTONE_IMAGE_CACHE_IMAGE_ADDED

Triggers on the eventTarget when an image is added to the image cache

Make use of ImageCacheAdded Event Type for typing your event listeners for IMAGE_CACHE_ADDED event, and see what event detail is included in ImageCacheAdded Event Detail

IMAGE_CACHE_IMAGE_REMOVED

IMAGE_CACHE_IMAGE_REMOVED: CORNERSTONE_IMAGE_CACHE_IMAGE_REMOVED

Triggers on the eventTarget when an image is removed from the image cache

Make use of ImageCacheRemoved Event Type for typing your event listeners for IMAGE_CACHE_REMOVED event, and see what event detail is included in ImageCacheRemoved Event Detail

IMAGE_LOADED

IMAGE_LOADED: CORNERSTONE_IMAGE_LOADED

Triggers on the eventTarget when the image has successfully loaded by imageLoaders

Make use of ImageLoaded Event Type for typing your event listeners for IMAGE_LOADED event, and see what event detail is included in ImageLoaded Event Detail

IMAGE_LOAD_ERROR

IMAGE_LOAD_ERROR: IMAGE_LOAD_ERROR

Happens if an image (either a single image in stack viewport) or a slice of a volume fails to load by the image/volume loaders.

IMAGE_LOAD_FAILED

IMAGE_LOAD_FAILED: CORNERSTONE_IMAGE_LOAD_FAILED

Triggers on the eventTarget when the image has failed loading by imageLoaders

Make use of ImageLoadedFailed Event Type for typing your event listeners for IMAGE_LOADED_FAILED event, and see what event detail is included in ImageLoadedFailed Event Detail

IMAGE_LOAD_PROGRESS

IMAGE_LOAD_PROGRESS: CORNERSTONE_IMAGE_LOAD_PROGRESS

Triggers on the eventTarget when there is a progress in the image load process. Note: this event is being used in the Cornerstone-WADO-Image-Loader repository. See here

Make use of ImageLoadProgress Event Type for typing your event listeners for IMAGE_LOAD_PROGRESS event, and see what event detail is included in ImageLoadProgress Event Detail

IMAGE_RENDERED

IMAGE_RENDERED: CORNERSTONE_IMAGE_RENDERED

Triggers on the element when the image in the element has been rendered

Make use of ImageRendered Event Type for typing your event listeners for IMAGE_RENDERED event, and see what event detail is included in ImageRendered Event Detail

IMAGE_SPACING_CALIBRATED

IMAGE_SPACING_CALIBRATED: CORNERSTONE_IMAGE_SPACING_CALIBRATED

Triggers on the element when the viewport’s image has calibrated its pixel spacings

Make use of ImageSpacingCalibrated Event Type for typing your event listeners for IMAGE_SPACING_CALIBRATED event, and see what event detail is included in ImageSpacingCalibrated Event Detail

IMAGE_VOLUME_MODIFIED

IMAGE_VOLUME_MODIFIED: CORNERSTONE_IMAGE_VOLUME_MODIFIED

Triggers on the eventTarget when the image volume data is modified. This happens in the streamingImageLoader when each frame is loaded and inserted into a volume.

Make use of ImageVolumeModified Event Type for typing your event listeners for IMAGE_VOLUME_MODIFIED event, and see what event detail is included in ImageVolumeModified Event Detail

PRE_STACK_NEW_IMAGE

PRE_STACK_NEW_IMAGE: CORNERSTONE_PRE_STACK_NEW_IMAGE

Triggers on the element when a new image is about to be set on the stackViewport, pre display

Make use of PreStackNewImage Event Type for typing your event listeners for PRE_STACK_NEW_IMAGE event, and see what event detail is included in PreStackNewImage Event Detail

STACK_NEW_IMAGE

STACK_NEW_IMAGE: CORNERSTONE_STACK_NEW_IMAGE

Triggers on the element when a new image is set on the stackViewport

Make use of StackNewImage Event Type for typing your event listeners for STACK_NEW_IMAGE event, and see what event detail is included in StackNewImage Event Detail

STACK_VIEWPORT_NEW_STACK

STACK_VIEWPORT_NEW_STACK: CORNERSTONE_STACK_VIEWPORT_NEW_STACK

Triggers on the event target when a new stack is set on its stack viewport. Make use of StackViewportNewStack Event Type for typing your event listeners for STACK_VIEWPORT_NEW_STACK event, and see what event detail is included in StackViewportNewStack Event Detail

STACK_VIEWPORT_SCROLL

STACK_VIEWPORT_SCROLL: CORNERSTONE_STACK_VIEWPORT_SCROLL

Triggers on the element when the underlying StackViewport is scrolled. Make use of StackViewportScroll Event Type for typing your event listeners for STACK_VIEWPORT_SCROLL event, and see what event detail is included in StackViewportScroll Event Detail

VOI_MODIFIED

VOI_MODIFIED: CORNERSTONE_VOI_MODIFIED

Triggers on the HTML element when viewport modifies its VOI

Make use of VoiModified Event Type for typing your event listeners for VOI_MODIFIED event, and see what event detail is included in VoiModified Event Detail

VOLUME_CACHE_VOLUME_ADDED

VOLUME_CACHE_VOLUME_ADDED: CORNERSTONE_VOLUME_CACHE_VOLUME_ADDED

Triggers on the eventTarget when a volume is added to the volume cache

Make use of VolumeCacheAdded Event Type for typing your event listeners for VOLUME_CACHE_ADDED event, and see what event detail is included in VolumeCacheAdded Event Detail

VOLUME_CACHE_VOLUME_REMOVED

VOLUME_CACHE_VOLUME_REMOVED: CORNERSTONE_VOLUME_CACHE_VOLUME_REMOVED

Triggers on the eventTarget when a volume is removed from the volume cache

Make use of VolumeCacheRemoved Event Type for typing your event listeners for VOLUME_CACHE_REMOVED event, and see what event detail is included in VolumeCacheRemoved Event Detail

VOLUME_LOADED

VOLUME_LOADED: CORNERSTONE_VOLUME_LOADED

Triggers on the eventTarget when the volume has successfully loaded by volumeLoaders

Make use of VolumeLoaded Event Type for typing your event listeners for VOLUME_LOADED event, and see what event detail is included in VolumeLoaded Event Detail

VOLUME_LOADED_FAILED

VOLUME_LOADED_FAILED: CORNERSTONE_VOLUME_LOADED_FAILED

Triggers on the eventTarget when the image has failed loading by volumeLoaders

Make use of VolumeLoadedFailed Event Type for typing your event listeners for VOLUME_LOADED_FAILED event, and see what event detail is included in VolumeLoadedFailed Event Detail

VOLUME_NEW_IMAGE

VOLUME_NEW_IMAGE: CORNERSTONE_VOLUME_NEW_IMAGE

Triggers on the element when a new image is set on the volumeViewport, this can be due to scrolling or other tools that change the camera position or focal point.

Make use of VolumeNewImage Event Type for typing your event listeners for VOLUME_NEW_IMAGE event, and see what event detail is included in VolumeNewImage Event Detail

InterpolationType

InterpolationType:

Interpolation types for image rendering

FAST_LINEAR

FAST_LINEAR: 2

LINEAR

LINEAR: 1

linear interpolation - Default

NEAREST

NEAREST: 0

nearest neighbor interpolation

OrientationAxis

OrientationAxis:

ACQUISITION

ACQUISITION: acquisition

AXIAL

AXIAL: axial

CORONAL

CORONAL: coronal

SAGITTAL

SAGITTAL: sagittal

RequestType

RequestType:

Request types for requesting images from the imageLoadPoolManager

Interaction

Interaction: interaction

Highest priority for loading

Prefetch

Prefetch: prefetch

Lowest priority for loading

Thumbnail

Thumbnail: thumbnail

Second highest priority for loading

ViewportType

ViewportType:

ViewportType enum for cornerstone-render which defines the type of viewport. It can be either STACK, PERSPECTIVE, ORTHOGRAPHIC.

ORTHOGRAPHIC

ORTHOGRAPHIC: orthographic
  • Suitable for rendering a volumetric data which is considered as one 3D image.
  • Having a VolumeViewport enables Multi-planar reformation or reconstruction (MPR) by design, in which you can visualize the volume from various different orientations without addition of performance costs.

PERSPECTIVE

PERSPECTIVE: perspective

Perspective Viewport: Not Implemented yet

STACK

STACK: stack
  • Suitable for rendering a stack of images, that might or might not belong to the same image.
  • Stack can include 2D images of different shapes, size and direction