bgc_data_processing.tracers

Plotting objects.

BasePlot(storer, constraints)

Bases: ABC

Base class to plot data from a storer.

Parameters:

Name	Type	Description	Default
storer	Storer	Storer to plot data of.	required
constraints	Constraints	Constraint slicer.	required

Initiate Base class to plot data from a storer.

Parameters:

Name	Type	Description	Default
storer	Storer	Storer to plot data of.	required
constraints	Constraints	Constraint slicer.	required

Source code in src/bgc_data_processing/tracers.py

def __init__(self, storer: "Storer", constraints: "Constraints") -> None:
    """Initiate Base class to plot data from a storer.

    Parameters
    ----------
    storer : Storer
        Storer to plot data of.
    constraints: Constraints
            Constraint slicer.
    """
    self._storer = constraints.apply_constraints_to_storer(storer)
    self._variables = storer.variables
    self._constraints = constraints

show(title=None, suptitle=None, **kwargs) abstractmethod

Plot method.

Parameters:

Name	Type	Description	Default
title	str	Specify a title to change from default., by default None	None
suptitle	str	Specify a suptitle to change from default., by default None	None
*kwargs		Additional parameters to pass to self._build_to_new_figure.	{}

Source code in src/bgc_data_processing/tracers.py

@abstractmethod
@with_verbose(trigger_threshold=0, message="Showing Figure.")
def show(
    self,
    title: str | None = None,
    suptitle: str | None = None,
    **kwargs,
) -> None:
    """Plot method.

    Parameters
    ----------
    title : str, optional
        Specify a title to change from default., by default None
    suptitle : str, optional
        Specify a suptitle to change from default., by default None
    *kwargs: dict
        Additional parameters to pass to self._build_to_new_figure.
    """
    self._build_to_new_figure(
        title=title,
        suptitle=suptitle,
        **kwargs,
    )
    plt.show()
    plt.close()

save(save_path, title=None, suptitle=None, **kwargs) abstractmethod

Figure saving method.

Parameters:

Name	Type	Description	Default
save_path	str	Path to save the output image.	required
title	str	Specify a title to change from default., by default None	None
suptitle	str	Specify a suptitle to change from default., by default None	None
*kwargs		Additional parameters to pass to self._build_to_new_figure.	{}

Source code in src/bgc_data_processing/tracers.py

@abstractmethod
@with_verbose(trigger_threshold=0, message="Saving figure in [save_path]")
def save(
    self,
    save_path: str,
    title: str | None = None,
    suptitle: str | None = None,
    **kwargs,
) -> None:
    """Figure saving method.

    Parameters
    ----------
    save_path : str
        Path to save the output image.
    title : str, optional
        Specify a title to change from default., by default None
    suptitle : str, optional
        Specify a suptitle to change from default., by default None
    *kwargs: dict
        Additional parameters to pass to self._build_to_new_figure.
    """
    self._build_to_new_figure(
        title=title,
        suptitle=suptitle,
        **kwargs,
    )
    plt.savefig(save_path)

plot_to_axes(ax, *args, **kwargs) abstractmethod

Plot data to the given axes.

Parameters:

Name	Type	Description	Default
ax	Axes | GeoAxes	Axes to plot the data on.	required
*args		Additional parameters for the axes plotting method.	()
*kwargs		Additional parameters for the axes plotting method.	{}

Returns:

Type	Description
Axes | GeoAxes	Axes were the data is plotted on.

Source code in src/bgc_data_processing/tracers.py

@abstractmethod
def plot_to_axes(
    self,
    ax: "Axes | GeoAxes",
    *args,
    **kwargs,
) -> "Axes | GeoAxes":
    """Plot data to the given axes.

    Parameters
    ----------
    ax : Axes | GeoAxes
        Axes to plot the data on.
    *args: list
        Additional parameters for the axes plotting method.
    *kwargs: dict
        Additional parameters for the axes plotting method.

    Returns
    -------
    Axes | GeoAxes
        Axes were the data is plotted on.
    """

DensityPlotter(storer, constraints=None)

Bases: BasePlot

Base class for tracing on earthmaps.

Parameters:

Name	Type	Description	Default
storer	Storer	Data Storer containing data to plot.	required
constraints	Constraints | None	Constraint slicer.	None

Instanciate base class for tracing on earthmaps.

Parameters:

Name	Type	Description	Default
storer	Storer	Data Storer containing data to plot.	required
constraints	Constraints | None	Constraint slicer.	None

Source code in src/bgc_data_processing/tracers.py

