ImageVolume

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

Hierarchy

• ImageVolume
  • IStreamingImageVolume

Implements

• IImageVolume

Index

Constructors

• constructor

Properties

• cancelLoading
• dimensions
• direction
• hasPixelSpacing
• imageData
• isPrescaled
• loadStatus
• metadata
• numVoxels
• origin
• referencedVolumeId
• scaling
• sizeInBytes
• spacing
• volumeId
• vtkOpenGLTexture

Accessors

• imageIds

Methods

• destroy
• getImageIdIndex
• getImageURIIndex
• getScalarData
• isDynamicVolume

Constructors

constructor

• new ImageVolume(props: IVolume): ImageVolume

• Parameters

  • props: IVolume

  Returns ImageVolume

Properties

cancelLoading

cancelLoading: () => void

Implementation of IImageVolume.cancelLoading

Type declaration

• • (): void

  • Returns void

dimensions

dimensions: Point3

Implementation of IImageVolume.dimensions

Dimensions of the volume

direction

direction: Mat3

Implementation of IImageVolume.direction

volume direction in world space

hasPixelSpacing

hasPixelSpacing: boolean

Implementation of IImageVolume.hasPixelSpacing

whether the metadata for the pixel spacing is not undefined

optionalimageData

imageData?: vtkImageData

Implementation of IImageVolume.imageData

volume image data

isPrescaled

isPrescaled: boolean = false

Implementation of IImageVolume.isPrescaled

Whether preScaling has been performed on the volume

optionalloadStatus

loadStatus?: Record<string, any>

Implementation of IImageVolume.loadStatus

load status object for the volume

metadata

metadata: Metadata

Implementation of IImageVolume.metadata

volume metadata

numVoxels

numVoxels: number

Implementation of IImageVolume.numVoxels

volume number of voxels

origin

origin: Point3

Implementation of IImageVolume.origin

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

optionalreferencedVolumeId

referencedVolumeId?: string

Implementation of IImageVolume.referencedVolumeId

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

optionalscaling

scaling?: { PET?: { SUVbsaFactor?: number; SUVlbmFactor?: number; suvbwToSuvbsa?: number; suvbwToSuvlbm?: number } }

Implementation of IImageVolume.scaling

volume scaling parameters if it contains scaled data

---

Type declaration

• optionalPET?: { SUVbsaFactor?: number; SUVlbmFactor?: number; suvbwToSuvbsa?: number; suvbwToSuvlbm?: number }

  • optionalSUVbsaFactor?: number

  • optionalSUVlbmFactor?: number

  • optionalsuvbwToSuvbsa?: number

  • optionalsuvbwToSuvlbm?: number

optionalsizeInBytes

sizeInBytes?: number

Implementation of IImageVolume.sizeInBytes

volume size in bytes

spacing

spacing: Point3

Implementation of IImageVolume.spacing

volume spacing in 3d world space

readonlyvolumeId

volumeId: string

Implementation of IImageVolume.volumeId

Read-only unique identifier for the volume

vtkOpenGLTexture

vtkOpenGLTexture: any

Implementation of IImageVolume.vtkOpenGLTexture

open gl texture for the volume

Accessors

publicimageIds

• get imageIds(): string[]
• set imageIds(newImageIds: string[]): void

• Implementation of IImageVolume.imageIds

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

  ---

  Returns string[]

• Implementation of IImageVolume.imageIds

  updates the image ids

  ---

  Parameters

  • newImageIds: string[]

  Returns void

Methods

destroy

• destroy(): void

• Implementation of IImageVolume.destroy

  destroy the volume and make it unusable

  ---

  Returns void

publicgetImageIdIndex

• getImageIdIndex(imageId: string): number

• Implementation of IImageVolume.getImageIdIndex

  return the index of a given imageId

  ---

  Parameters

  • imageId: string

    imageId

  Returns number

  imageId index

publicgetImageURIIndex

• getImageURIIndex(imageURI: string): number

• Implementation of IImageVolume.getImageURIIndex

  return the index of a given imageURI

  ---

  Parameters

  • imageURI: string

  Returns number

  imageURI index

publicgetScalarData

• getScalarData(): VolumeScalarData

• Implementation of IImageVolume.getScalarData

  Return the scalar data for 3D volumes or the active scalar data (current time point) for 4D volumes

  ---

  Returns VolumeScalarData

publicisDynamicVolume

• isDynamicVolume(): boolean

• Implementation of IImageVolume.isDynamicVolume

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

  ---

  Returns boolean