NCL source code functions and procedures


bigger.ncl
Contains a single procedure to make plots bigger.
Source: bigger.ncl
procedure bigger (
	plot[1]:graphic,
	frac[1]:numeric
)
Arguments
- plot
 -  A reference to an HLU plot object
 - frac
 -  A numeric value given in % 
 
Description
Makes a plot bigger by a given fraction. 
centerat.ncl
Contains a single procedure that will center a plot at a give NDC point.
Source: centerat.ncl
procedure centerat (
	plot[1]:graphic,
	x[1]:numeric,
	y[1]:numeric
)
Arguments
- plot
 -  A reference to an HLU plot object
 - x
 -  x coordinate of center point in NDC units
 - y
 -  y coordinate of center point in NDC units
 
Description
Resets a plots view port so it is centered at the input point (/x,y/)
copy.ncl
Contains 6 procedures for copying attributes, dimension names and coordinate variables from
variables to variables and from file variables to variables
Source: copy.ncl
procedure copy_varcoords (
	var_from ,
	var_to
)
Arguments
- var_from
 -  Variable from which coordinates will be copied.
 - var_to
 -  Variable to which coordinates will be copied.
 
Description
Copies all the dimension names and ascotiated coordinate variables from var_from to var_to if and only if the dimension sizes match.
Source: copy.ncl
procedure copy_varatts (
	var_from,
	var_to
)
Arguments
- var_from
 -  Variable from which attributes will be copied
 - var_to
 -  Variable to which attributes will be copied
 
Description
Copies all the atttributes from var_from to var_to
Source: copy.ncl
procedure copy_vardims (
	var_from,
	var_to
)
Arguments
- var_from
 -  Variable to copy dimension names from
 - var_to
 -  Variable to copy dimension names to
 
Description
Copies dimension names from one variable to another. The variables must have the same number of dimensions.
Source: copy.ncl
procedure copy_filevaratts (
	fromfile[1]:file,
	fromvar[1]:string,
	var_to
)
Arguments
- fromfile
 -  A reference to the file containing the variable fromvar
 - fromvar
 -  The string name of the variable from which the attributes will be read 
 - var_to
 -  The variable towhich the attributes will be copied
 
Description
Reads attributes of a file variable and assigns them to var_to
Source: copy.ncl
procedure copy_filevarcoords (
        fromfile[1]:file,
        fromvar[1]:string,
        var_to
)
Arguments
- fromfile
 -  A reference to the file containing the variable fromvar
 - fromvar
 -  The string name of the variable from which the coordinate variables will be read 
 - var_to
 -  The variable to which the coordinate variables will be assigned
 
Description
Copies coordinate variables from the variable fromvar in the file fromfile to var_to. If
the dimension sizes or number of dimensions don't match then an error is printed and no changes are made to var_to.
Source: copy.ncl
procedure copy_filevardims (
        fromfile[1]:file,
        fromvar[1]:string,
        var_to
)
Arguments
- fromfile
 -  A reference to the file containing the variable fromvar
 - fromvar
 -  The string name of the variable from which the dimension names will be read 
 - var_to
 -  The variable to which the dimension names will be assigned
 
Description
Copies dimension names from the variable fromvar in the file fromfile to var_to. If
the number of dimensions don't match then an error is printed and no changes are made to var_to.
hsv2rgb.ncl
Converts from the HSV color model to the RGB color model required by the HLU
workstation object
Source: hsv2rgb.ncl
function hsv2rgb (
	h[*]:float,
	v[*]:float,
	s[*]:float
)
Arguments
- h
 - A singly dimensioned array of values from [0.0..360.0]
 - v
 - A singly dimensioned array the same size as h with values from [0.0..1.0]
 - s
 - A singly dimensioned array the same size as h with values from [0.0..1.0]
 
Description
This function maps values from the HSV color model to the RGB color model.
HSV is a good model for generating smooth color maps. See (Computer Graphics: Principles and Practice by Foley). The return value is a 2 dimensional array of
rgb color triplets. The return value from this function can be directly assigned to the "wkColorMap" resource of an HLU workstation object.
map_corners.ncl
Contains a single function for returning the lat/lon coordinates at the corners of the viewport.
Source: map_corners.ncl
function  map_corners (
	mp[1]:graphic
)
Arguments
- mp
 -  A reference to an HLU mapPlotClass object
 
