Built-in NCL functions and procedures
- addfile - creates a variable that references a file
- all - returns True if all input is True
- any - returns True if any input is True
- asciiread - reads an ASCII data file
- cbinread - reads a C binary data file
- craybinnumrec - returns the number of records in a COS block sequential file
- craybinrecread - works like fbinrecread, reads multiple unformatted sequential records from a COS block file
- day_of_year - returns the day of year, given the year, month, and day of month (Gregorian calendar)
- days_in_month - returns the number of days in a given month (Gregorian calendar)
- dim_max - finds max for dimension n-1 at all other indexes
- dim_min - finds min for dimension n-1 at all other indexes
- dimsizes - returns an array of integer dimension sizes
- fbindirread - reads records from a file written with Fortran's "access=direct"
- fbinnumrec - counts the number of records
in a file written with Fortran's "access=sequential"
- fbinread - reads from a file containing a single unformatted record written with Fortran's "access=sequential"
- fbinrecread - reads from a file containing multiple unformatted records written with Fortran's "access=sequential"
- filevardimsizes - returns an array of integer dimension sizes for file variables
- fspan - returns an array of equally spaced floating point numbers in an inclusive specified range
- getenv - returns a csh environment variable
- getfilevaratts - returns a list of attribute names for a file variable
- getfilevardims - returns a list of dimension names for a file variable
- getfilevarnames - returns a list of variable names for a file
- getvaratts - returns a list of attribute names for a variable
- ind - returns the integer indexes of all elements that are True
- isatt - returns True if the attribute exists
- isbyte - returns True if input expression is of type byte
- ischar - returns True if input expression is of type char
- iscoord - returns True if the coordinate variable exists
- isdefined - returns True if the input string is a defined identifier
- isdim - returns True if a dimension exists
- isdouble - returns True if input expression is of type double
- isfile - returns True if input expression is of type file
- isfilevar - returns True if a file variables exists
- isfilevaratt - returns True if a file variable attribute exists
- isfilevardim - returns True if a file variable dimension exists
- isfilevarcoord - returns True if a file variable dimension has a coordinate variable
- isfloat - returns True if input expression is of type float
- isfunc - returns True if input string is a defined function
- isgraphic - returns True if input expression is of type graphic
- isinteger - returns True if input expression is of type integer
- isleapyear - returns True if input is a leap year (Gregorian calendar)
- islogical - returns True if input expression is of type logical
- islong - returns True if input expression is of type long
- ismissing - returns an n-dimensional logical array where elements are True if the input is missing
- isnumeric - returns True if input is a numeric value
- ispan - returns an array of equally spaced integer values
- isproc - returns True if input string is a defined procedure
- isshort - returns True if input expression is of type short
- isstring - returns True if input expression is of type string
- isvar - returns True if a variable exists
- mask - returns masked n-dimensional array
- max - returns the maximum value of an array
- maxind - returns the index of the maximum value for a 1-dimensional array
- min - returns the minimum value of an array
- minind - returns the index of the minimum value for a 1-dimensional array
- monthday - returns concatenated month and day, given the year and day of year (Gregorian calendar)
- ndtooned - converts an n-dimensional array to a 1-dimensional array
- num - returns the number of True values from input
- onedtond - converts a 1-dimensional array to an n-dimensional array
- rand - returns a random number
- sizeof - returns the total size in bytes of the input
- sprintf - formats floating point number as strings
- systemfunc - returns the output of a shell command as a string
- typeof - returns the type string name of an expression or variable
- asciiwrite - writes a variable to an ASCII file
- attsetvalues - applies a list of resources to a list of HLU objects
- cbinwrite - writes a variable to a C binary file
- delete - deletes an attribute, coordinate variable, or variable
- exit - exits the current script
- fbindirwrite - writes records in a similar manner as using Fortran's "access=direct"
- fbinrecwrite - writes multiple unformatted Fortran records which can be read in Fortran with "access=sequential"
- fbinwrite - writes a variable as a Fortran unformatted array (flat binary write)
- fileattdef - copies attributes from a variable to a file as global attributes
- filedimdef - defines dimensions in files, used to establish an unlimited dimension
- filevarattdef - copies attributes from a variable to a file variable
- filevardef - defines one or more variables in a file without requiring a write
- list_files - lists all open files
- list_filevars - lists all variables for a file
- list_hlus - lists all HLU objects
- list_procfuncs - lists all procedures and functions
- list_vars - lists all variables
- print - prints a variable or expression
- qsort - sorts a 1-dimensional array
- sleep - sleeps for n seconds
- sqsort - string sort
- srand - sets the random number generator seed
- system - calls a system shell command
- undef - undefines variables, functions, and procedures
Functions
- abs - computes absolute value for integer input
- acos - computes inverse cosine in radians
- asin - computes inverse sin in radians
- atan - computes inverse tangent in radians
- atan2 - returns the arctangent of y/x in radians
- avg - average an n-dimensional array of numeric data
- ceil - computes the smallest integer larger than input
-
chiinv - evaluates the inverse chi=squared distribution function
- cos - computes cosine from radian input
- cosh - computes hyperbolic cosine from radian input
- cz2ccm - computes geopotential height for a CCM2 hybrid coordinates
- dim_avg - averages dimension n-1 at all other indexes
- dim_product - computes the product for dimension n-1 at all other indexes
- dim_sum - computes the sum for dimension n-1 at all other indexes
- dim_stddev - computes standard deviation for dimension n-1 at all other indexes
- dim_variance - computes variance for dimension n-1 at all other indexes
- dtrend - removes the least squares linear trend and estimates of the linear trend at all grid points
- eofcor - computes empirical orthogonal functions via the correlation matrix
- eofcov - computes empirical orthogonal functions via the covariance matrix
- eofcor_ts - computes time series of eof amplitudes for each eigenvalue returned by eofcor
- eofcov_ts - computes time series of eof amplitudes for each eigenvalue returned by eofcov
- esacr - computes sample autocorrelations
- esacv - computes sample auto covariances
- esccr - computes sample cross correlations
- esccv - computes sample cross covariances
- exp - computes e to the power of the input
- ezfftb - computes periodic sequences given Fourier coefficients (synthesis)
- ezfftf - computes Fourier coefficients given periodic sequences (analysis)
- f2fsh - interpolates a scalar quantity from one fixed grid to another using spherical harmonics
- f2gsh - interpolates a scalar quantity on a fixed grid to a Gaussian grid using spherical harmonics
- f2fosh - interpolates a scalar quantity on a fixed grid (including pole points) to a fixed-offset grid using spherical harmonics
- fabs - computes absolute value for floating point input
- floor - computes the largest integer smaller than input
- fluxEddy - calculates time averaged eddy flux quantities
- fo2fsh - interpolates a scalar quantity on a fixed-offset grid (including pole points) to a fixed grid using spherical harmonics
- g2fsh - interpolates a scalar quantity on a Gaussian grid to a fixed grid using spherical harmonics
- g2gsh - interpolates a scalar quantity from one Gaussian grid to another using spherical harmonics
- gaus - computes Gaussian latitudes and weights
- hydro - computes the geopotential height using the hydrostatic equation
- idsfft - computes uniform grid from randomly spaced data
- igradsF - computes the scalar function given the gradient (fixed grid)
- igradsG - computes the scalar function given the gradient (Gaussian grid)
- ilapsF - inverts the Laplacian of a scalar function (fixed grid)
- ilapsG - inverts the Laplacian of a scalar function (Gaussian grid)
- int2p - interpolates from one set of pressure levels to another using linear or log interpolation
- lapsF - computes the Laplacian of a scalar (fixed grid)
- lapsG - computes the Laplacian of a scalar (Gaussian grid)
- log - computes natural log
- log10 - computes log base 10
- product - computes the product of every element of the input
- pslec - computes sea level pressure using the ECMWF formulation
- pslhor - computes sea level pressure using the ECMWF formulation and Trenberth's horizontal correction
- pslhyp - computes sea level pressure via the hypsometric equation
- regcoef - calculates the linear regression coefficient between two series
- relhum - calculates relative humidity
- runave - calculates an unweighted running average
- sin - computes sin from radian input
- sindex_yrmo - calculates the Southern Oscillation Index given two series of year-month values
- snindex_yrmo - calculates the Southern Oscillation Index and the noise given two series of year-month values
- sinh - computes hyperbolic sin from radian input
- specx_anal - calculates spectra quantities of a series
- specxy_anal - calculates cross spectra quantities of a series
- sqrt - computes square root of input
- stddev - computes standard deviation
- sum - computes the sum of every element of the input
- svdcov - computes singular value decomposition
- svdstd - standardizes the input data and computes singular value decomposition
- tan - computes tangent from radian input
- tanh - computes hyperbolic tangent from radian input
- uv2dvF - computes the divergence given u and v wind components (fixed grid)
- uv2dvG - computes the divergence given u and v wind components (Gaussian grid)
- uv2vrF - computes the vorticity given u and v wind components (fixed grid)
- uv2vrG - computes the vorticity given u and v wind components (Gaussian grid)
- variance - computes variance
- vibeta - vertical integration using beta factors
- vinth2p - vertical interpolation (optionally, extrapolation) from hybrid coordinates to pressure levels
- wgt_runave - calculates a weighted running average
Procedures
- dv2uvf - computes the divergent (irrotational) wind components given the divergence (fixed grid)
- dv2uvg - computes the divergent (irrotational) wind components given the divergence (Gaussian grid)
- f2foshv - interpolates a vector pair on a fixed grid (including pole points) to a fixed-offset grid using spherical harmonics
- f2fshv - interpolates a vector pair from one fixed grid to another using spherical harmonics
- f2gshv - interpolates a vector pair on a fixed grid to a Gaussian grid using spherical harmonics
- fo2fshv - interpolates a vector pair on a fixed-offset grid (including pole points) to a fixed grid using spherical harmonics
- g2fshv - interpolates a vector pair on a Gaussian grid to a fixed grid using spherical harmonics
- g2gshv - interpolates a vector pair from one Gaussian grid to another using spherical harmonics
- gradsf - computes the gradient of a scalar (fixed grid)
- gradsg - computes the gradient of a scalar (Gaussian grid)
- igradsf - computes the scalar function given the gradient (fixed grid)
- igradsg - computes the scalar function given the gradient (Gaussian grid)
- ilapsf - inverts the Laplacian of a scalar quantity (fixed grid)
- ilapsg - inverts the Laplacian of a scalar quantity (Gaussian grid)
- ilapvf - inverts the vector Laplacian (fixed grid)
- ilapvg - inverts the vector Laplacian (Gaussian grid)
- lapsf - computes the Laplacian of a scalar (fixed grid)
- lapsg - computes the Laplacian of a scalar (Gaussian grid)
- lapvf - computes the vector Laplacian of a vector quantity (fixed grid)
- lapvg - computes the vector Laplacian of a vector quantity (Gaussian grid)
- lderuvf - computes the latitudinal derivatives given a vector function (fixed grid)
- lderuvg - computes the latitudinal derivatives given a vector function (Gaussian) grid)
- shaec - spherical harmonic analyses of a scalar (fixed grid)
- shagc - spherical harmonic analyses of a scalar (Gaussian grid)
- shsec - spherical harmonic syntheses of a scalar (fixed grid)
- shsgc - spherical harmonic syntheses of a scalar (Gaussian grid)
- stat_medrng - calculates the median, range, and mid-range of the given vectors
- stat_trim - calculates trimmed estimates of the first two moments of the given vectors
- stat2 - calculates estimates of the first two moments of the given vectors
- stat4 - calculates estimates of the first four moments of the given vectors
- uv2dvf - computes the divergence given u and v wind components (fixed grid)
- uv2dvg - computes the divergence given u and v wind components (Gaussian grid)
- uv2sfvpf - computes the stream function and velocity potential given u and v wind components (fixed grid)
- uv2sfvpg - computes the stream function and velocity potential given u and v wind components (Gaussian grid)
- uv2vrf - computes the vorticity given u and v wind components (fixed grid)
- uv2vrg - computes the vorticity given u and v wind components (Gaussian grid)
- uv2vrdvf - computes the vorticity and divergence given u and v wind components (fixed grid)
- uv2vrdvg - computes the vorticity and divergence given u and v wind components (Gaussian grid)
- vhaec - vector harmonic analyses (fixed grid)
- vhagc - vector harmonic analyses (Gaussian grid)
- vhsec - vector spherical harmonic syntheses (fixed grid)
- vhsgc - vector spherical harmonic syntheses (Gaussian grid)
- vr2uvf - computes non-divergent (rotational) wind components given relative vorticity (fixed grid)
- vr2uvg - computes non-divergent (rotational) wind components given relative vorticity (Gaussian grid)
- vrdv2uvf - computes wind components u and v given vorticity and divergence (fixed grid)
- vrdv2uvg - computes wind components u and v given vorticity and divergence (Gaussian grid)
- natgridd - interpolates 2D random data to a rectangular grid using natural neighbor interpolation
- natgrids - interpolates 2D random data to a rectangular grid using natural neighbor interpolation
- nngetp - gets a parameter value
- nngetaspectd - returns an aspect at a specified coordinate value
- nngetaspects - returns an aspect at a specified coordinate value
- nngetsloped - retrieves a slope at a specified coordinate value
- nngetslopes - retrieves a slope at a specified coordinate value
- nnpntend - terminates interpolation at single points
- nnpntendd - terminates interpolation at single points
- nnpntinitd - calculates all natural neighbor relationships in an input data array
- nnpntinits - calculates all natural neighbor relationships in an input data array
- nnpntd - interpolates at a specified point
- nnpnts - interpolates at a specified point
- nnsetp - sets a parameter value
- dsgetp - gets a character parameter
- dsgrid2d - interpolates 2D random data to a rectangular grid using simple inverse distance weighted interpolation
- dsgrid2s - interpolates 2D random data to a rectangular grid using simple inverse distance weighted interpolation
- dsgrid3d - interpolates 3D random data to a rectangular grid using simple inverse distance weighted interpolation
- dsgrid3s - interpolates 3D random data to a rectangular grid using simple inverse distance weighted interpolation
- dssetp - sets a parameter value
- dspnt2d - interpolates 2D data at a list of specified points
- dspnt2s - interpolates 2D data at a list of specified points
- dspnt3d - interpolates 3D data at a list of specified points
- dspnt3s - interpolates 3D data at a list of specified points
- ftgetp - retrieves control parameter values
- ftcurv - calculates an interpolatory tension spline
- ftcurvd - calculates the derivatives of an interpolatory tension spline
- ftcurvi - calculates integrals of an interpolatory tension spline
- ftcurvp - calculates an interpolatory tension
spline for periodic functions
- ftcurvpi - calculates the integral of an interpolatory tension spline for periodic functions
- ftcurvs - calculates a smoothing tension spline
- ftcurvps - calculates a smoothing tension spline for periodic functions
- ftsurf - calculates an interpolatory surface passing through a rectangular grid of function values
- ftsetp - sets values for control parameters
- ftkurv - calculates an interpolatory spline for parametric curves
- ftkurvp - calculates an interpolatory spline for closed parametric curves
- ftkurvd - calculates an interpolatory spline and derivatives for parametric curves
- ftkurvpd - calculates an interpolatory spline and derivatives for closed parametric curves
- csa1s - one-dimensional approximation, simple interface
- csa1xs - one-dimensional approximation, expanded interface
- csa2s - two-dimensional approximation, simple interface, gridded output
- csa2xs - two-dimensional approximation, expanded interface, gridded output
- csa2ls - two-dimensional approximation, simple interface, list output
- csa2lxs - two-dimensional approximation, expanded interface, list output
- csa3s - three-dimensional approximation, simple interface, gridded output
- csa3xs - three-dimensional approximation, expanded interface, gridded output
- csa3ls - three-dimensional approximation, simple interface, list output
- csa3lxs - three-dimensional approximation, expanded interface, list output
Functions
Procedures
Note: Some of these procedures have abbreviated names that
reduce the typing needed to enter them. All alternate names are provided
in parentheses.
NCL versions of LLU functions and procedures
Functions
Procedures
- ncargversion
- tdez2d - simplified entry to Tdpack for drawing surfaces
- tdez3d - simplified entry to Tdpack for drawing isosurfaces
- wmbarb - draw wind barbs
- wmsetp - set control
parameter values for wmap.
Note: The reason the functions floattodouble, shorttointeger, integertofloat, etc. don't exist is NCL's implicit coercion rules handle data type conversions that do not potentially truncate the data.
Reference Manual Control Panel
NG4.1 Home, Index, Examples, Glossary, Feedback, Ref Contents, Ref WhereAmI?
$Revision: 1.68 $ $Date: 1999/04/19 13:36:36 $