Interface: IDynamicImageVolume

Interface for Dynamic Image Volume that supports dimension group-based operations

Extends

• IImageVolume

Properties

additionalDetails?

optional additionalDetails: Record<string, unknown>

Property to store additional information

Inherited from

IImageVolume.additionalDetails

Defined in

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

---

cancelLoading()

cancelLoading: () => void

Returns

void

Inherited from

IImageVolume.cancelLoading

Defined in

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

---

cornerstoneImageMetaData

protected cornerstoneImageMetaData: any = null

Inherited from

IImageVolume.cornerstoneImageMetaData

Defined in

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

---

dataType?

optional dataType: PixelDataTypedArrayString

Inherited from

IImageVolume.dataType

Defined in

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

---

dimensions

dimensions: Point3

Dimensions of the volume

Inherited from

IImageVolume.dimensions

Defined in

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

---

direction

direction: Mat3

volume direction in world space

Inherited from

IImageVolume.direction

Defined in

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

---

hasPixelSpacing

hasPixelSpacing: boolean

whether the metadata for the pixel spacing is not undefined

Inherited from

IImageVolume.hasPixelSpacing

Defined in

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

---

imageData?

optional imageData: vtkImageData

volume image data

Inherited from

IImageVolume.imageData

Defined in

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

---

isPreScaled

isPreScaled: boolean = false

Inherited from

IImageVolume.isPreScaled

Defined in

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

---

loadStatus?

optional loadStatus: Record<string, unknown>

load status object for the volume

Inherited from

IImageVolume.loadStatus

Defined in

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

---

metadata

metadata: Metadata

volume metadata

Inherited from

IImageVolume.metadata

Defined in

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

---

numFrames

numFrames: number

Inherited from

IImageVolume.numFrames

Defined in

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

---

numVoxels

numVoxels: number

volume number of voxels

Inherited from

IImageVolume.numVoxels

Defined in

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

---

origin

origin: Point3

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

Inherited from

IImageVolume.origin

Defined in

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

---

referencedImageIds?

optional referencedImageIds: string[]

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

Inherited from

IImageVolume.referencedImageIds

Defined in

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

---

referencedVolumeId?

optional referencedVolumeId: string

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

Inherited from

IImageVolume.referencedVolumeId

Defined in

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

---

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

Inherited from

IImageVolume.scaling

Defined in

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

---

spacing

spacing: Point3

volume spacing in 3d world space

Inherited from

IImageVolume.spacing

Defined in

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

---

totalNumFrames

protected totalNumFrames: number

volume scalar data 3D or 4D

Inherited from

IImageVolume.totalNumFrames

Defined in

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

---

volumeId

readonly volumeId: string

Read-only unique identifier for the volume

Inherited from

IImageVolume.volumeId

Defined in

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

---

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

Inherited from

IImageVolume.voxelManager

Defined in

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

---

vtkOpenGLTexture

vtkOpenGLTexture: vtkStreamingOpenGLTexture

open gl texture for the volume

Inherited from

IImageVolume.vtkOpenGLTexture

Defined in

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

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

Returns

number

Defined in

packages/core/src/types/IDynamicImageVolume.ts:10

---

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[]

Inherited from

IImageVolume.imageIds

Defined in

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

---

numDimensionGroups

get numDimensionGroups(): number

Number of dimension groups in the volume

Returns

number

Defined in

packages/core/src/types/IDynamicImageVolume.ts:21

---

numTimePoints

get numTimePoints(): number

Deprecated

Use numDimensionGroups instead

Returns

number

Overrides

IImageVolume.numTimePoints

Defined in

packages/core/src/types/IDynamicImageVolume.ts:36

---

sizeInBytes

get sizeInBytes(): number

Returns

number

Inherited from

IImageVolume.sizeInBytes

Defined in

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

---

timePointIndex

get timePointIndex(): number

Deprecated

Use dimensionGroupNumber instead. timePointIndex is zero-based while dimensionGroupNumber starts at 1.

set timePointIndex(timePointIndex): void

Deprecated

Use dimensionGroupNumber instead. timePointIndex is zero-based while dimensionGroupNumber starts at 1.

Parameters

• timePointIndex: number

Returns

number

Defined in

packages/core/src/types/IDynamicImageVolume.ts:26

Methods

destroy()

destroy(): void

destroy the volume and make it unusable

Returns

void

Inherited from

IImageVolume.destroy

Defined in

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

---

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.

Inherited from

IImageVolume.getCornerstoneImages

Defined in

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

---

getImageIdByIndex()

getImageIdByIndex(imageIdIndex): string

Parameters

• imageIdIndex: number

Returns

string

Inherited from

IImageVolume.getImageIdByIndex

Defined in

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

---

getImageIdIndex()

getImageIdIndex(imageId): number

return the index of a given imageId

Parameters

• imageId: string

imageId

Returns

number

imageId index

Inherited from

IImageVolume.getImageIdIndex

Defined in

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

---

getImageURIIndex()

getImageURIIndex(imageURI): number

return the index of a given imageURI

Parameters

• imageURI: string

Returns

number

imageURI index

Inherited from

IImageVolume.getImageURIIndex

Defined in

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

---

getScalarDataLength()

getScalarDataLength(): number

Returns

number

Inherited from

IImageVolume.getScalarDataLength

Defined in

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

---

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

Inherited from

IImageVolume.imageIdIndexToFrameIndex

Defined in

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

---

invalidate()

invalidate(): void

Returns

void

Inherited from

IImageVolume.invalidate

Defined in

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

---

isDynamicVolume()

isDynamicVolume(): boolean

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

Returns

boolean

Inherited from

IImageVolume.isDynamicVolume

Defined in

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

---

load()

load(callback?): void

Parameters

• callback?

Returns

void

Inherited from

IImageVolume.load

Defined in

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

---

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

Inherited from

IImageVolume.modified

Defined in

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

---

removeFromCache()

removeFromCache(): void

Returns

void

Inherited from

IImageVolume.removeFromCache

Defined in

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

---

scroll()

scroll(delta): void

Scroll through dimension groups, handling wrapping at start/end

Parameters

• delta: number

The number of dimension groups to scroll by (positive or negative)

Returns

void

Defined in

packages/core/src/types/IDynamicImageVolume.ts:42