Description
Returns the lat/lon coordinates of the map plot at the corners of the viewport. This function only works when
"mpLimitMode" is not equal to "MAXIMALAREA".
mapzoom.ncl
Contains a single procedure that zooms in on a specific lat/lon location.
Source: mapzoom.ncl
procedure mapzoom(
	mp[1]:graphic,
	lat[1]:float,
	lon[1]:float,
	scale[1]:integer
)
Arguments
- mp
 -  A reference to an HLU mapPlotClass object
 - lat
 -  Lattitude about which the map will be centered
 - lon
 -  Longitude about which the map will be centered
 - scale
 -  Number of times to zoom in (i.e. 2 means 2X zoom)
 
Description
Configures the mapPlotClass object mp such that it is centered at (lat,lon) and
is zoomed in by scale. A value of 2 for  scale means a 2X zoom is applied.
move.ncl
Contains a single routine to move a plot by a x and y NDC value
Source: move.ncl
procedure move (
	plot[1]:graphic,
	dx[1]:float,
	dy[1]:float
)
Arguments
- plot
 -  A reference to an HLU plot object
 - dx
 -  A offset in NDC units to move the plot in the x direction
 - dy
 -  A offset in NDC units to move the plot in the y direction
 
Description
Given NDC offset, this procedure moves the input plot by the offset (dx,dy).
moveto.ncl
Contains a single routine to move a plot to a specific location in NDC units.
Source: moveto.ncl
procedure moveto (
	plot[1]:graphic,
	vpx[1]:float,
	vpy[1]:float
)
Arguments
- plot
 -  A reference to an HLU plot object
 - vpx
 -  New x coordinate of upper left corner of plot in NDC units
 - vpy
 -  New y coordinate of upper left corner of plot in NDC units
 
Description
Assigns vpx and vpy to the resources "vpXF" and "vpYF" 
respectively
plot_utils.ncl
Source: plot_utils.ncl
procedure FUNCNAME (
)
Arguments
- frac
 -  A numeric value given in % 
 
Description
Makes a plot bigger by a given fraction. 
plotcolors.ncl
Source: plotcolors.ncl
procedure FUNCNAME (
)
Arguments
- frac
 -  A numeric value given in % 
 
Description
Makes a plot bigger by a given fraction. 
save.ncl
Source: save.ncl
procedure FUNCNAME (
)
Arguments
- frac
 -  A numeric value given in % 
 
Description
Makes a plot bigger by a given fraction. 
setaspect.ncl
Source: setaspect.ncl
procedure FUNCNAME (
)
Arguments
- frac
 -  A numeric value given in % 
 
Description
Makes a plot bigger by a given fraction. 
sm11tr.ncl
Source: sm11tr.ncl
procedure FUNCNAME (
)
Arguments
- frac
 -  A numeric value given in % 
 
Description
Makes a plot bigger by a given fraction. 
smaller.ncl
Source: smaller.ncl
procedure FUNCNAME (
)
Arguments
- frac
 -  A numeric value given in % 
 
Description
Makes a plot bigger by a given fraction. 
smooth92d.ncl
Source: smooth92d.ncl
procedure FUNCNAME (
)
Arguments
- frac
 -  A numeric value given in % 
 
Description
Makes a plot bigger by a given fraction. 
vor.ncl
Source: vor.ncl
procedure FUNCNAME (
)
Arguments
- frac
 -  A numeric value given in % 
 
Description
Makes a plot bigger by a given fraction. 
zoom.ncl
Source: zoom.ncl
procedure FUNCNAME (
)
Arguments
- frac
 -  A numeric value given in % 
 
Description
Makes a plot bigger by a given fraction. 
Reference Manual Control Panel
NG4.1 Home, Index, Examples, Glossary, Feedback, Ref Contents, Ref WhereAmI?
 $Revision: 1.4 $ $Date: 1998/09/17 16:11:07 $