source: trunk/SRC/Documentation/xmldoc/mini_notice.html @ 147

Last change on this file since 147 was 145, checked in by pinsard, 18 years ago

new .html file from .xml file following the previous revision for Id modification

  • Property svn:keywords set to Id
File size: 29.8 KB
Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3<head>
4<meta name="generator" content=
5"HTML Tidy for Mac OS X (vers 1 September 2005), see www.w3.org">
6<meta http-equiv="Content-Type" content=
7"text/html; charset=us-ascii">
8<title>Mini Guide for Basic Commands in the XXX Program</title>
9<link rel="stylesheet" href="style.css" type="text/css">
10<link rel="stylesheet" href="saxo.css" type="text/css">
11<meta name="generator" content="DocBook XSL Stylesheets V1.70.1">
12<meta name="keywords" content="idl, SAXO, xxx">
13</head>
14<body bgcolor="white" text="black" link="#0000FF" vlink="#840084"
15alink="#0000FF">
16<div class="article" lang="en">
17<div class="titlepage">
18<div>
19<div>
20<h2 class="title"><a name="d0e2" id="d0e2"></a> Mini Guide for
21Basic Commands in the XXX Program</h2>
22</div>
23<div>
24<div class="authorgroup">
25<div class="author">
26<h3 class="author"><span class="firstname">S&eacute;bastien</span>
27<span class="surname">Masson</span> <code class=
28"email">&lt;<a href="mailto:Sebastien.Masson_at_locean-ipsl.upmc.fr">Sebastien.Masson_at_locean-ipsl.upmc.fr</a>&gt;</code></h3>
29</div>
30<div class="author">
31<h3 class="author"><span class="firstname">Albert</span>
32<span class="surname">Fisher</span></h3>
33</div>
34<div class="author">
35<h3 class="author"><span class="firstname">Fran&ccedil;oise</span>
36<span class="surname">Pinsard</span> <code class=
37"email">&lt;<a href=
38"mailto:Francoise.Pinsard_at_locean-ipsl.upmc.fr">Francoise.Pinsard_at_locean-ipsl.upmc.fr</a>&gt;</code></h3>
39</div>
40<div class="author">
41<h3 class="author"><span class="firstname">Steve</span>
42<span class="surname">Navarro</span></h3>
43</div>
44</div>
45</div>
46<div><span class="pubdate">svn Id of xml source file : $Id:
47mini_notice.xml 144 2006-07-21 14:32:11Z pinsard $<br>
48<br></span></div>
49<div>
50<div class="revhistory">
51<table border="1" width="100%" summary="Revision history">
52<tr>
53<th align="left" valign="top" colspan="2"><b>Revision
54History</b></th>
55</tr>
56<tr>
57<td align="left">Revision 0.0</td>
58<td align="left">May 29, 2000</td>
59</tr>
60<tr>
61<td align="left" colspan="2">French release by S&eacute;bastien
62Masson</td>
63</tr>
64<tr>
65<td align="left">Revision 0.1</td>
66<td align="left">July, 2002</td>
67</tr>
68<tr>
69<td align="left" colspan="2">Translation by Albert Fisher</td>
70</tr>
71<tr>
72<td align="left">Revision 0.2</td>
73<td align="left">July 20, 2006</td>
74</tr>
75<tr>
76<td align="left" colspan="2">HTML to XML/Docbook migration by
77Fran&ccedil;oise Pinsard</td>
78</tr>
79</table>
80</div>
81</div>
82</div>
83<hr></div>
84<div class="toc">
85<p><b>Table of Contents</b></p>
86<dl>
87<dt><span class="sect1"><a href="#intro">1. Introduction and
88assumptions</a></span></dt>
89<dt><span class="sect1"><a href="#beforefirststeps">2. Before
90this</a></span></dt>
91<dt><span class="sect1"><a href="#initfiles">3. Install the files
92<code class="filename">init.pro</code> and <code class=
93"filename">initgrid.pro</code></a></span></dt>
94<dd>
95<dl>
96<dt><span class="sect2"><a href="#modifinitgrid">3.1. Modification
97or creation of the <code class="filename">initgrid.pro</code>
98script</a></span></dt>
99</dl>
100</dd>
101<dt><span class="sect1"><a href="#introxxx">4. Starting the
102<span class="application">SAXO</span> package and an explanation of
103the XXX widget functions</a></span></dt>
104<dd>
105<dl>
106<dt><span class="sect2"><a href="#launchxxx">4.1. Launching
107XXX</a></span></dt>
108<dt><span class="sect2"><a href="#wigdets">4.2. An explanation of
109the different widgets</a></span></dt>
110</dl>
111</dd>
112<dt><span class="sect1"><a href="#examples">5. Concrete examples of
113XXX in practice</a></span></dt>
114<dd>
115<dl>
116<dt><span class="sect2"><a href="#example1">5.1. First
117plots</a></span></dt>
118<dt><span class="sect2"><a href="#example2">5.2. Work with more
119than one file</a></span></dt>
120<dt><span class="sect2"><a href="#mouse">5.3. Mouse actions in the
121graphics window on a horizontal plot</a></span></dt>
122<dt><span class="sect2"><a href="#multipleplots">5.4. Create
123multiple plots on the same sheet and make them
124interact</a></span></dt>
125</dl>
126</dd>
127<dt><span class="sect1"><a href="#crash">6. How to quit when it
128crashes</a></span></dt>
129</dl>
130</div>
131<div class="sect1" lang="en">
132<div class="titlepage">
133<div>
134<div>
135<h2 class="title" style="clear: both"><a name="intro" id=
136"intro"></a>1.&nbsp;Introduction and assumptions</h2>
137</div>
138</div>
139</div>
140<p>This micro guide is unfortunately not a user's guide for all the
141scripts that have been written for IDL (version 5.2 or higher
142required). The goal is simply to clarify a few points on the use of
143the <code class="filename">xxx.pro</code> program.</p>
144<p>For further help on the furnished scripts, here are several
145possibilities:</p>
146<div class="itemizedlist">
147<ul type="disc">
148<li>
149<p>execute in IDL the command</p>
150<pre class="screen">
151<code class="prompt">idl&gt;</code> <strong class=
152"userinput"><code>xhelp, '<em class=
153"replaceable"><code>script_name</code></em>'</code></strong>
154</pre></li>
155<li>
156<p>consult the IDL online help for scripts whose source is
157unavailable</p>
158</li>
159<li>
160<p>subscribe to the mailing list for updates and user
161questions/responses</p>
162<p>to subscribe, send a mail to: <a href=
163"mailto:majordomo@lmd.jussieu.fr" target=
164"_top">majordomo@lmd.jussieu.fr</a> with no subject, containing the
165message: <strong class="userinput"><code>subscribe forum-idl
166<em class="replaceable"><code>e-mail
167address</code></em></code></strong></p>
168</li>
169<li>
170<p>consult the archives of this mail list: <a href=
171"http://www.lmd.jussieu.fr/archives/form-idl/last/mail1.html"
172target=
173"_top">http://www.lmd.jussieu.fr/archives/form-idl/last/mail1.html</a></p>
174</li>
175<li>
176<p>consult in desperation the feeble web pages we have started to
177write (while waiting for something better) <a href=
178"http://www.ipsl.jussieu.fr/~smlod/" target=
179"_top">http://www.ipsl.jussieu.fr/~smlod/</a></p>
180</li>
181<li>
182<p>wait until we write a full user's manual!</p>
183</li>
184</ul>
185</div>
186<p>The XXX widget is a layer on top of the scripts in the
187<span class="application">SAXO</span> package (themselves layered
188on top of IDL). It is designed to permit the visualization and
189rapid exploration of data, offering a maximum in options, while not
190necessarily all those offered by the package and by IDL.</p>
191<p>Based on the use of files in the NetCDF format, it can easily
192work with other file formats. For this, all that is necessary is to
193write an IDL function capable of extracting a matrix from a file as
194a function of the following parameters: the variable name, two
195dates, an experiment name, and a domain.</p>
196<p>Developed to visualize the output of the OPA model, the
197<span class="application">SAXO</span> package was conceived to work
198on C grids. To use it on grids where the T, U, and V points are the
199same, one must nevertheless declare the parameters of the grid that
200correspond to the U and V points. Careful, for this type of
201discretization, the calculation scripts of type <code class=
202"filename">div.pro</code> and <code class=
203"filename">curl.pro</code> are wrong.</p>
204<p>The averaging routines are not adapted to warped grids, they sum
205following the i, j, and k indices, weighting each point by scale
206factors and the land-sea mask. Slices and Hovmoellers do not work
207in the diagonal, but are always done following i, j, or k. When a
208domain is given to one of the scripts, an average over the domain
209in the directions perpendicular to that displayed is automatically
210made before display.</p>
211<p>Before continuing on to the practical part of this guide, the
212installation and use of the <span class="application">SAXO</span>
213package, I'd like to thank Guillaume Roullet, who also participated
214in the writing of the scripts in the package (notably the drawing
215of vectors on warped grids).</p>
216</div>
217<div class="sect1" lang="en">
218<div class="titlepage">
219<div>
220<div>
221<h2 class="title" style="clear: both"><a name="beforefirststeps"
222id="beforefirststeps"></a>2.&nbsp;Before this</h2>
223</div>
224</div>
225</div>
226<p>In this document, we supposed that you followed <a href=
227"getsaxo.html?format=raw" target="_top">Get SAXO</a>
228recommandations.</p>
229</div>
230<div class="sect1" lang="en">
231<div class="titlepage">
232<div>
233<div>
234<h2 class="title" style="clear: both"><a name="initfiles" id=
235"initfiles"></a>3.&nbsp;Install the files <code class=
236"filename">init.pro</code> and <code class=
237"filename">initgrid.pro</code></h2>
238</div>
239</div>
240</div>
241<p>This version of the <span class="application">SAXO</span>
242package depends a certain number of common variables that are
243primarily environmental parameters (working paths, color
244management, Postscript formatting) and the parameters of the grid
245on which you are working (longitude, latitude, depth, land-sea
246mask, scale factors, position of the zoom in relation to the
247original grid).</p>
248<p>These two types of parameters are kept separately:</p>
249<div class="itemizedlist">
250<ul type="disc">
251<li>
252<p>environmental parameters are defined at the very beginning of
253the IDL session, and are in principle never changed. They are
254initialized by the <code class="filename">init.pro</code>
255script.</p>
256</li>
257<li>
258<p>Those that belong to the grid are reinitialized every time the
259grid is changed. They can therefore be called at any time during a
260session. These parameters are initialized by the <code class=
261"filename">initgrid.pro</code> scripts, and are specific to each
262particular grid.</p>
263<p>For example: <code class="filename">initorca.pro</code> for the
264ORCA 2&deg; grid, <code class="filename">initorca05.pro</code> for
265the ORCA 0.5&deg; grid, or <code class=
266"filename">initorcapac.pro</code> for the ORCA grid zoomed on the
267Pacific.</p>
268</li>
269</ul>
270</div>
271<p>To begin, one must therefore copy <code class=
272"filename"><em class=
273"replaceable"><code>packagedir</code></em>/INIT/init.pro</code>
274into <em class="replaceable"><code>homedir</code></em>, and create
275in <em class="replaceable"><code>homedir</code></em> a script of
276the type <code class="filename">initgrid.pro</code>.</p>
277<div class="sect2" lang="en">
278<div class="titlepage">
279<div>
280<div>
281<h3 class="title"><a name="modifinitgrid" id=
282"modifinitgrid"></a>3.1.&nbsp;Modification or creation of the
283<code class="filename">initgrid.pro</code> script</h3>
284</div>
285</div>
286</div>
287<p>In the <em class="replaceable"><code>packagedir</code></em>/INIT
288directory you will find a certain number of scripts associated with
289the latest grids on which I've worked. If you are also working on
290one of these grids, for example ORCA, copy the file <code class=
291"filename"><em class=
292"replaceable"><code>packagedir</code></em>/INIT/initorca.pro</code>
293to your <em class="replaceable"><code>homedir</code></em>. If not,
294copy it nevertheless to use as a model. In the file <code class=
295"filename">initgrid.pro</code>, adjust the zoom parameters (if it
296has not already been done).</p>
297<p>Careful: unlike in previous versions of the <span class=
298"application">SAXO</span> package, all the zoom parameters must be
299defined. If you do not know them in advance, define their values to
300be -1.</p>
301<p>In the rest of the script, define iodir as <em class=
302"replaceable"><code>iodir</code></em>, and verify the name of the
303mask file, if one exists.</p>
304</div>
305</div>
306<div class="sect1" lang="en">
307<div class="titlepage">
308<div>
309<div>
310<h2 class="title" style="clear: both"><a name="introxxx" id=
311"introxxx"></a>4.&nbsp;Starting the <span class=
312"application">SAXO</span> package and an explanation of the XXX
313widget functions</h2>
314</div>
315</div>
316</div>
317<div class="sect2" lang="en">
318<div class="titlepage">
319<div>
320<div>
321<h3 class="title"><a name="launchxxx" id=
322"launchxxx"></a>4.1.&nbsp;Launching XXX</h3>
323</div>
324</div>
325</div>
326<p>The first command to type is</p>
327<pre class="screen">
328<code class="prompt">idl&gt;</code> <strong class=
329"userinput"><code>@init</code></strong>
330</pre>
331<p>Afterwards, to work directly with XXX, type:</p>
332<pre class="screen">
333
334<code class="prompt">idl&gt;</code> <strong class=
335"userinput"><code>xxx</code></strong>
336</pre>
337<p>To work without the XXX interface, initialize a grid</p>
338<pre class="screen">
339
340<code class="prompt">idl&gt;</code> <strong class=
341"userinput"><code>@initgrid</code></strong>
342</pre>
343<p>A window will open with 2 lines to complete.</p>
344<div class="figure"><a name="fig_xxx_1" id="fig_xxx_1"></a>
345<p class="title"><b>Figure&nbsp;1.&nbsp;Window xxx 1</b></p>
346<div class="figure-contents">
347<div class="mediaobjectco"><img border="0" usemap="d0e293" src=
348"figpng/xxx_1_complete.png" alt="Window xxx 1"><map name="d0e293"
349id="d0e293">
350<area shape="rect" coords="5,254,515,219">
351<area shape="rect" coords="5,159,515,109"></map>
352<div class="calloutlist">
353<table border="0" summary="Callout list">
354<tr>
355<td width="5%" valign="top" align="left"><img src=
356"images/callouts/1.png" alt="1" border="0"></td>
357<td valign="top" align="left">
358<p>datafile</p>
359</td>
360</tr>
361<tr>
362<td width="5%" valign="top" align="left"><img src=
363"images/callouts/2.png" alt="2" border="0"></td>
364<td valign="top" align="left">
365<p>initfile</p>
366</td>
367</tr>
368</table>
369</div>
370</div>
371</div>
372</div>
373<p><br class="figure-break"></p>
374<p>These lines must contain the address of a file. The name can be
375typed directly in the window provided, or selected with the help of
376the <span class="guibutton">browse</span> button. The first line
377must contain the name of the data file, the second the name of the
378<code class="filename">initgrid.pro</code> script which will permit
379the reading and processing of the grid associated with the data
380file.</p>
381<p>Once these two lines have been completed, click on <span class=
382"guibutton">let's go</span>. Two other windows will then open,
383giving you the parameters for reading the grid and the file (these
384parameters are read in the <code class=
385"filename">initgrid.pro</code> script). Click twice on <span class=
386"guibutton">OK</span>.</p>
387</div>
388<div class="sect2" lang="en">
389<div class="titlepage">
390<div>
391<div>
392<h3 class="title"><a name="wigdets" id="wigdets"></a>4.2.&nbsp;An
393explanation of the different widgets</h3>
394</div>
395</div>
396</div>
397<p>Now the XXX window will open.</p>
398<div class="figure"><a name="fig_xxx_2" id="fig_xxx_2"></a>
399<p class="title"><b>Figure&nbsp;2.&nbsp;Window xxx 2</b></p>
400<div class="figure-contents">
401<div class="mediaobjectco"><img border="0" usemap="d0e340" src=
402"figpng/xxx_2_complete.png" alt="Window xxx 2"><map name="d0e340"
403id="d0e340">
404<area shape="rect" coords="70,575,200,550">
405<area shape="rect" coords="10,490,230,450">
406<area shape="rect" coords="10,430,300,230">
407<area shape="rect" coords="10,180,350,130"></map>
408<div class="calloutlist">
409<table border="0" summary="Callout list">
410<tr>
411<td width="5%" valign="top" align="left"><img src=
412"images/callouts/1.png" alt="1" border="0"></td>
413<td valign="top" align="left">
414<p>Page layout</p>
415</td>
416</tr>
417<tr>
418<td width="5%" valign="top" align="left"><img src=
419"images/callouts/2.png" alt="2" border="0"></td>
420<td valign="top" align="left">
421<p>Calendar</p>
422</td>
423</tr>
424<tr>
425<td width="5%" valign="top" align="left"><img src=
426"images/callouts/3.png" alt="3" border="0"></td>
427<td valign="top" align="left">
428<p>Domain</p>
429</td>
430</tr>
431<tr>
432<td width="5%" valign="top" align="left"><img src=
433"images/callouts/4.png" alt="4" border="0"></td>
434<td valign="top" align="left">
435<p>Specify</p>
436</td>
437</tr>
438</table>
439</div>
440</div>
441</div>
442</div>
443<p><br class="figure-break"></p>
444<p>It's configuration will change depending on whether you are in
445portrait or in landscape, but here are the different parts
446available for your use.</p>
447<div class="sect3" lang="en">
448<div class="titlepage">
449<div>
450<div>
451<h4 class="title"><a name="menubar" id=
452"menubar"></a>4.2.1.&nbsp;The menu bar made up of 3 submenus</h4>
453</div>
454</div>
455</div>
456<div class="sect4" lang="en">
457<div class="titlepage">
458<div>
459<div>
460<h5 class="title"><a name="filesubmenu" id=
461"filesubmenu"></a>4.2.1.1.&nbsp;<span class=
462"guisubmenu">File</span> submenu</h5>
463</div>
464</div>
465</div>
466<div class="itemizedlist">
467<ul type="disc">
468<li>
469<p><span class="guimenuitem">Open:</span> to open a second file.
470Same procedure as during the launching of XXX. The new file can be
471on a different grid, with different variables, with a different
472time base.</p>
473</li>
474<li>
475<p><span class="guimenuitem">New XXX:</span> to open a second XXX
476window identical to the first.</p>
477</li>
478<li>
479<p><span class="guimenuitem">Close:</span> to close the XXX
480window.</p>
481</li>
482</ul>
483</div>
484</div>
485<div class="sect4" lang="en">
486<div class="titlepage">
487<div>
488<div>
489<h5 class="title"><a name="saveassubmenu" id=
490"saveassubmenu"></a>4.2.1.2.&nbsp;<span class="guisubmenu">Save
491As</span> submenu</h5>
492</div>
493</div>
494</div>
495<div class="itemizedlist">
496<ul type="disc">
497<li>
498<p><span class="guimenuitem">Postscript:</span> to save in
499Postscript format</p>
500</li>
501<li>
502<p><span class="guimenuitem">Animations:</span> to create an
503animation from the XXX window. Careful, the creation of an
504animation is only possible if none of the plots have a time axis,
505and if the plots are all on the same time base (calendar). On the
506other hand, animations of horizontal and vertical plots, with
507different color palettes (for those not on an X-terminal), are
508possible.</p>
509</li>
510<li>
511<p><span class="guimenuitem">Image:</span> to save a gif of the XXX
512graphics window.</p>
513</li>
514<li>
515<p><span class="guimenuitem">Script:</span> to save the command
516history that has created the plot. For example if I save the
517commands in <code class="filename">xxx_figure.pro</code>, I can
518then launch a new IDL session and type:</p>
519<pre class="screen">
520<code class="prompt">idl&gt;</code> <strong class=
521"userinput"><code>@init</code></strong>
522<code class="prompt">idl&gt;</code> <strong class=
523"userinput"><code>xxx_figure</code></strong>
524</pre>
525<p>and I'll obtain the saved figure.</p>
526<pre class="screen">
527<code class="prompt">idl&gt;</code> <strong class=
528"userinput"><code>xxx_figure,/post </code></strong>
529</pre>
530<p>or</p>
531<pre class="screen">
532<code class="prompt">idl&gt;</code> <strong class=
533"userinput"><code>@ps</code></strong>
534</pre>
535<p>will then create a Postscript file of the figure.</p>
536</li>
537<li>
538<p><span class="guimenuitem">Prompt:</span> lists in the IDL window
539the command history that created the last plot. Useful primarily
540for debugging...</p>
541</li>
542</ul>
543</div>
544</div>
545<div class="sect4" lang="en">
546<div class="titlepage">
547<div>
548<div>
549<h5 class="title"><a name="flagsubmenu" id=
550"flagsubmenu"></a>4.2.1.3.&nbsp;<span class="guisubmenu">Flag
551options</span> submenu</h5>
552</div>
553</div>
554</div>
555<div class="itemizedlist">
556<ul type="disc">
557<li>
558<p><span class="guibutton">OK</span> To show/hide the OK button in
559the upper left corner.</p>
560</li>
561<li>
562<p><span class="guibutton">Portrait/Landscape:</span> changes the
563configuration of the plot.</p>
564</li>
565<li>
566<p><span class="guibutton">Overlay:</span> to plot contours of a
567different field on top the one represented as color-filled
568contours. It is necessary to relaunch the entire plot to make this
569work!</p>
570</li>
571<li>
572<p><span class="guibutton">Vecteur:</span> to plot a vector field
573on top of contours. Only works on horizontal plots (<code class=
574"filename">plt.pro</code>). As for Overlay, a relaunch of the
575entire plot is necessary.</p>
576</li>
577<li>
578<p><span class="guibutton">Longitude / x index:</span> switches
579longitude labelling of the plot subdomain from degrees to indices
580following i.</p>
581</li>
582<li>
583<p><span class="guibutton">Latitude / y index:</span> switches
584latitude labelling of the plot subdomain from degrees to indices
585following j.</p>
586</li>
587</ul>
588</div>
589</div>
590</div>
591<div class="sect3" lang="en">
592<div class="titlepage">
593<div>
594<div>
595<h4 class="title"><a name="typeplot" id=
596"typeplot"></a>4.2.2.&nbsp;What type of plot and where?</h4>
597</div>
598</div>
599</div>
600<div class="itemizedlist">
601<ul type="disc">
602<li>
603<p><span class="guibutton">OK</span> Show/hide the OK button in the
604upper left. When present, a click is required to make a new plot
605appear. Otherwise each action creates a new plot.</p>
606</li>
607<li>
608<p><span class="guimenuitem">Plot type list:</span> allows
609specification of the type of plot desired.</p>
610<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
611<h3 class="title">Note</h3>
612<p>If the type <code class="constant">plt</code> is selected, the
613selection of plot type is made by mouse. Cf <a href="#mouse" title=
614"5.3.&nbsp;Mouse actions in the graphics window on a horizontal plot">
615Section&nbsp;5.3, &ldquo;Mouse actions in the graphics window on a
616horizontal plot&rdquo;</a></p>
617</div>
618</li>
619<li>
620<p><span class="guimenuitem">Layout configuration:</span> specify
621the number of columns and rows for plots on the sheet of paper.
622There's no code behind the undo command! The <span class=
623"guibutton">clear</span> button erases all plots.</p>
624</li>
625<li>
626<p><span class="guimenuitem">List of open files:</span> you can
627choose the file to work on.</p>
628</li>
629<li>
630<p><span class="guimenuitem">Command window:</span> this window
631permits simple operations on the fields:</p>
632<p>for example:</p>
633<div class="literallayout">
634<p>toto&nbsp;-&nbsp;10*field&nbsp;+&nbsp;36</p>
635</div>
636<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
637<h3 class="title">Note</h3>
638<p>In the default case, the name given to a field is of no
639importance.</p>
640</div>
641</li>
642</ul>
643</div>
644</div>
645<div class="sect3" lang="en">
646<div class="titlepage">
647<div>
648<div>
649<h4 class="title"><a name="sect_calendar" id=
650"sect_calendar"></a>4.2.3.&nbsp;Calendar</h4>
651</div>
652</div>
653</div>
654<p>The calendar is made up of two droplists, which allow
655specification of two dates, the beginning and end of a time series,
656or the period over which to average before plotting.</p>
657</div>
658<div class="sect3" lang="en">
659<div class="titlepage">
660<div>
661<div>
662<h4 class="title"><a name="sect_domain" id=
663"sect_domain"></a>4.2.4.&nbsp;Domain specification</h4>
664</div>
665</div>
666</div>
667<p>A series of widgets that allow specification of the min/max
668limits of the domain in longitude/x-index, latitude/y-index, and
669depth in levels or meters. For depth, one can specify in levels for
670a horizontal plot, and in meters for a vertical plot.</p>
671</div>
672<div class="sect3" lang="en">
673<div class="titlepage">
674<div>
675<div>
676<h4 class="title"><a name="details" id=
677"details"></a>4.2.5.&nbsp;Plot details</h4>
678</div>
679</div>
680</div>
681<p>You can specify the min, max, and contour interval by filling
682out the provided boxes! For the color palette, you can either
683specify the name or go search for one among the palettes
684available.</p>
685<p>The "keywords" window allows specification of all desired
686keywords. These keywords can be those of <code class=
687"filename">plt.pro</code>, <code class="filename">pltt.pro</code>,
688<code class="filename">pltz.pro</code>, <code class=
689"filename">plt1d.pro</code>, or those of contour, plot, or all
690other programs that are used. Cf <a href="#example1" title=
691"5.1.&nbsp;First plots">Section&nbsp;5.1, &ldquo;First
692plots&rdquo;</a></p>
693</div>
694</div>
695</div>
696<div class="sect1" lang="en">
697<div class="titlepage">
698<div>
699<div>
700<h2 class="title" style="clear: both"><a name="examples" id=
701"examples"></a>5.&nbsp;Concrete examples of XXX in practice</h2>
702</div>
703</div>
704</div>
705<div class="sect2" lang="en">
706<div class="titlepage">
707<div>
708<div>
709<h3 class="title"><a name="example1" id=
710"example1"></a>5.1.&nbsp;First plots</h3>
711</div>
712</div>
713</div>
714<p>One single file, one single plot per page</p>
715<p>Click on OK.</p>
716<p>Test the various basic functions: change the dates, the zoom,
717the field...</p>
718<p>Specify the min, max, and contour interval in the provided
719boxes.</p>
720<p>Add some keywords in the "keywords:" box, for example:</p>
721<div class="blockquote">
722<blockquote class="blockquote">
723<p>/nocontour, /carte</p>
724</blockquote>
725</div>
726<p>or the keywords for a northern hortographic polar
727projection:</p>
728<div class="blockquote">
729<blockquote class="blockquote">
730<p>/nocontour, map=[90,0,0], /horto</p>
731</blockquote>
732</div>
733<p>Test the various possibilities in the <span class="guimenu">Save
734As</span> menu.</p>
735<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
736<h3 class="title">Note</h3>
737<p>the creation of animations has a tendency to saturate the video
738memory of X-terminals, crashing the entire program...</p>
739</div>
740<p>Test the various possibilities in the <span class="guimenu">Flag
741options</span> menu.</p>
742<div class="caution" style=
743"margin-left: 0.5in; margin-right: 0.5in;">
744<h3 class="title">Caution</h3>
745<p>Careful, a selected option remains selected until it is
746reclicked.</p>
747</div>
748</div>
749<div class="sect2" lang="en">
750<div class="titlepage">
751<div>
752<div>
753<h3 class="title"><a name="example2" id=
754"example2"></a>5.2.&nbsp;Work with more than one file</h3>
755</div>
756</div>
757</div>
758<p>Open some other files and go between them by selecting them from
759the file list... Note that the different widgets (calendar, domain,
760...) follow the different file characteristics.</p>
761</div>
762<div class="sect2" lang="en">
763<div class="titlepage">
764<div>
765<div>
766<h3 class="title"><a name="mouse" id="mouse"></a>5.3.&nbsp;Mouse
767actions in the graphics window on a horizontal plot</h3>
768</div>
769</div>
770</div>
771<p>Select a domain and select the horizontal plot (<code class=
772"constant">plt</code>), vertical plot (<code class=
773"constant">pltz</code>), or the hovmoeller plot (<code class=
774"constant">pltt</code>):</p>
775<p>The domain we'd like to select for the plot is determined by one
776of its diagonals, defined therefore by two points. The first point
777is defined when the mouse button is pushed, then the mouse is
778moved, and the second point is defined as the mouse button is
779released (click-drag). The domains are thus defined by a long click
780(<abbr class="abbrev">LC</abbr>). To determine which type of plot
781should be made of selection, use:</p>
782<div class="variablelist">
783<dl>
784<dt><span class="term">If the plot selector is on <code class=
785"constant">plt</code></span></dt>
786<dd>
787<p>the left mouse button to create horizontal plots (<code class=
788"constant">plt</code>)</p>
789<p>the middle mouse button to create vertical plots (<code class=
790"constant">pltz</code>)</p>
791<p>the right mouse button to create common hovmoellers for xt and
792yt cuts (<code class="constant">pltt</code>)</p>
793<p>In summary: <abbr class="abbrev">LCL</abbr>---&gt;<code class=
794"constant">plt</code></p>
795<p>LCM---&gt;<code class="constant">pltz</code></p>
796<p>LCR---&gt;<code class="constant">pltt</code></p>
797</dd>
798<dt><span class="term">If the plot selector is on something other
799than <code class="constant">plt</code></span></dt>
800<dd>
801<p>the indicated plot type is made.</p>
802</dd>
803</dl>
804</div>
805</div>
806<div class="sect2" lang="en">
807<div class="titlepage">
808<div>
809<div>
810<h3 class="title"><a name="multipleplots" id=
811"multipleplots"></a>5.4.&nbsp;Create multiple plots on the same
812sheet and make them interact</h3>
813</div>
814</div>
815</div>
816<p>Select the number of columns and rows for the page.</p>
817<p>Create a first plot. It will appear in the first frame.</p>
818<p>To create a plot in another frame double-click in the frame with
819the middle button (<abbr class="abbrev">DCM</abbr>). A black dotted
820frame will surround the designated frame, the &ldquo;<span class=
821"quote">target</span>&rdquo; frame. A black frame will surround the
822first plot. This is the &ldquo;<span class=
823"quote">reference</span>&rdquo; frame, in other words the one that
824all the XXX widgets refer to. Change for example the date and
825create a new plot. With a left button double-click in the first
826frame, all the widgets change and refer again to the first plot. A
827double-click with the right button in the second frame will erase
828the plot.</p>
829<p>In summary: <abbr class=
830"abbrev">DCL</abbr>---&gt;&ldquo;<span class=
831"quote">reference</span>&rdquo; frame</p>
832<p><abbr class="abbrev">DCM</abbr>---&gt;&ldquo;<span class=
833"quote">target</span>&rdquo; frame</p>
834<p><abbr class="abbrev">DCR</abbr>---&gt;erase the frame</p>
835<p>Here's a series of commands to show how this works.</p>
836<div class="procedure">
837<ol type="1">
838<li>
839<p>Select a 3-D field and create 6 frames for the sheet of
840paper.</p>
841</li>
842<li>
843<p>Create a horizontal plot in Frame 1</p>
844</li>
845<li>
846<p><abbr class="abbrev">DCM</abbr> in frame 2, <abbr class=
847"abbrev">LCL</abbr> on the plot in frame 1, to create a horizontal
848zoom in frame 2.</p>
849<p><abbr class="abbrev">DCM</abbr> in frame 3, <abbr class=
850"abbrev">LCM</abbr> on the plot in frame 1, to create a vertical
851cut in frame 3.</p>
852<p><abbr class="abbrev">DCM</abbr> in frame 4, <abbr class=
853"abbrev">LCR</abbr> on the plot in frame 1, to create a hovmoeller
854in frame 4.</p>
855</li>
856</ol>
857</div>
858<div class="procedure">
859<p>To redo the hovmoeller with the keyword</p>
860<div class="literallayout">
861<p>/nocontour</p>
862</div>
863<ol type="1">
864<li>
865<p><abbr class="abbrev">DCL</abbr> in frame 4 which now becomes the
866reference and target frame.</p>
867</li>
868<li>
869<p>Add the keyword</p>
870<div class="literallayout">
871<p>/nocontour</p>
872</div>
873</li>
874<li>
875<p>click <span class="guibutton">OK</span>, and the plot is
876redone.</p>
877</li>
878</ol>
879</div>
880<div class="procedure">
881<p>in frame 5, let's create the same plot as in frame 2 except with
882different dates</p>
883<ol type="1">
884<li>
885<p><abbr class="abbrev">DCL</abbr> on frame 2</p>
886</li>
887<li>
888<p><abbr class="abbrev">DCM</abbr> on frame 5</p>
889</li>
890<li>
891<p>change the date</p>
892</li>
893<li>
894<p>click on <span class="guibutton">OK</span> , and voil&agrave;,
895the new plot.</p>
896</li>
897</ol>
898</div>
899</div>
900</div>
901<div class="sect1" lang="en">
902<div class="titlepage">
903<div>
904<div>
905<h2 class="title" style="clear: both"><a name="crash" id=
906"crash"></a>6.&nbsp;How to quit when it crashes</h2>
907</div>
908</div>
909</div>
910<div class="orderedlist">
911<ol type="1">
912<li>
913<p>in the IDL window, type</p>
914<pre class="screen">
915<code class="prompt">idl&gt;</code> <strong class=
916"userinput"><code>retall</code></strong>
917</pre></li>
918<li>
919<p><abbr class="abbrev">DCR</abbr> to erase the problem frame</p>
920</li>
921<li>
922<p>press the <span class="guibutton">clear</span> button</p>
923</li>
924<li>
925<p>change the orientation of the plot</p>
926</li>
927<li>
928<p>quit XXX cleanly using <span class="guibutton">quit</span> from
929the <span class="guimenu">File</span> menu</p>
930</li>
931</ol>
932</div>
933<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
934<h3 class="title">Note</h3>
935<p>Always avoid if at all possible closing and killing the XXX
936window, but rather select <span class="guibutton">quit</span> from
937the <span class="guimenu">File</span> menu. XXX uses a large number
938of pointers, and wantonly killing the window will leave a large
939number of unused variables in memory, which could in the end
940overflow. To clean up this memory:</p>
941<pre class="screen">
942<code class="prompt">idl&gt;</code> <strong class=
943"userinput"><code>ptr_free, ptr_valid()</code></strong>
944</pre></div>
945</div>
946</div>
947</body>
948</html>
Note: See TracBrowser for help on using the repository browser.