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
Defined in
packages/core/src/cache/classes/ImageVolume.ts:105
Properties
additionalDetails?
optionaladditionalDetails:Record<string,unknown>
Property to store additional information
Defined in
packages/core/src/cache/classes/ImageVolume.ts:78
cancelLoading()
cancelLoading: () =>
void
Returns
void
Defined in
packages/core/src/cache/classes/ImageVolume.ts:235
cornerstoneImageMetaData
protectedcornerstoneImageMetaData:any=null
Defined in
packages/core/src/cache/classes/ImageVolume.ts:34
dataType?
optionaldataType:PixelDataTypedArrayString
Defined in
packages/core/src/cache/classes/ImageVolume.ts:90
dimensions
dimensions:
Point3
Dimensions of the volume
Defined in
packages/core/src/cache/classes/ImageVolume.ts:42
direction
direction:
Mat3
volume direction in world space
Defined in
packages/core/src/cache/classes/ImageVolume.ts:44
hasPixelSpacing
hasPixelSpacing:
boolean
whether the metadata for the pixel spacing is not undefined
Defined in
packages/core/src/cache/classes/ImageVolume.ts:76
imageData?
optionalimageData:vtkImageData
volume image data
Defined in
packages/core/src/cache/classes/ImageVolume.ts:66
isPreScaled
isPreScaled:
boolean=false
Defined in
packages/core/src/cache/classes/ImageVolume.ts:39
loadStatus?
optionalloadStatus:Record<string,unknown>
load status object for the volume
Defined in
packages/core/src/cache/classes/ImageVolume.ts:70
metadata
metadata:
Metadata
volume metadata
Defined in
packages/core/src/cache/classes/ImageVolume.ts:46
numDimensionGroups
numDimensionGroups:
number
Property to store the number of dimension groups.
Deprecated
Defined in
packages/core/src/cache/classes/ImageVolume.ts:83
numFrames
numFrames:
number
Defined in
packages/core/src/cache/classes/ImageVolume.ts:102
numVoxels
numVoxels:
number
volume number of voxels
Defined in
packages/core/src/cache/classes/ImageVolume.ts:64
origin
origin:
Point3
volume origin, Note this is an opinionated origin for the volume
Defined in
packages/core/src/cache/classes/ImageVolume.ts:48
referencedImageIds?
optionalreferencedImageIds: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:74
referencedVolumeId?
optionalreferencedVolumeId:string
optional reference volume id if the volume is derived from another volume
Defined in
packages/core/src/cache/classes/ImageVolume.ts:72
scaling?
optionalscaling:object
volume scaling parameters if it contains scaled data
PT?
optionalPT:object
PT.SUVbsaFactor?
optionalSUVbsaFactor:number
PT.suvbwToSuvbsa?
optionalsuvbwToSuvbsa:number
PT.suvbwToSuvlbm?
optionalsuvbwToSuvlbm:number
PT.SUVlbmFactor?
optionalSUVlbmFactor:number
Defined in
packages/core/src/cache/classes/ImageVolume.ts:51
spacing
spacing:
Point3
volume spacing in 3d world space
Defined in
packages/core/src/cache/classes/ImageVolume.ts:62
suppressWarnings
suppressWarnings:
boolean
Defined in
packages/core/src/cache/classes/ImageVolume.ts:103
totalNumFrames
protectedtotalNumFrames:number
volume scalar data 3D or 4D
Defined in
packages/core/src/cache/classes/ImageVolume.ts:33
volumeId
readonlyvolumeId:string
Read-only unique identifier for the volume
Defined in
packages/core/src/cache/classes/ImageVolume.ts:37
voxelManager?
optionalvoxelManager: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:89
vtkOpenGLTexture
vtkOpenGLTexture:
vtkStreamingOpenGLTexture
open gl texture for the volume
Defined in
packages/core/src/cache/classes/ImageVolume.ts:68
Accessors
imageIds
getimageIds():string[]
return the image ids for the volume if it is made of separated images
setimageIds(newImageIds):void
updates the image ids
Parameters
• newImageIds: string[]
Returns
string[]
Defined in
packages/core/src/cache/classes/ImageVolume.ts:213
numTimePoints
getnumTimePoints():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:97
sizeInBytes
getsizeInBytes():number
Returns
number
Defined in
packages/core/src/cache/classes/ImageVolume.ts:208
Methods
destroy()
destroy():
void
destroy the volume and make it unusable
Returns
void
Defined in
packages/core/src/cache/classes/ImageVolume.ts:275
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:341
getImageIdByIndex()
getImageIdByIndex(
imageIdIndex):string
Parameters
• imageIdIndex: number
Returns
string
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
Defined in
packages/core/src/cache/classes/ImageVolume.ts:251
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:264
getScalarDataLength()
getScalarDataLength():
number
Returns
number
Defined in
packages/core/src/cache/classes/ImageVolume.ts:309
imageIdIndexToFrameIndex()
protectedimageIdIndexToFrameIndex(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:331
invalidate()
invalidate():
void
Returns
void
Defined in
packages/core/src/cache/classes/ImageVolume.ts:285
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:238
load()
load(
callback?):void
Parameters
• callback?
Returns
void
Defined in
packages/core/src/cache/classes/ImageVolume.ts:268
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:298
removeFromCache()
removeFromCache():
void
Returns
void