weldx.visualization.matplotlib_impl.plot_local_coordinate_system_matplotlib#

weldx.visualization.matplotlib_impl.plot_local_coordinate_system_matplotlib(lcs, axes=None, color=None, label=None, time=None, time_ref=None, time_index=None, scale_vectors=None, show_origin=True, show_trace=True, show_vectors=True)#

Visualize a weldx.transformations.LocalCoordinateSystem using matplotlib.

Parameters

  • lcs (LocalCoordinateSystem) – The coordinate system that should be visualized

  • axes (Optional[Axes]) – The target matplotlib axes. If None is provided, a new one will be created

  • color (Optional[Any]) – An arbitrary color. The data type must be compatible with matplotlib.

  • label (Optional[str]) – Name of the coordinate system

  • time (Union[DatetimeIndex, TimedeltaIndex, List[Timestamp], None]) – The time steps that should be plotted

  • time_ref (Optional[Timestamp]) – A reference timestamp that can be provided if the time parameter is a pandas.TimedeltaIndex

  • time_index (Optional[int]) – Index of a specific time step that should be plotted

  • scale_vectors (Union[float, list, ndarray, None]) – A scaling factor or array to adjust the vector length

  • show_origin (bool) – If True, the origin of the coordinate system will be highlighted in the color passed as another parameter

  • show_trace (bool) – If True, the trace of a time dependent coordinate system will be visualized in the color passed as another parameter

  • show_vectors (bool) – If True, the the coordinate axes of the coordinate system are visualized

Returns

The axes object that was used as canvas for the plot.

Return type

matplotlib.axes.Axes