Class: StreamingDynamicImageVolume

Streaming Image Volume Class that extends StreamingImageVolume base class. It implements load method to load the imageIds and insert them into the volume.

Extends

• BaseStreamingImageVolume

Implements

• IDynamicImageVolume

Constructors

new StreamingDynamicImageVolume()

new StreamingDynamicImageVolume(imageVolumeProperties, streamingProperties): StreamingDynamicImageVolume

Parameters

• imageVolumeProperties: ImageVolumeProps & object

• streamingProperties: IStreamingVolumeProperties

Returns

StreamingDynamicImageVolume

Overrides

BaseStreamingImageVolume.constructor

Defined in

packages/core/src/cache/classes/StreamingDynamicImageVolume.ts:26

Properties

additionalDetails?

optional additionalDetails: Record<string, unknown>

Property to store additional information

Implementation of

IDynamicImageVolume.additionalDetails

Inherited from

BaseStreamingImageVolume.additionalDetails

Defined in

packages/core/src/cache/classes/ImageVolume.ts:78

---

autoRenderOnLoad

protected autoRenderOnLoad: boolean = true

Inherited from

BaseStreamingImageVolume.autoRenderOnLoad

Defined in

packages/core/src/cache/classes/BaseStreamingImageVolume.ts:44

---

cachedFrames

protected cachedFrames: any[] = []

Inherited from

BaseStreamingImageVolume.cachedFrames

Defined in

packages/core/src/cache/classes/BaseStreamingImageVolume.ts:45

---

cornerstoneImageMetaData

protected cornerstoneImageMetaData: any = null

Implementation of

IDynamicImageVolume.cornerstoneImageMetaData

Inherited from

BaseStreamingImageVolume.cornerstoneImageMetaData

Defined in

packages/core/src/cache/classes/ImageVolume.ts:34

---

dataType?

optional dataType: PixelDataTypedArrayString

Implementation of

IDynamicImageVolume.dataType

Inherited from

BaseStreamingImageVolume.dataType

Defined in

packages/core/src/cache/classes/ImageVolume.ts:90

---

dimensions

dimensions: Point3

Dimensions of the volume

Implementation of

IDynamicImageVolume.dimensions

Inherited from

BaseStreamingImageVolume.dimensions

Defined in

packages/core/src/cache/classes/ImageVolume.ts:42

---

direction

direction: Mat3

volume direction in world space

Implementation of

IDynamicImageVolume.direction

Inherited from

BaseStreamingImageVolume.direction

Defined in

packages/core/src/cache/classes/ImageVolume.ts:44

---

hasPixelSpacing

hasPixelSpacing: boolean

whether the metadata for the pixel spacing is not undefined

Implementation of

IDynamicImageVolume.hasPixelSpacing

Inherited from

BaseStreamingImageVolume.hasPixelSpacing

Defined in

packages/core/src/cache/classes/ImageVolume.ts:76

---

imageData?

optional imageData: vtkImageData

volume image data

Implementation of

IDynamicImageVolume.imageData

Inherited from

BaseStreamingImageVolume.imageData

Defined in

packages/core/src/cache/classes/ImageVolume.ts:66

---

imagesLoader

imagesLoader: IImagesLoader

Inherited from

BaseStreamingImageVolume.imagesLoader

Defined in

packages/core/src/cache/classes/BaseStreamingImageVolume.ts:55

---

isPreScaled

isPreScaled: boolean = false

Implementation of

IDynamicImageVolume.isPreScaled

Inherited from

BaseStreamingImageVolume.isPreScaled

Defined in

packages/core/src/cache/classes/ImageVolume.ts:39

---

loadStatus

loadStatus: object

load status object for the volume

callbacks

callbacks: (...args) => void[]

cancelled

cancelled: boolean

loaded

loaded: boolean

loading

loading: boolean

Implementation of

IDynamicImageVolume.loadStatus

Inherited from

BaseStreamingImageVolume.loadStatus

Defined in

packages/core/src/cache/classes/BaseStreamingImageVolume.ts:49

---

metadata

metadata: Metadata

volume metadata

Implementation of

IDynamicImageVolume.metadata

Inherited from

BaseStreamingImageVolume.metadata

Defined in

packages/core/src/cache/classes/ImageVolume.ts:46

---

numDimensionGroups

numDimensionGroups: number

Property to store the number of dimension groups.

Deprecated

Implementation of

IDynamicImageVolume.numDimensionGroups

