comparison.VerticalPlotter

comparison.VerticalPlotter(comparer)

Methods

Name	Description
hovmoller	Hovmöller plot of model and observations as a function of depth and time.
profile	Plot vertical profiles of model and observations.

hovmoller

comparison.VerticalPlotter.hovmoller(
    title=None,
    model=None,
    ylim=None,
    ax=None,
    figsize=(12, 4),
    obs_marker_size=20.0,
    **kwargs,
)

Hovmöller plot of model and observations as a function of depth and time.

Parameters

Name	Type	Description	Default
title	str	Title of the plot.	None
model	str or int	Model to plot when multiple model results are present. If omitted and only one model is available, that model is used. If omitted and multiple models are available, a ValueError is raised.	None
ylim	tuple	Limits for the depth axis (z).	None
ax	matplotlib.axes.Axes	Matplotlib Axes to plot on (if None, a new figure and axes will be created).	None
figsize	tuple	Size of the figure (only used if ax is None).	(12, 4)
obs_marker_size	float	Base observation marker size in points^2 for reference figure width.	20.0
**kwargs		Other keyword arguments to matplotlib’s function contourf.	{}

Returns

Name	Type	Description
	matplotlib.axes.Axes	Axes object with the Hovmöller plot.

Examples

>>> ax = cmp.vertical.plot.hovmoller(figsize=(16,5))
>>> ax = cmp.vertical.plot.hovmoller(model="mod2", figsize=(16,5))

profile

comparison.VerticalPlotter.profile(
    title=None,
    ax=None,
    figsize=None,
    show_matched_model=False,
)

Plot vertical profiles of model and observations.

Parameters

Name	Type	Description	Default
title	str	Title of the plot.	None
ax	matplotlib.axes.Axes	Matplotlib Axes to plot on (if None, a new figure and axes will be created).	None
figsize	tuple	Size of the figure (only used if ax is None).	None

Returns

Name	Type	Description
	matplotlib.axes.Axes	Axes object with the vertical profile plot.