def __init__(
    self,
    storer: "Storer",
    constraints: Constraints | None = None,
) -> None:
    """Instanciate base class for tracing on earthmaps.

    Parameters
    ----------
    storer : Storer
        Data Storer containing data to plot.
    constraints: Constraints | None
            Constraint slicer.
    """
    if constraints is None:
        constraints = Constraints()
    super().__init__(storer=storer, constraints=constraints)
    self._lat_bin: int | float = self.__default_lat_bin
    self._lon_bin: int | float = self.__default_lon_bin
    self._depth_density: bool = self.__default_depth_density
    self._lat_map_min = np.nan
    self._lat_map_max = np.nan
    self._lon_map_min = np.nan
    self._lon_map_max = np.nan
    depth_var_name = self._variables.depth_var_name
    depth_var_label = self._variables.get(depth_var_name).label
    self._data = self._storer.data.sort_values(depth_var_label, ascending=False)
    self._grouping_columns = self._get_grouping_columns(self._variables)

__default_lat_bin: int | float = 1 class-attribute instance-attribute

__default_lon_bin: int | float = 1 class-attribute instance-attribute

__default_depth_density: bool = True class-attribute instance-attribute

set_bins_size(bins_size)

Set the bin sizes.

Parameters:

Name	Type	Description	Default
bins_size	int | float | Iterable[int | float]	Bins size, if tuple, first for latitude, second for longitude. If float or int, size is applied for both latitude and longitude. Unit is supposed to be degree.	required

Source code in src/bgc_data_processing/tracers.py

def set_bins_size(
    self,
    bins_size: int | float | Iterable[int | float],
) -> None:
    """Set the bin sizes.

    Parameters
    ----------
    bins_size : int | float | Iterable[int  |  float]
        Bins size, if tuple, first for latitude, second for longitude.
        If float or int, size is applied for both latitude and longitude.
        Unit is supposed to be degree.
    """
    if isinstance(bins_size, Iterable):
        self._lat_bin = bins_size[0]
        self._lon_bin = bins_size[1]
    else:
        self._lat_bin = bins_size
        self._lon_bin = bins_size

set_density_type(consider_depth)

Set the self._depth_density value.

Parameters:

Name	Type	Description	Default
consider_depth	bool	Whether to consider all value in the water for density mapping.	required

Source code in src/bgc_data_processing/tracers.py

def set_density_type(self, consider_depth: bool) -> None:
    """Set the self._depth_density value.

    Parameters
    ----------
    consider_depth : bool
        Whether to consider all value in the water for density mapping.
    """
    self._depth_density = consider_depth

set_map_boundaries(latitude_min=np.nan, latitude_max=np.nan, longitude_min=np.nan, longitude_max=np.nan)

Define the boundaries of the map.

(different from the boundaries of the plotted data).

Parameters:

Name	Type	Description	Default
latitude_min	int | float	Minimum latitude, by default np.nan	nan
latitude_max	int | float	Maximal latitude, by default np.nan	nan
longitude_min	int | float	Mnimal longitude, by default np.nan	nan
longitude_max	int | float	Maximal longitude, by default np.nan	nan

Source code in src/bgc_data_processing/tracers.py

def set_map_boundaries(
    self,
    latitude_min: int | float = np.nan,
    latitude_max: int | float = np.nan,
    longitude_min: int | float = np.nan,
    longitude_max: int | float = np.nan,
) -> None:
    """Define the boundaries of the map.

    (different from the boundaries of the plotted data).

    Parameters
    ----------
    latitude_min : int | float, optional
        Minimum latitude, by default np.nan
    latitude_max : int | float, optional
        Maximal latitude, by default np.nan
    longitude_min : int | float, optional
        Mnimal longitude, by default np.nan
    longitude_max : int | float, optional
        Maximal longitude, by default np.nan
    """
    if not np.isnan(latitude_min):
        self._lat_map_min = latitude_min
    if not np.isnan(latitude_max):
        self._lat_map_max = latitude_max
    if not np.isnan(longitude_min):
        self._lon_map_min = longitude_min
    if not np.isnan(longitude_max):
        self._lon_map_max = longitude_max

save(save_path, variable_name, title=None, suptitle=None, **kwargs)

Plot the colormesh for the given variable.

Parameters:

Name	Type	Description	Default
save_path	str	Path to save the figure at.	required
variable_name	str	Name of the variable to plot.	required
title	str | None	Title for the figure, if set to None, automatically created. , by default None.	None
suptitle	str | None	Suptitle for the figure, if set to None, automatically created. , by default None.	None
**kwargs		Additional arguments to pass to plt.pcolor.	{}

Source code in src/bgc_data_processing/tracers.py

