ImageVolumeGraphic#

ImageVolumeGraphic#

Constructor#

ImageVolumeGraphic(data[, mode, vmin, vmax, ...])

Create an ImageVolumeGraphic.

Properties#

ImageVolumeGraphic.alpha

The opacity of the graphic

ImageVolumeGraphic.alpha_mode

How the alpha is handled by the renderer

ImageVolumeGraphic.axes

ImageVolumeGraphic.block_events

Used to block events for a graphic and prevent recursion.

ImageVolumeGraphic.block_handlers

Used to block event handlers for a graphic and prevent recursion.

ImageVolumeGraphic.cmap

Get or set colormap, only used for grayscale images

ImageVolumeGraphic.cmap_interpolation

Get or set the cmap interpolation method

ImageVolumeGraphic.data

Get or set the image data

ImageVolumeGraphic.deleted

used to emit an event after the graphic is deleted

ImageVolumeGraphic.emissive

Get or set isosurface emissive color, only for iso mode.

ImageVolumeGraphic.event_handlers

Registered event handlers.

ImageVolumeGraphic.gamma

gamma correction applied to the image

ImageVolumeGraphic.imgui_right_click

The imgui popup that is opened by a right-click on this graphic.

ImageVolumeGraphic.interpolation

Get or set the image data interpolation method

ImageVolumeGraphic.legend_item

The legend item of this graphic, created with create_legend_item().

ImageVolumeGraphic.mode

Get or set the volume rendering mode

ImageVolumeGraphic.name

Graphic name

ImageVolumeGraphic.offset

[x, y, z]

ImageVolumeGraphic.plane

Get or set displayed plane in the volume.

ImageVolumeGraphic.rotation

Orientation of the graphic as a quaternion

ImageVolumeGraphic.scale

(x, y, z) scaling factor

ImageVolumeGraphic.shininess

Get or set isosurface shininess

ImageVolumeGraphic.step_size

Get or set isosurface step_size, only for iso mode

ImageVolumeGraphic.substep_size

Get or set isosurface substep_size, only for iso mode

ImageVolumeGraphic.supported_events

events supported by this graphic

ImageVolumeGraphic.threshold

Get or set isosurface threshold, only for iso mode

ImageVolumeGraphic.tooltip_format

set a custom tooltip format function which takes a pick_info dict and returns a str to be displayed in the tooltip

ImageVolumeGraphic.visible

Whether the graphic is visible

ImageVolumeGraphic.vmax

Get or set the upper contrast limit

ImageVolumeGraphic.vmin

Get or set the lower contrast limit

ImageVolumeGraphic.world_object

Associated pygfx WorldObject.

Methods#

ImageVolumeGraphic.add_axes()

Add axes onto this Graphic

ImageVolumeGraphic.add_event_handler(*args)

Register an event handler.

ImageVolumeGraphic.append_imgui_right_click([gui])

Append imgui elements to the right-click popup of this graphic.

ImageVolumeGraphic.clear_event_handlers()

clear all event handlers added to this graphic

ImageVolumeGraphic.format_pick_info(pick_info)

Takes a pygfx.PointerEvent and returns formatted pick info.

ImageVolumeGraphic.map_model_to_world(position)

map position from model (data) space to world space, basically applies the world affine transform

ImageVolumeGraphic.map_world_to_model(position)

map position from world space to model (data) space, basically applies the inverse world affine transform

ImageVolumeGraphic.remove_event_handler(...)

remove a registered event handler

ImageVolumeGraphic.remove_imgui_right_click()

Remove and return the right-click popup of this graphic

ImageVolumeGraphic.reset_vmin_vmax()

Reset the vmin, vmax by estimating it from the data

ImageVolumeGraphic.rotate(alpha[, axis])

Rotate the Graphic with respect to the world.

ImageVolumeGraphic.set_imgui_right_click([...])

Set the imgui popup that is opened by a right-click on this graphic, replaces the popup of the subplot or Figure for this graphic.