<<prev file | next file >>    view single page | view frames    summary: fields | routine    details: routine

ToBeReviewed/PLOTS/DIVERS/

checkfield.pro

In input of plt, pltz, pltt and plt1d, it check that the field give a size compatible with the domain and, if needed, average to give us a 2d array if we make a plot of the type: 'xy', 'xz', 'xt', 'yz', 'yt' , 'zt' or a 1d array if we make a plot of the type: 'x', 'y', 'z', 't'.

Routine summary

result = err_1d(type, n1, name, n2)

result = err_2d(type, sz, nx, ny, nz)

result = err_3d(type, sz, nx, ny, nz)

result = checkfield(field, procedure, TYPE=TYPE, BOXZOOM=BOXZOOM, DIREC=DIREC, NOQUESTION=NOQUESTION, VECTEUR=VECTEUR, WDEPTH=WDEPTH, _EXTRA=_EXTRA)

toperr_1d

result = err_1d(type, n1, name, n2)

Parameters

type       

n1       

name       

n2       

toperr_2d

result = err_2d(type, sz, nx, ny, nz)

Parameters

type       

sz       

nx       

ny       

nz       

toperr_3d

result = err_3d(type, sz, nx, ny, nz)

Parameters

type       

sz       

nx       

ny       

nz       

topcheckfield graphic

result = checkfield(field, procedure, TYPE=TYPE, BOXZOOM=BOXZOOM, DIREC=DIREC, NOQUESTION=NOQUESTION, VECTEUR=VECTEUR, WDEPTH=WDEPTH, _EXTRA=_EXTRA)

Parameters

field        in required

A field respecting litchamp.pro's criterions. See IDL>xhelp,'litchamp'

procedure       

Keywords

TYPE       

BOXZOOM       

Vector indicating the geographic zone on which we want to cut the map. If BOXZOOM has : 1 element : The extraction is made on [lon1, lon2, lat1, lat2, 0.,boxzoom[0]] 2 elements: The extraction is made on [lon1, lon2, lat1, lat2, boxzoom[0],boxzoom[1]] 4 elements: The extraction is made on [Boxzoom, 0, max([gdept, gdepw])] 5 elements: The extraction is made on [Boxzoom[0:3], 0, Boxzoom[4]] 6 elements: The extraction is made on Boxzoom Where lon1, lon2,lat1,lat2 are global variables defined at the last domdef!

DIREC       

NOQUESTION       

VECTEUR       

is also appropriated.

WDEPTH       

to specify that the field is at W depth instad of T depth (automatically activated if vargrid eq 'W')

_EXTRA       

used to pass your keywords

Version history

Version

$Id$

History

Known issues

Todo items

seb: mettre les param

Other attributes

Uses routines

common.pro
Produced by IDLdoc 2.0.