Skip to main content

Function: updateVolumeFromTimeData()

updateVolumeFromTimeData(dynamicVolume, operation, options): void

Updates the scalar data for a target volume based on a series of dimension groups from a 4D volume, performing AVERAGE, SUM or SUBTRACT operations.

Parameters​

• dynamicVolume: IDynamicImageVolume

volume to compute dimension group data from

• operation: GenerateImageType

operation to perform on dimension group data, operations include SUM, AVERAGE, and SUBTRACT (can only be used with 2 dimension groups provided)

• options

additional options for the operation

• options.dimensionGroupNumbers?: number[]

an array of dimension group numbers to perform the operation on (1-based), if left empty, all dimension groups will be used

• options.frameNumbers?: number[]

• options.targetVolume: ImageVolume

the volume to update with the result of the operation

Returns​

void

Deprecated​

Use dimensionGroupNumbers instead

Throws​

If no target volume is provided or if the operation is not supported

Defined in​

tools/src/utilities/dynamicVolume/generateImageFromTimeData.ts:160