def save(
    self,
    save_path: str,
    variable_name: str,
    title: str | None = None,
    suptitle: str | None = None,
    **kwargs,
) -> None:
    """Plot the colormesh for the given variable.

    Parameters
    ----------
    save_path: str
        Path to save the figure at.
    variable_name : str
        Name of the variable to plot.
    title: str, optional
        Title for the figure, if set to None, automatically created.
        , by default None.
    suptitle: str, optional
        Suptitle for the figure, if set to None, automatically created.
        , by default None.
    **kwargs
        Additional arguments to pass to plt.pcolor.
    """
    super().save(
        save_path=save_path,
        variable_name=variable_name,
        title=title,
        suptitle=suptitle,
        **kwargs,
    )

show(variable_name, title=None, suptitle=None, **kwargs)

Plot the colormesh for the given variable.

Parameters:

Name	Type	Description	Default
variable_name	str	Name of the variable to plot.	required
title	str | None	Title for the figure, if set to None, automatically created. , by default None.	None
suptitle	str | None	Suptitle for the figure, if set to None, automatically created. , by default None.	None
**kwargs		Additional arguments to pass to plt.pcolor.	{}

Source code in src/bgc_data_processing/tracers.py

def show(
    self,
    variable_name: str,
    title: str | None = None,
    suptitle: str | None = None,
    **kwargs,
) -> None:
    """Plot the colormesh for the given variable.

    Parameters
    ----------
    variable_name : str
        Name of the variable to plot.
    title: str, optional
        Title for the figure, if set to None, automatically created.
        , by default None.
    suptitle: str, optional
        Suptitle for the figure, if set to None, automatically created.
        , by default None.
    **kwargs
        Additional arguments to pass to plt.pcolor.
    """
    super().show(
        variable_name=variable_name,
        title=title,
        suptitle=suptitle,
        **kwargs,
    )

plot_to_axes(variable_name, ax, **kwargs)

Build the plot to given axes.

Parameters:

Name	Type	Description	Default
variable_name	str	Name of the variable to plot.	required
ax	GeoAxes	GeoAxes (from cartopy) to plot the data to.	required
**kwargs		Additional arguments to pass to plt.pcolormesh.	{}

Returns:

Type	Description
tuple[GeoAxes, Collection]	Axes, Colorbar.

Source code in src/bgc_data_processing/tracers.py

def plot_to_axes(
    self,
    variable_name: str,
    ax: "GeoAxes",
    **kwargs,
) -> tuple["GeoAxes", "Collection"]:
    """Build the plot to given axes.

    Parameters
    ----------
    variable_name : str
        Name of the variable to plot.
    ax : GeoAxes
        GeoAxes (from cartopy) to plot the data to.
    **kwargs
        Additional arguments to pass to plt.pcolormesh.

    Returns
    -------
    tuple[GeoAxes, Collection]
        Axes, Colorbar.
    """
    return self._build_to_geoaxes(
        variable_name=variable_name,
        ax=ax,
        **kwargs,
    )

get_df(variable_name)

Return the density of the given variable on the bins.

Parameters:

Name	Type	Description	Default
variable_name	str	Name of the variable to bin.	required

Returns:

Type	Description
Dataframe	Three columns dataframe : longitude, latitude and variable density. The column names are the same as in the original DataFrame.

Source code in src/bgc_data_processing/tracers.py

@with_verbose(trigger_threshold=1, message="Meshing [variable_name] data.")
def get_df(
    self,
    variable_name: str,
) -> pd.DataFrame:
    """Return the density of the given variable on the bins.

    Parameters
    ----------
    variable_name : str
        Name of the variable to bin.

    Returns
    -------
    pd.Dataframe
        Three columns dataframe : longitude, latitude and variable density.
         The column names are the same as in the original DataFrame.
    """
    if variable_name == "all":
        label = "all"
    else:
        label = self._variables.get(variable_name).label
    lon_label = self._variables.get(self._variables.longitude_var_name).label
    lat_label = self._variables.get(self._variables.latitude_var_name).label
    df = self._group(
        var_key=label,
        lat_key=lat_label,
        lon_key=lon_label,
    )
    if df.empty:
        return pd.DataFrame(columns=[lon_label, lat_label, label])
    longis_2d, latis_2d, values_2d = self._mesh(
        df=df,
        label=label,
    )
    # Ravel the arrays to concatenate them in a single dataframe
    lons = longis_2d.ravel()
    lats = latis_2d.ravel()
    vals = values_2d.ravel()
    data = {lon_label: lons, lat_label: lats, label: vals}
    transformed_df = pd.DataFrame.from_dict(data)
    return transformed_df[~transformed_df[label].isna()]

EvolutionProfile(storer, constraints=None)

Bases: BasePlot

Class to plot the evolution of data on a given area.

Parameters:

