pltz.pro (SAXO Documentation)

toppltz Graphics

pltz, tab, giventype, givenmin, givenmax, BOXZOOM=BOXZOOM, CONTOUR=CONTOUR, ENDPOINTS=ENDPOINTS, INTERVALLE=INTERVALLE, INV=INV, ZRATIO=ZRATIO, CONTINTERVALLE=CONTINTERVALLE, LABEL=LABEL, CONTLABEL=CONTLABEL, STYLE=STYLE, CONTMAX=CONTMAX, SIN=SIN, TYPEIN=TYPEIN, CONTMIN=CONTMIN, NLEVEL=NLEVEL, CONTNLEVEL=CONTNLEVEL, 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.pro. See IDL> xhelp,'litchamp'. The array contin in the structure must be 2 or 3d (See case 1) ces arguments ne sont pas obligatoires: MAX: 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) MIN: 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)

giventype

givenmin

givenmax

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 examlpe E-P in color and QSR in contours). It must be a field respecting same caracteristics than the argument number one of plt.

ENDPOINTS

keyword specifing that we want to make a vertical cut in diagonal. Then coorinated of extremities of these one are difined by the 4 elements of the vector ENDPOINTS: [x1,y1,x2,y2] which are coordinates.

INTERVALLE

Value of an internal between to isoline. 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 isoline. 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

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). By default =2./3

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

It is an integer n. If n different of 0, it choose the label's type corresponding to cases n. cf label.pro Comment: When CONTOUR is activated, it only specify the label's type for colored isolines. For tese one traced by a trait, use CONTLABEL.

CONTLABEL

It is an integer n. When CONTOUR is actvated, 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

Contour's style to adopt to draw isolines(by default, style=0. see style.pro)

CONTMAX

When CONTOUR is activated, max value we want to consider in the isoline traced by a trait's line. By default, we take the max (on ocean points) of the array passed in the keyword CONTOUR.

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

When CONTOUR is activated, min value we want to consider in the isoline traced by a trait's line. By default, we take the min (on ocean points) of the array passed in the keyword CONTOUR.

NLEVEL

Number of contour to draw by default =20. active if LABEL=0 or is not specified.

CONTNLEVEL

When CONTOUR is activated, it is the numbre of contours traced by a trait for drawing (active if CONTLABEL=0) by default=20.

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) exept 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

Depth where i can make our maximum zoom. By default 200m or max depth if it is inferior at 200m

XZ

Force to make a cut following xz

YZ

Force to make a cut following yz

MININ

Allows to specify the min value we want to consider in the drawing of contour helping by the keyword instead of the argument min. If the argument and the keyword are specified in the same time, it is the value specified by the keyword which is retained.

MAXIN

Allows to specify the max value we want to consider in the drawing of contour helping by the keyword instead of the argument max. If the argument and the keyword are specified in the same time, it is the value specified by the keyword which is retained.

STRICTFILL

Activate this keyword to that the filling of contours be precisely done between the min and the max specified letting values inferior at the specified min and values superior at the specified max in white.

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$

History

Known issues

Todo items

seb L.20 � 26, L.215 � 221

Other attributes

Uses routines

common.pro

SAXO Documentation

ToBeReviewed/PLOTS/DESSINE/

pltz.pro