NCL Website header
NCL Home > Documentation > Functions > Interpolation, Regridding

obj_anal_ic_Wrap

Iterative improvement objective analysis and returns meta data.

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 obj_anal_ic_Wrap (
		zlon   [*] : numeric,  
		zlat   [*] : numeric,  
		z          : numeric,  
		glon   [*] : numeric,  
		glat   [*] : numeric,  
		rscan  [*] : numeric,  
		option [1] : logical   
	)

Arguments

zlon
zlat

One-dimensional arrays containing the longitudes and latitudes associated with the z values. They must be the same length as the rightmost dimension of z.

z

An array, whose rightmost dimension is the same length as zlon and zlat, containing the values associated with the zlon and zlat coordinates. Missing values, indicated via z@_FillValue, may be present but will be ignored.

glon

A one-dimensional array of length M containing the longitude coordinates associated with the returned two-dimensional grid.

glat

A one-dimensional array of length N containing the latitude coordinates associated with the returned two-dimensional grid.

rscan

A one-dimensional array of length K specifying the successive radii of influence. The maximum size of rscan is 10. Typically, rscan contains one-to-four elements. Must be expressed in degrees of latitude and must be monotonically decreasing. eg: rscan = (/10, 5, 3/)

option

If option=False, this function will operate under default mode. If option=True, then this variable may have associated with it the attribute blend_wgt. This specifies how successive new estimates are 'blended'(local smoother) with previously derived estimates. These values must be 0.0 < blend_wgt < 1.0. A value of 1.0 means that the current interpolated value will be used. Otherwise:

      new_value(n) = blend_wgt(n)*current_estimate + (1-blend_wgt(n))*value(n-1)
The size of blend_wgt must be the same size as rscan.

Description

This function is identical to obj_anal_ic, except the return value will have metadata added based on metadata attached to z. See the obj_anal_ic page for full documentation and examples.