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

ToBeReviewed/PLOTS/DESSINE/

pltt.pro

Trace hovmoeller graphs: xt,yt,zt,t

toppltt Graphics

pltt, tab, giventype, givenmin, givenmax, datmin, datmax, BOXZOOM=BOXZOOM, CONTOUR=CONTOUR, ENDPOINTS=ENDPOINTS, INTERVALLE=INTERVALLE, INV=INV, CONTINTERVALLE=CONTINTERVALLE, LABEL=integer, CONTLABEL=integer, STYLE=STYLE, CONTMAX=CONTMAX, CONTMIN=CONTMIN, NOFILL=NOFILL, NLEVEL=NLEVEL, CONTNLEVEL=CONTNLEVEL, COL1D=COL1D, STY1D=STY1D, MININ=MININ, MAXIN=MAXIN, OV1D=OV1D, FILTER=FILTER, TREND_TYPE=TREND_TYPE, REPEAT_C=REPEAT_C, TYPEIN=TYPEIN, XT=XT, YT=YT, ZT=ZT, TT=TT, STRICTFILL=STRICTFILL, OVERPLOT=OVERPLOT, EXCHANGE_XY=EXCHANGE_XY, _EXTRA=_EXTRA

Parameters

tab        in required

The field whose we want to make the hovmoeller map can be 2 kind of thing: 1) An array which can be: * 3d or 4d: array 'xt','yt','zt','t'. The last component is the time. In this case, the array will pass in grossemoyenne to be averaged and become an 1d or 2d array. * 2d: If the array is already 2d, it is not modified (beware, lands must be masked at the value valmask) and nevertheless, type must be specified to we know of which trace it is about. To have a correct caption, respecify the extraction zone via BOXZOOM. * 1d: only for traces of the 't' type. Nevertheless, type must be specified to we know of which trace it is about. To have a correct caption, respecify the extraction zone via BOXZOOM. 2) a structure respecting all criterions specified by litchamp See IDL> xhelp,'litchamp'. The array contained in the structure respecting criterions of case 1)

giventype       

givenmin       

valeur minimum que l''on veut prendre en compte dans le trace des contours. Par defaut on prend le min de tableau (sur les pts mer)

givenmax       

valeur maximum que l''on veut prendre en compte dans le trace des contours. Par defaut on prend le max de tableau (sur les pts mer)

datmin       

c''est la borne inf de l''axe temporel. c''est un longinteger de la forme yyyymmdd (ou bien yymmdd).

datmax       

c''est la borne max de l''axe temporel. c''est un longinteger de la forme yyyymmdd (ou bien yymmdd)

Keywords

BOXZOOM       

Vector indicating the geographic zone (3d) on which the extraction of the field must be done to do the hovmoeller. 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, vert1, vert2] 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,vert1,vert2 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 pltt.

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)

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

If n different of 0, it choose the label's type corresponding to cases n. cf 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: we take the max of the array passed in 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.

CONTMIN        default: we take the min of the array passed in 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.

NOFILL       

To make just isolines with no filling

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). When CONTOUR is activated, it is the number of contours traced by a trait for drawing (active if CONTLABEL=0).

COL1D       

--OBSOLETE--Color number when we make a trace 1d by default, 0.It is better to use the keyword COLOR used by plot.

STY1D       

--OBSOLETE-- Number of the style used when we make a 1d drawing. We should better use the keyword LINESTYLE which is tho one of the plot. Beware, this keyword is still useful if we want to d bars instead of curves, put sty1d='bar'

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.

OV1D       

Allows to overprint a 1d curve over a precedent 1d drawing.

FILTER       

Apply a slippery average of width FILTER

TREND_TYPE       

Modify field by calling trends

REPEAT_C       

TYPEIN       

allows to specify the type of hovmoeller we want to do 'xt','yt','zt','t' with help of a keyword rather than the argument type. If the argument and the keyword are specified in the same time, it is the value specified by the keyword which is retained.

XT       

YT       

ZT       

TT       

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.

EXCHANGE_XY       

Allows to invert axes.

_EXTRA       

Used to pass keywords

Version history

Version

$Id: pltt.pro 328 2007-12-13 19:27:11Z smasson $

History

Sebastien Masson (smasson@lodyc.jussieu.fr) 27/5/98 Jerome Vialard (adapting plt to hovmoeller drawing) 2/7/98 Sebastien Masson 14/8/98 (continents,barres) 15/1/98 Adaptation for arrays 3 and 4d to the average be done in pltt rather than during the reading. Sebastien Masson 14/8/98 7/1999 Eric Guilyardi 29/7/99 FILTER, TREND_TYPE, REPEAT_C Sebastien Masson 08/02/2000 checkfield and usetri keyword.

Known issues

Todo items

seb: definition of parameters, L.426 à 427, L. 492 à 493

Other attributes

Uses routines

common.pro

Statistics

McCabe cyclic 95
McCabe essential 8
McCabe modular design 1
Produced by IDLdoc 2.0.