NCL Home > Documentation

Listing of NCL Functions by Category

Alphabetical listing | Function type listing | Browsable listing

Visualization:
Graphics routines
Color
Object manipulation
Workstation
General NCL routines:
Array creation, manipulation, query
String
System
Type conversion
Variable query, manipulation
Earth Science:
Climatology
CCSM
Date
Lat/lon functions
Metadata/missing values
Meteorology
Oceanography
RIP functions
WRF functions
Math and statistics:
General applied math
Cumulative distribution functions
Empirical orthogonal functions
Interpolation
Random number generators
Regridding
Singular value decomposition
Spherical harmonics
Input/output:
File input/output
Printing

Array creators

fspan Creates an array of evenly-spaced floating point numbers.
ispan Creates an array of equally-spaced integer values.
nice_mnmxintvl Calculates "nice" values for endpoints and spacing to be used for creating a series of equally-spaced levels through the data domain.

Array manipulators

conform Expands an array or scalar so that it conforms to the shape of the given variable.
conform_dims Expands an array or scalar so that it conforms to the shape of the given dimension sizes.
dim_gbits Unpacks bit chunks from the rightmost dimension of the input array.
epsZero Sets all values in input array to zero that are +/- a user supplied epsilon about zero.
get1Dindex_Collapse Returns a one dimensional array of subscript indices that DO NOT match the values contained in a user specified list.
get1Dindex_Exclude Returns a one dimensional array of subscript indices that DO NOT match the values contained in a user suppliedlist.
getbitsone Unpacks one-bit chunks from the input array.
grid2triple Converts a two-dimensional grid with one-dimensional coordinate variables to an array where each grid value is associated with its coordinates.
ind_resolve Resolves a single list of indices to their multi-dimensional representation.
mask Masks a multi-dimensional array against another given a single mask value.
ndtooned Converts a multi-dimensional array to a one-dimensional array.
onedtond Converts a one-dimensional array to a multi-dimensional array.
transpose Transposes a matrix and copies all attributes and coordinate variables.
where Performs array assignments based on a conditional array.

Array query

all Returns True if all the elements of the input evaluate as True.
any Returns True if any of the values of its input evaluate as True.
closest_val Finds the index value in a monotonically increasing one dimensional array closest to a desired value.
dimsizes Returns the dimension sizes of the input variable.
get1Dindex Finds the indices of a one-dimensional array which exactly match a user specified list of values.
getind_latlon2d Finds the indices (subscripts) of two-dimensional latitude/longitude arrays closest to a user specified latitude/longitude coordinate pair.
ind Returns the indices where the input is True.
ind_nearest_coord Determine indices of locations closest to a coordinate array.
isMonotonic Check a one dimensional array to see if it is monotonic.
local_max_1d Determines the relative maxima for a 1-dimensional array.
local_min_1d Determines the relative minima for a 1-dimensional array.
maxind Returns the index of the first occurrence of a maximum value.
minind Returns the index of the first occurrence of a minimum value.
month_to_annual Converts monthly values to annual values.
month_to_annual_weighted Converts monthly values to annual values weighted by the number of days in a month.
monthly_total_to_daily_mean Convert monthly total values [eg, precipitation] to "per day" values.
niceLatLon2D Check two dimensional map coordinates to see if they have a "nice" structure.
num Counts the number of True values in the input.

CCSM

covcor Calculate a covariance or correlation matrix.
cz2ccm Computes geopotential height in hybrid coordinates.
dpres_hybrid_ccm Calculates the pressure differences of a hybrid coordinate system.
dpres_plevel Calculates the pressure layer thicknesses of a constant pressure level coordinate system.
dpres_plevel_Wrap Calculates the pressure layer thicknesses of a constant pressure level coordinate system.
dz_height Calculates the height layer thicknesses at each grid point over varying surface terrain.
omega_ccm Calculates omega [vertical pressure velocity] using the model diagnostic method.
omega_ccm_driver Computes vertical pressure velocity [omega] via model diagnostic code.
pres_hybrid_ccm Calculates pressure at the hybrid levels.
vinth2p Interpolates CCSM hybrid coordinates to pressure coordinates
vinth2p_ecmwf Interpolates CCSM hybrid coordinates to pressure coordinates but uses an ECMWF formulation to extrapolate values below ground.
vintp2p_ecmwf Interpolates data at multidimensional pressure levels to constant pressure coordinates and uses an ECMWF formulation to extrapolate values below ground.
wgt_vert_avg_beta Computes weighted vertical average or sum using pressure thickness and beta factors.
wkSpaceTime Calculate Wheeler-Kiladis space-time spectra.
wkSpaceTime_cam Calculate Wheeler-Kiladis space-time spectra using a generic CAM interface.

Climatology

