Skip to main content

Interface: VolumeProps

Properties required to instantiate a Volume object. This includes all the necessary data and metadata to define a volume in 3D/4D space.

Extended by​

Properties​

additionalDetails?​

optional additionalDetails: Record<string, unknown>

Property to store additional information

Defined in​

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

dataType​

dataType: PixelDataTypedArrayString

Defined in​

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

dimensions​

dimensions: Point3

Dimensions of the volume (width, height, depth)

Defined in​

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

direction​

direction: Mat3

Direction of the volume in world space

Defined in​

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

imageData?​

optional imageData: vtkImageData

Image data representing the volume

Defined in​

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

metadata​

metadata: Metadata

Metadata describing the volume

Defined in​

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

numberOfComponents?​

optional numberOfComponents: number

Number of components for scalar data in the volume

Defined in​

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

origin​

origin: Point3

Origin point of the volume in world space

Defined in​

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

referencedVolumeId?​

optional referencedVolumeId: string

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

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

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

Defined in​

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

sizeInBytes?​

optional sizeInBytes: number

Defined in​

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

spacing​

spacing: Point3

Spacing between volume points in 3D world space

Defined in​

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

volumeId​

volumeId: string

Unique identifier for the volume

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

Defined in​

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