DisplayOptions3d
Configures the display options for 3D volume rendering of images.
Window/level parameters are defined in original pixel value domain (e.g. Hounsfield Units). Conversion of pixel values to display intensities is performed using the LINEAR_EXACT VOI LUT function as described in section C.11.2.1.3.2 of the DICOM standard.
See
http://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.11.2.html#sect_C.11.2.1.3
Extends
Properties
Methods
| Method | Description |
|---|---|
| transferFunctionPresetNames() | Returns the names of the available 3D transfer-function presets. |
| applyTransferFunctionPreset() | Applies a 3D transfer-function preset. |
| onChanged() | Fires when the display options change. |
| state() | Returns the current configuration of the 3D display options as JS object. |
| stateSchema() | |
| setState() | Configures the 3D display options from the given JS object. |
| transferFunction() | Returns the transfer function used for rendering. |
Inherited from ClassHandle
| Method | Description |
|---|---|
| isAliasOf() | Returns true if this handle and other alias the same underlying C++ object. |
| delete() | Releases this JavaScript handle. |
| deleteLater() | Schedules this handle for deferred deletion and returns this handle. |
| isDeleted() | Returns true if this handle has already been deleted. |
| [dispose]() | Releases this handle when the enclosing scope exits, so a handle can be declared with using instead of calling delete() later manually. |
| clone() | Returns a new JavaScript handle aliasing the same underlying C++ object. |
transferFunctionPresetNames()
transferFunctionPresetNames(): string[];Returns the names of the available 3D transfer-function presets.
Returns
string[]
applyTransferFunctionPreset()
applyTransferFunctionPreset(name: EmbindString, data: SharedImageSet): boolean;Applies a 3D transfer-function preset.
Parameters
| Parameter | Type | Description |
|---|---|---|
name | EmbindString | Must be one of the names returned by DisplayOptions3d#transferFunctionPresetNames. |
data | SharedImageSet | Image data used to derive data-dependent presets. |
Returns
boolean
Whether the preset was found and applied.
onChanged()
onChanged(callback: (options: DisplayOptions3d) => void): () => void;Fires when the display options change.
Parameters
| Parameter | Type |
|---|---|
callback | (options: DisplayOptions3d) => void |
Returns
Unsubscribe function.
() => void
state()
state(): Record<string, unknown>;Returns the current configuration of the 3D display options as JS object.
Returns
Record<string, unknown>
stateSchema()
stateSchema(): Record<string, unknown>;Returns
Record<string, unknown>
setState()
setState(state: Record<string, unknown>): boolean;Configures the 3D display options from the given JS object.
Parameters
| Parameter | Type |
|---|---|
state | Record<string, unknown> |
Returns
boolean
If configuration was successful or false if an error occurred.
transferFunction()
transferFunction(): TransferFunction;Returns the transfer function used for rendering.