Name	Type	Description	Default
storer	Storer	Storer to map data of.	required
constraints	Constraints | None	Constraint slicer.	None

Class to plot the evolution of data on a given area.

Parameters:

Name	Type	Description	Default
storer	Storer	Storer to map data of.	required
constraints	Constraints | None	Constraint slicer.	None

Source code in src/bgc_data_processing/tracers.py

def __init__(
    self,
    storer: "Storer",
    constraints: Constraints | None = None,
) -> None:
    """Class to plot the evolution of data on a given area.

    Parameters
    ----------
    storer : Storer
        Storer to map data of.
    constraints: Constraints|None
            Constraint slicer.
    """
    if constraints is None:
        constraints = Constraints()
    super().__init__(storer, constraints)
    self._interval: str = self.__default_interval
    self._interval_length: int = self.__default_interval_length
    self._depth_interval: int | float = self.__default_depth_interval
    self._depth_col = self._variables.get(self._variables.depth_var_name).label
    self._date_col = self._variables.get(self._variables.date_var_name).label

__default_interval: str = 'day' class-attribute instance-attribute

__default_interval_length: int = 10 class-attribute instance-attribute

__default_depth_interval: int = 100 class-attribute instance-attribute

__default_depth_max: int = 0 class-attribute instance-attribute

reset_intervals()

Reset interval parameters to the default ones.

Source code in src/bgc_data_processing/tracers.py

def reset_intervals(self) -> None:
    """Reset interval parameters to the default ones."""
    self._interval = self.__default_interval
    self._interval_length = self.__default_interval_length
    self._depth_interval = self.__default_depth_interval

reset_parameters()

Reset all boundaries and intervals to default values.

Source code in src/bgc_data_processing/tracers.py

def reset_parameters(self) -> None:
    """Reset all boundaries and intervals to default values."""
    self.reset_intervals()

set_depth_interval(depth_interval=np.nan)

Set the depth interval value.

This represents the vertical resolution of the final plot.

Parameters:

Name	Type	Description	Default
depth_interval	int | float | list[int | float]	Depth interval values, if numeric, interval resolution, if instance of list, list of depth bins to use., by default np.nan	nan

Source code in src/bgc_data_processing/tracers.py

def set_depth_interval(
    self,
    depth_interval: int | float | list[int | float] = np.nan,
) -> None:
    """Set the depth interval value.

    This represents the vertical resolution of the final plot.

    Parameters
    ----------
    depth_interval : int | float | list[int|float], optional
        Depth interval values, if numeric, interval resolution, if instance of list,
        list of depth bins to use., by default np.nan
    """
    if isinstance(depth_interval, list) or (not np.isnan(depth_interval)):
        self._depth_interval = depth_interval

set_date_intervals(interval, interval_length=None)

Set the date interval parameters.

This represent the horizontal resolution of the final plot.

Parameters:

Name	Type	Description	Default
interval	str	Interval resolution, can be "day", "week", "month", "year" or "custom".	required
interval_length	int	Only useful if the resolution interval is "custom". Represents the interval length, in days., by default None	None

Source code in src/bgc_data_processing/tracers.py

def set_date_intervals(
    self,
    interval: str,
    interval_length: int | None = None,
) -> None:
    """Set the date interval parameters.

    This represent the horizontal resolution of the final plot.

    Parameters
    ----------
    interval : str
        Interval resolution, can be "day", "week", "month", "year" or "custom".
    interval_length : int, optional
        Only useful if the resolution interval is "custom". \
        Represents the interval length, in days., by default None
    """
    self._interval = interval
    if interval_length is not None:
        self._interval_length = interval_length

show(variable_name, title=None, suptitle=None, **kwargs)

Plot the figure of data density evolution in a givemn area.

Parameters:

Name	Type	Description	Default
variable_name	str	Name of the variable to plot.	required
title	str	Specify a title to change from default., by default None	None
suptitle	str	Specify a suptitle to change from default., by default None	None
**kwargs		Additional arguments to pass to plt.pcolor.	{}

Source code in src/bgc_data_processing/tracers.py

def show(
    self,
    variable_name: str,
    title: str | None = None,
    suptitle: str | None = None,
    **kwargs,
) -> None:
    """Plot the figure of data density evolution in a givemn area.

    Parameters
    ----------
    variable_name : str
        Name of the variable to plot.
    title : str, optional
        Specify a title to change from default., by default None
    suptitle : str, optional
        Specify a suptitle to change from default., by default None
    **kwargs
        Additional arguments to pass to plt.pcolor.
    """
    super().show(
        variable_name=variable_name,
        title=title,
        suptitle=suptitle,
        **kwargs,
    )

