oceanspy.plot.vertical_section
- oceanspy.plot.vertical_section(od, varName, plotType='pcolormesh', use_dist=True, subsampMethod=None, contourName=None, meanAxes=False, intAxes=False, contour_kwargs=None, clabel_kwargs=None, subsamp_kwargs=None, cutout_kwargs=None, **kwargs)[source]
Plot vertical section.
- Parameters:
- od: OceanDataset
oceandataset used to plot.
- varName: str, None
Name of the variable to plot.
- plotType: str
2D plot type. Options: {‘contourf’, ‘contour’, ‘imshow’, ‘pcolormesh’}
- use_dist: bool
If True, use distances for x axis. If False, use mooring or station.
- subsampMethod: str, None
Subsample method. Options: {‘mooring_array’, ‘survey_station’}
- contourName: str, None
Name of the variable to contour on top.
- meanAxes: 1D array_like, str, or bool
List of axes over which to apply
oceanspy.compute.weighted_mean()
. If True, set meanAxes=oceanspy.OceanDataset.grid_coords
. If False, skip weighted mean.- intAxes: 1D array_like, str, or bool
List of axes over which to apply
oceanspy.compute.integral()
. If True, set intAxes=oceanspy.OceanDataset.grid_coords
. If False, skip integral.- contour_kwargs: dict
Keyword arguments for
xarray.plot.contour()
- clabel_kwargs: dict
Keyword arguments for
matplotlib.pyplot.clabel()
- subsamp_kwargs: dict
Keyword arguments for
oceanspy.subsample.mooring_array()
oroceanspy.subsample.survey_stations()
- cutout_kwargs: dict
Keyword arguments for
oceanspy.subsample.cutout()
- **kwargs:
Kewyword arguments for
xarray.plot
.plotType
- Returns:
- matplotlib.pyplot.axes or xarray.plot.FacetGrid
See also
References