1 | <?xml version='1.0' encoding='iso-8859-1'?> |
---|
2 | <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" |
---|
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" |
---|
4 | [ |
---|
5 | <!ENTITY promptidl "idl>"> |
---|
6 | ] |
---|
7 | > |
---|
8 | <!-- |
---|
9 | |
---|
10 | ./SAXO_DIR/SRC/Documentation/xmldoc/mini_notice.xml |
---|
11 | |
---|
12 | update : |
---|
13 | fplod 2006-07-20T08:45:14Z aedon.locean-ipsl.upmc.fr (Darwin) |
---|
14 | . creation by hand made migration from mini_notice.html to XML/Docbook |
---|
15 | . installation part has been removed |
---|
16 | . add images |
---|
17 | ++ fake graphics callouts see forxxxdoc.sh |
---|
18 | |
---|
19 | --> |
---|
20 | <article lang="en"> |
---|
21 | <title> |
---|
22 | Mini Guide for Basic Commands in the XXX Program |
---|
23 | </title> |
---|
24 | <articleinfo> |
---|
25 | <authorgroup> |
---|
26 | <author><firstname>Sébastien</firstname><surname>Masson</surname><email>Sebastien.Masson_at_locean-ipsl.upmc.fr</email></author> |
---|
27 | <author><firstname>Albert</firstname><surname>Fisher</surname></author> |
---|
28 | <author><firstname>Françoise</firstname><surname>Pinsard</surname><email>Francoise.Pinsard_at_locean-ipsl.upmc.fr</email></author> |
---|
29 | <author><firstname>Steve</firstname><surname>Navarro</surname></author> |
---|
30 | </authorgroup> |
---|
31 | <keywordset> |
---|
32 | <keyword>idl</keyword> |
---|
33 | <keyword>SAXO</keyword> |
---|
34 | <keyword>xxx</keyword> |
---|
35 | </keywordset> |
---|
36 | <revhistory> |
---|
37 | <revision> |
---|
38 | <revnumber>0.0</revnumber> |
---|
39 | <date>May 29, 2000</date> |
---|
40 | <revremark>French release by Sébastien Masson</revremark> |
---|
41 | </revision> |
---|
42 | <revision> |
---|
43 | <revnumber>0.1</revnumber> |
---|
44 | <date>July, 2002</date> |
---|
45 | <revremark>Translation by Albert Fisher</revremark> |
---|
46 | </revision> |
---|
47 | <revision> |
---|
48 | <revnumber>0.2</revnumber> |
---|
49 | <date>July 20, 2006</date> |
---|
50 | <revremark>HTML to XML/Docbook migration by Françoise Pinsard</revremark> |
---|
51 | </revision> |
---|
52 | </revhistory> |
---|
53 | <pubdate>$Id$</pubdate> |
---|
54 | </articleinfo> |
---|
55 | |
---|
56 | |
---|
57 | <!-- |
---|
58 | La partie suivante n'a plus tellement de sens maintenant que tout SAXO est disponible sur forge |
---|
59 | <para> |
---|
60 | Where to find the source code |
---|
61 | </para> |
---|
62 | The scripts are available in the IDL_29_5_2000 directory. |
---|
63 | </para> |
---|
64 | <para> |
---|
65 | In this directory are |
---|
66 | <itemizedlist> |
---|
67 | <listitem><para>a tar file IDL_29_5_2000.tar with all the files</para></listitem> |
---|
68 | <listitem><para>the scripts in ASCII, in subdirectories by theme</para></listitem> |
---|
69 | </itemizedlist> |
---|
70 | |
---|
71 | <para> |
---|
72 | This IDL_29_5_2000 directory is available: |
---|
73 | <itemizedlist> |
---|
74 | <listitem><para>at LODYC: adonis.lodyc.jussieu.fr:/usr/home/smasson/IDL_29_5_2000</para></listitem> |
---|
75 | <listitem><para>at IPSL: cook.ipsl.jussieu.fr:/home/smlod/IDL_29_5_2000</para></listitem> |
---|
76 | <listitem><para>at IDRIS: rhodes.idris.fr:/home/rech/eee/reee217/IDL_29_5_2000</para></listitem> |
---|
77 | <listitem><para>on the anonymous ftp site of LODYC (contact <ulink url="mailto:smasson@lodyc.jussieu.fr">smasson@lodyc.jussieu.fr</ulink> |
---|
78 | for access).</para></listitem> |
---|
79 | <listitem><para>soon, from <ulink url="http://www.lodyc.jussieu.fr/~opatlod/SAXO/"/></para></listitem> |
---|
80 | </itemizedlist> |
---|
81 | </para> |
---|
82 | <para> |
---|
83 | This mini guide is also found in the IDL_29_5_2000 directory, in |
---|
84 | different formats. It is also consultable on the web at: |
---|
85 | </para> |
---|
86 | <para> |
---|
87 | <ulink url="http://www.ipsl.jussieu.fr/~smlod/mini_notice.html"/> |
---|
88 | </para> |
---|
89 | |
---|
90 | --> |
---|
91 | <!-- ++ n'a plus rien à faire ici |
---|
92 | <sect1 id="intro"><title>Introduction and assumptions</title> |
---|
93 | |
---|
94 | <para> |
---|
95 | This micro guide is unfortunately not a user's guide for all the |
---|
96 | scripts that have been written for IDL (version 5.2 or higher |
---|
97 | required). The goal is simply to clarify a few points on the use of the <filename>xxx.pro</filename> |
---|
98 | program. |
---|
99 | </para> |
---|
100 | <para> |
---|
101 | For further help on the furnished scripts, here are |
---|
102 | several possibilities: |
---|
103 | |
---|
104 | <itemizedlist> |
---|
105 | <listitem><para>execute in IDL the command |
---|
106 | <screen format="linespecific"> |
---|
107 | <prompt>&promptidl;</prompt> <userinput>xhelp, '<replaceable>script_name</replaceable>'</userinput> |
---|
108 | </screen> |
---|
109 | </para></listitem> |
---|
110 | <listitem><para>consult the IDL online help for scripts whose source is unavailable</para></listitem> |
---|
111 | <listitem><para> |
---|
112 | subscribe to the mailing list for updates and user questions/responses |
---|
113 | </para> |
---|
114 | <para> |
---|
115 | to subscribe, send a mail to: <ulink url="mailto:majordomo@lmd.jussieu.fr">majordomo@lmd.jussieu.fr</ulink> |
---|
116 | with no subject, containing the message: |
---|
117 | <userinput>subscribe forum-idl <replaceable>e-mail address</replaceable></userinput> |
---|
118 | </para></listitem> |
---|
119 | <listitem><para>consult the archives of this mail list: |
---|
120 | <ulink url="http://www.lmd.jussieu.fr/archives/form-idl/last/mail1.html"/></para></listitem> |
---|
121 | <listitem><para>consult in desperation the feeble web pages we have started to write |
---|
122 | (while waiting for something better) |
---|
123 | <ulink url="http://www.ipsl.jussieu.fr/~smlod/"/></para></listitem> |
---|
124 | <listitem><para>wait until we write a full user's manual!</para></listitem> |
---|
125 | </itemizedlist> |
---|
126 | </para> |
---|
127 | |
---|
128 | <para> |
---|
129 | The XXX widget is a layer on top of the scripts in the <application>SAXO</application> package |
---|
130 | (themselves layered on top of IDL). It is designed to permit the |
---|
131 | visualization and rapid exploration of data, offering a maximum in |
---|
132 | options, while not necessarily all those offered by the package and by |
---|
133 | IDL. |
---|
134 | </para> |
---|
135 | <para> |
---|
136 | Based on the use of files in the NetCDF format, it can easily work |
---|
137 | with other file formats. For this, all that is necessary is to write |
---|
138 | an IDL function capable of extracting a matrix from a file as a |
---|
139 | function of the following parameters: the variable name, two dates, an |
---|
140 | experiment name, and a domain. |
---|
141 | </para> |
---|
142 | <para> |
---|
143 | Developed to visualize the output of the OPA model, the <application>SAXO</application> package was |
---|
144 | conceived to work on C grids. To use it on grids where the T, U, and |
---|
145 | V points are the same, one must nevertheless declare the parameters of |
---|
146 | the grid that correspond to the U and V points. Careful, for this |
---|
147 | type of discretization, the calculation scripts of type <filename>div.pro</filename> and |
---|
148 | <filename>curl.pro</filename> are wrong. |
---|
149 | </para> |
---|
150 | <para> |
---|
151 | The averaging routines are not adapted to warped grids, they sum |
---|
152 | following the i, j, and k indices, weighting each point by scale |
---|
153 | factors and the land-sea mask. Slices and Hovmoellers do not work in |
---|
154 | the diagonal, but are always done following i, j, or k. When a domain |
---|
155 | is given to one of the scripts, an average over the domain in the |
---|
156 | directions perpendicular to that displayed is automatically made before |
---|
157 | display. |
---|
158 | </para> |
---|
159 | <para> |
---|
160 | Before continuing on to the practical part of this guide, the |
---|
161 | installation and use of the <application>SAXO</application> package, I'd like to thank Guillaume |
---|
162 | Roullet, who also participated in the writing of the scripts in the |
---|
163 | package (notably the drawing of vectors on warped grids). |
---|
164 | </para> |
---|
165 | </sect1> |
---|
166 | |
---|
167 | <sect1 id="beforefirststeps"> |
---|
168 | <title>Before this</title> |
---|
169 | <para> |
---|
170 | In this document, we supposed that you followed <ulink url="getsaxo.html?format=raw">Get SAXO</ulink> recommandations. |
---|
171 | </para> |
---|
172 | </sect1> |
---|
173 | |
---|
174 | |
---|
175 | <sect1 id="initfiles"><title>Install the files <filename>init.pro</filename> and |
---|
176 | <filename>initgrid.pro</filename></title> |
---|
177 | |
---|
178 | <para> |
---|
179 | This version of the <application>SAXO</application> package depends a certain number of common |
---|
180 | variables that are primarily environmental parameters (working paths, |
---|
181 | color management, Postscript formatting) and the parameters of the |
---|
182 | grid on which you are working (longitude, latitude, depth, land-sea |
---|
183 | mask, scale factors, position of the zoom in relation to the original |
---|
184 | grid). |
---|
185 | </para> |
---|
186 | <para> |
---|
187 | These two types of parameters are kept separately: |
---|
188 | <itemizedlist> |
---|
189 | <listitem><para>environmental parameters are defined at the very beginning of the |
---|
190 | IDL session, and are in principle never changed. They are initialized |
---|
191 | by the <filename>init.pro</filename> script.</para></listitem> |
---|
192 | <listitem><para>Those that belong to the grid are reinitialized every time the |
---|
193 | grid is changed. They can therefore be called at any time during a |
---|
194 | session. These parameters are initialized by the <filename>initgrid.pro</filename> |
---|
195 | scripts, and are specific to each particular grid. |
---|
196 | </para> |
---|
197 | <para> |
---|
198 | For example: <filename>initorca.pro</filename> for the ORCA 2° grid, |
---|
199 | <filename>initorca05.pro</filename> for |
---|
200 | the ORCA 0.5° grid, or <filename>initorcapac.pro</filename> for the ORCA grid zoomed on |
---|
201 | the Pacific.</para></listitem> |
---|
202 | </itemizedlist> |
---|
203 | </para> |
---|
204 | <para> |
---|
205 | To begin, one must therefore copy <filename><replaceable>packagedir</replaceable>/INIT/init.pro</filename> |
---|
206 | into <replaceable>homedir</replaceable>, and create in <replaceable>homedir</replaceable> a script of the |
---|
207 | type <filename>initgrid.pro</filename>. |
---|
208 | </para> |
---|
209 | |
---|
210 | <sect2 id="modifinit"><title>Modification of the <filename>init.pro</filename> script</title> |
---|
211 | |
---|
212 | <para> |
---|
213 | It is necessary to personalize the lines that correspond to the 6 |
---|
214 | directories defined in § 1.1. That is: |
---|
215 | <itemizedlist> |
---|
216 | <listitem><para>The definition of !path.</para><para> |
---|
217 | The first expand_path must contain <replaceable>homedir</replaceable>, the second |
---|
218 | <replaceable>packagedir</replaceable>. The directory declaration must be preceded by a + |
---|
219 | sign, and must take the form of a character chain. The + sign |
---|
220 | specifies that subdirectories must also be considered. For those |
---|
221 | working on a Mac, <literallayout>"+':'+"</literallayout> must be replaced by <literallayout>"+','+"</literallayout> and for Windows |
---|
222 | by <literallayout>"+';'+"</literallayout>.</para> |
---|
223 | <warning> |
---|
224 | <para> |
---|
225 | In their definition, the directories must not finish with the |
---|
226 | directory separation character ("/" under UNIX/Linux). |
---|
227 | </para> |
---|
228 | </warning> |
---|
229 | </listitem> |
---|
230 | <listitem><para>Definition of the rest of the directories:</para><para> |
---|
231 | Define as necessary the variables homedir, workdir, iodir, animdir, |
---|
232 | psdir, and imagedir.</para> |
---|
233 | <warning> |
---|
234 | <para> |
---|
235 | Despite precautions taken, in order to avoid bugs it is |
---|
236 | recommended that these directories be defined with the directory |
---|
237 | separation character as the final character ("/" under UNIX/Linux). |
---|
238 | </para> |
---|
239 | </warning> |
---|
240 | </listitem> |
---|
241 | </itemizedlist> |
---|
242 | </para> |
---|
243 | <note> |
---|
244 | <para> |
---|
245 | Depending on the resolution of your screen and the type of |
---|
246 | machine used, it is possible that the graphics window which is created |
---|
247 | will be too large. If this is the case, change the ccwindowsize |
---|
248 | variable which is a multiplicative coefficient applied to the window |
---|
249 | size. |
---|
250 | </para> |
---|
251 | </note> |
---|
252 | </sect2> |
---|
253 | <sect2 id="modifinitgrid"><title>Modification or creation of the <filename>initgrid.pro</filename> script</title> |
---|
254 | |
---|
255 | <para> |
---|
256 | In the <replaceable>packagedir</replaceable>/INIT directory you will find a certain |
---|
257 | number of scripts associated with the latest grids on which I've |
---|
258 | worked. If you are also working on one of these grids, for example |
---|
259 | ORCA, copy the file <filename><replaceable>packagedir</replaceable>/INIT/initorca.pro</filename> to your |
---|
260 | <replaceable>homedir</replaceable>. If not, copy it nevertheless to use as a model. In |
---|
261 | the file <filename>initgrid.pro</filename>, adjust the zoom parameters (if it has not |
---|
262 | already been done). |
---|
263 | </para> |
---|
264 | <para> |
---|
265 | Careful: unlike in previous versions of the <application>SAXO</application> package, all the zoom |
---|
266 | parameters must be defined. If you do not know them in advance, |
---|
267 | define their values to be -1. |
---|
268 | </para> |
---|
269 | <para> |
---|
270 | In the rest of the script, define iodir as <replaceable>iodir</replaceable>, and verify |
---|
271 | the name of the mask file, if one exists. |
---|
272 | </para> |
---|
273 | </sect2> |
---|
274 | </sect1> |
---|
275 | --> |
---|
276 | <sect1 id="introxxx"><title>XXX widget functions</title> |
---|
277 | <sect2 id="launchxxx"><title>Launching XXX</title> |
---|
278 | |
---|
279 | <para> |
---|
280 | The first command to type is |
---|
281 | |
---|
282 | <screen format="linespecific"> |
---|
283 | <prompt>&promptidl;</prompt> <userinput>@init</userinput> |
---|
284 | </screen> |
---|
285 | |
---|
286 | </para> |
---|
287 | <para> |
---|
288 | Afterwards, to work directly with XXX, type: |
---|
289 | |
---|
290 | <screen format="linespecific"> |
---|
291 | |
---|
292 | <prompt>&promptidl;</prompt> <userinput>xxx</userinput> |
---|
293 | </screen> |
---|
294 | |
---|
295 | </para> |
---|
296 | |
---|
297 | |
---|
298 | A window will open with 2 lines to complete. |
---|
299 | <figure id="fig_xxx_0101"> |
---|
300 | <title>Window xxx 1</title> |
---|
301 | <mediaobjectco> |
---|
302 | <imageobjectco> |
---|
303 | <areaspec units="calspair"> |
---|
304 | <area id="datafile" coords="500,1715 9326,3074"/> |
---|
305 | <area id="initmethod" coords="1500,3268 8326,4919"/> |
---|
306 | <area id="initprogram" coords="57,5145 9961,8996"/> |
---|
307 | </areaspec> |
---|
308 | <imageobject> |
---|
309 | <imagedata fileref="figpng/xxx_0101.png"/> <!-- ++ instead of figpng/xxx_0101_org.png --> |
---|
310 | </imageobject> |
---|
311 | <calloutlist> |
---|
312 | <callout arearefs="datafile"> |
---|
313 | <para>Data file</para> |
---|
314 | </callout> |
---|
315 | <callout arearefs="initmethod"> |
---|
316 | <para>Init method</para> |
---|
317 | </callout> |
---|
318 | <callout arearefs="initprogram"> |
---|
319 | <para>Init program</para> |
---|
320 | </callout> |
---|
321 | </calloutlist> |
---|
322 | </imageobjectco> |
---|
323 | <!-- ++ si on met textobject, on ne voit plus l'image !! |
---|
324 | <textobject>[plot figpng/xxx_0101.png]</textobject> |
---|
325 | --> |
---|
326 | </mediaobjectco> |
---|
327 | </figure> |
---|
328 | <sect3 id="datafiletxt"><title>File name</title> |
---|
329 | <para> |
---|
330 | the name of the data file. The name can be typed directly in the window |
---|
331 | provided, or selected with the help of the <guibutton>browse</guibutton> button. |
---|
332 | </para> |
---|
333 | </sect3> |
---|
334 | <sect3 id="initmethodtxt"><title>Grid initalization method</title> |
---|
335 | <para> |
---|
336 | +++ |
---|
337 | </para> |
---|
338 | </sect3> |
---|
339 | <sect3 id="initprogramtxt"><title>Grid initalization parameters</title> |
---|
340 | <para> |
---|
341 | <figure id="fig_xxx_0102"> |
---|
342 | <title>Window xxx 1</title> |
---|
343 | <mediaobjectco> |
---|
344 | <imageobjectco> |
---|
345 | <imageobject> |
---|
346 | <imagedata fileref="figpng/xxx_0102.png"/> |
---|
347 | </imageobject> |
---|
348 | </imageobjectco> |
---|
349 | </mediaobjectco> |
---|
350 | </figure> |
---|
351 | </para> |
---|
352 | <para> |
---|
353 | the second the name of |
---|
354 | the <filename>initgrid.pro</filename> script which will permit the reading and processing of the |
---|
355 | grid associated with the data file. |
---|
356 | </para> |
---|
357 | <para> |
---|
358 | Once these two lines have been completed, click on <guibutton>let's go</guibutton>. |
---|
359 | </para> |
---|
360 | </sect3> |
---|
361 | </sect2> |
---|
362 | |
---|
363 | <sect2 id="wigdets"><title>Description of XXX window</title> |
---|
364 | |
---|
365 | <para> |
---|
366 | Now the XXX window will open. |
---|
367 | <!-- cf example in http://www.docbook.org/tdg/en/html/area.html |
---|
368 | sauf que dans l'exemple en question on ne donne que 2 nombres et pas 4 |
---|
369 | voir aussi message http://www.oasis-open.org/archives/docbook-apps/200501/msg00089.html |
---|
370 | peut-etre du nouveau dans les xsl depuis le 16 janvier 2005 |
---|
371 | peut-être essayé http://lists.kde.org/?l=kde-doc-english&m=112780764426265&w=2 |
---|
372 | ce produit klickety est installable via fink sous mac |
---|
373 | --> |
---|
374 | <figure id="fig_xxx_0201"> |
---|
375 | <title>Window xxx 2</title> |
---|
376 | <mediaobjectco> |
---|
377 | <imageobjectco> |
---|
378 | <areaspec units="calspair"> |
---|
379 | <area id="plottype" coords="69,380 2261,809"/> |
---|
380 | <area id="menu" coords="2517,380 7575,841"/> |
---|
381 | <area id="ok" coords="116,936 1025,1365"/> |
---|
382 | <area id="pagelayout" coords="1631,936 4498,1365"/> |
---|
383 | <area id="variableslist" coords="4871,952 7529,1349"/> |
---|
384 | <area id="fileslist" coords="46,1507 8018,1857"/> |
---|
385 | <area id="commandtext" coords="46,2000 8065,2539"/> |
---|
386 | <area id="calendar" coords="46,2682 4941,3428"/> |
---|
387 | <area id="domdef" coords="372,3603 7179,7095"/> |
---|
388 | <area id="specifications" coords="23,7269 8041,9206"/> |
---|
389 | </areaspec> |
---|
390 | <imageobject> |
---|
391 | <imagedata fileref="figpng/xxx_0201.png"/> <!-- ++ instead of figpng/xxx_0201_org.png --> |
---|
392 | </imageobject> |
---|
393 | <calloutlist> |
---|
394 | <callout arearefs="plottype"> |
---|
395 | <para>Plot type</para> |
---|
396 | </callout> |
---|
397 | <callout arearefs="menu"> |
---|
398 | <para>Menu</para> |
---|
399 | </callout> |
---|
400 | <callout arearefs="ok"> |
---|
401 | <para>OK</para> |
---|
402 | </callout> |
---|
403 | <callout arearefs="pagelayout"> |
---|
404 | <para>Page layout</para> |
---|
405 | </callout> |
---|
406 | <callout arearefs="variableslist"> |
---|
407 | <para>Variables list</para> |
---|
408 | </callout> |
---|
409 | <callout arearefs="fileslist"> |
---|
410 | <para>Files list</para> |
---|
411 | </callout> |
---|
412 | <callout arearefs="commandtext"> |
---|
413 | <para>Command text</para> |
---|
414 | </callout> |
---|
415 | <callout arearefs="calendar"> |
---|
416 | <para>Calendar</para> |
---|
417 | </callout> |
---|
418 | <callout arearefs="domdef"> |
---|
419 | <para>Domdef</para> |
---|
420 | </callout> |
---|
421 | <callout arearefs="specifications"> |
---|
422 | <para>Spefications</para> |
---|
423 | </callout> |
---|
424 | </calloutlist> |
---|
425 | </imageobjectco> |
---|
426 | <!-- ++ si on met textobject, on ne voit plus l'image |
---|
427 | <textobject>[plot figpng/xxx_0201.png]</textobject> |
---|
428 | --> |
---|
429 | </mediaobjectco> |
---|
430 | </figure> |
---|
431 | </para> |
---|
432 | <para> |
---|
433 | It's configuration will change |
---|
434 | depending on whether you are in portrait or in landscape, but here are |
---|
435 | the different parts available for your use. |
---|
436 | </para> |
---|
437 | |
---|
438 | <sect3 id="plottypetxt"><title>Plot type list</title> |
---|
439 | <para>allows specification of the type of plot desired.</para> |
---|
440 | <para> |
---|
441 | <figure id="fig_xxx_0202"> |
---|
442 | <title></title> |
---|
443 | <mediaobjectco> |
---|
444 | <imageobjectco> |
---|
445 | <imageobject> |
---|
446 | <imagedata fileref="figpng/xxx_0202.png"/> |
---|
447 | </imageobject> |
---|
448 | </imageobjectco> |
---|
449 | </mediaobjectco> |
---|
450 | </figure> |
---|
451 | </para> |
---|
452 | <note> |
---|
453 | <para> |
---|
454 | If the type <constant>plt</constant> is selected, the selection of plot type |
---|
455 | is made by mouse. Cf <xref linkend="mouse"/></para> |
---|
456 | </note> |
---|
457 | </sect3> |
---|
458 | |
---|
459 | <sect3 id="menutxt"><title>The menu bar made up of 3 submenus</title> |
---|
460 | <sect4 id="filesubmenu"><title><guisubmenu>File</guisubmenu> submenu</title> |
---|
461 | <para> |
---|
462 | <figure id="fig_xxx_0203"> |
---|
463 | <title></title> |
---|
464 | <mediaobjectco> |
---|
465 | <imageobjectco> |
---|
466 | <imageobject> |
---|
467 | <imagedata fileref="figpng/xxx_0203.png"/> |
---|
468 | </imageobject> |
---|
469 | </imageobjectco> |
---|
470 | </mediaobjectco> |
---|
471 | </figure> |
---|
472 | </para> |
---|
473 | |
---|
474 | <para> |
---|
475 | <itemizedlist> |
---|
476 | <listitem> |
---|
477 | <para> |
---|
478 | <guimenuitem>Open:</guimenuitem> to open a second file. Same procedure as during the |
---|
479 | launching of XXX. The new file can be on a different grid, with |
---|
480 | different variables, with a different time base. |
---|
481 | </para></listitem> |
---|
482 | <listitem><para><guimenuitem>New XXX:</guimenuitem> to open a second XXX window identical to the first.</para></listitem> |
---|
483 | <listitem><para><guimenuitem>Close:</guimenuitem> to close the XXX window.</para></listitem> |
---|
484 | </itemizedlist> |
---|
485 | </para> |
---|
486 | |
---|
487 | </sect4> |
---|
488 | <sect4 id="saveassubmenu"><title><guisubmenu>Save As</guisubmenu> submenu</title> |
---|
489 | <para> |
---|
490 | <figure id="fig_xxx_0204"> |
---|
491 | <title></title> |
---|
492 | <mediaobjectco> |
---|
493 | <imageobjectco> |
---|
494 | <imageobject> |
---|
495 | <imagedata fileref="figpng/xxx_0204.png"/> |
---|
496 | </imageobject> |
---|
497 | </imageobjectco> |
---|
498 | </mediaobjectco> |
---|
499 | </figure> |
---|
500 | </para> |
---|
501 | |
---|
502 | <para> |
---|
503 | <itemizedlist> |
---|
504 | <listitem><para><guimenuitem>Postscript:</guimenuitem> to save in Postscript format</para></listitem> |
---|
505 | <listitem><para><guimenuitem>Animations:</guimenuitem> to create an animation from the XXX window. |
---|
506 | Careful, the creation of an animation is only possible if none of the |
---|
507 | plots have a time axis, and if the plots are all on the same time base |
---|
508 | (calendar). On the other hand, animations of horizontal and vertical |
---|
509 | plots, with different color palettes (for those not on an X-terminal), |
---|
510 | are possible.</para></listitem> |
---|
511 | <listitem><para><guimenuitem>Image:</guimenuitem> to save a gif of the XXX graphics window.</para></listitem> |
---|
512 | <listitem><para><guimenuitem>Script:</guimenuitem> to save the command history that has created the |
---|
513 | plot. For example if I save the commands in <filename>xxx_figure.pro</filename>, I can |
---|
514 | then launch a new IDL session and type: |
---|
515 | <screen format="linespecific"> |
---|
516 | <prompt>&promptidl;</prompt> <userinput>@init</userinput> |
---|
517 | <prompt>&promptidl;</prompt> <userinput>xxx_figure</userinput> |
---|
518 | </screen> |
---|
519 | </para> |
---|
520 | <para> |
---|
521 | and I'll obtain the saved figure. |
---|
522 | <screen format="linespecific"> |
---|
523 | <prompt>&promptidl;</prompt> <userinput>xxx_figure,/post </userinput> |
---|
524 | </screen> |
---|
525 | or |
---|
526 | <screen format="linespecific"> |
---|
527 | <prompt>&promptidl;</prompt> <userinput>@ps</userinput> |
---|
528 | </screen> |
---|
529 | will then create a Postscript file of the figure.</para><para></para></listitem> |
---|
530 | <listitem><para><guimenuitem>Prompt:</guimenuitem> lists in the IDL window the command history that |
---|
531 | created the last plot. Useful primarily for debugging...</para></listitem> |
---|
532 | </itemizedlist> |
---|
533 | </para> |
---|
534 | </sect4> |
---|
535 | <sect4 id="flagsubmenu"><title><guisubmenu>Flag options</guisubmenu> submenu</title> |
---|
536 | <para> |
---|
537 | <figure id="fig_xxx_0205"> |
---|
538 | <title></title> |
---|
539 | <mediaobjectco> |
---|
540 | <imageobjectco> |
---|
541 | <imageobject> |
---|
542 | <imagedata fileref="figpng/xxx_0205.png"/> |
---|
543 | </imageobject> |
---|
544 | </imageobjectco> |
---|
545 | </mediaobjectco> |
---|
546 | </figure> |
---|
547 | </para> |
---|
548 | |
---|
549 | <para> |
---|
550 | <itemizedlist> |
---|
551 | <listitem><para><guibutton>Portrait/Landscape:</guibutton> changes the configuration of the plot.</para></listitem> |
---|
552 | <listitem><para><guibutton>Overlay:</guibutton> to plot contours of a different field on top the |
---|
553 | one represented as color-filled contours. It is necessary to relaunch the |
---|
554 | entire plot to make this work!</para></listitem> |
---|
555 | <listitem><para><guibutton>Vecteur:</guibutton> to plot a vector field on top of contours. Only |
---|
556 | works on horizontal plots (<filename>plt.pro</filename>). As for Overlay, a relaunch of |
---|
557 | the entire plot is necessary.</para></listitem> |
---|
558 | <listitem><para><guibutton>Longitude / x index:</guibutton> switches longitude labelling of the plot |
---|
559 | subdomain from degrees to indices following i. </para></listitem> |
---|
560 | <listitem><para><guibutton>Latitude / y index:</guibutton> switches latitude labelling of the plot |
---|
561 | subdomain from degrees to indices following j. </para></listitem> |
---|
562 | </itemizedlist> |
---|
563 | </para> |
---|
564 | </sect4> |
---|
565 | </sect3> |
---|
566 | |
---|
567 | <sect3 id="oktxt"><title>OK button</title> |
---|
568 | <para>click on this <guibutton>OK</guibutton> button is required to make a new plot appear</para> |
---|
569 | </sect3> |
---|
570 | |
---|
571 | <sect3 id="pagelayouttxt"><title>Page Layout</title> |
---|
572 | <para>specify the number of columns and rows for plots on the sheet of paper.</para> |
---|
573 | <para> |
---|
574 | <figure id="fig_xxx_0206"> |
---|
575 | <title></title> |
---|
576 | <mediaobjectco> |
---|
577 | <imageobjectco> |
---|
578 | <imageobject> |
---|
579 | <imagedata fileref="figpng/xxx_0206.png"/> |
---|
580 | </imageobject> |
---|
581 | </imageobjectco> |
---|
582 | </mediaobjectco> |
---|
583 | </figure> |
---|
584 | </para> |
---|
585 | </sect3> |
---|
586 | |
---|
587 | <sect3 id="variableslisttxt"><title><guimenuitem>List of variables</guimenuitem></title> |
---|
588 | <para> you can choose the variable to work on.</para> |
---|
589 | <para> |
---|
590 | <figure id="fig_xxx_0207"> |
---|
591 | <title></title> |
---|
592 | <mediaobjectco> |
---|
593 | <imageobjectco> |
---|
594 | <imageobject> |
---|
595 | <imagedata fileref="figpng/xxx_0207.png"/> |
---|
596 | </imageobject> |
---|
597 | </imageobjectco> |
---|
598 | </mediaobjectco> |
---|
599 | </figure> |
---|
600 | </para> |
---|
601 | </sect3> |
---|
602 | |
---|
603 | <sect3 id="fileslisttxt"><title><guimenuitem>List of open files</guimenuitem></title> |
---|
604 | <para> you can choose the file to work on.</para> |
---|
605 | <para> |
---|
606 | <figure id="fig_xxx_0208"> |
---|
607 | <title></title> |
---|
608 | <mediaobjectco> |
---|
609 | <imageobjectco> |
---|
610 | <imageobject> |
---|
611 | <imagedata fileref="figpng/xxx_0208.png"/> |
---|
612 | </imageobject> |
---|
613 | </imageobjectco> |
---|
614 | </mediaobjectco> |
---|
615 | </figure> |
---|
616 | </para> |
---|
617 | </sect3> |
---|
618 | |
---|
619 | <sect3 id="commandtexttxt"><title><guimenuitem>Command text</guimenuitem></title> |
---|
620 | <para>To specify the computation you want to do |
---|
621 | +++ donner plus d'infos et des examples |
---|
622 | <note><para>In the default case, the name given to a field is of no importance.</para></note> |
---|
623 | </para> |
---|
624 | </sect3> |
---|
625 | |
---|
626 | <sect3 id="calendartxt"><title>Calendar</title> |
---|
627 | <para> |
---|
628 | The calendar is made up of two droplists, which allow specification of |
---|
629 | two dates, the beginning and end of a time series, or the period over |
---|
630 | which to average before plotting. |
---|
631 | </para> |
---|
632 | </sect3> |
---|
633 | |
---|
634 | <sect3 id="domdeftxt"><title>Define the domain</title> |
---|
635 | <para> |
---|
636 | A series of widgets that allow specification of the min/max limits of |
---|
637 | the domain in longitude/x-index, latitude/y-index, and depth in levels |
---|
638 | or meters. For depth, one can specify in levels for a horizontal |
---|
639 | plot, and in meters for a vertical plot. |
---|
640 | </para> |
---|
641 | </sect3> |
---|
642 | |
---|
643 | <sect3 id="specificationstxt"><title>specify your plot</title> |
---|
644 | <para> |
---|
645 | You can specify the min, max, and contour interval by filling out the |
---|
646 | provided boxes! For the color palette, you can either specify the name |
---|
647 | or go search for one among the palettes available. |
---|
648 | <para> |
---|
649 | The "keywords" window allows specification of all desired |
---|
650 | keywords. These keywords can be those of |
---|
651 | <filename>plt.pro</filename>, <filename>pltt.pro</filename>, <filename>pltz.pro</filename>, |
---|
652 | <filename>plt1d.pro</filename>, or those of contour, plot, or all other programs that are |
---|
653 | used. Cf <xref linkend="example1"/> |
---|
654 | </para></para> |
---|
655 | </sect3> |
---|
656 | |
---|
657 | |
---|
658 | </sect2> |
---|
659 | </sect1> |
---|
660 | <sect1 id="examples"><title>Concrete examples of XXX in practice</title> |
---|
661 | |
---|
662 | <sect2 id="example1"><title>First plots</title> |
---|
663 | |
---|
664 | <para> |
---|
665 | One single file, one single plot per page |
---|
666 | </para> |
---|
667 | <para> |
---|
668 | Click on OK. |
---|
669 | </para> |
---|
670 | <para> |
---|
671 | Test the various basic functions: change the dates, the zoom, the |
---|
672 | field...</para> |
---|
673 | <para> |
---|
674 | Specify the min, max, and contour interval in the provided boxes.</para> |
---|
675 | <para> |
---|
676 | Add some keywords in the "keywords:" box, for example: </para> |
---|
677 | <blockquote> |
---|
678 | <para> |
---|
679 | /nocontour, /carte |
---|
680 | </para> |
---|
681 | </blockquote> |
---|
682 | <para> |
---|
683 | or the keywords for a northern hortographic polar projection:</para> |
---|
684 | <blockquote> |
---|
685 | <para> |
---|
686 | /nocontour, map=[90,0,0], /horto |
---|
687 | </para> |
---|
688 | </blockquote> |
---|
689 | <para> |
---|
690 | Test the various possibilities in the <guimenu>Save As</guimenu> menu.</para> |
---|
691 | <note> |
---|
692 | <para> |
---|
693 | the creation of animations has a tendency to saturate the video |
---|
694 | memory of X-terminals, crashing the entire program...</para> |
---|
695 | </note> |
---|
696 | <para> |
---|
697 | Test the various possibilities in the <guimenu>Flag options</guimenu> menu. |
---|
698 | </para> |
---|
699 | <caution> |
---|
700 | <para> |
---|
701 | Careful, a selected option remains selected until it is reclicked. |
---|
702 | </para> |
---|
703 | </caution> |
---|
704 | </sect2> |
---|
705 | |
---|
706 | <sect2 id="example2"><title>Work with more than one file</title> |
---|
707 | <para> |
---|
708 | Open some other files and go between them by selecting them from the |
---|
709 | file list... Note that the different widgets (calendar, domain, ...) |
---|
710 | follow the different file characteristics. |
---|
711 | </para> |
---|
712 | </sect2> |
---|
713 | |
---|
714 | <sect2 id="mouse"><title>Mouse actions in the graphics window on a horizontal plot</title> |
---|
715 | |
---|
716 | <para> |
---|
717 | Select a domain and select the horizontal plot (<constant>plt</constant>), vertical plot |
---|
718 | (<constant>pltz</constant>), or the hovmoeller plot (<constant>pltt</constant>):</para> |
---|
719 | <para> |
---|
720 | The domain we'd like to select for the plot is determined by one of |
---|
721 | its diagonals, defined therefore by two points. The first point is |
---|
722 | defined when the mouse button is pushed, then the mouse is moved, and |
---|
723 | the second point is defined as the mouse button is released |
---|
724 | (click-drag). The domains are thus defined by a long click (<abbrev>LC</abbrev>). To |
---|
725 | determine which type of plot should be made of selection, use: |
---|
726 | </para> |
---|
727 | <para> |
---|
728 | If the plot selector is on <constant>plt</constant> |
---|
729 | <itemizedlist> |
---|
730 | <listitem><para>the left mouse button to create horizontal plots (<constant>plt</constant>)</para></listitem> |
---|
731 | <listitem><para>the middle mouse button to create vertical plots (<constant>pltz</constant>)</para></listitem> |
---|
732 | <listitem><para>the right mouse button to create common hovmoellers for xt and yt cuts (<constant>pltt</constant>)</para></listitem> |
---|
733 | </itemizedlist> |
---|
734 | </para> |
---|
735 | |
---|
736 | <para>In summary:</para> |
---|
737 | <para> |
---|
738 | <itemizedlist> |
---|
739 | <listitem><para> |
---|
740 | <figure id="fig_mousell"> |
---|
741 | <title><abbrev>LCL</abbrev>---><constant>plt</constant></title> |
---|
742 | <mediaobjectco> |
---|
743 | <imageobjectco> |
---|
744 | <imageobject> |
---|
745 | <imagedata fileref="figpng/xxx_mousell.png"/> |
---|
746 | </imageobject> |
---|
747 | </imageobjectco> |
---|
748 | </mediaobjectco> |
---|
749 | </figure> |
---|
750 | |
---|
751 | </para></listitem> |
---|
752 | <listitem><para> |
---|
753 | <figure id="fig_mouselm"> |
---|
754 | <title><abbrev>LCM</abbrev>---><constant>pltz</constant></title> |
---|
755 | <mediaobjectco> |
---|
756 | <imageobjectco> |
---|
757 | <imageobject> |
---|
758 | <imagedata fileref="figpng/xxx_mouselm.png"/> |
---|
759 | </imageobject> |
---|
760 | </imageobjectco> |
---|
761 | </mediaobjectco> |
---|
762 | </figure> |
---|
763 | |
---|
764 | </para></listitem> |
---|
765 | <listitem><para> |
---|
766 | <figure id="fig_mouselr"> |
---|
767 | <title><abbrev>LCR</abbrev>---><constant>pltt</constant></title> |
---|
768 | <mediaobjectco> |
---|
769 | <imageobjectco> |
---|
770 | <imageobject> |
---|
771 | <imagedata fileref="figpng/xxx_mouselr.png"/> |
---|
772 | </imageobject> |
---|
773 | </imageobjectco> |
---|
774 | </mediaobjectco> |
---|
775 | </figure> |
---|
776 | |
---|
777 | </para></listitem> |
---|
778 | </itemizedlist> |
---|
779 | </para> |
---|
780 | |
---|
781 | <note><para>If the plot selector is on something other than <constant>plt</constant> the indicated plot type is made.</para></note> |
---|
782 | |
---|
783 | </sect2> |
---|
784 | <sect2 id="multipleplots"><title>Create multiple plots on the same sheet and make them interact</title> |
---|
785 | |
---|
786 | <para> |
---|
787 | Select the number of columns and rows for the page.</para> |
---|
788 | <para> |
---|
789 | Create a first plot. It will appear in the first frame.</para> |
---|
790 | <para> |
---|
791 | To create a plot in another frame double-click in the frame with the |
---|
792 | middle button (<abbrev>DCM</abbrev>). A black dotted frame will surround the |
---|
793 | designated frame, the <quote>target</quote> frame. A black frame will surround the |
---|
794 | first plot. This is the <quote>reference</quote> frame, in other words the one |
---|
795 | that all the XXX widgets refer to. Change for example the date and |
---|
796 | create a new plot. With a left button double-click in the first |
---|
797 | frame, all the widgets change and refer again to the first plot. A |
---|
798 | double-click with the right button in the second frame will erase the |
---|
799 | plot.</para> |
---|
800 | <para>In summary: </para> |
---|
801 | <itemizedlist> |
---|
802 | <listitem><para> |
---|
803 | <figure id="fig_mousedl"> |
---|
804 | <title><abbrev>DCL</abbrev>---><quote>reference</quote> frame</title> |
---|
805 | <mediaobjectco> |
---|
806 | <imageobjectco> |
---|
807 | <imageobject> |
---|
808 | <imagedata fileref="figpng/xxx_mousedl.png"/> |
---|
809 | </imageobject> |
---|
810 | </imageobjectco> |
---|
811 | </mediaobjectco> |
---|
812 | </figure> |
---|
813 | |
---|
814 | </para></listitem> |
---|
815 | <listitem><para> |
---|
816 | <figure id="fig_mousedm"> |
---|
817 | <title><abbrev>DCM</abbrev>---><quote>target</quote> frame</title> |
---|
818 | <mediaobjectco> |
---|
819 | <imageobjectco> |
---|
820 | <imageobject> |
---|
821 | <imagedata fileref="figpng/xxx_mousedm.png"/> |
---|
822 | </imageobject> |
---|
823 | </imageobjectco> |
---|
824 | </mediaobjectco> |
---|
825 | </figure> |
---|
826 | |
---|
827 | </para></listitem> |
---|
828 | <listitem><para> |
---|
829 | <figure id="fig_mousedr"> |
---|
830 | <title><abbrev>DCR</abbrev>--->erase the frame</title> |
---|
831 | <mediaobjectco> |
---|
832 | <imageobjectco> |
---|
833 | <imageobject> |
---|
834 | <imagedata fileref="figpng/xxx_mousedr.png"/> |
---|
835 | </imageobject> |
---|
836 | </imageobjectco> |
---|
837 | </mediaobjectco> |
---|
838 | </figure> |
---|
839 | |
---|
840 | </para></listitem> |
---|
841 | </itemizedlist> |
---|
842 | <para>Here's a series of commands to show how this works.</para> |
---|
843 | <procedure> |
---|
844 | <step> |
---|
845 | <para> |
---|
846 | Select a 3-D field and create 6 frames for the sheet of paper. |
---|
847 | </para> |
---|
848 | </step> |
---|
849 | <step> |
---|
850 | <para> |
---|
851 | Create a horizontal plot in Frame 1 |
---|
852 | </para> |
---|
853 | </step> |
---|
854 | <!-- je n'arrive pas à utliser <stepalternatives> --> |
---|
855 | <step> |
---|
856 | <para> |
---|
857 | <abbrev>DCM</abbrev> in frame 2, <abbrev>LCL</abbrev> on the plot in frame 1, to create a horizontal |
---|
858 | zoom in frame 2.</para> |
---|
859 | <para> |
---|
860 | <abbrev>DCM</abbrev> in frame 3, <abbrev>LCM</abbrev> on the plot in frame 1, to create a vertical cut |
---|
861 | in frame 3.</para> |
---|
862 | <para> |
---|
863 | <abbrev>DCM</abbrev> in frame 4, <abbrev>LCR</abbrev> on the plot in frame 1, to create a hovmoeller in frame 4. |
---|
864 | </para> |
---|
865 | </step> |
---|
866 | </procedure> |
---|
867 | <procedure> |
---|
868 | <para> |
---|
869 | To redo the hovmoeller with the keyword <literallayout>/nocontour</literallayout> |
---|
870 | </para> |
---|
871 | <step> |
---|
872 | <para> |
---|
873 | <abbrev>DCL</abbrev> in frame 4 which now becomes the reference and target frame. |
---|
874 | </para> |
---|
875 | </step> |
---|
876 | <step> |
---|
877 | <para> |
---|
878 | Add the keyword |
---|
879 | <literallayout>/nocontour</literallayout> |
---|
880 | </para> |
---|
881 | </step> |
---|
882 | <step> |
---|
883 | <para> |
---|
884 | click <guibutton>OK</guibutton>, and the plot is redone. |
---|
885 | </para> |
---|
886 | </step> |
---|
887 | </procedure> |
---|
888 | <procedure> |
---|
889 | <para> |
---|
890 | in frame 5, let's create the same plot as in frame 2 except with different dates |
---|
891 | </para> |
---|
892 | <step> |
---|
893 | <para> |
---|
894 | <abbrev>DCL</abbrev> on frame 2 |
---|
895 | </para> |
---|
896 | </step> |
---|
897 | <step> |
---|
898 | <para> |
---|
899 | <abbrev>DCM</abbrev> on frame 5 |
---|
900 | </para> |
---|
901 | </step> |
---|
902 | <step> |
---|
903 | <para> |
---|
904 | change the date |
---|
905 | </para> |
---|
906 | </step> |
---|
907 | <step> |
---|
908 | <para> |
---|
909 | click on <guibutton>OK</guibutton> |
---|
910 | , and voilà, the new plot. |
---|
911 | </para> |
---|
912 | </step> |
---|
913 | </procedure> |
---|
914 | </sect2> |
---|
915 | </sect1> |
---|
916 | <sect1 id="crash"><title>How to quit when it crashes</title> |
---|
917 | |
---|
918 | <para> |
---|
919 | <orderedlist> |
---|
920 | <listitem> |
---|
921 | <para> |
---|
922 | in the IDL window, type |
---|
923 | <screen format="linespecific"> |
---|
924 | <prompt>&promptidl;</prompt> <userinput>retall</userinput> |
---|
925 | </screen> |
---|
926 | </para></listitem> |
---|
927 | <listitem> |
---|
928 | <para><abbrev>DCR</abbrev> to erase the problem frame |
---|
929 | </para> |
---|
930 | </listitem> |
---|
931 | <listitem><para>press the <guibutton>clear</guibutton> button |
---|
932 | </para></listitem> |
---|
933 | <listitem><para>change the orientation of the plot |
---|
934 | </para></listitem> |
---|
935 | <listitem><para>quit XXX cleanly using <guibutton>quit</guibutton> from the <guimenu>File</guimenu> menu |
---|
936 | </para></listitem> |
---|
937 | </orderedlist> |
---|
938 | </para> |
---|
939 | <note> |
---|
940 | <para> |
---|
941 | Always avoid if at all possible closing and killing the XXX |
---|
942 | window, but rather select <guibutton>quit</guibutton> from the <guimenu>File</guimenu> menu. XXX uses a |
---|
943 | large number of pointers, and wantonly killing the window will leave a |
---|
944 | large number of unused variables in memory, which could in the end |
---|
945 | overflow. To clean up this memory: |
---|
946 | <screen format="linespecific"> |
---|
947 | <prompt>&promptidl;</prompt> <userinput>ptr_free, ptr_valid()</userinput> |
---|
948 | </screen> |
---|
949 | </para> |
---|
950 | </note> |
---|
951 | </sect1> |
---|
952 | </article> |
---|