save(save_path, variable_name, title=None, suptitle=None, **kwargs)

Save the figure of data density evolution in a givemn area.

Parameters:

Name	Type	Description	Default
save_path	str	Path to save the output image.	required
variable_name	str	Name of the variable to plot.	required
title	str	Specify a title to change from default., by default None	None
suptitle	str	Specify a suptitle to change from default., by default None	None
**kwargs		Additional arguments to pass to plt.pcolor.	{}

Source code in src/bgc_data_processing/tracers.py

def save(
    self,
    save_path: str,
    variable_name: str,
    title: str | None = None,
    suptitle: str | None = None,
    **kwargs,
) -> None:
    """Save the figure of data density evolution in a givemn area.

    Parameters
    ----------
    save_path : str
        Path to save the output image.
    variable_name : str
        Name of the variable to plot.
    title : str, optional
        Specify a title to change from default., by default None
    suptitle : str, optional
        Specify a suptitle to change from default., by default None
    **kwargs
        Additional arguments to pass to plt.pcolor.
    """
    super().save(
        save_path=save_path,
        variable_name=variable_name,
        title=title,
        suptitle=suptitle,
        **kwargs,
    )

plot_to_axes(variable_name, ax, **kwargs)

Plot the data on a given axes.

Parameters:

Name	Type	Description	Default
variable_name	str	Name of the variable to plot the data of.	required
ax	Axes	Axes to plot the data on.	required
**kwargs		Additional arguments to pass to plt.pcolormesh.	{}

Returns:

Type	Description
tuple[Axes, Collection]	Axes, colorbar

Source code in src/bgc_data_processing/tracers.py

def plot_to_axes(
    self,
    variable_name: str,
    ax: "Axes",
    **kwargs,
) -> tuple["Axes", "Collection"]:
    """Plot the data on a given axes.

    Parameters
    ----------
    variable_name : str
        Name of the variable to plot the data of.
    ax : Axes
        Axes to plot the data on.
    **kwargs:
        Additional arguments to pass to plt.pcolormesh.

    Returns
    -------
    tuple[Axes, Collection]
        Axes, colorbar
    """
    return self._build_to_axes(
        variable_name=variable_name,
        ax=ax,
        **kwargs,
    )

TemperatureSalinityDiagram(storer, constraints, salinity_field, temperature_field, ptemperature_field)

Bases: BasePlot

Class to plot a Temperature-Salinity Diagram.

Parameters:

Name	Type	Description	Default
storer	Storer	Storer to map data of.	required
constraints	Constraints	Constraint slicer.	required
temperature_field	str	Name of the temperature field in storer (column name).	required
salinity_field	str	Name of the salinity field in storer (column name).	required

Source code in src/bgc_data_processing/tracers.py

def __init__(
    self,
    storer: "Storer",
    constraints: "Constraints",
    salinity_field: str,
    temperature_field: str,
    ptemperature_field: str,
) -> None:
    super().__init__(storer, constraints)
    self.salinity_field = salinity_field
    self.temperature_field = temperature_field
    self.ptemperature_field = ptemperature_field

salinity_field = salinity_field instance-attribute

temperature_field = temperature_field instance-attribute

ptemperature_field = ptemperature_field instance-attribute

show(title=None, suptitle=None, **kwargs)

Plot the Temperature-Salinity diagram.

Parameters:

Name	Type	Description	Default
title	str	Specify a title to change from default., by default None	None
suptitle	str	Specify a suptitle., by default None	None
**kwargs		Additional arguments to pass to plt.pcolor.	{}

Source code in src/bgc_data_processing/tracers.py

def show(
    self,
    title: str | None = None,
    suptitle: str | None = None,
    **kwargs,
) -> None:
    """Plot the Temperature-Salinity diagram.

    Parameters
    ----------
    title : str, optional
        Specify a title to change from default., by default None
    suptitle : str, optional
        Specify a suptitle., by default None
    **kwargs
        Additional arguments to pass to plt.pcolor.
    """
    super().show(title=title, suptitle=suptitle, **kwargs)

save(save_path, title=None, suptitle=None, **kwargs)

Save the figure of Temperature-Salinity Diagram.

Parameters:

Name	Type	Description	Default
save_path	str	Path to save the output image.	required
title	str	Specify a title to change from default., by default None	None
suptitle	str	Specify a suptitle to change from default., by default None	None
**kwargs		Additional arguments to pass to plt.scatter.	{}

Source code in src/bgc_data_processing/tracers.py