Overrides

BaseStreamingImageVolume.numDimensionGroups

Defined in

packages/core/src/cache/classes/StreamingDynamicImageVolume.ts:24

---

numFrames

numFrames: number

Implementation of

IDynamicImageVolume.numFrames

Inherited from

BaseStreamingImageVolume.numFrames

Defined in

packages/core/src/cache/classes/ImageVolume.ts:102

---

numVoxels

numVoxels: number

volume number of voxels

Implementation of

IDynamicImageVolume.numVoxels

Inherited from

BaseStreamingImageVolume.numVoxels

Defined in

packages/core/src/cache/classes/ImageVolume.ts:64

---

origin

origin: Point3

volume origin, Note this is an opinionated origin for the volume

Implementation of

IDynamicImageVolume.origin

Inherited from

BaseStreamingImageVolume.origin

Defined in

packages/core/src/cache/classes/ImageVolume.ts:48

---

referencedImageIds?

optional referencedImageIds: string[]

optional reference image ids if the volume is derived from a set of images in the image cache

Implementation of

IDynamicImageVolume.referencedImageIds

Inherited from

BaseStreamingImageVolume.referencedImageIds

Defined in

packages/core/src/cache/classes/ImageVolume.ts:74

---

referencedVolumeId?

optional referencedVolumeId: string

optional reference volume id if the volume is derived from another volume

Implementation of

IDynamicImageVolume.referencedVolumeId

Inherited from

BaseStreamingImageVolume.referencedVolumeId

Defined in

packages/core/src/cache/classes/ImageVolume.ts:72

---

reRenderFraction

protected reRenderFraction: number = 2

Inherited from

BaseStreamingImageVolume.reRenderFraction

Defined in

packages/core/src/cache/classes/BaseStreamingImageVolume.ts:47

---

reRenderTarget

protected reRenderTarget: number = 0

Inherited from

BaseStreamingImageVolume.reRenderTarget

Defined in

packages/core/src/cache/classes/BaseStreamingImageVolume.ts:46

---

scaling?

optional scaling: object

volume scaling parameters if it contains scaled data

PT?

optional PT: object

PT.SUVbsaFactor?

optional SUVbsaFactor: number

PT.suvbwToSuvbsa?

optional suvbwToSuvbsa: number

PT.suvbwToSuvlbm?

optional suvbwToSuvlbm: number

PT.SUVlbmFactor?

optional SUVlbmFactor: number

Implementation of

IDynamicImageVolume.scaling

Inherited from

BaseStreamingImageVolume.scaling

Defined in

packages/core/src/cache/classes/ImageVolume.ts:51

---

spacing

spacing: Point3

volume spacing in 3d world space

Implementation of

IDynamicImageVolume.spacing

Inherited from

BaseStreamingImageVolume.spacing

Defined in

packages/core/src/cache/classes/ImageVolume.ts:62

---

suppressWarnings

suppressWarnings: boolean

Implementation of

IDynamicImageVolume.suppressWarnings

Inherited from

BaseStreamingImageVolume.suppressWarnings

Defined in

packages/core/src/cache/classes/ImageVolume.ts:103

---

totalNumFrames

protected totalNumFrames: number

volume scalar data 3D or 4D

Implementation of

IDynamicImageVolume.totalNumFrames

Inherited from

BaseStreamingImageVolume.totalNumFrames

Defined in

packages/core/src/cache/classes/ImageVolume.ts:33

---

volumeId

readonly volumeId: string

Read-only unique identifier for the volume

Implementation of

IDynamicImageVolume.volumeId

Inherited from

BaseStreamingImageVolume.volumeId

Defined in

packages/core/src/cache/classes/ImageVolume.ts:37

---

voxelManager?

optional voxelManager: IVoxelManager<number> | IVoxelManager<RGB>

The new volume model which solely relies on the separate image data and do not cache the volume data at all

Implementation of

IDynamicImageVolume.voxelManager

Inherited from

BaseStreamingImageVolume.voxelManager

Defined in

packages/core/src/cache/classes/ImageVolume.ts:89

---

vtkOpenGLTexture

vtkOpenGLTexture: vtkStreamingOpenGLTexture

open gl texture for the volume

Implementation of

IDynamicImageVolume.vtkOpenGLTexture

Inherited from

BaseStreamingImageVolume.vtkOpenGLTexture

Defined in

packages/core/src/cache/classes/ImageVolume.ts:68

Accessors

