Skip to main content

Interface: ImageVolumeProps

ImageVolume which is considered a special case of a Volume, which is constructed out of set of images (imageIds). Unlike Volume which can be constructed from any type of volumetric data, such as nifti or nrrd,

Extends​

Properties​

additionalDetails?​

optional additionalDetails: Record<string, unknown>

Property to store additional information

Inherited from​

VolumeProps.additionalDetails

Defined in​

packages/core/src/types/VolumeProps.ts:56

dataType​

dataType: PixelDataTypedArrayString

Inherited from​

VolumeProps.dataType

Defined in​

packages/core/src/types/VolumeProps.ts:45

dimensions​

dimensions: Point3

Dimensions of the volume (width, height, depth)

Inherited from​

VolumeProps.dimensions

Defined in​

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

direction​

direction: Mat3

Direction of the volume in world space

Inherited from​

VolumeProps.direction

Defined in​

packages/core/src/types/VolumeProps.ts:35

imageData?​

optional imageData: vtkImageData

Image data representing the volume

Inherited from​

VolumeProps.imageData

Defined in​

packages/core/src/types/VolumeProps.ts:38

imageIds​

imageIds: string[]

imageIds of the volume (if it is built of separate imageIds)

Defined in​

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

metadata​

metadata: Metadata

Metadata describing the volume

Inherited from​

VolumeProps.metadata

Defined in​

packages/core/src/types/VolumeProps.ts:23

numberOfComponents?​

optional numberOfComponents: number

Number of components for scalar data in the volume

Inherited from​

VolumeProps.numberOfComponents

Defined in​

packages/core/src/types/VolumeProps.ts:72

origin​

origin: Point3

Origin point of the volume in world space

Inherited from​

VolumeProps.origin

Defined in​

packages/core/src/types/VolumeProps.ts:32

referencedImageIds?​

optional referencedImageIds: string[]

if the volume is created from a stack, the imageIds of the stack

Defined in​

packages/core/src/types/ImageVolumeProps.ts:12

referencedVolumeId?​

optional referencedVolumeId: string

Optional ID of a referenced volume if this volume is derived from another

Inherited from​

VolumeProps.referencedVolumeId

Defined in​

packages/core/src/types/VolumeProps.ts:69

scalarData?​

optional scalarData: PixelDataTypedArray | PixelDataTypedArray[]

To be deprecated scalarData and sizeInBytes which is the old model of allocating the volume data and caching it in the volume object

Inherited from​

VolumeProps.scalarData

Defined in​

packages/core/src/types/VolumeProps.ts:52

scaling?​

optional scaling: object

Scaling parameters if the volume contains scaled data (optional)

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​

VolumeProps.scaling

Defined in​

packages/core/src/types/VolumeProps.ts:59

sizeInBytes?​

optional sizeInBytes: number

Inherited from​

VolumeProps.sizeInBytes

Defined in​

packages/core/src/types/VolumeProps.ts:53

spacing​

spacing: Point3

Spacing between volume points in 3D world space

Inherited from​

VolumeProps.spacing

Defined in​

packages/core/src/types/VolumeProps.ts:29

volumeId​

volumeId: string

Unique identifier for the volume

Inherited from​

VolumeProps.volumeId

Defined in​

packages/core/src/types/VolumeProps.ts:20

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​

VolumeProps.voxelManager

Defined in​

packages/core/src/types/VolumeProps.ts:44