angmom_atm Calculates the atmosphere's relative angular momentum.
calcDayAnomTLL Calculates daily anomalies from a daily data climatology.
calcMonAnomLLLT Calculates monthly anomalies by subtracting the long term mean from each point (lev,lat,lon,time version)
calcMonAnomLLT Calculates monthly anomalies by subtracting the long term mean from each point (lat,lon,time version)
calcMonAnomTLL Calculates monthly anomalies by subtracting the long term mean from each point (time,lat,lon version)
calcMonAnomTLLL Calculates monthly anomalies by subtracting the long term mean from each point: (time,lev,lat,lon) version.
clmDayTLL Calculates long term daily means (daily climatology) from daily data.
clmMon2clmDay Create a daily climatology from a monthly climatology.
clmMonLLLT Calculates long term monthly means (monthly climatology) from monthly data: (lev,lat,lon,time) version.
clmMonLLT Calculates long term monthly means (monthly climatology) from monthly data (lat,lon,time version)
clmMonTLL Calculates long term monthly means (monthly climatology) from monthly data: (time,lat,lon) version
clmMonTLLL Calculates long term monthly means (monthly climatology) from monthly data: (time,lev,lat,lon) version
month_to_season Computes a user-specified three-month seasonal mean (DJF, JFM, FMA, MAM, AMJ, MJJ, JJA, JAS, ASO, SON, OND, NDJ).
month_to_season12 Computes three-month seasonal means (DJF, JFM, FMA, MAM, AMJ, MJJ, JJA, JAS, ASO, SON, OND, NDJ).
month_to_seasonN Computes a user-specified list of three-month seasonal means (DJF, JFM, FMA, MAM, AMJ, MJJ, JJA, JAS, ASO, SON, OND, NDJ).
rmAnnCycle1D Removes annual cycle from a one-dimensional time series.
rmMonAnnCycLLLT Removes the annual cycle from "monthly" data.
rmMonAnnCycLLT Removes the annual cycle from "monthly" data.
rmMonAnnCycTLL Removes the annual cycle from "monthly" data.
smthClmDayTLL Calculates a smooth mean daily annual cycle.
stdMonLLLT Calculates standard deviations of monthly means.
stdMonLLT Calculates standard deviations of monthly means.
stdMonTLL Calculates standard deviations of monthly means.
stdMonTLLL Calculates standard deviations of monthly means.
wgt_volave_ccm Calculates the volume average of a quantity from the CCM using weights.
wgt_volrmse_ccm Calculates a weighted volume root-mean-square-difference between two variables from the CCM.

Color routines

gsn_define_colormap Defines a color map for the given workstation.
gsn_draw_colormap Draws the current color map for the given workstation.
gsn_draw_named_colors Draws the given list of named colors.
gsn_merge_colormaps Merges two color maps and sets this as the color map for the given workstation.
gsn_retrieve_colormap Retrieves a color map for the given workstation.
gsn_reverse_colormap Reverses the color map for the given workstation.
hlsrgb Converts HLS color values to RGB.
hsv2rgb Maps values from the HSV color model to the RGB color model (deprecated).
hsvrgb Converts HSV color values to RGB.
NhlFreeColor Removes one or more color entries from one or more workstations.
NhlGetNamedColorIndex Returns color map indexes that match the given color names in the color maps of the given workstations.
NhlIsAllocatedColor Queries a list of workstations to determine whether or not the given color indexes have been allocated.
NhlNewColor Allocates new workstation color indexes.
NhlPalGetDefined Returns a list of available color maps.
NhlSetColor Sets the colors for a given list of color indexes and workstations.
rgbhls Converts RGB color values to HLS.
rgbhsv Converts RGB color values to HSV.
RGBtoCmap Reads a text file of RGB triplets and converts them to a colormap.
rgbyiq Converts RGB color values to YIQ values.
yiqrgb Converts YIQ color values to RGB.

Cumulative distribution functions

cdfbin_p Calculates the binomial density of a cumulative distribution function.
cdfbin_pr Calculates the probability of success of each trial of a cumulative distribution function.
cdfbin_s Calculates the number of successes of a cumulative distribution function.
cdfbin_xn Calculates the number of binomial trials of a cumulative distribution function.
cdfchi_p Calculates the intergral of a cumulative chi-square distribution function.
cdfchi_x Calculates the upper limit of intergration of a cumulative chi-square distribution function.
cdfgam_p Calculates the integral of a cumulative gamma distribution function.
cdfgam_x Calculates the upper limit of intergration of a cumulative gamma distribution function.
cdfnor_p Calculates the integral of a cumulative normal distribution function.
cdfnor_x Calculates the upper limit of integration of a cumulative normal distribution function.

Date routines

day_of_week Calculates the day of the week given month, day, and year.
day_of_year Calculates the day of the year given month, day, and year.
days_in_month Calculates the number of days in a month given month, day, and year.
get_file_suffix Extract the suffix associated with a file name.
greg2jul Converts a Gregorian date to a Julian day.
grib_stime2itime Converts grib initial_time (string) to time (integer).
isleapyear Determines if a given year is a leap year (Gregorian calendar).
jul2greg Converts a Julian day to a Gregorian date.
latlon2utm Converts from lat/lon to UTM using a specified datum.
monthday Calculates a concatenated month_day given a day and year.
ut_calendar Converts a mixed Julian/Gregorian date to a UT-referenced date.
ut_convert Converts a time variable from one set of units to another.
ut_inv_calendar Converts a a UT-referenced date to a mixed Julian/Gregorian date.
utm2latlon Converts from UTM to lat/lon using a specified datum.
yyyymm_time Creates a one-dimensional array containing year-month [yyyymm] values.
yyyymm_to_yyyyfrac Converts a one dimensional array containing yyyymm values to yyyy and fractional year.
yyyymmdd_time Creates a one-dimensional array containing year-month-day [yyyymmdd] values.
yyyymmdd_to_yyyyfrac Converts a one dimensional array containing yyyymmdd values to yyyy and fractional year.
yyyymmddhh_to_yyyyfrac Converts a one dimensional array containing yyyymmddhh values to yyyy and fractional year.

Empirical orthogonal functions

