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=vector, DIREC=DIREC, NOQUESTION=NOQUESTION, VECTEUR=vetcor, WDEPTH=WDEPTH, _EXTRA=_EXTRA)
-
-
err_1d
result = err_1d(type, n1[, name], n2)
Return value
Parameters
type
in
required
type: string
A string of two characters specifying the type of plot we do
n1
in
required
type: integer
Number of elements in the first dimension
name
in
optional
type: string
It gives the name of the file to be opened. If NAME
does not contain the separating character of directories ('/' under
unix for example), the file will be looked for in the current directory.
n2
in
required
type: integer
Number of elements in the second dimension
Examples
Version history
Version
$Id: checkfield.pro 157 2006-08-21 09:01:50Z navarro $
History
Known issues
Restrictions
err_2d
result = err_2d(type[, sz][, nx][, ny], nz)
Return value
Parameters
type
in
required
type: string
A string of two characters specifying the type of plot we do
sz
in
optional
default: defined by grille.pro
nx
in
optional
default: defined by grille.pro
ny
in
optional
default: defined by grille.pro
nz
Examples
Version history
Version
$Id: checkfield.pro 157 2006-08-21 09:01:50Z navarro $
History
Known issues
Restrictions
err_3d
result = err_3d(type[, sz][, nx][, ny], nz)
Return value
Parameters
type
in
required
type: string
A string of two characters specifying the type of plot we do
sz
in
optional
default: defined by grille.pro
nx
in
optional
default: defined by grille.pro
ny
in
optional
default: defined by grille.pro
nz
Examples
Version history
Version
$Id: checkfield.pro 157 2006-08-21 09:01:50Z navarro $
History
Known issues
Restrictions
checkfield
Graphics
result = checkfield(field, procedure, TYPE=TYPE, BOXZOOM=vector, DIREC=DIREC, NOQUESTION=NOQUESTION, VECTEUR=vetcor, WDEPTH=WDEPTH, _EXTRA=_EXTRA)
Parameters
field
in
required
type: field
It respect litchamp.pro's criterions. See IDL>xhelp,'litchamp'
procedure
in
required
Keywords
TYPE
BOXZOOM
type: vector
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
type: vetcor
is also appropriated.
WDEPTH
to specify that the field is at W depth instead of T
depth (automatically activated if vargrid eq 'W')
_EXTRA
used to pass your keywords
Version history
Version
$Id: checkfield.pro 157 2006-08-21 09:01:50Z navarro $
History
Sebastien Masson (smasson@lodyc.jussieu.fr)
08/02/2000
Known issues
Todo items
seb: mettre les param
Other attributes
Uses routines
common.pro
Produced by IDLdoc 2.0 on Tue Aug 29 14:50:18 2006.
