Skip to main content

Function: createLocalVolume()

createLocalVolume(volumeId, options): IImageVolume

Creates and cache a volume based on a set of provided properties including dimensions, spacing, origin, direction, metadata, scalarData. It should be noted that scalarData should be provided for this function to work. If a volume with the same Id exists in the cache it returns it immediately.

Parameters​

• volumeId: string

Id of the generated volume

• options: LocalVolumeOptions = ...

Object containing scalarData, metadata, dimensions, spacing, origin, direction

Returns​

IImageVolume

ImageVolume

Defined in​

packages/core/src/loaders/volumeLoader.ts:355