ToBeReviewed/PLOTS/DESSINE/
pltz.pro
Trace vertical graphs.
pltz
Graphics
pltz, tab, giventype, givenmin, givenmax, BOXZOOM=BOXZOOM, CONTOUR=CONTOUR, ENDPOINTS=ENDPOINTS, INTERVALLE=INTERVALLE, INV=INV, ZRATIO=ZRATIO, CONTINTERVALLE=CONTINTERVALLE, LABEL=integer, CONTLABEL=integer, STYLE=STYLE, CONTMAX=CONTMAX, SIN=SIN, TYPEIN=TYPEIN, CONTMIN=CONTMIN, NLEVEL=NLEVEL, CONTNLEVEL=CONTNLEVEL, NOFILL=NOFILL, NOTRI=NOTRI, USETRI=USETRI, FILLXDIR=FILLXDIR, ZOOM=ZOOM, XZ=XZ, YZ=YZ, MININ=MININ, MAXIN=MAXIN, STRICTFILL=STRICTFILL, OVERPLOT=OVERPLOT, MASKFILL=MASKFILL, WDEPTH=WDEPTH, REALSECTION=REALSECTION, _EXTRA=_EXTRA
Parameters
tab
The field whose we want to make a vertical cut can be 2 kind of thing:
1) An 2d or 3d array.
If the field is 2d, indicate, with the keyword BOXZOOM, geographic delineations of the boxzoom.
If the field is 3d, we extract the section on we average possibly before to do the plot.
2) a structure respecting all criterions specified by litchamp.
See IDL> xhelp,'litchamp'. The array contained in the structure must be 2 or 3d (See case 1)
giventype
givenmin
required
valeur minimum que l'on veut prendre en compte dans le trace
des contours. Par defaut on prend le min de tab1 (sur les pts mer)
givenmax
required
valeur maximum que l'on veut prendre en compte dans le trace
des contours. Par defaut on prend le max de tab1 (sur les pts mer)
Keywords
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 !
CONTOUR
If we want to trace contours of a different field than the one
whose we have the colored drawing (by example E-P in color and QSR in contours).
It must be a field respecting same characteristics than the argument number one of plt.
ENDPOINTS
keyword specifying that we want to make a vertical cut in diagonal. Then coordinated of extremities
of these one are defined by the 4 elements of the vector ENDPOINTS: [x1,y1,x2,y2] which are
coordinates.
INTERVALLE
Value of an interval between two isolines. If there is none specified min,
we choose a min contour which goes well with the specified interval!. If this keyword is not
specified, we trace 20 isoline from the min to the max. Comment: When CONTOUR is activated,
INTERVALLE only specify the interval between 2 colored isolines. To specify the interval
between 2 isolines traced by a trait, use CONTINTERVALLE.
INV
Invert the color vector used to color the graph
(without use the black, the white and the used palette)
ZRATIO
default: 2./3
When the drawing has a zoomed part, it is the size rapport between the zoomed part,
hz (zoom height), and the whole drawing, ht (total height).
CONTINTERVALLE
When CONTOUR is activated, it is the value between 2 isolines
traced by a trait. So it can be different from the one specified by INTERVALLE which,
in this case, does not control colored isolines in color anymore. If there is noone
specified min, we choose a contour min which goes well with the specified interval!
If this keyword is not specified, we trace 20 isolines from the min to the max.
LABEL
type: integer
default: 0
It choose the label's type corresponding to cases in label
Comment: When CONTOUR is activated, it only specify the label's type for colored isolines.
For these one traced by a trait, use CONTLABEL.
CONTLABEL
type: integer
When CONTOUR is activated, if n
is different of 0, choose the label type corresponding to n cases for
the traced by a traitisolines. To specify the type of label of the
colored contour, use LABEL
STYLE
default: style
Contour's style to adopt to draw isolines. See style for more informations
CONTMAX
default: max of the keyword CONTOUR (on ocean points)
When CONTOUR is activated, max value we want to consider in the isoline
traced by a trait's line.
SIN
Activate this keyword if we want the x axis to be traced in sinus of the
latitude when we make a drawing f(y)
TYPEIN
CONTMIN
default: min of the keyword CONTOUR (on ocean points)
When CONTOUR is activated, min value we want to consider in the isoline
traced by a trait's line.
NLEVEL
default: 20
Number of contours to draw. active if
LABEL=0 or is not specified.
CONTNLEVEL
default: 20
When CONTOUR is activated, it is the number of contours
traced by a trait for drawing (active if
CONTLABEL=0).
NOFILL
To make just isolines with no filling
NOTRI
To force not to use the triangulation. Beware, in this case, the
drawing only works if the grid is undeformed (It means that each point of a longitude
give one latitude and each point of a latitude give one longitude) except if we use
the keyword CELL_FILL=2.
Comment: if the field contain points !values.f_nan, then we even do a triangulation.
USETRI
FILLXDIR
ZOOM
default: 200m or max depth if it is inferior at 200m
Depth where i can make our maximum zoom.
XZ
Force to make a cut following xz
YZ
Force to make a cut following yz
MININ
to specify the min value we want to plot with a keyword instead of with the
input parameter min. If min is defined by both, parameter and keyword, the
keyword is retained.
MAXIN
to specify the max value we want to plot with a keyword instead of with the
input parameter max. If max is defined by both, parameter and keyword, the
keyword is retained.
STRICTFILL
Activate this keyword to that the filling of contours be
precisely done between the min and the max specified. Values inferior/superior at the
specified min/max are not filled. Note that max values a considered
as missing values so cells containing one or more corners with
values above max will have no contours drawn through them.
OVERPLOT
To make a plot over an other one.
Comment: Contrarily to the use of CONTOUR or VECTEUR, the use of this keyword
does not the caption and/or the color bar.
MASKFILL
WDEPTH
To specify that the field is at W depth instead of T
depth (automatically activated if vargrid eq 'W')
REALSECTION
_EXTRA
Version history
Version
$Id: pltz.pro 360 2008-06-06 13:43:54Z smasson $
History
Sebastien Masson (smasson@lodyc.jussieu.fr)
7/1999
Sebastien Masson 08/02/2000 checkfield and
notri keyword.
Known issues
Todo items
seb definition of paramaters L.215 à 221
Other attributes
Uses routines
common.pro
Produced by IDLdoc 2.0.