def save(
    self,
    save_path: str,
    title: str | None = None,
    suptitle: str | None = None,
    **kwargs,
) -> None:
    """Save the figure of Temperature-Salinity Diagram.

    Parameters
    ----------
    save_path : str
        Path to save the output image.
    title : str, optional
        Specify a title to change from default., by default None
    suptitle : str, optional
        Specify a suptitle to change from default., by default None
    **kwargs
        Additional arguments to pass to plt.scatter.
    """
    super().save(save_path=save_path, title=title, suptile=suptitle, **kwargs)

plot_to_axes(ax, **kwargs)

Plot the data on a given axes.

Parameters:

Name	Type	Description	Default
ax	Axes	Axes to plot the data on.	required
**kwargs		Additional arguments to pass to plt.scatter.	{}

Returns:

Type	Description
tuple[Axes, Collection]	Axes, colorbar

Source code in src/bgc_data_processing/tracers.py

def plot_to_axes(self, ax: "Axes", **kwargs) -> tuple["Axes", "PathCollection"]:
    """Plot the data on a given axes.

    Parameters
    ----------
    ax : Axes
        Axes to plot the data on.
    **kwargs:
        Additional arguments to pass to plt.scatter.

    Returns
    -------
    tuple[Axes, Collection]
        Axes, colorbar
    """
    return self._build_to_axes(
        ax=ax,
        **kwargs,
    )

VariableBoxPlot(storer, constraints)

Bases: BasePlot

Class to draw box plots for a given variable.

Parameters:

Name	Type	Description	Default
storer	Storer	Storer to map the data of.	required
constraints	Constraints	Constraints slicer.	required

Source code in src/bgc_data_processing/tracers.py

def __init__(self, storer: "Storer", constraints: "Constraints") -> None:
    super().__init__(storer, constraints)

period_mapping: dict[str, str] = {'year': '%Y', 'month': '%Y-%m', 'week': '%Y-%W', 'day': '%Y-%m-%d'} class-attribute

show(variable_name, period, title=None, suptitle=None, **kwargs)

Plot method.

Parameters:

Name	Type	Description	Default
variable_name	str	Name of the variable to plot.	required
period	str	Period on which to plot each boxplot.	required
title	str	Specify a title to change from default., by default None	None
suptitle	str	Specify a suptitle to change from default., by default None	None
*kwargs		Additional parameters to pass to plt.boxplot.	{}

Source code in src/bgc_data_processing/tracers.py

def show(
    self,
    variable_name: str,
    period: str,
    title: str | None = None,
    suptitle: str | None = None,
    **kwargs,
) -> None:
    """Plot method.

    Parameters
    ----------
    variable_name: str
        Name of the variable to plot.
    period: str
        Period on which to plot each boxplot.
    title : str, optional
        Specify a title to change from default., by default None
    suptitle : str, optional
        Specify a suptitle to change from default., by default None
    *kwargs: dict
        Additional parameters to pass to plt.boxplot.
    """
    super().show(
        variable_name=variable_name,
        period=period,
        title=title,
        suptitle=suptitle,
        **kwargs,
    )

save(variable_name, period, save_path, title=None, suptitle=None, **kwargs)

Figure saving method.

Parameters:

Name	Type	Description	Default
variable_name	str	Name of the variable to plot.	required
period	str	Period on which to plot each boxplot.	required
save_path	str	Path to save the ouput image.	required
title	str | None	Specify a title to change from default., by default None	None
suptitle	str | None	Add a suptitle to the figure., by default None	None
**kwargs		Addictional parameters to pass to plt.boxplot.	{}

Source code in src/bgc_data_processing/tracers.py

def save(
    self,
    variable_name: str,
    period: str,
    save_path: str,
    title: str | None = None,
    suptitle: str | None = None,
    **kwargs,
) -> None:
    """Figure saving method.

    Parameters
    ----------
    variable_name : str
        Name of the variable to plot.
    period : str
        Period on which to plot each boxplot.
    save_path : str
        Path to save the ouput image.
    title : str | None, optional
        Specify a title to change from default., by default None
    suptitle : str | None, optional
        Add a suptitle to the figure., by default None
    **kwargs: dict
        Addictional parameters to pass to plt.boxplot.
    """
    return super().save(
        save_path=save_path,
        variable_name=variable_name,
        period=period,
        title=title,
        suptitle=suptitle,
        **kwargs,
    )

plot_to_axes(variable_name, period, ax, **kwargs)

Plot the data to the given axes.

Parameters:

Name	Type	Description	Default
variable_name	str	Name of the variable to plot.	required
period	str	Period on which to plot each boxplot.	required
ax	Axes	Axes to plot the data on.	required
**kwargs		Additional parameters to pass to plt.boxplot.	{}

Returns:

Type	Description
Axes	Axes where the data is plotted on.

Source code in src/bgc_data_processing/tracers.py

