ess.dream.instrument_view#

ess.dream.instrument_view(data, dim=None, pixel_size=None, autoscale=False, **kwargs)[source]#

Three-dimensional visualization of the DREAM instrument. The instrument view is capable of slicing the input data with a slider widget along a dimension (e.g. tof) by using the dim argument. It will also generate checkboxes to hide/show the different modules that make up the DREAM detectors.

Parameters:

  • data (DataArray | DataGroup | dict) – Data to visualize. The data can be a single detector module (DataArray), or a group of detector modules (dict or DataGroup). The data must contain a position coordinate.

  • dim (Optional[str], default: None) – Dimension to use for the slider. No slider will be shown if this is None.

  • pixel_size (Union[float, Variable, None], default: None) – Size of the pixels.

  • autoscale (bool, default: False) – If True, the color scale will be automatically adjusted to the data as it gets updated. This can be somewhat expensive with many pixels, so it is set to False by default.

  • **kwargs (Any) – Additional arguments are forwarded to the scatter3d figure (see https://scipp.github.io/plopp/generated/plopp.scatter3d.html).

Return type:

Box