ocetrac.measures.plot_displacement

ocetrac.measures.plot_displacement(coordinate_list: List[Tuple[float, float]], intensity_array: DataArray, cmap: str = 'viridis', quiver_color: str = 'Orange', text_color: str = 'k', marker_color: str = 'Red', figsize: Tuple[int, int] = (12, 6), vmin=None, vmax=None, quiver_width: float = 0.005, text_fontsize: int = 12) → None

Plots the displacement of centroids over time on an intensity map.

Parameters

coordinate_listList[Tuple[float, float]]

List of (latitude, longitude) coordinates for centroids over time.

intensity_arrayxr.DataArray

Intensity array to plot the displacement on. Must have dimensions (time, lat, lon).

cmapstr, optional

Colormap for the intensity map. Default is ‘Greys’.

quiver_colorstr, optional

Color of the quiver arrows representing displacement. Default is ‘Orange’.

text_colorstr, optional

Color of the text labels for each centroid. Default is ‘Red’.

marker_colorstr, optional

Color of the markers for each centroid. Default is ‘Red’.

figsizeTuple[int, int], optional

Size of the figure. Default is (12, 6).

vminfloat, optional

Minimum value for the intensity map colormap. Default is None.

vmaxfloat, optional

Maximum value for the intensity map colormap. Default is None.

quiver_widthfloat, optional

Width of the quiver arrows. Default is 0.005.

text_fontsizeint, optional

Font size for the text labels. Default is 15.

Returns

None

Displays the plot.