dimensionGroupNumber

get dimensionGroupNumber(): number

Returns the active dimension group number (1-based)

set dimensionGroupNumber(dimensionGroupNumber): void

Set the active dimension group number which also updates the active scalar data Dimension group numbers are 1-based.

Parameters

• dimensionGroupNumber: number

The dimension group number to set as active (1-based)

Returns

number

active dimension group number

Implementation of

IDynamicImageVolume.dimensionGroupNumber

Defined in

packages/core/src/cache/classes/StreamingDynamicImageVolume.ts:73

---

imageIds

get imageIds(): string[]

return the image ids for the volume if it is made of separated images

set imageIds(newImageIds): void

updates the image ids

Parameters

• newImageIds: string[]

Returns

string[]

Implementation of

IDynamicImageVolume.imageIds

Inherited from

BaseStreamingImageVolume.imageIds

Defined in

packages/core/src/cache/classes/ImageVolume.ts:213

---

numTimePoints

get numTimePoints(): number

Calculates the number of time points to be the number of dimension groups as a fallback for existing handling.

Deprecated

Returns

number

Implementation of

IDynamicImageVolume.numTimePoints

Inherited from

BaseStreamingImageVolume.numTimePoints

Defined in

packages/core/src/cache/classes/ImageVolume.ts:97

---

sizeInBytes

get sizeInBytes(): number

Returns

number

Implementation of

IDynamicImageVolume.sizeInBytes

Inherited from

BaseStreamingImageVolume.sizeInBytes

Defined in

packages/core/src/cache/classes/ImageVolume.ts:208

---

splittingTag

get splittingTag(): string

Returns the splitting tag used to split the imageIds in the volume

Returns

string

Defined in

packages/core/src/cache/classes/StreamingDynamicImageVolume.ts:137

Methods

callLoadImage()

callLoadImage(imageId, imageIdIndex, options): any

Parameters

• imageId: any

• imageIdIndex: any

• options: any

Returns

any

Inherited from

BaseStreamingImageVolume.callLoadImage

Defined in

packages/core/src/cache/classes/BaseStreamingImageVolume.ts:424

---

callLoadStatusCallback()

protected callLoadStatusCallback(evt): void

Parameters

• evt: any

Returns

void

Inherited from

BaseStreamingImageVolume.callLoadStatusCallback

Defined in

packages/core/src/cache/classes/BaseStreamingImageVolume.ts:118

---

cancelLoading()

cancelLoading(): void

It cancels loading the images of the volume. It sets the loading status to false and filters any imageLoad request in the requestPoolManager that has the same volumeId

Returns

void

Implementation of

IDynamicImageVolume.cancelLoading

Inherited from

BaseStreamingImageVolume.cancelLoading

Defined in

packages/core/src/cache/classes/BaseStreamingImageVolume.ts:85

---

checkDimensionGroupCompletion()

protected checkDimensionGroupCompletion(imageIdIndex): void

Parameters

• imageIdIndex: number

Returns

void

Overrides

BaseStreamingImageVolume.checkDimensionGroupCompletion

Defined in

packages/core/src/cache/classes/StreamingDynamicImageVolume.ts:181

---

clearLoadCallbacks()

clearLoadCallbacks(): void

Clear the load callbacks

Returns

void

Inherited from

BaseStreamingImageVolume.clearLoadCallbacks

Defined in

packages/core/src/cache/classes/BaseStreamingImageVolume.ts:114

---

destroy()

destroy(): void

destroy the volume and make it unusable

Returns

void

Implementation of

IDynamicImageVolume.destroy

Inherited from

BaseStreamingImageVolume.destroy

Defined in

packages/core/src/cache/classes/ImageVolume.ts:275

---

errorCallback()

errorCallback(imageId, permanent, error): void

Parameters

• imageId: any

• permanent: any

• error: any

Returns

void

Inherited from

BaseStreamingImageVolume.errorCallback

Defined in

packages/core/src/cache/classes/BaseStreamingImageVolume.ts:236

---

flatImageIdIndexToDimensionGroupNumber()

flatImageIdIndexToDimensionGroupNumber(flatImageIdIndex): number

Parameters

• flatImageIdIndex: number

Returns

number

Defined in

packages/core/src/cache/classes/StreamingDynamicImageVolume.ts:124

---

flatImageIdIndexToImageIdIndex()

flatImageIdIndexToImageIdIndex(flatImageIdIndex): number

Parameters

