Class: ImageVolume

The base class for volume data. It includes the volume metadata and the volume data along with the loading status.

Constructors

new ImageVolume()

new ImageVolume(props): ImageVolume

Parameters

• props: ImageVolumeProps

Returns

ImageVolume

Defined in

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

Properties

additionalDetails?

optional additionalDetails: Record<string, unknown>

Property to store additional information

Defined in

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

---

cancelLoading()

cancelLoading: () => void

Returns

void

Defined in

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

---

cornerstoneImageMetaData

protected cornerstoneImageMetaData: any = null

Defined in

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

---

dataType?

optional dataType: PixelDataTypedArrayString

Defined in

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

---

dimensions

dimensions: Point3

Dimensions of the volume

Defined in

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

---

direction

direction: Mat3

volume direction in world space

Defined in

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

---

hasPixelSpacing

hasPixelSpacing: boolean

whether the metadata for the pixel spacing is not undefined

Defined in

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

---

imageData?

optional imageData: vtkImageData

volume image data

Defined in

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

---

isPreScaled

isPreScaled: boolean = false

Defined in

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

---

loadStatus?

optional loadStatus: Record<string, unknown>

load status object for the volume

Defined in

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

---

metadata

metadata: Metadata

volume metadata

Defined in

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

---

numDimensionGroups

numDimensionGroups: number

Property to store the number of dimension groups.

Deprecated

Defined in

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

---

numFrames

numFrames: number

Defined in

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

---

numVoxels

numVoxels: number

volume number of voxels

Defined in

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

---

origin

origin: Point3

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

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

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

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

Defined in

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

---

spacing

spacing: Point3

volume spacing in 3d world space

Defined in

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

---

suppressWarnings

suppressWarnings: boolean

Defined in

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

---

totalNumFrames

protected totalNumFrames: number

volume scalar data 3D or 4D

Defined in

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

---

volumeId

readonly volumeId: string

Read-only unique identifier for the volume

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

Defined in

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

---

vtkOpenGLTexture

vtkOpenGLTexture: vtkStreamingOpenGLTexture

open gl texture for the volume

Defined in

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

Accessors

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

Defined in

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

---

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

Defined in

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

---

sizeInBytes

get sizeInBytes(): number

Returns

number

Defined in

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

Methods

destroy()

destroy(): void

destroy the volume and make it unusable

Returns

void

Defined in

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

---

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.

Defined in

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

---

getImageIdByIndex()

getImageIdByIndex(imageIdIndex): string

Parameters

• imageIdIndex: number

Returns

string

Defined in

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

---

getImageIdIndex()

getImageIdIndex(imageId): number

return the index of a given imageId

Parameters

• imageId: string

imageId

Returns

number

imageId index

Defined in

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

---

getImageURIIndex()

getImageURIIndex(imageURI): number

return the index of a given imageURI

Parameters

• imageURI: string

Returns

number

imageURI index

Defined in

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

---

getScalarDataLength()

getScalarDataLength(): number

Returns

number

Defined in

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

---

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

Defined in

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

---

invalidate()

invalidate(): void

Returns

void

Defined in

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

---

isDynamicVolume()

isDynamicVolume(): boolean

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

Returns

boolean

Defined in

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

---

load()

load(callback?): void

Parameters

• callback?

Returns

void

Defined in

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

---

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

Defined in

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

---

removeFromCache()

removeFromCache(): void

Returns

void

Defined in

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