bluemath_tk.core.plotting package

Submodules

bluemath_tk.core.plotting.base_plotting module

class bluemath_tk.core.plotting.base_plotting.BasePlotting

Bases: ABC

Abstract base class for handling default plotting functionalities across the project.

get_list_of_colors_for_colormap(cmap: str | Colormap, num_colors: int) → list

Get a list of colors from a colormap.

Parameters:

• cmap (str or Colormap) – The colormap to use.

• num_colors (int) – The number of colors to generate.

Returns:

A list of colors generated from the colormap.

Return type:

list

abstractmethod plot_line(x, y)

Abstract method for plotting a line. Should be implemented by subclasses.

abstractmethod plot_map(markers=None)

Abstract method for plotting a map. Should be implemented by subclasses.

abstractmethod plot_scatter(x, y)

Abstract method for plotting a scatter plot. Should be implemented by subclasses.

class bluemath_tk.core.plotting.base_plotting.DefaultInteractivePlotting

Bases: BasePlotting

Concrete implementation of BasePlotting with interactive plotting behaviors.

plot_line(x, y)

Abstract method for plotting a line. Should be implemented by subclasses.

plot_map(markers=None)

Abstract method for plotting a map. Should be implemented by subclasses.

plot_scatter(x, y)

Abstract method for plotting a scatter plot. Should be implemented by subclasses.

class bluemath_tk.core.plotting.base_plotting.DefaultStaticPlotting(template: str = 'default')

Bases: BasePlotting

Concrete implementation of BasePlotting with static plotting behaviors.

get_subplot(figsize, **kwargs)

get_subplots(**kwargs)

plot_line(ax, **kwargs)

Abstract method for plotting a line. Should be implemented by subclasses.

plot_map(ax, **kwargs)

Abstract method for plotting a map. Should be implemented by subclasses.

plot_pie(ax, **kwargs)

plot_scatter(ax, **kwargs)

Abstract method for plotting a scatter plot. Should be implemented by subclasses.

set_grid(ax, grid=True)

Sets the grid for a given axis.

set_title(ax, title='Plot Title')

Sets the title for a given axis.

set_xlabel(ax, xlabel='X-axis')

Sets the x-axis label for a given axis.

set_xlim(ax, xmin, xmax)

Sets the x-axis limits for a given axis.

set_ylabel(ax, ylabel='Y-axis')

Sets the y-axis label for a given axis.

set_ylim(ax, ymin, ymax)

Sets the y-axis limits for a given axis.

templates = {'default': {'line': {'color': 'blue', 'line_style': '-'}, 'scatter': {'color': 'red', 'marker': 'o', 'size': 10}}}

bluemath_tk.core.plotting.colors module

bluemath_tk.core.plotting.colors.GetFamsColors(num_fams)

Choose colors or Interpolate custom colormap to number of waves families

bluemath_tk.core.plotting.colors.colormap_bathy(topat, topag)

returns custom colormap for bathymetry plot

bluemath_tk.core.plotting.colors.colormap_spectra()

bluemath_tk.core.plotting.colors.colors_awt()

bluemath_tk.core.plotting.colors.colors_dwt(num_clusters)

bluemath_tk.core.plotting.colors.colors_fams_3()

custom colors for 3 waves families

bluemath_tk.core.plotting.colors.colors_interp(num_clusters)

bluemath_tk.core.plotting.colors.colors_mjo()

custom colors for MJO 25 categories

bluemath_tk.core.plotting.colors.get_cluster_colors(num_clusters)

Choose colors or Interpolate custom colormap to number of clusters

bluemath_tk.core.plotting.colors.get_config_variables()

Module contents