• flatImageIdIndex: number

Returns

number

Defined in

packages/core/src/cache/classes/StreamingDynamicImageVolume.ts:130

---

getCornerstoneImages()

getCornerstoneImages(): IImage[]

Returns an array of all the volume's images as Cornerstone images. It iterates over all the imageIds and converts them to Cornerstone images.

Returns

IImage[]

An array of Cornerstone images.

Implementation of

IDynamicImageVolume.getCornerstoneImages

Inherited from

BaseStreamingImageVolume.getCornerstoneImages

Defined in

packages/core/src/cache/classes/ImageVolume.ts:341

---

getCurrentDimensionGroupImageIds()

getCurrentDimensionGroupImageIds(): string[]

Returns

string[]

Defined in

packages/core/src/cache/classes/StreamingDynamicImageVolume.ts:120

---

getImageIdByIndex()

getImageIdByIndex(imageIdIndex): string

Parameters

• imageIdIndex: number

Returns

string

Implementation of

IDynamicImageVolume.getImageIdByIndex

Inherited from

BaseStreamingImageVolume.getImageIdByIndex

Defined in

packages/core/src/cache/classes/ImageVolume.ts:255

---

getImageIdIndex()

getImageIdIndex(imageId): number

return the index of a given imageId

Parameters

• imageId: string

imageId

Returns

number

imageId index

Implementation of

IDynamicImageVolume.getImageIdIndex

Inherited from

BaseStreamingImageVolume.getImageIdIndex

Defined in

packages/core/src/cache/classes/ImageVolume.ts:251

---

getImageIdsRequests()

protected getImageIdsRequests(imageIds, priorityDefault): object[]

Parameters

• imageIds: string[]

• priorityDefault: number

Returns

object[]

Inherited from

BaseStreamingImageVolume.getImageIdsRequests

Defined in

packages/core/src/cache/classes/BaseStreamingImageVolume.ts:464

---

getImageIdsToLoad()

getImageIdsToLoad(): string[]

Returns

string[]

Overrides

BaseStreamingImageVolume.getImageIdsToLoad

Defined in

packages/core/src/cache/classes/StreamingDynamicImageVolume.ts:65

---

getImageLoadRequests()

getImageLoadRequests(priority): object[]

It returns the imageLoad requests for the streaming image volume instance. It involves getting all the imageIds of the volume and creating a success callback which would update the texture (when the image has loaded) and the failure callback. Note that this method does not execute the requests but only returns the requests. It can be used for sorting requests outside of the volume loader itself e.g. loading a single slice of CT, followed by a single slice of PET (interleaved), before moving to the next slice.

Parameters

• priority: number

Returns

object[]

Array of requests including imageId of the request, its imageIdIndex, options (targetBuffer and scaling parameters), and additionalDetails (volumeId)

Overrides

BaseStreamingImageVolume.getImageLoadRequests

Defined in

packages/core/src/cache/classes/StreamingDynamicImageVolume.ts:153

---

getImageURIIndex()

getImageURIIndex(imageURI): number

return the index of a given imageURI

Parameters

• imageURI: string

Returns

number

imageURI index

Implementation of

IDynamicImageVolume.getImageURIIndex

Inherited from

BaseStreamingImageVolume.getImageURIIndex

Defined in

packages/core/src/cache/classes/ImageVolume.ts:264

---

getLoaderImageOptions()

getLoaderImageOptions(imageId): object

Parameters

• imageId: string

Returns

object

additionalDetails

additionalDetails: object

additionalDetails.imageId

imageId: string

additionalDetails.imageIdIndex

imageIdIndex: number

additionalDetails.volumeId

volumeId: string

allowFloatRendering

allowFloatRendering: boolean

preScale

preScale: object

preScale.enabled

enabled: boolean

preScale.scalingParameters

scalingParameters: ScalingParameters

requestType

requestType: RequestType = requestTypeDefault

retrieveOptions

retrieveOptions: any = undefined

targetBuffer

targetBuffer: object

targetBuffer.columns

columns: number = targetCols

targetBuffer.rows

rows: number = targetRows

targetBuffer.type

type: PixelDataTypedArrayString

transferPixelData

transferPixelData: boolean = true

transferSyntaxUID

transferSyntaxUID: any

Inherited from

BaseStreamingImageVolume.getLoaderImageOptions

Defined in

packages/core/src/cache/classes/BaseStreamingImageVolume.ts:327

---

