Skip to main content

Enums

Index

Namespaces

VideoEnums

VideoEnums:

SpeedUnit

SpeedUnit:

video viewport speed units

FRAME

FRAME: f

SECOND

SECOND: s

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

CalibrationTypes

CalibrationTypes:

Defines the calibration types available. These define how the units for measurements are specified.

ERMF

ERMF: ERMF

ERMF is estimated radiographic magnification factor. This defines how much the image is magnified at the detector as opposed to the location in the body of interest. This occurs because the radiation beam is expanding and effectively magnifies the image on the detector compared to where the point of interest in the body is. This suggests that measurements can be partially trusted, but the user still needs to be aware that different depths within the body have differing ERMF values, so precise measurements would still need to be manually calibrated.

ERROR

ERROR: Error

Error is used to define mismatches between various units, such as when there are two different ERMF values specified. This is an indication to NOT trust the measurement values but to manually calibrate.

NOT_APPLICABLE

NOT_APPLICABLE:

Not applicable means the units are directly defind by the underlying hardware, such as CT and MR volumetric displays, so no special handling or notification is required.

PROJECTION

PROJECTION: Proj

A projection calibration means the raw detector size, without any ERMF applied, meaning that the size in the body cannot be trusted and that a calibration should be applied. This is different from Error in that there is simply no magnification factor applied as opposed to having multiple, inconsistent magnification factors.

REGION

REGION: Region

A region calibration is used for other types of images, typically ultrasouunds where the distance in the image may mean something other than physical distance, such as mV or Hz or some other measurement values.

UNCALIBRATED

UNCALIBRATED: Uncalibrated

Uncalibrated image

USER

USER: User

User calibration means that the user has provided a custom calibration specifying how large the image data is. This type can occur on volumetric images, eg for scout images that might have invalid spacing tags.

ContourType

ContourType:

CLOSED_PLANAR

CLOSED_PLANAR: CLOSED_PLANAR

OPEN_PLANAR

OPEN_PLANAR: OPEN_PLANAR

DynamicOperatorType

DynamicOperatorType:

DynamicOperatorType enum for cornerstone-render which defines the operator to use for generateImageFromTimeData. It can be either SUM, AVERAGE or SUBTRACT.

AVERAGE

AVERAGE: AVERAGE

For averaging the time frames.

SUBTRACT

SUBTRACT: SUBTRACT

For subtracting two time frames

SUM

SUM: SUM

For summing the time frames.

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

CAMERA_RESET

CAMERA_RESET: CORNERSTONE_CAMERA_RESET

Triggers on the HTML element when the viewport camera resets

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

CLIPPING_PLANES_UPDATED

CLIPPING_PLANES_UPDATED: CORNERSTONE_CLIPPING_PLANES_UPDATED

Triggers when the clipping planes has been updated

COLORMAP_MODIFIED

COLORMAP_MODIFIED: CORNERSTONE_COLORMAP_MODIFIED

Triggers on the HTML element when viewport modifies its colormap Make use of ColormapModified Event Type for typing your event listeners for COLORMAP_MODIFIED event, and see what event detail is included in ColormapModified Event Detail

DISPLAY_AREA_MODIFIED

DISPLAY_AREA_MODIFIED: CORNERSTONE_DISPLAY_AREA_MODIFIED

Triggers on the HTML element when viewport modifies its display area

Make use of DisplayAreaModified Event Type for typing your event listeners for DISPLAY_AREA_MODIFIED event, and see what event detail is included in DisplayAreaModified 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

GEOMETRY_CACHE_GEOMETRY_ADDED

GEOMETRY_CACHE_GEOMETRY_ADDED: CORNERSTONE_GEOMETRY_CACHE_GEOMETRY_ADDED

Triggers on the eventTarget when a new geometry is added to the geometry cache

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. This event may be fired multiple times for different statuses as the image data gets loaded.

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_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_RETRIEVAL_STAGE

IMAGE_RETRIEVAL_STAGE: CORNERSTONE_IMAGE_RETRIEVAL_STAGE

Triggers on the eventTarget when progressive loading stages are completed. That is, the stage is complete for all images included in that stage (which can be zero). If you need individual image load information related to the stage, see the status attribute on the IMAGE_LOADED event - which has the status of the image, but not the actual stage that loaded it.

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_LOADING_COMPLETED

IMAGE_VOLUME_LOADING_COMPLETED: CORNERSTONE_IMAGE_VOLUME_LOADING_COMPLETED

Triggers on the eventTarget when the image volume loading is completed and all frames are loaded and inserted into a volume.

Make use of ImageVolumeLoadingCompleted Event Type for typing your event listeners for IMAGE_VOLUME_LOADING_COMPLETED event, and see what event detail is included in ImageVolumeLoadingCompleted 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

PRESET_MODIFIED

PRESET_MODIFIED: CORNERSTONE_VIEWPORT_RENDERING_PRESET_MODIFIED

Triggers on the HTML element when viewport modifies its preset (used in volume viewport 3D)

Make use of PresetModified Event Type for typing your event listeners for PRESET_MODIFIED event,

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

VOLUME_SCROLL_OUT_OF_BOUNDS