def plot_to_axes(
    self,
    variable_name: str,
    period: str,
    ax: "Axes",
    **kwargs,
) -> "Axes":
    """Plot the data to the given axes.

    Parameters
    ----------
    variable_name : str
        Name of the variable to plot.
    period : str
        Period on which to plot each boxplot.
    ax : Axes
        Axes to plot the data on.
    **kwargs: dict
        Additional parameters to pass to plt.boxplot.

    Returns
    -------
    Axes
        Axes where the data is plotted on.
    """
    return self._build_to_axes(
        variable_name=variable_name,
        period=period,
        ax=ax,
        **kwargs,
    )

WaterMassVariableComparison(storer, constraints, pressure_var_name, ptemperature_var_name, salinity_var_name, sigma_t_var_name)

Bases: BasePlot

Class to draw a pressure vs variable comparison of water masses.

Parameters:

Name	Type	Description	Default
storer	Storer	Storer to map the data of.	required
constraints	Constraints	Constraints slicer.	required
pressure_var_name	str	Name of the pressure variable.	required
ptemperature_var_name	str	Potential temperature variable name.	required
salinity_var_name	str	Salinity variable name.	required
sigma_t_var_name	str	Sigma-t variable name.	required

Source code in src/bgc_data_processing/tracers.py

def __init__(
    self,
    storer: "Storer",
    constraints: "Constraints",
    pressure_var_name: str,
    ptemperature_var_name: str,
    salinity_var_name: str,
    sigma_t_var_name: str,
) -> None:
    super().__init__(storer, constraints)
    self.pressure_var = self._variables.get(pressure_var_name)
    self.ptemp_var = self._variables.get(ptemperature_var_name)
    self.salty_var = self._variables.get(salinity_var_name)
    self.sigma_t_var = self._variables.get(sigma_t_var_name)

pressure_var = self._variables.get(pressure_var_name) instance-attribute

ptemp_var = self._variables.get(ptemperature_var_name) instance-attribute

salty_var = self._variables.get(salinity_var_name) instance-attribute

sigma_t_var = self._variables.get(sigma_t_var_name) instance-attribute

show(variable_name, wmasses, title=None, suptitle=None, **kwargs)

Plot method.

Parameters:

Name	Type	Description	Default
variable_name	str	Name of the variable to plot.	required
wmasses	list[WaterMass]	List all water masses.	required
title	str	Specify a title to change from default., by default None	None
suptitle	str	Specify a suptitle to change from default., by default None	None
*kwargs		Additional parameters to pass to plt.scatter.	{}

Source code in src/bgc_data_processing/tracers.py

def show(
    self,
    variable_name: str,
    wmasses: list["WaterMass"],
    title: str | None = None,
    suptitle: str | None = None,
    **kwargs,
) -> None:
    """Plot method.

    Parameters
    ----------
    variable_name: str
        Name of the variable to plot.
    wmasses : list[WaterMass]
        List all water masses.
    title : str, optional
        Specify a title to change from default., by default None
    suptitle : str, optional
        Specify a suptitle to change from default., by default None
    *kwargs: dict
        Additional parameters to pass to plt.scatter.
    """
    super().show(
        variable_name=variable_name,
        wmasses=wmasses,
        title=title,
        suptitle=suptitle,
        **kwargs,
    )

save(variable_name, wmasses, save_path, title=None, suptitle=None, **kwargs)

Figure saving method.

Parameters:

Name	Type	Description	Default
variable_name	str	Name of the variable to plot.	required
wmasses	list[WaterMass]	List all water masses.	required
save_path	str	Path to save the ouput image.	required
title	str | None	Specify a title to change from default., by default None	None
suptitle	str | None	Add a suptitle to the figure., by default None	None
**kwargs		Addictional parameters to pass to plt.scatter.	{}

Source code in src/bgc_data_processing/tracers.py

def save(
    self,
    variable_name: str,
    wmasses: list["WaterMass"],
    save_path: str,
    title: str | None = None,
    suptitle: str | None = None,
    **kwargs,
) -> None:
    """Figure saving method.

    Parameters
    ----------
    variable_name : str
        Name of the variable to plot.
    wmasses : list[WaterMass]
        List all water masses.
    save_path : str
        Path to save the ouput image.
    title : str | None, optional
        Specify a title to change from default., by default None
    suptitle : str | None, optional
        Add a suptitle to the figure., by default None
    **kwargs: dict
        Addictional parameters to pass to plt.scatter.
    """
    super().save(
        variable_name=variable_name,
        wmasses=wmasses,
        save_path=save_path,
        title=title,
        suptitle=suptitle,
        **kwargs,
    )

plot_to_axes(variable_name, wmasses, ax, **kwargs)