getScalarDataLength()

getScalarDataLength(): number

Returns

number

Implementation of

IDynamicImageVolume.getScalarDataLength

Inherited from

BaseStreamingImageVolume.getScalarDataLength

Defined in

packages/core/src/cache/classes/ImageVolume.ts:309

---

imageIdIndexToFrameIndex()

protected imageIdIndexToFrameIndex(imageIdIndex): number

Converts imageIdIndex into frameIndex which will be the same for 3D volumes but different for 4D volumes. The indices are 0 based.

Parameters

• imageIdIndex: number

Returns

number

Implementation of

IDynamicImageVolume.imageIdIndexToFrameIndex

Inherited from

BaseStreamingImageVolume.imageIdIndexToFrameIndex

Defined in

packages/core/src/cache/classes/ImageVolume.ts:331

---

invalidate()

invalidate(): void

Returns

void

Implementation of

IDynamicImageVolume.invalidate

Inherited from

BaseStreamingImageVolume.invalidate

Defined in

packages/core/src/cache/classes/ImageVolume.ts:285

---

invalidateVolume()

protected invalidateVolume(immediate): void

Parameters

• immediate: boolean

Returns

void

Inherited from

BaseStreamingImageVolume.invalidateVolume

Defined in

packages/core/src/cache/classes/BaseStreamingImageVolume.ts:65

---

isDimensionGroupLoaded()

isDimensionGroupLoaded(dimensionGroupNumber): boolean

Checks if a specific dimension group is fully loaded

Parameters

• dimensionGroupNumber: number

The dimension group number to check (1-based)

Returns

boolean

boolean indicating if the dimension group is fully loaded

Defined in

packages/core/src/cache/classes/StreamingDynamicImageVolume.ts:163

---

isDynamicVolume()

isDynamicVolume(): boolean

return true if it is a 4D volume or false if it is 3D volume

Returns

boolean

Implementation of

IDynamicImageVolume.isDynamicVolume

Inherited from

BaseStreamingImageVolume.isDynamicVolume

Defined in

packages/core/src/cache/classes/ImageVolume.ts:238

---

load()

load(callback): void

It triggers a prefetch for images in the volume.

Parameters

• callback

A callback function to be called when the volume is fully loaded

Returns

void

Implementation of

IDynamicImageVolume.load

Inherited from

BaseStreamingImageVolume.load

Defined in

packages/core/src/cache/classes/BaseStreamingImageVolume.ts:280

---

loadImages()

loadImages(): Promise<boolean>

Retrieves images using the older getImageLoadRequests method to setup all the requests. Ensures compatibility with the custom image loaders.

Returns

Promise<boolean>

Inherited from

BaseStreamingImageVolume.loadImages

Defined in

packages/core/src/cache/classes/BaseStreamingImageVolume.ts:542

---

modified()

modified(): void

Updates the internals of the volume to reflect the changes in the underlying scalar data. This should be called when the scalar data is modified externally

Returns

void

Implementation of

IDynamicImageVolume.modified

Inherited from

BaseStreamingImageVolume.modified

Defined in

packages/core/src/cache/classes/ImageVolume.ts:298

---

removeFromCache()

removeFromCache(): void

Returns

void

Implementation of

IDynamicImageVolume.removeFromCache

Inherited from

BaseStreamingImageVolume.removeFromCache

Defined in

packages/core/src/cache/classes/ImageVolume.ts:305

---

scroll()

scroll(delta): void

Scroll properly to enable looping

Parameters

• delta: number

The amount to scroll

Returns

void

Implementation of

IDynamicImageVolume.scroll

Defined in

packages/core/src/cache/classes/StreamingDynamicImageVolume.ts:108

---

successCallback()

successCallback(imageId, image): void

Parameters

• imageId: string

• image: any

Returns

void

Inherited from

BaseStreamingImageVolume.successCallback

Defined in

packages/core/src/cache/classes/BaseStreamingImageVolume.ts:209

---

updateTextureAndTriggerEvents()

protected updateTextureAndTriggerEvents(imageIdIndex, imageId, imageQualityStatus): void

Parameters

• imageIdIndex: any

• imageId: any

• imageQualityStatus: ImageQualityStatus = ImageQualityStatus.FULL_RESOLUTION

Returns

void

Inherited from

BaseStreamingImageVolume.updateTextureAndTriggerEvents

Defined in

packages/core/src/cache/classes/BaseStreamingImageVolume.ts:148