Interface: IStreamingImageVolume
Cornerstone StreamingImageVolume which extends ImageVolume
Extends
Properties
additionalDetails?
optionaladditionalDetails:Record<string,unknown>
Property to store additional information
Inherited from
IImageVolume.additionalDetails
Defined in
packages/core/src/cache/classes/ImageVolume.ts:78
cancelLoading()
cancelLoading: () =>
void
Returns
void
Inherited from
IImageVolume.cancelLoading
Defined in
packages/core/src/cache/classes/ImageVolume.ts:230
cornerstoneImageMetaData
protectedcornerstoneImageMetaData:any=null
Inherited from
IImageVolume.cornerstoneImageMetaData
Defined in
packages/core/src/cache/classes/ImageVolume.ts:34
dataType?
optionaldataType:PixelDataTypedArrayString
Inherited from
IImageVolume.dataType
Defined in
packages/core/src/cache/classes/ImageVolume.ts:90
dimensions
dimensions:
Point3
Dimensions of the volume
Inherited from
IImageVolume.dimensions
Defined in
packages/core/src/cache/classes/ImageVolume.ts:42
direction
direction:
Mat3
volume direction in world space
Inherited from
IImageVolume.direction
Defined in
packages/core/src/cache/classes/ImageVolume.ts:44
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:76
imageData?
optionalimageData:vtkImageData
volume image data
Inherited from
IImageVolume.imageData
Defined in
packages/core/src/cache/classes/ImageVolume.ts:66
isPreScaled
isPreScaled:
boolean=false
Inherited from
IImageVolume.isPreScaled
Defined in
packages/core/src/cache/classes/ImageVolume.ts:39
loadStatus?
optionalloadStatus:Record<string,unknown>
load status object for the volume
Inherited from
IImageVolume.loadStatus
Defined in
packages/core/src/cache/classes/ImageVolume.ts:70
metadata
metadata:
Metadata
volume metadata
Inherited from
IImageVolume.metadata
Defined in
packages/core/src/cache/classes/ImageVolume.ts:46
numDimensionGroups
numDimensionGroups:
number
Property to store the number of dimension groups.
Deprecated
Inherited from
IImageVolume.numDimensionGroups
Defined in
packages/core/src/cache/classes/ImageVolume.ts:83
numFrames
numFrames:
number
Inherited from
IImageVolume.numFrames
Defined in
packages/core/src/cache/classes/ImageVolume.ts:102
numVoxels
numVoxels:
number
volume number of voxels
Inherited from
IImageVolume.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
Inherited from
IImageVolume.origin
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
Inherited from
IImageVolume.referencedImageIds
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
Inherited from
IImageVolume.referencedVolumeId
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
Inherited from
IImageVolume.scaling
Defined in
packages/core/src/cache/classes/ImageVolume.ts:51
spacing
spacing:
Point3
volume spacing in 3d world space
Inherited from
IImageVolume.spacing
Defined in
packages/core/src/cache/classes/ImageVolume.ts:62
suppressWarnings
suppressWarnings:
boolean
Inherited from
IImageVolume.suppressWarnings
Defined in
packages/core/src/cache/classes/ImageVolume.ts:103
totalNumFrames
protectedtotalNumFrames:number
volume scalar data 3D or 4D
Inherited from
IImageVolume.totalNumFrames
Defined in
packages/core/src/cache/classes/ImageVolume.ts:33
volumeId
readonlyvolumeId:string
Read-only unique identifier for the volume
Inherited from
IImageVolume.volumeId
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
Inherited from
IImageVolume.voxelManager
Defined in
packages/core/src/cache/classes/ImageVolume.ts:89
vtkOpenGLTexture
vtkOpenGLTexture:
vtkStreamingOpenGLTexture
open gl texture for the volume
Inherited from
IImageVolume.vtkOpenGLTexture
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[]
Inherited from
IImageVolume.imageIds
Defined in
packages/core/src/cache/classes/ImageVolume.ts:208
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
Inherited from
IImageVolume.numTimePoints
Defined in
packages/core/src/cache/classes/ImageVolume.ts:97
sizeInBytes
getsizeInBytes():number
Returns
number
Inherited from
IImageVolume.sizeInBytes
Defined in
packages/core/src/cache/classes/ImageVolume.ts:203
Methods
clearLoadCallbacks()
clearLoadCallbacks():
void
method to load all the loading requests
Returns
void
Defined in
packages/core/src/types/IStreamingImageVolume.ts:9
decache()
decache(
completelyRemove?):void
method to decache the volume from cache
Parameters
• completelyRemove?: boolean
Returns
void
Defined in
packages/core/src/types/IStreamingImageVolume.ts:11
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:270
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:336
getImageIdByIndex()
getImageIdByIndex(
imageIdIndex):string
Parameters
• imageIdIndex: number
Returns
string
Inherited from
IImageVolume.getImageIdByIndex
Defined in
packages/core/src/cache/classes/ImageVolume.ts:250
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:246
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:259
getScalarDataLength()
getScalarDataLength():
number
Returns
number
Inherited from
IImageVolume.getScalarDataLength
Defined in
packages/core/src/cache/classes/ImageVolume.ts:304
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
Inherited from
IImageVolume.imageIdIndexToFrameIndex
Defined in
packages/core/src/cache/classes/ImageVolume.ts:326
invalidate()
invalidate():
void
Returns
void
Inherited from
IImageVolume.invalidate
Defined in
packages/core/src/cache/classes/ImageVolume.ts:280
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:233
load()
load():
void
Returns
void
Overrides
IImageVolume.load
Defined in
packages/core/src/types/IStreamingImageVolume.ts:7
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:293
removeFromCache()
removeFromCache():
void
Returns
void
Inherited from
IImageVolume.removeFromCache