VOLUME_SCROLL_OUT_OF_BOUNDS: VOLUME_SCROLL_OUT_OF_BOUNDS

Triggers when the scroll function is called with a delta that is out of bounds. This is usually for signaling that the user may want a different volume for partially loaded volumes which is meant to optimize memory.

VOLUME_VIEWPORT_NEW_VOLUME

VOLUME_VIEWPORT_NEW_VOLUME: CORNERSTONE_VOLUME_VIEWPORT_NEW_VOLUME

Triggers on element when a new voluem is set on the volume viewport

VOLUME_VIEWPORT_SCROLL

VOLUME_VIEWPORT_SCROLL: VOLUME_VIEWPORT_SCROLL

Triggers when the scroll function is called on a volume.

WEB_WORKER_PROGRESS

WEB_WORKER_PROGRESS: CORNERSTONE_WEB_WORKER_PROGRESS

Triggers when the webworker has made progress You should use it with a workerType to indicate the type of worker that is making progress Checkout the polySEG convertors in the cornerstone tools to lean how to use it

GeometryType

GeometryType:

CONTOUR

CONTOUR: contour

SURFACE

SURFACE: Surface

ImageQualityStatus

ImageQualityStatus:

Status of a frame as it gets loaded. This is ordered, with lower values being more lossy, and higher values being less lossy.

ADJACENT_REPLICATE

ADJACENT_REPLICATE: 3

Adjacent replicate is a duplicated image of a nearby image

FAR_REPLICATE

FAR_REPLICATE: 1

Replicate is a duplicated image, from some larger distance

FULL_RESOLUTION

FULL_RESOLUTION: 8

Full resolution means the image is full resolution/complete data/lossless (or at least as lossless as the image is going to get)

LOSSY

LOSSY: 7

Lossy images, encoded with a lossy encoding, but full resolution or size.

SUBRESOLUTION

SUBRESOLUTION: 6

Sub resolution images are encodings of smaller than full resolution images. The encoding may or may not be lossy, but the lower resolution means it has lost information already compared to full resolution/lossless.

InterpolationType

InterpolationType:

Interpolation types for image rendering

FAST_LINEAR

FAST_LINEAR: 2

LINEAR

LINEAR: 1

linear interpolation - Default

NEAREST

NEAREST: 0

nearest neighbor interpolation

MetadataModules

MetadataModules:

Contains the names for the metadata modules. Recommendation is to add all module names here rather than having them just use string names. The naming convention is that the enum has the modules in it, so the enum key does not repeat the Modules, but the enum value does (to agree with existing naming conventions)

CALIBRATION

CALIBRATION: calibrationModule

CINE

CINE: cineModule

GENERAL_SERIES

GENERAL_SERIES: generalSeriesModule

IMAGE_PIXEL

IMAGE_PIXEL: imagePixelModule

IMAGE_PLANE

IMAGE_PLANE: imagePlaneModule

IMAGE_URL

IMAGE_URL: imageUrlModule

MODALITY_LUT

MODALITY_LUT: modalityLutModule

MULTIFRAME

MULTIFRAME: multiframeModule

NM_MULTIFRAME_GEOMETRY

NM_MULTIFRAME_GEOMETRY: nmMultiframeGeometryModule

PATIENT_STUDY

PATIENT_STUDY: patientStudyModule

SOP_COMMON

SOP_COMMON: sopCommonModule

ULTRASOUND_ENHANCED_REGION

ULTRASOUND_ENHANCED_REGION: ultrasoundEnhancedRegionModule

VOI_LUT

VOI_LUT: voiLutModule

OrientationAxis

OrientationAxis:

ACQUISITION

ACQUISITION: acquisition

AXIAL

AXIAL: axial

CORONAL

CORONAL: coronal

SAGITTAL

SAGITTAL: sagittal

RequestType

RequestType:

Request types for requesting images from the imageLoadPoolManager

Compute

Compute: compute

Lower priority, often used for background computations in the worker

Interaction

Interaction: interaction

Highest priority for loading

Prefetch

Prefetch: prefetch

Third highest priority for loading, usually used for image loading in the background

Thumbnail

Thumbnail: thumbnail

Second highest priority for loading

SharedArrayBufferModes

SharedArrayBufferModes:

SharedArrayBuffer Modes

AUTO

AUTO: auto

use SharedArrayBuffer if avalaible

FALSE

FALSE: false

TRUE

TRUE: true

VOILUTFunctionType

VOILUTFunctionType:

Interpolation types for image rendering

LINEAR

LINEAR: LINEAR

SAMPLED_SIGMOID

SAMPLED_SIGMOID: SIGMOID

ViewportStatus

ViewportStatus:

LOADING

LOADING: loading

Stack/volumes are available but are in progress

NO_DATA

NO_DATA: noData

Initial state before any volumes or stacks are available

PRE_RENDER

PRE_RENDER: preRender

Ready to be rendered

RENDERED

RENDERED: rendered

Rendered image data

RESIZE

RESIZE: resize

In the midst of a resize

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

VIDEO

VIDEO: video

VOLUME_3D

VOLUME_3D: volume3d