Enums
Index
Namespaces
VideoEnums
SpeedUnit
FRAME
SECOND
Enumerations
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 projection
COMPOSITE
composite blending - suitable for compositing multiple images
MAXIMUM_INTENSITY_BLEND
maximum intensity projection
MINIMUM_INTENSITY_BLEND
minimum intensity projection
CalibrationTypes
Defines the calibration types available. These define how the units for measurements are specified.
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 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 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
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
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 image
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
CLOSED_PLANAR
OPEN_PLANAR
DynamicOperatorType
DynamicOperatorType enum for cornerstone-render which defines the operator to use for generateImageFromTimeData. It can be either SUM, AVERAGE or SUBTRACT.
AVERAGE
For averaging the time frames.
SUBTRACT
For subtracting two time frames
SUM
For summing the time frames.
Events
Cornerstone Core events
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
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
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
Triggers when the clipping planes has been updated
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
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
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
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
ERROR_EVENT
ERROR CODES
GEOMETRY_CACHE_GEOMETRY_ADDED
Triggers on the eventTarget when a new geometry is added to the geometry cache
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
Triggers on element when a new voluem is set on the volume viewport
VOLUME_VIEWPORT_SCROLL
Triggers when the scroll function is called on a volume.
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
CONTOUR
SURFACE
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 is a duplicated image of a nearby image
FAR_REPLICATE
Replicate is a duplicated image, from some larger distance
FULL_RESOLUTION
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 images, encoded with a lossy encoding, but full resolution or size.
SUBRESOLUTION
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
Interpolation types for image rendering
FAST_LINEAR
LINEAR
linear interpolation - Default
NEAREST
nearest neighbor interpolation
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
CINE
GENERAL_IMAGE
GENERAL_SERIES
GENERAL_STUDY
IMAGE_PIXEL
IMAGE_PLANE
IMAGE_URL
MODALITY_LUT
MULTIFRAME
NM_MULTIFRAME_GEOMETRY
OVERLAY_PLANE
PATIENT
PATIENT_STUDY
PET_IMAGE
PET_ISOTOPE
PET_SERIES
SOP_COMMON
ULTRASOUND_ENHANCED_REGION
VOI_LUT
OrientationAxis
ACQUISITION
AXIAL
CORONAL
SAGITTAL
RequestType
Request types for requesting images from the imageLoadPoolManager
Compute
Lower priority, often used for background computations in the worker
Interaction
Highest priority for loading
Prefetch
Third highest priority for loading, usually used for image loading in the background
Thumbnail
Second highest priority for loading
SharedArrayBufferModes
SharedArrayBuffer Modes
AUTO
use SharedArrayBuffer if avalaible
FALSE
TRUE
VOILUTFunctionType
Interpolation types for image rendering
LINEAR
SAMPLED_SIGMOID
ViewportStatus
LOADING
Stack/volumes are available but are in progress
NO_DATA
Initial state before any volumes or stacks are available
PRE_RENDER
Ready to be rendered
RENDERED
Rendered image data
RESIZE
In the midst of a resize
ViewportType
ViewportType enum for cornerstone-render which defines the type of viewport. It can be either STACK, PERSPECTIVE, 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 Viewport: Not Implemented yet
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 viewport speed units