NCL Home > Documentation > Functions > Lat/Lon functions

latGauWgt

Generates gaussian weights and associated metadata.

Prototype

load "$NCARG_ROOT/lib/ncarg/nclscripts/csm/contributed.ncl"  ; This library is automatically loaded
                                                             ; from NCL V6.2.0 onward.
                                                             ; No need for user to explicitly load.

	function latGauWgt (
		nlat     [1] : integer or long,  
		name     [1] : string,           
		longname [1] : string,           
		units    [1] : string            
	)

	return_val [*] :  float

Arguments

nlat

A scalar equal to the number of latitudes desired.

As of version 6.0.0, this can be of type integer or long.

name

A string that will become the named dimension of the output (e.g. "lat").

longname

A string that will become the long_name of the output variable (e.g. "gaussian weights").

units

A string that will become the units of the output. Gaussian weights are dimensionless. Setting units to "" (no space between the "") will result in no units attribute. The user may prefer to explicitly have a units attribute. If so, setting units to (say) "dimensionless" will result in an explicit units attribute.

Return value

A one-dimensional array of size nlat. Type float by default. If double precision is desired, set nlat@double = True prior to invoking the function.

Description

Generates gaussian weights and associated metadata.

Examples

Example 1

Create a one dimensional array of gaussian weights.

      nlat = 64
      gwt  = latGauWgt(nlat, "lat", "gaussian weights", "")
      print(gwt)

The above returns a 1D array of length nlat values.