Class Volume

Describes the information about a single volume.

Hierarchy

Volume

Index

Constructors

constructor

Properties

Methods

Constructors

Private constructor

new Volume(entity: RawDataEntity, inspectionPlanItemId: string | undefined, measurementId: string | undefined, key: number, name: string, size: VolumeVector, resolution: VolumeVector, properties: PlotPropertyCollection): Volume

- Defined in data/volume.ts:138
Parameters
- entity: RawDataEntity
- inspectionPlanItemId: string | undefined
- measurementId: string | undefined
- key: number
- name: string
- size: VolumeVector
- resolution: VolumeVector
- properties: PlotPropertyCollection
Returns Volume

Properties

entity

entity: RawDataEntity

The entity type to which the volume is attached.

Optional Private inspectionPlanItemId

inspectionPlanItemId: string

key

key: number

Gets the key of this item.

Optional Private measurementId

measurementId: string

name

name: string

Gets the filename.

properties

properties: PlotPropertyCollection

Gets a collection of user data that is attached to this volume.

resolution

resolution: VolumeVector

Gets the size of a single voxel of the volume in mm.

size

size: VolumeVector

Gets the size of the volume in voxels.

Methods

Private getInspectionGuid

getInspectionGuid(): string | undefined

- Defined in data/volume.ts:158
Returns string | undefined

Private getMeasurementGuid

getMeasurementGuid(): string | undefined

- Defined in data/volume.ts:168
Returns string | undefined

getSlice

getSlice(direction: VolumeDirection, index: number): HostBinary | undefined

- Defined in data/volume.ts:194
Returns the slice with the specified index in the specified direction as HostBinary.

Parameters
- direction: VolumeDirection
- index: number
Returns HostBinary | undefined

getSliceBuffer

getSliceBuffer(direction: VolumeDirection, index: number): Buffer | undefined

- Defined in data/volume.ts:178
Returns the slice with the specified index in the specified direction as [[Buffer]].

Parameters
- direction: VolumeDirection
- index: number
Returns Buffer | undefined

Generated using TypeDoc