eof2data Reconstructs a data set from EOFs and EOF time series.
eof_varimax Rotates EOFs using the using Kaiser row normalization and the varimax criterion (deprecated version).
eofcor Calculates empirical orthogonal functions via a correlation matrix (NCL's original function).
eofcor_pcmsg Calculates empirical orthogonal functions via a correlation matrix (missing values allowed) (deprecated version).
eofcor_ts Calculates the time series of the amplitudes associated with each eigenvalue in an EOF which was calculated using a correlation matrix.
eofcor_Wrap Calculates empirical orthogonal functions and retains meta data. (NCL's original function).
eofcov Calculates empirical orthogonal functions via a covariance matrix (original version).
eofcov_pcmsg Calculates empirical orthogonal functions via a covariance matrix (missing values allowed)(deprecated version).
eofcov_ts Calculates the time series of the amplitudes associated with each eigenvalue in an EOF which was calculated using a covariance matrix.
eofcov_Wrap Calculates empirical orthogonal functions and retains meta data. (NCL's original EOF function).
eofunc Compute empirical orthogonal functions (EOFs, aka: Principal Component Analysis).
eofunc_ts Calculates the time series of the amplitudes associated with each eigenvalue in an EOF.
eofunc_ts_Wrap Calculates the time series of the amplitudes associated with each eigenvalue in an EOF and retains metadata.
eofunc_varimax Rotates EOFs using the using Kaiser row normalization and the varimax criterion.
eofunc_varimax_reorder Reorder the results returned by eof_varimax into descending order by percent variance explained.
eofunc_varimax_Wrap Rotates EOFs using the using Kaiser row normalization and the varimax criterion and retains metadata.
eofunc_Wrap Computes empirical orthogonal functions (aka: Principal Component Analysis, Eigen Analysis) and retains metadata.

File IO

addfile Opens a data file that is (or is to be) written in a supported file format.
addfiles Creates a reference that spans multiple data files.
addfiles_GetVar Creates a reference that spans multiple data files and returns metadata.
asciiread Reads a file that contains ASCII representations of basic data types.
asciiwrite Creates an ascii text file of numeric or string data type.
cbinread Reads binary files created using the C block I/O function write.
cbinwrite Creates a binary file in raw C block I/O format for a numeric data type.
craybinnumrec Returns the number of unformatted sequential access Fortran records in a Cray COS blocked binary file.
craybinrecread Reads COS blocked unformatted sequential access Fortran binary files.
fbindirread Reads records written by a Fortran direct access write.
fbindirSwap Reads byte-reversed data and writes output file that can be read by fbindirread or cbinread.
fbindirwrite Writes binary records to a file in manner analogous to fortran's "access=direct".
fbinnumrec Returns the number of unformatted sequential Fortran records in a binary file.
fbinread Reads one binary record that has been written using an UNFORMATTED FORTRAN write.
fbinrecread Reads unformatted sequential access Fortran binary files.
fbinrecwrite Writes a single unformatted sequential access Fortran record to a file.
fbinseqSwap1 Byte swaps Fortran sequential files.
fbinseqSwap2 Byte swaps Fortran sequential files (more memory friendly).
fbinwrite Writes a single binary record to a file in manner analogous to fortran's "form=unformatted, access=sequential".
fileattdef Defines global (file) attributes associated with a supported file.
filedimdef Defines dimension names, dimension sizes, unlimited dimensions on a supported file.
filevarattdef Copies attributes from an input variable to one or more variables on a supported file.
filevardef Defines a list of variable names, variable var_types, and variable dimension names for a supported file.
filevardimsizes Returns the dimension sizes of variable on a supported file.
getfiledimsizes Returns a list of dimension sizes of the given file variable.
getfilevaratts Returns all attribute names associated with a variable on a supported file.
getfilevardims Returns all dimension names associated with a variable on a supported file.
getfilevardimsizes Returns the dimension sizes of variable on a supported file.
getfilevarnames Returns an array of file variable names in the specified supported file.
getfilevartypes Returns the types of the named variables stored in the given supported file.
isfile Returns True if input is of type file.
isfilepresent Checks if a file exists.
isfilevar Checks if specified file variables are defined in a file.
isfilevaratt Checks if specified file variable attributes are defined for a file variable.
isfilevarcoord Checks if a coordinate variable is defined in a file.
isfilevardim Checks if file variable dimensions are defined for a file variable.
list_files Lists all of the variables that reference files.
list_filevars Lists all of the variables associated with a specific file.
ListGetType Queries the manner in which a variable of type list was created.
ListSetType Specifies the manner in which a variable of type list is to be implemented.
numAsciiCol Returns the number of columns in an ASCII file.
numAsciiRow Returns the number of rows in an ASCII file.
readAsciiHead Reads an ASCII file and returns just the header.
readAsciiTable Reads an ASCII file given the number of lines at the beginning and end of the file to ignore.
setfileoption Sets a number of file-format-specific options.
v5d_close Closes a Vis5D+ format file.
v5d_create Creates a Vis5D+ format file.
v5d_setLowLev Sets the lowest vertical offset, in grid level, for each 3-dimensional gridded variable in a Vis5D+ format file.
v5d_setUnits Sets a name for physical units for a variable in a Vis5D+ format file.
v5d_write Writes compressed data to a Vis5D+ format file.
v5d_write_var Writes a single 3-dimensional gridded variable to a Vis5D+ format file.
wrf_rip_dbz Calculates simulated reflectivity using data extracted from ARW WRF model output.
wrf_user_getvar Extracts data from ARW WRF model output, and does basic diagnostics calculations.
wrf_user_list_times Extracts the list of available times in the ARW WRF model output.
write_matrix Writes nicely-formatted integer, float, or double precision two-dimensional (2D) arrays to standard out or to a file.

General applied math

abs Returns the absolute value of numeric data.
acos Computes the inverse cosine of numeric types.
asin Computes the inverse sine of numeric types.
atan Computes the inverse tangent of numeric types.
atan2 Computes the inverse tangent of (y/x) for numeric types.
avg Computes the average of a variable regardless of dimensionality.
betainc Evaluates the incomplete beta function.
cancor Performs canonical correlation analysis between two sets of variables.
cdft_p Calculates the one-sided probability given a t-value and the degrees of freedom.
cdft_t Calculates the t-value given the one-sided probability and the degrees of freedom.
ceil Computes the smallest integer value larger than the input.
center_finite_diff Performs a centered finite difference operation on the rightmost dimension.
cfftb Performs a backward complex discrete fourier transform [Fourier Synthesis].
cfftf Performs a forward complex discrete fourier transform of a real periodic sequence.
cfftf_frq_reorder Reorders the data returned by cfftf.
chiinv Evaluates the inverse chi-squared distribution function.
cos Computes the cosine of numeric types.
cosh Computes the hyperbolic cosine of numeric types.
cumsum Calculates the cumulative sum.
decimalPlaces Truncates or rounds to the number of decimal places specified
dim_avg Computes the average of a variable's rightmost dimension at all other dimensions.
dim_avg_wgt Computes the weighted average of a variable's rightmost dimension at all other dimensions.
dim_avg_wgt_Wrap Computes the weighted average of a variable's rightmost dimension at all other dimensions and retains metadata.
dim_avg_Wrap Computes the average of a variable's rightmost dimension at all other dimensions and retains metadata.
dim_cumsum Calculates the cumulative sum along the rightmost dimension.
dim_cumsum_Wrap Calculates the cumulative sum along the rightmost dimension and retains meta data.
dim_max Finds the maximum of a variable's rightmost dimension at all other dimensions.
dim_median Computes the median of a variable's rightmost dimension at all other dimensions.
dim_min Finds the minimum of a variable's rightmost dimension at all other dimensions.
dim_num Calculates the number of True values of a variable's rightmost dimension at all other dimensions.
dim_pqsort Computes the permutation vector generated by sorting the n - 1th (rightmost) dimension.
dim_product Computes the product of a variable's rightmost dimension at all other dimensions.
dim_rmsd Computes the root-mean-square-difference between two variables' rightmost dimension at all other dimensions.
dim_rmsd_Wrap Computes the root-mean-square-difference between two variables' rightmost dimension at all other dimensions.
dim_rmvmean Calculates and removes the mean of the (rightmost) dimension at all other dimensions.
dim_rmvmean_Wrap Calculates and removes the mean of the (rightmost) dimension at all other dimensions and retains metadata.
dim_rmvmed Calculates and removes the median of the (rightmost) dimension at all other dimensions.
dim_standardize Calculates standardized anomalies of the rightmost dimension at all other dimensions.
dim_standardize_Wrap Calculates standardized anomalies of the rightmost dimension at all other dimensions.
dim_stat4 Computes the first four moments (average, variance, skewness, and kurtosis) of the rightmost dimension for all other dimensions.
dim_stddev Computes the population standard deviation of a variable's rightmost dimension at all other dimensions.
dim_stddev_Wrap Computes the population standard deviation of a variable's rightmost dimension at all other dimensions and retains metadata.
dim_sum Computes the arithmetic sum of a variable's rightmost dimension at all other dimensions.
dim_sum_wgt Computes the weighted sum of a variable's rightmost dimension at all other dimensions.
dim_sum_wgt_Wrap Computes the weighted sum of a variable's rightmost dimension at all other dimensions and retains metadata.
dim_sum_Wrap Computes the arithmetic sum of a variable's rightmost dimension at all other dimensions and retains metadata.
dim_variance Computes the population variance of a variable's rightmost dimension at all other dimensions.
dim_variance_Wrap Computes the population variance of a variable's rightmost dimension at all other dimensions and retains metadata.
dtrend Estimates and removes the least squares linear trend of the rightmost dimension from all grid points.
dtrend_msg Estimates and removes the least squares linear trend of the rightmost dimension from all grid points (missing values allowed).
dtrend_quadratic Estimates and removes the least squares quadratic trend of the rightmost dimension from all grid points.
equiv_sample_size Estimates the number of independent values of a series of correlated observations.
erf Evaluates the real error function.
erfc Evaluates the real complementary error function.
esacr Computes sample auto-correlations
esacv Computes sample auto-covariances
esccr Computes sample cross-correlations.
esccv Computes sample cross-covariances.
escorc Computes sample cross-correlations at lag 0 only.
escovc Computes sample cross-covariances at lag 0 only.
exp Computes the value of e (the base of natural logarithms) raised to the power of the input.
ezfftb Perform a Fourier synthesis from real and imaginary coefficients.
ezfftf Perform a Fourier analysis on a periodic sequence.
fabs Computes the absolute value of numeric types.
fft2db Performs a two-dimensional discrete backward Fourier transform (Fourier synthesis).
fft2df Performs a two-dimensional forward real discrete Fourier transform (i.e., Fourier analysis) of a real periodic array.
filwgts_lancos Calculates one-dimensional filter weights (deprecated).
filwgts_lanczos Calculates one-dimensional filter weights.
filwgts_normal Calculates one-dimensional filter weights based upon the normal (gaussian) distribution.
floor Computes the largest integer value smaller than the input.
fourier_info Performs fourier analysis on one or more periodic series.
ftest Applies F-test for variances and returns an estimate of the statistical significance.
gammainc Evaluates the incomplete gamma function.
inverse_matrix Computes the inverse of a general matrix using LU factorization.
linrood_latwgt Computes the latitudes and weights used by the Lin-Rood Model.
linrood_wgt Computes the weights used by the Lin-Rood Model.
local_max Determines the relative maxima for a 2-dimensional array.
local_min Determines the relative minima for a 2-dimensional array.
log Computes the natural log of a numeric type.
log10 Computes the log base 10 of a numeric type.
lspoly Calculates a set of coefficients for a weighted least squares polynomial fit to the given data.
max Computes the maximum value of a multi-dimensional array.
min Computes the minimum value of a multi-dimensional array.
NewCosWeight Performs cosine weighting on the given array.
product Computes the product of the input.
qsort Sorts a singly dimensioned array.
reg_multlin Performs basic multiple linear regression analysis.
regCoef Calculates the linear regression coefficient between two variables.
regcoef Calculates the linear regression coefficient between two variables.
regline Calculates the linear regression coefficient between two series.
rmInsufData Sets all instances (i.e. time) of a grid point to missing if a user-prescribed percentage of points is missing.
round Rounds a float or double variable to the nearest whole number.
rtest Determines the statistical significance of a linear correlation coefficient.
runave Calculates an unweighted running average.
runave_Wrap Calculates an unweighted running average and retains metadata.
simpeq Integrates a sequence of equally spaced points using Simpson's Rule.
simpne Integrates a sequence of unequally spaced points using Simpson's three-point formula.
sin Computes the sine of numeric types.
sindex_yrmo Calculates the Southern Oscillation Index given two series of year-month values.
sinh Computes the hyperbolic sine of numeric types.
smth9 Performs nine point local smoothing on one or more 2D grids.
smth9_Wrap Performs nine point local smoothing on one or more 2D grids and retains metadata.
snindex_yrmo Calculates the Southern Oscillation Index and the noise index given two series of year-month values.
solve_linsys Computes the solution to a real system of linear equations.
specx_anal Calculates spectra quantities of a series.
specx_ci Calculates the theoretical Markov spectrum and the lower and upper confidence curves.
specxy_anal Calculates cross spectra quantities of a series.
sqrt Computes the square root of its input.
SqrtCosWeight Performs square-root of the cosine weighting on the given array.
sqsort Sorts a singly dimensioned arrays of strings.
stat2 Calculates the first two moments of the given input.
stat4 Calculates estimates of the first four moments (mean, variance, skewness, and kurtosis) of the given input.
stat_medrng Calculates median, range, and mid-range of the given input.
stat_trim Calculates trimmed estimates of the first two moments of the given input.
stddev Calculates the sample standard deviation.
student_t Calculates the two-tailed probability of the Student-t distribution.
sum Sums the input.
tan Computes the tangent of numeric types.
tanh Computes the hyperbolic tangent of numeric types.
taper Applies split-cosine-bell tapering to one or more series.
ttest Returns an estimate of the statistical significance and, optionally, the t-values.
variance Computes the sample variance of all input points.
wave_number_spc Computes the total power spectrum as a function of latitudinal wave number.
wavelet Calculates the wavelet transform of a time series and significance levels.
wavelet_default Calculates the wavelet transform of a time series and significance levels.
wgt_areaave Calculates the area average of a quantity using weights.
wgt_areaave2 Calculates the area average of a quantity using two-dimensional weights.
wgt_areaave_Wrap Calculates the area average of a quantity using weights and retains metadata.
wgt_arearmse Calculates a weighted area root-mean-square-difference between two variables.
wgt_arearmse2 Calculates a weighted area root-mean-square-difference (rmse) between two variables using two-dimensional weights.
wgt_areasum2 Calculates the area sum (total) of a quantity using two-dimensional weights.
wgt_runave Calculates a weighted running average.
wgt_runave_Wrap Calculates a weighted running average and retains metadata.
wgt_volave Calculates the volume average of a quantity using weights.
wgt_volrmse Calculates a weighted volume root-mean-square-difference between two variables.
wk_smooth121 Performs a specialized 1-2-1 filter for Wheeler-Kiladis plots.
zonalAve Computes a zonal average of the input array.

Graphics routines

boxplot Creates a boxplot.
ColorNegDashZeroPosContour Sets the negative contours to dashed, and colors the negative, positive, and zero contours to user-specified colors.
ColorShadeLeGeContour Shades contour regions given low and high values and two colors.
(Superceded by gsn_contour_shade as of version 4.3.0.)
draw Draws the given graphical objects.
drawNDCGrid Draws NDC grid lines at 0.1 NDC coordinate intervals and labels them.
GetFillColor Chooses a color from a group of RGB triplets based upon a secondary scalar field.
GetFillColorIndex Chooses from a list of color table indices based upon a secondary scalar field.
gsn_add_annotation Attaches the given annotation to the given plot.
gsn_add_polygon Attaches a filled polygon to the given plot.
gsn_add_polyline Attaches a polyline to the given plot.
gsn_add_polymarker Attaches polymarkers to the given plot.
gsn_add_text Attaches text strings to the given plot.
gsn_attach_plots Attaches a series of plots to a base plot.
gsn_blank_plot Draws a blank plot.
gsn_contour Creates and draws a contour plot.
gsn_contour_map Creates and draws a contour plot over a map.
gsn_contour_shade Shades contour regions given low and/or high values using colors or patterns.
gsn_create_labelbar Creates a labelbar.
gsn_create_legend Creates a legend.
gsn_create_text Creates text strings.
gsn_csm_attach_zonal_means Attaches a zonal means plot to a contour/map plot.
gsn_csm_contour Creates and draws a contour plot.
gsn_csm_contour_map Creates and draws a contour plot over a map.
gsn_csm_contour_map_ce Creates and draws a contour plot over a cylindrical equidistant map.
gsn_csm_contour_map_overlay Creates and draws two contour plot over a map.
gsn_csm_contour_map_polar Creates and draws a contour plot over a polar stereographic map.
gsn_csm_hov Creates and draws a Hovmueller (time v.s. longitude) plot.
gsn_csm_lat_time Creates and draws a latitude versus time plot.
gsn_csm_map Creates and draws a map.
gsn_csm_map_ce Creates and draws a cylindrical equidistant map.
gsn_csm_map_polar Creates and draws a polar stereographic map.
gsn_csm_pres_hgt Creates and draws a pressure/height plot.
gsn_csm_pres_hgt_streamline Creates and draws a pressure/height contour plot overlaid with streamlines.
gsn_csm_pres_hgt_vector Creates and draws a pressure/height contour plot overlaid with vectors.
gsn_csm_streamline Creates and draws a streamline plot.
gsn_csm_streamline_contour_map Creates and draws streamlines over a contour plot over a map.
gsn_csm_streamline_contour_map_ce Creates and draws streamlines over a contour plot over a cylindrical equidistant map.
gsn_csm_streamline_contour_map_polar Creates and draws streamlines over a contour plot over a polar stereographic map.
gsn_csm_streamline_map Creates and draws a streamline plot over a map.
gsn_csm_streamline_map_ce Creates and draws a streamline plot over a cylindrical equidistant map.
gsn_csm_streamline_map_polar Creates and draws a streamline plot over a polar stereographic map.
gsn_csm_time_lat Creates and draws a time versus latitude plot.
gsn_csm_vector Creates and draws a vector plot.
gsn_csm_vector_map Creates and draws a vector plot over a map.
gsn_csm_vector_map_ce Creates and draws a vector plot over a cylindrical equidistant map.
gsn_csm_vector_map_polar Creates and draws a vector plot over a polar stereographic map.
gsn_csm_vector_scalar Creates and draws a vector plot, and uses a scalar field to draw a separate contour plot or color the vectors.
gsn_csm_vector_scalar_map Creates and draws a vector plot over a map, and uses a scalar field to draw a separate contour plot or color the vectors.
gsn_csm_vector_scalar_map_ce Creates and draws a vector plot over a cylindrical equidistant map projection, and uses a scalar field to draw a separate contour plot or color the vectors.
gsn_csm_vector_scalar_map_polar Creates and draws a vector plot over a polar stereographic map projection, and uses a scalar field to draw a separate contour plot or color the vectors.
gsn_csm_x2y Creates and draws an XY plot with two different X axes.
gsn_csm_x2y2 Creates and draws an XY plot with two different X and Y axes
gsn_csm_xy Creates and draws an XY plot.
gsn_csm_xy2 Creates and draws an XY plot with two different Y axes.
gsn_csm_xy3 Creates and draws an XY plot with three different Y axes.
gsn_csm_y Creates and draws an XY plot, using index values for the X axis.
gsn_histogram Draws a histogram plot on the given workstation.
gsn_labelbar_ndc Draws a labelbar on the given workstation.
gsn_legend_ndc Draws a legend on the given workstation.
gsn_map Creates and draws a map.
gsn_open_wks Opens a workstation on which to draw graphics.
gsn_panel Draws multiple plots of identical size on a single frame.
gsn_polygon Draws a filled polygon on the given plot.
gsn_polygon_ndc Draws a filled polygon on the given workstation.
gsn_polyline Draws a polyline on the given plot.
gsn_polyline_ndc Draws a polyline on the given workstation.
gsn_polymarker Draws polymarkers on the given plot.
gsn_polymarker_ndc Draws polymarkers on the given workstation.
gsn_streamline Creates and draws a streamline plot.
gsn_streamline_map Creates and draws a streamline plot over a map.
gsn_table Draws a table with text.
gsn_text Draws text strings on the given plot.
gsn_text_ndc Draws text strings on the given workstation.
gsn_vector Creates and draws a vector plot.
gsn_vector_map Creates and draws a vector plot over a map.
gsn_vector_scalar Creates and draws a vector plot, and colors the vectors given a scalar field.
gsn_vector_scalar_map Creates and draws a vector plot over a map, and colors the vectors given a scalar field.
gsn_xy Creates and draws an XY plot.
gsn_y Creates and draws an XY plot, using index values for the X axis.
infoTimeStamp Draws two text strings at the bottom of the workstation to indicate the time the plot was created and other information.
maximize_output Maximizes the sizes of a series of plots drawn in a single frame.
msgValOutline Draws an outline around missing data in vector and streamline plots.
ngezlogo Draws the NCAR logo in the lower right corner of the given workstation.
nggetp Retrieves values for various parameters for the NCAR ngezlogo procedure.
nglogo Draws various NCAR and UCAR logos on the given workstation.
ngsetp Sets values for various parameters for the NCAR ngezlogo procedure.
NhlAddAnnotation Add annotations to a plot object as an external annotation.
NhlAddOverlay Overlays one plot object on another.
NhlAddPrimitive Adds a Primitive object to an existing plot.
NhlDataPolygon Draws a polygon using data coordinates.
NhlDataPolyline Draws a polyline using data coordinates.
NhlDataPolymarker Draws polymarkers using data coordinates.
NhlDraw Draws the given graphical objects.
NhlNDCPolygon Draws a polygon using NDC coordinates.
NhlNDCPolyline Draws a polyline using NDC coordinates.
NhlNDCPolymarker Draws polymarkers using NDC coordinates.
NhlNewDashPattern Adds new dash patterns to the existing table of dash patterns.
NhlNewMarker Adds new markers to the existing table of markers.
NhlRemoveAnnotation Remove annotations from the plot they are registered in.
NhlRemoveOverlay Removes one or more plots from an overlay.
NhlRemovePrimitive Removes one or more primitives from the given Transform object.
NhlSetDashPattern Sets the dash patterns for a given list of dash pattern indexes and workstations.
NhlSetMarker Sets the markers for a given list of marker indexes and workstations.
overlay Overlays one plot object on another.
paleo_outline Creates continental outlines from model orography data.
reset_device_coordinates Resets the PS/PDF device coordinates back to their default values.
setColorContourClear Sets the color contours between two given levels transparent.
ShadeCOI Adds the cone of influence as a shaded polygon.
ShadeGeLeContour Shades contour regions given low and high values and a shade pattern.
(Superceded by gsn_contour_shade as of version 4.3.0.)
ShadeGtContour Shades contour regions above a given value with the given fill pattern.
(Superceded by gsn_contour_shade as of version 4.3.0.)
ShadeLtContour Shades contour regions below a given value with the given fill pattern.
(Superceded by gsn_contour_shade as of version 4.3.0.)
ShadeLtGtContour Shades contour regions below a given value and above a given value with the specified fill patterns.
(Superceded by gsn_contour_shade as of version 4.3.0.)
skewT_BackGround Creates a background chart for Skew T, Log P plotting. (documentation under construction.)
skewT_PlotData Plot a sounding and (optionally) winds on Skew T, Log P charts created by skewT_BackGround. (documentation under construction.)
symMinMaxPlt Calculates the minimum/maximum values for a variable and uses nice_mnmxintvl to calculate the symmetric contour interval.
tdclrs Defines a set of colors for use with selected TDPACK routines.
tdctri Cuts the triangles in a triangle list with a plane perpendicular to an axis (for use with selected TDPACK routines).
tdcudp Not yet implemented.
tdcurv Draws the projection of a curve defined by an array of points in 3-space.
tddtri Draws triangles defined by a triangle list (for use with selected TDPACK routines).
tdez2d Draws a surface on the specified workstation.
tdez3d Draws an isosurface on the specified workstation.
tdgetp Retrieves TDPACK parameter values.
tdgrds Draws perimeters, ticks, and grid lines on the six sides of a box (for use with selected TDPACK routines).
tdgrid Draws a grid on a particular face of a box in 3-space (for use with selected TDPACK routines).
tdgtrs Gets the definition of a specified rendering style (for use with selected TDPACK routines).
tdinit Defines eye position, line of sight, up direction, and stereo flag for selected TDPACK routines.
tditri Adds triangles defining an isosurface to a triangle list (for use with selected TDPACK routines).
tdlbla Draws labels for a particular face of a box in 3-space (for use with selected TDPACK routines).
tdlblp Not yet implemented.
tdlbls Draws labels for all faces of a box in 3-space (for use with selected TDPACK routines).
tdline Draws the projection of a solid line in 3-space (for use with selected TDPACK routines).
tdlndp Not yet implemented.
tdlnpa Draws the projection of a line joining two points in the reference parallelogram (for use with selected TDPACK routines).
tdlpdp Not yet implemented.
tdmtri Adds triangles defining a 3D marker to a triangle list for use with selected TDPACK routines.
tdotri Orders the triangles in a triangle list for proper rendering (for use with selected TDPACK routines).
tdpara Defines the reference parallelogram for use with selected TDPACK routines.
tdplch Draws a string in the plane of the reference parallelogram (for use with selected TDPACK routines).
tdprpa Retrieves the coordinates of a projection in the projection plane, given the parallelogram coordinates of a point (for use with selected TDPACK routines).
tdprpi Retrieves the parallelogram coordinates of a point in the reference parallelogram, given a point in the projection plane (for use with selected TDPACK routines.)
tdprpt Retrieves the coordinates of its projection in the projection plane, given the coordinates of a point in 3-space (for use with selected TDPACK routines).
tdsetp Sets TDPACK parameter values.
tdsort Sorts an array (for use with selected TDPACK routines).
tdstri Adds triangles defining a simple surface to a triangle list (for use with selected TDPACK routines).
tdstrs Sets the values defining a selected rendering style (for use with selected TDPACK routines).
tdttri Adds triangles defining a trajectory to a triangle list (for use with selected TDPACK routines).
WindRoseBasic Plots a basic wind rose.
WindRoseColor Plot a wind rose diagram where different colors are used to differentiate speed ranges.
WindRoseThickLine Plot a black and white wind rose diagram where different line thicknesses are used to differentiate speed ranges.
wmbarb Draws wind barbs on the given workstation.
wmbarbmap Draws wind barbs over maps.
wmdrft Draws weather front lines on the given workstation.
wmgetp Retrieves parameter values for selected Wmap routines.
wmlabs Plots special symbols and icons for daily weather.
wmsetp Sets parameter values for selected Wmap routines.
wmstnm Plots station model data on the given workstation.
wmvect Draws vectors on the given workstation.
wmvectmap Draws vectors over maps.
wmvlbl Draws an informational label box for plots produced by wmvect or wmvectmap.
wrf_contour Creates a contour plot from ARW WRF model output.
wrf_map Creates a map background for ARW WRF model data.
wrf_map_overlay Overlays different plot id's over a map background (deprecated in version 5.0.1).
wrf_map_overlays Overlays different plot id's over a map background.
wrf_map_zoom Zooms into a portion of the ARW WRF model domain, and creates a map background (deprecated in version 5.0.1)..
wrf_overlay Overlays multiple plots, created from other ARW WRF plot functions (deprecated in version 5.0.1).
wrf_overlays Overlays multiple plots, created from other ARW WRF plot functions.
wrf_vector Creates a vector plot from ARW WRF model output.

Interpolation

area_hi2lores Interpolates from high resolution grids to low resolution grids using local area averaging.
area_hi2lores_Wrap Interpolates from high resolution grids to low resolution grids using local area averaging. (retains meta data)
areaint2 Interpolates from one grid to another grid using local area averaging.
csa1 Calculates an approximating cubic spline for the input data, one 1-dimensional section at a time.
csa1d Calculates an approximating cubic spline for the input data, one 1-dimensional section at a time.
csa1s Calculates an approximating cubic spline for the input data, one 1-dimensional section at a time.
csa1x Calculates an approximating cubic spline for the input data, one 1-dimensional section at a time.
csa1xd Calculates an approximating cubic spline for the input data, one 1-dimensional section at a time.
csa1xs Calculates an approximating cubic spline for the input data, one 1-dimensional section at a time.
csa2 Calculates an approximating cubic spline for two-dimensional input data.
csa2d Calculates an approximating cubic spline for two-dimensional input data.
csa2l Calculates an approximating cubic spline for two-dimensional input data.
csa2ld Calculates an approximating cubic spline for two-dimensional input data.
csa2ls Calculates an approximating cubic spline for two-dimensional input data.
csa2lx Calculates an approximating cubic spline for two-dimensional input data.
csa2lxd Calculates an approximating cubic spline for two-dimensional input data.
csa2lxs Calculates an approximating cubic spline for two-dimensional input data.
csa2s Calculates an approximating cubic spline for two-dimensional input data.
csa2x Calculates an approximating cubic spline for two-dimensional input data.
csa2xd Calculates an approximating cubic spline for two-dimensional input data.
csa2xs Calculates an approximating cubic spline for two-dimensional input data.
csa3 Calculates an approximating cubic spline for three-dimensional input data.
csa3d Calculates an approximating cubic spline for three-dimensional input data.
csa3l Calculates an approximating cubic spline for three-dimensional input data.
csa3ld Calculates an approximating cubic spline for three-dimensional input data.
csa3ls Calculates an approximating cubic spline for three-dimensional input data.
csa3lx Calculates an approximating cubic spline for three-dimensional input data.
csa3lxd Calculates an approximating cubic spline for three-dimensional input data.
csa3lxs Calculates an approximating cubic spline for three-dimensional input data.
csa3s Calculates an approximating cubic spline for three-dimensional input data.
csa3x Calculates an approximating cubic spline for three-dimensional input data.
csa3xd Calculates an approximating cubic spline for three-dimensional input data.
csa3xs Calculates an approximating cubic spline for three-dimensional input data.
csc2s Converts Cartesian coordinates on a unit sphere to spherical coordinates (lat/lon).
csgetp Retrieves control parameters for Cssgrid routines.
css2c Converts spherical coordinates (lat/lon) to Cartesian coordinates on a unit sphere.
cssetp Sets control parameters for Cssgrid routines.
cssgrid Uses tension splines to interpolate randomly spaced data on a unit sphere to data values on a uniform grid.
cssgrid_Wrap Uses tension splines to interpolate randomly spaced data on a unit sphere to data values on a uniform grid (retains metadata).
csstri Calculates a Delaunay triangulation of data randomly positioned on the surface of a sphere.
csvoro Determines Voronoi polygons for data randomly positioned on a sphere and returns vertices for the one surrounding a specified input point.
dsgetp Gets parameters for Dsgrid routines.
dsgrid2 Interpolates gridded 2-D data.
dsgrid2d Interpolates gridded 2-D data.
dsgrid2s Interpolates gridded 2-D data.
dsgrid3 Interpolates gridded 3-D data.
dsgrid3d Interpolates gridded 3-D data.
dsgrid3s Interpolates gridded 3-D data.
dspnt2 Interpolates 2-D data at specified points.
dspnt2d Interpolates 2-D data at specified points.
dspnt2s Interpolates 2-D data at specified points.
dspnt3 Interpolates 3-D data at specified points.
dspnt3d Interpolates 3-D data at specified points.
dspnt3s Interpolates 3-D data at specified points.
dssetp Sets parameters for Dsgrid routines.
ftcurv Calculates an interpolatory spline through a sequence of functional values.
ftcurvd Calculates the derivatives of an interpolatory spline under tension.
ftcurvi Calculates integrals of an interpolatory spline under tension between two user-specified limits.
ftcurvp Calculates an interpolatory spline under tension through a sequence of functional values for a periodic function.
ftcurvpi Calculates an integral of an interpolatory spline between two specified points.
ftcurvps Calculates a smoothing spline.
ftcurvs Calculates a smoothing spline.
ftgetp Retrieves control parameters for Fitgrid routines.
ftkurv Calculates an interpolatory spline for parametric curves.
ftkurvd Calculates an interpolatory spline for parametric curves; it also calculates first and second derivatives of the interpolatory spline.
ftkurvp Calculates an interpolatory spline under tension through a sequence of points in the plane forming a closed curve.
ftkurvpd Calculates an interpolatory spline for closed parametric curves; it also calculates first and second derivatives of the interpolatory spline.
ftsetp Sets control parameters for Fitgrid routines.