differt.plotting.draw_markers

draw_markers(markers, labels=None, text_kwargs=None, **kwargs)

Plot markers and, optionally, their label.

Parameters:

• markers (Real[ArrayLike, '*batch 3']) – The array of marker vertices.

• labels (Sequence[str] | None) – The marker labels.

• text_kwargs (Mapping[str, Any] | None) –

  A mapping of keyword arguments passed to Text if VisPy backend is used.

  By default, font_size=1000 is used.

• kwargs (Any) – Keyword arguments passed to Markers, scatter, or Scatter3d, depending on the backend.

Return type:

Any

Returns:

The resulting plot output.

Warning

Matplotlib does not support labels.

Examples

The following example shows how to plot several annotated markers.

>>> from differt.plotting import draw_markers
>>>
>>> markers = np.array([
...     [0.0, 0.0, 0.0],
...     [1.0, 0.0, 0.0],
...     [1.0, 1.0, 0.0],
...     [0.0, 1.0, 0.0],
... ])
>>> labels = ["A", "B", "C", "D"]
>>> fig = draw_markers(markers, labels, backend="plotly")
>>> fig