plotMOC: Plot Meridional Overturning Circulation from CESM POP2...

In garciapintado/rdafCESM: Setup and Assimilation of CESM

Description

Plot a Meridional Overtuning Circulation image for a requested NetCDF CESM POP2 history file.

Usage

plotMOC(fname, pdffile=NULL, moc_ic=1, moc_itr=2,
        xlim=NULL, ylim=NULL, vlim=c(-10,30), supcol=NULL,
        nlevels=21, yscl=1.E-05, pretty_by=10, main='', xlab='Latitude',
        ylab='Depth [km]', it = NULL, add_bath=TRUE, bath_col='grey20',
        use_contour = TRUE, get_summary=TRUE)

Arguments

fname	CHARACTER, input NetCDF file, with path included
pdffile	CHARACTER, output PDF file
moc_ic	INTEGER, index indicating one out of ["Eulerian Mean","Eddy-Induced (bolus)", "Submeso"]
moc_itr	INTEGER, index indicating one out of ["Global Ocean - Marginal Seas", "Atlantic Ocean + Mediterranean Sea + Labrador Sea + GIN Sea + Arctic Ocean + HudsonBay"]
xlim	x coordinate [latitude] limits
ylim	x coordinate [longitude] limits
vlim	variable limits. If NULL; limits are takem from dataset
supcol	vector of hexadecimal color names. NULL will take a divergence matlab-like palette
nlevels	ncolors+1
yscl	1.E-05 default to convert original [cm] to [km] in depth vector
pretty_by	increment for colorbar ticks. NULL for automated pretty ones
main	main plot title
xlab	label for x axis
ylab	label for y axis
it	INTEGER, time index for multistep grids. NULL (default) get the mean values over all timesteps available in the netCDF file
add_bath	LOGICAL, whether to add bathymetry polygon
bath_col	CHARACTER, color code for bathymetry polygon
use_contour	LOGICAL, TRUE to use filled contours, FALSE for a gridded image
get_summary	LOGICAL, TRUE for an internal call to summaryMOC function

Details

Plot an AMOC image and associated colorbar

Value

A plot on an existing or new device is generated. The return value is 0, or a matrix with a summary of the requested MOC if get_summary=TRUE.

garciapintado/rdafCESM documentation built on July 18, 2019, 4:41 p.m.