Plot the data to the given axes.

Parameters:

Name	Type	Description	Default
variable_name	str	Name of the variable to plot.	required
wmasses	list[WaterMass]	List all water masses.	required
ax	Axes	Axes to plot the data on.	required
**kwargs		Additional parameters to pass to plt.scatter.	{}

Returns:

Type	Description
Axes	Axes where the data is plotted on.

Source code in src/bgc_data_processing/tracers.py

def plot_to_axes(
    self,
    variable_name: str,
    wmasses: list["WaterMass"],
    ax: "Axes",
    **kwargs,
) -> "Axes":
    """Plot the data to the given axes.

    Parameters
    ----------
    variable_name : str
        Name of the variable to plot.
    wmasses : list[WaterMass]
        List all water masses.
    ax : Axes
        Axes to plot the data on.
    **kwargs: dict
        Additional parameters to pass to plt.scatter.

    Returns
    -------
    Axes
        Axes where the data is plotted on.
    """
    return self._build_to_axes(
        variable_name=variable_name,
        wmasses=wmasses,
        ax=ax,
        **kwargs,
    )

VariableHistogram(storer, constraints)

Bases: BasePlot

Class to draw histogram for a given variable.

Parameters:

Name	Type	Description	Default
storer	Storer	Storer to map the data of.	required
constraints	Constraints	Constraints slicer.	required

Source code in src/bgc_data_processing/tracers.py

def __init__(self, storer: "Storer", constraints: "Constraints") -> None:
    super().__init__(storer, constraints)

bin_number: int = 100 class-attribute instance-attribute

show(variable_name, title=None, suptitle=None, **kwargs)

Plot method.

Parameters:

Name	Type	Description	Default
variable_name	str	Name of the variable to plot.	required
title	str	Specify a title to change from default., by default None	None
suptitle	str	Specify a suptitle to change from default., by default None	None
*kwargs		Additional parameters to pass to plt.hist.	{}

Source code in src/bgc_data_processing/tracers.py

def show(
    self,
    variable_name: str,
    title: str | None = None,
    suptitle: str | None = None,
    **kwargs,
) -> None:
    """Plot method.

    Parameters
    ----------
    variable_name: str
        Name of the variable to plot.
    title : str, optional
        Specify a title to change from default., by default None
    suptitle : str, optional
        Specify a suptitle to change from default., by default None
    *kwargs: dict
        Additional parameters to pass to plt.hist.
    """
    super().show(
        variable_name=variable_name,
        title=title,
        suptitle=suptitle,
        **kwargs,
    )

save(variable_name, save_path, title=None, suptitle=None, **kwargs)

Figure saving method.

Parameters:

Name	Type	Description	Default
variable_name	str	Name of the variable to plot.	required
save_path	str	Path to save the ouput image.	required
title	str | None	Specify a title to change from default., by default None	None
suptitle	str | None	Add a suptitle to the figure., by default None	None
**kwargs		Addictional parameters to pass to plt.hist.	{}

Source code in src/bgc_data_processing/tracers.py

def save(
    self,
    variable_name: str,
    save_path: str,
    title: str | None = None,
    suptitle: str | None = None,
    **kwargs,
) -> None:
    """Figure saving method.

    Parameters
    ----------
    variable_name : str
        Name of the variable to plot.
    save_path : str
        Path to save the ouput image.
    title : str | None, optional
        Specify a title to change from default., by default None
    suptitle : str | None, optional
        Add a suptitle to the figure., by default None
    **kwargs: dict
        Addictional parameters to pass to plt.hist.
    """
    return super().save(
        save_path=save_path,
        variable_name=variable_name,
        title=title,
        suptitle=suptitle,
        **kwargs,
    )

plot_to_axes(variable_name, ax, **kwargs)

Plot the data to the given axes.

Parameters:

Name	Type	Description	Default
variable_name	str	Name of the variable to plot.	required
ax	Axes	Axes to plot the data on.	required
**kwargs		Additional parameters to pass to plt.hist.	{}

Returns:

Type	Description
Axes	Axes where the data is plotted on.

Source code in src/bgc_data_processing/tracers.py

def plot_to_axes(
    self,
    variable_name: str,
    ax: "Axes",
    **kwargs,
) -> "Axes":
    """Plot the data to the given axes.

    Parameters
    ----------
    variable_name : str
        Name of the variable to plot.
    ax : Axes
        Axes to plot the data on.
    **kwargs: dict
        Additional parameters to pass to plt.hist.

    Returns
    -------
    Axes
        Axes where the data is plotted on.
    """
    return self._build_to_axes(
        variable_name=variable_name,
        ax=ax,
        **kwargs,
    )