source: trunk/SRC/Documentation/xmldoc/mini_notice.xml @ 376

<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE article [
<!ENTITY % isolat1 SYSTEM "http://www.w3.org/2003/entities/iso8879/isolat1.ent">
%isolat1;
<!ENTITY % isolat2 SYSTEM "http://www.w3.org/2003/entities/iso8879/isolat2.ent">
%isolat2;
<!ENTITY % isogrk3 SYSTEM "http://www.w3.org/2003/entities/iso8879/isogrk3.ent">
%isogrk3;
<!ENTITY % isopub SYSTEM "http://www.w3.org/2003/entities/iso8879/isopub.ent">
%isopub;
<!ENTITY % isotech SYSTEM "http://www.w3.org/2003/entities/iso8879/isotech.ent">
%isotech;
<!ENTITY % isonum SYSTEM "http://www.w3.org/2003/entities/iso8879/isonum.ent">
%isonum;
<!ENTITY promptidl "idl&gt;">
]
>
<article version="5.0"
xmlns="http://docbook.org/ns/docbook"
xmlns:xl="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xml:lang="en"
xml:id="mini_notice">
<!--

./SAXO_DIR/SRC/Documentation/xmldoc/mini_notice.xml

update :
fplod 2006-07-20T08:45:14Z aedon.locean-ipsl.upmc.fr (Darwin)
. creation by hand made migration from mini_notice.html to XML/Docbook
. installation part has been removed
. add images
++ fake graphics callouts see forxxxdoc.sh

-->
<title> Mini Guide for Basic Commands in the XXX Program </title>
  <info>
    <authorgroup>
      <author><personname><firstname>Sébastien</firstname> <surname>Masson</surname></personname> <email>Sebastien.Masson_at_locean-ipsl.upmc.fr</email></author>
      <author><personname><firstname>Albert</firstname> <surname>Fisher</surname></personname></author>
      <author><personname><firstname>Françoise</firstname> <surname>Pinsard</surname></personname> <email>Francoise.Pinsard_at_locean-ipsl.upmc.fr</email></author>
      <author><personname><firstname>Steve</firstname> <surname>Navarro</surname></personname></author>
    </authorgroup>
    <keywordset>
      <keyword>IDL</keyword>
      <keyword>SAXO</keyword>
      <keyword>xxx</keyword>
    </keywordset>
    <revhistory>
      <revision>
        <revnumber>0.0</revnumber>
        <date>May 29, 2000</date>
        <revremark>French release by Sébastien Masson</revremark>
      </revision>
      <revision>
        <revnumber>0.1</revnumber>
        <date>July, 2002</date>
        <revremark>Translation by Albert Fisher</revremark>
      </revision>
      <revision>
        <revnumber>0.2</revnumber>
        <date>July 20, 2006</date>
        <revremark>HTML to XML/Docbook migration by Françoise Pinsard</revremark>
      </revision>
      <revision>
        <revnumber>1.0</revnumber>
        <date>August, 2006</date>
        <revremark>Major update by Steve Navarro</revremark>
      </revision>
      <revision>
        <revnumber>1.1</revnumber>
        <date>September, 2006</date>
        <revremark>Review by Sébastien Masson</revremark>
      </revision>
      <revision>
        <revnumber>1.2</revnumber>
        <date>April 2008</date>
        <revremark>migration from DocBook 4.2 to Docbook 5.0</revremark>
      </revision>

     </revhistory>
     <pubdate>$Id$</pubdate>
  </info>


<sect1 xml:id="launchxxx"><title>Launching XXX</title>

<para>
There is several ways to launch XXX which we will detail in the next sections:
  <screen>
    <prompt>&promptidl;</prompt> <userinput><command>xxx</command></userinput>
    <prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>/separate</parameter></userinput>
    <prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>restore = 'file.dat'</parameter></userinput>
    <prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>'file.nc'</parameter></userinput>
    <prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>'file.nc'</parameter>, <parameter>keywd1 = &hellip;</parameter>, <parameter>keywd2 = &hellip;</parameter></userinput>
    <prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>'file.nc'</parameter>, <parameter>'initgrid'</parameter></userinput>
    <prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>'file.nc'</parameter>, <parameter>'initgrid'</parameter>, <parameter>keywd1 = &hellip;</parameter>, <parameter>keywd2 = &hellip;</parameter></userinput>
    <prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>'file.nc'</parameter>, <parameter>'initgrid'</parameter>, <parameter>'arg1, arg2, &hellip;'</parameter></userinput>
  </screen>
</para>

<sect2 xml:id="launch_xxx_1"><title><prompt>&promptidl;</prompt> <userinput><command>xxx</command></userinput></title>
  <para>
    A window will open with 3 parts to consider.
<figure xml:id="fig_xxx_0101">
<title>Window xxx 1</title>
<mediaobject>
<imageobjectco>
<areaspec units="calspair">
<area xml:id="datafile" coords="500,1715 9326,3074"/>
<area xml:id="initmethod" coords="1500,3268 8326,4919"/>
<area xml:id="initprogram" coords="57,5145 9961,8996"/>
</areaspec>
<imageobject>
<imagedata fileref="figpng/xxx_0101.png"/> <!-- ++ instead of figpng/xxx_0101_org.png -->
</imageobject>
<calloutlist>
<callout arearefs="datafile">
<para>Data file name</para>
</callout>
<callout arearefs="initmethod">
<para>Grid initialization method</para>
</callout>
<callout arearefs="initprogram">
<para>Grid initialization parameters</para>
</callout>
</calloutlist>
</imageobjectco>
<!-- ++ si on met textobject, on ne voit plus l'image !!
<textobject>[plot figpng/xxx_0101.png]</textobject>
-->
</mediaobject>
</figure>
  </para>

<sect3 xml:id="datafiletxt"><title>Data file name</title>
  <para>
    The name of the data file. It can be typed directly in the window provided, or selected with the help of the <guibutton>browse</guibutton> button.
  </para>
</sect3>
<sect3 xml:id="initmethodtxt"><title>Grid initialization method</title>
  <para>
    For visualising grilled data, you need to <link xl:href="./firststeps.html#load_grid">define the grid</link> on which are located the data. By default, <guibutton>automatic grid construction with initncdf.pro</guibutton> is checked. This means that the grid will be defined by using the informations contained in the data file (through the IDL prodecure <command>initncdf</command>) without needing any other auxiliary file. If you checked <guibutton>grid construction with other IDL batch or procedure</guibutton>, this means that you don't want to use the default <command>initncdf</command> procedure to define the grid and you will provide your own IDL procedure or the so-called IDL batch file (a file which is called by using @, see IDL documentation).
  </para>
</sect3>
<sect3 xml:id="initprogramtxt"><title>Grid initialization parameters</title>
  <para>
    This third part allows you to specify the name, the argument and the keywords of the routine you want to use to initialize the grid.
By default the name of the procedure is <command>initncdf</command>, its argument will be automatically defined so you cannot change them. If you checked <guibutton>grid construction with other IDL batch or procedure</guibutton>, you have to select the name of the IDL procedure or batch file and its suitable arguments and keywords. Note that if you select an IDL batch file you cannot give any parameter or keyword.
    <figure xml:id="fig_xxx_0102">
      <title>Window xxx 1</title>
      <mediaobject>
  <imageobject>
    <imagedata fileref="figpng/xxx_0102.png"/>
  </imageobject>
      </mediaobject>
    </figure>
  </para>
  <para>
    Once these two lines have been completed, click on <guibutton>let's go</guibutton>.
  </para>
  <para>For example, we choose the IDL batch file <filename>tst_initlev</filename>. Compare the result with <guibutton>automatic grid construction with initncdf.pro</guibutton> checked. Cf <xref linkend="fig_xxx_0404"/>
  </para>
<para>
  <figure xml:id="fig_xxx_0103">
      <title>Oceania at 125 meters of depth with proper grid initialization</title>
<mediaobject>
<imageobject>
  <imagedata fileref="figpng/xxx_0103.png"/>
</imageobject>
      </mediaobject>
  </figure>
</para>
</sect3>
</sect2>

<sect2 xml:id="launch_xxx_2"><title><prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>/separate</parameter></userinput></title>
<para>
This is the same as the simple <xref linkend="launch_xxx_1"/> except that once the xxx window open, you will have 2 separate windows (command and plotting window) instead of one.
</para>
</sect2>

<sect2 xml:id="launch_xxx_3"><title><prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>restore = 'file.dat'</parameter></userinput></title>
<para>
In that case xxx window will open directly in the same state as it was when the file <filename>file.dat</filename> was created. see <xref linkend="restore"/>.
</para>
</sect2>

<sect2 xml:id="launch_xxx_4"><title><prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>'file.nc'</parameter></userinput></title>
<para>
In this case, the xxx window directly open the data file <filename>file.nc</filename> and build the grid automatically with the IDL procedure <command>initncdf</command>. For example:
  <screen>
    <prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>'Levitus98_1m_01_12_Temperature_Pot_1x1.nc'</parameter></userinput>
  </screen>
</para>
</sect2>

<sect2 xml:id="launch_xxx_5"><title><prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>'file.nc'</parameter>, <parameter>keywd1 = &hellip;</parameter>, <parameter>keywd2 = &hellip;</parameter></userinput></title>
<para>
In this case, the xxx window directly open the data file <filename>file.nc</filename>, build the grid automatically with the IDL procedure <command>initncdf</command> and use the keywords <userinput><parameter>keywd1 = &hellip;</parameter>, <parameter>keywd2 = &hellip;</parameter></userinput> in the call of <command>initncdf</command>. For example:
  <screen>
    <prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>'Levitus98_1m_01_12_Temperature_Pot_1x1.nc'</parameter>, <parameter>useasmask = 'votemper'</parameter>, <parameter>missing_value = 31.0720</parameter></userinput>
  </screen>
</para>
</sect2>

<sect2 xml:id="launch_xxx_6"><title><prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>'file.nc'</parameter>, <parameter>'initgrid'</parameter></userinput></title>
<para>
In this case, the xxx window directly open the data file <filename>file.nc</filename> and build the grid directly with the IDL procedure or batch file <command>initgrid</command>
  <screen>
    <prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>'Levitus98_1m_01_12_Temperature_Pot_ORCA2.nc'</parameter>, <parameter>'tst_initorca2'</parameter></userinput>
  </screen>
</para>
</sect2>

<sect2 xml:id="launch_xxx_7"><title><prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>'file.nc'</parameter>, <parameter>'initgrid'</parameter>, <parameter>keywd1 = &hellip;</parameter>, <parameter>keywd2 = &hellip;</parameter></userinput></title>
<para>
In this case, the xxx window directly open the data file <filename>file.nc</filename>, build the grid directly with the IDL procedure <command>initgrid</command> and use the keywords <userinput><parameter>keywd1 = &hellip;</parameter>, <parameter>keywd2 = &hellip;</parameter></userinput> in the call of <command>initgrid</command>.
</para>
</sect2>

<sect2 xml:id="launch_xxx_8"><title><prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>'file.nc'</parameter>, <parameter>'initgrid'</parameter>, <parameter>'arg1, arg2, &hellip;'</parameter></userinput></title>
<para>
In this case, the xxx window directly open the data file <filename>file.nc</filename>, build the grid directly with the IDL procedure <command>initgrid</command> and use the string <userinput><parameter>'arg1, arg2, &hellip;'</parameter></userinput> to specify the input arguments in the call of <command>initgrid</command>.
</para>
</sect2>

</sect1>

<sect1 xml:id="wigdets"><title>Description of XXX window</title>

<para>
<!-- cf example in http://www.docbook.org/tdg/en/html/area.html
sauf que dans l'exemple en question on ne donne que 2 nombres et pas 4
voir aussi message http://www.oasis-open.org/archives/docbook-apps/200501/msg00089.html
peut-etre du nouveau dans les xsl depuis le 16 janvier 2005
peut-être essayé http://lists.kde.org/?l=kde-doc-english&m=112780764426265&w=2
ce produit klickety est installable via fink sous mac
 -->
<figure xml:id="fig_xxx_0201">
<title>Window xxx 2</title>
<mediaobject>
<imageobjectco>
<areaspec units="calspair">
<area xml:id="plottype" coords="69,380 2261,809"/>
<area xml:id="menu" coords="2517,380 7575,841"/>
<area xml:id="ok" coords="116,936 1025,1365"/>
<area xml:id="pagelayout" coords="1631,936 4498,1365"/>
<area xml:id="variableslist" coords="4871,952 7529,1349"/>
<area xml:id="fileslist" coords="46,1507 8018,1857"/>
<area xml:id="commandtext" coords="46,2000 8065,2539"/>
<area xml:id="calendar" coords="46,2682 4941,3428"/>
<area xml:id="domdef" coords="372,3603 7179,7095"/>
<area xml:id="specifications" coords="23,7269 8041,9206"/>
</areaspec>
<imageobject>
<imagedata fileref="figpng/xxx_0201.png"/> <!-- ++ instead of figpng/xxx_0201_org.png -->
</imageobject>
<calloutlist>
<callout arearefs="plottype">
<para>Plot type</para>
</callout>
<callout arearefs="menu">
<para>Menu</para>
</callout>
<callout arearefs="ok">
<para>OK</para>
</callout>
<callout arearefs="pagelayout">
<para>Page layout</para>
</callout>
<callout arearefs="variableslist">
<para>Variables list</para>
</callout>
<callout arearefs="fileslist">
<para>Files list</para>
</callout>
<callout arearefs="commandtext">
<para>Command text</para>
</callout>
<callout arearefs="calendar">
<para>Calendar</para>
</callout>
<callout arearefs="domdef">
<para>Domdef</para>
</callout>
<callout arearefs="specifications">
<para>Spefications</para>
</callout>
</calloutlist>
</imageobjectco>
<!-- ++ si on met textobject, on ne voit plus l'image
<textobject>[plot figpng/xxx_0201.png]</textobject>
-->
</mediaobject>
</figure>
</para>

<sect2 xml:id="plottypetxt"><title>Plot type list</title>
<para>Allows specification of the type of plot desired.</para>
<para>
    <figure xml:id="fig_xxx_0202">
      <title>Different plot types available</title>
<mediaobject>
  <imageobject>
    <imagedata fileref="figpng/xxx_0202.png"/>
  </imageobject>
      </mediaobject>
    </figure>
</para>
<note>
<para>
If the type <constant>plt</constant> is selected, the selection of plot type
is made by mouse. Cf <xref linkend="mouse"/></para>
</note>
</sect2>

<sect2 xml:id="menutxt"><title>The menu bar made up of 3 sub-menus</title>
<sect3 xml:id="filesubmenu"><title><guibutton>File</guibutton> sub-menu</title>
<para>
    <figure xml:id="fig_xxx_0203">
      <title>The File menu</title>
<mediaobject>
  <imageobject>
    <imagedata fileref="figpng/xxx_0203.png"/>
  </imageobject>
      </mediaobject>
    </figure>
</para>
<para>
<itemizedlist>
<listitem><para><menuchoice><guisubmenu>Open:</guisubmenu></menuchoice> to open a new file. Same procedure as during the <xref linkend="launch_xxx_1"/>.
The new file can be on a different grid, with different variables, with a different time base &hellip;
</para></listitem>
<listitem><para><menuchoice><guisubmenu>New XXX:</guisubmenu></menuchoice> to open a second XXX window identical to the first one.</para></listitem>
<listitem><para><menuchoice><guisubmenu>Quit:</guisubmenu></menuchoice> to close the XXX window.</para></listitem>
</itemizedlist>
</para>
</sect3>
<sect3 xml:id="saveassubmenu"><title><guibutton>Save As</guibutton> sub-menu</title>
<para>
    <figure xml:id="fig_xxx_0204">
      <title>The Save As menu</title>
<mediaobject>
  <imageobject>
    <imagedata fileref="figpng/xxx_0204.png"/>
  </imageobject>
      </mediaobject>
    </figure>
</para>
<para>
<itemizedlist>
<listitem><para><menuchoice><guisubmenu>Postscript:</guisubmenu></menuchoice> to save the plotting window in Postscript format</para></listitem>
<listitem><para><menuchoice><guisubmenu>Animated gif:</guisubmenu></menuchoice> to create an animation of the plotting window.
<note><para>The creation of an animation is only possible if none of the plots have a time axis, and if the plots are all on the same time base (calendar). On the other hand, animations of horizontal and vertical plots, with different color palettes (for those not on an X-terminal), are possible.</para></note>
<note><para>The creation of animations has a tendency to saturate the video memory of X-terminals, crashing the entire program &hellip;</para></note>
</para></listitem>
<listitem><para><menuchoice><guisubmenu>Gif:</guisubmenu></menuchoice> to save a gif of the plotting window.</para></listitem>
<listitem><para><menuchoice><guisubmenu>IDL procedure:</guisubmenu></menuchoice> to save the command history that has created the plot in an IDL procedure that can be re-executed later. For example if I save the commands in <filename>xxx_figure.pro</filename> file, when ever I want, I can then launch a new IDL session and type:
  <screen>
<prompt>&promptidl;</prompt> <userinput>@init</userinput>
<prompt>&promptidl;</prompt> <userinput>xxx_figure</userinput>
</screen>
and I'll obtain the saved figure.
  <screen>
<prompt>&promptidl;</prompt> <userinput>xxx_figure,/post</userinput>
</screen>
or
  <screen>
<prompt>&promptidl;</prompt> <userinput>@ps</userinput>
</screen>
will then create a Postscript file of the figure.
</para></listitem>
<listitem>
<para xml:id="restore"><menuchoice><guisubmenu>RESTORE kwd of xxx:</guisubmenu></menuchoice> to save the xxx widget (all buttons and parameters stored in memory &hellip;) in a binary file in order to quit xxx and relaunch it later like in <xref linkend="launch_xxx_3"/> and get exactly the same configuration.
</para>
</listitem>
<listitem>
<para>
<menuchoice><guisubmenu>Print to prompt:</guisubmenu></menuchoice> lists in the IDL window the command history that created the last plot. Useful primarily for debugging&hellip;
</para>
</listitem>
</itemizedlist>
</para>
</sect3>
<sect3 xml:id="flagsubmenu"><title><guisubmenu>Flag options</guisubmenu> sub-menu</title>
<para>
    <figure xml:id="fig_xxx_0205">
      <title>The <guisubmenu>Flag option</guisubmenu> menu</title>
<mediaobject>
  <imageobject>
    <imagedata fileref="figpng/xxx_0205.png"/>
  </imageobject>
      </mediaobject>
    </figure>
</para>
<para>
<itemizedlist>
<listitem><para><guisubmenu>Portrait/Landscape:</guisubmenu> changes the configuration of the plot.</para></listitem>
<listitem><para><guisubmenu>Overlay:</guisubmenu> to plot contours of a different field on top the one represented as color-filled contours. It is necessary to relaunch the entire plot to make this work!</para></listitem>
<listitem><para><guisubmenu>Vecteur:</guisubmenu> to plot a vector field on top of contours. Only works on horizontal plots (<filename>plt.pro</filename>).
As for Overlay, a relaunch of the entire plot is necessary.</para></listitem>
<listitem><para><guisubmenu>Longitude / x index:</guisubmenu> switches longitude labeling of the plot sub-domain from degrees to indexes following i.</para></listitem>
<listitem><para><guisubmenu>Latitude / y index:</guisubmenu> switches latitude labeling of the plot sub-domain from degrees to indexes following j.</para></listitem>
</itemizedlist>
</para>
<caution><para>Careful, a selected option remains selected until it is re-clicked.</para></caution>
</sect3>
</sect2>

<sect2 xml:id="oktxt"><title>OK button</title>
<para>Click on this <guibutton>OK</guibutton> button is required to make a new plot appear</para>
</sect2>

<sect2 xml:id="pagelayouttxt"><title>Page Layout</title>
<para>Specify the number of columns and rows for plots on the sheet of paper.</para>
<para>
    <figure xml:id="fig_xxx_0206">
      <title>Number of Column</title>
<mediaobject>
  <imageobject>
    <imagedata fileref="figpng/xxx_0206.png"/>
  </imageobject>
      </mediaobject>
    </figure>
</para>
<para>
    <figure xml:id="fig_xxx_0206a">
      <title>Example: For 2 columns and 2 rows</title>
<mediaobject>
  <imageobject>
    <imagedata fileref="figpng/xxx_0206a.png"/>
  </imageobject>
      </mediaobject>
    </figure>
</para>
</sect2>

<sect2 xml:id="variableslisttxt"><title>List of variables</title>
<para>You can choose the variable to work on.</para>
<para>
    <figure xml:id="fig_xxx_0207">
      <title>Example of different variables available</title>
<mediaobject>
  <imageobject>
    <imagedata fileref="figpng/xxx_0207.png"/>
  </imageobject>
      </mediaobject>
    </figure>
</para>
</sect2>

<sect2 xml:id="fileslisttxt"><title>List of open files</title>
<para>You can choose the file to work on.</para>
<para>
    <figure xml:id="fig_xxx_0208">
      <title>Example of list of open files</title>
<mediaobject>
  <imageobject>
    <imagedata fileref="figpng/xxx_0208.png"/>
  </imageobject>
      </mediaobject>
    </figure>
</para>
</sect2>

<sect2 xml:id="commandtexttxt"><title><guimenuitem>Command text</guimenuitem><!--++ textarea--></title>
<para>
To specify in the widget part number 7 the computation you want to do on the data
<note><para>In all cases bellow, the name given to a field (a, b, c, &hellip;) is of no importance.</para></note>
</para>
<sect3 xml:id="commandtext_linear"><title>Linear calculation</title>
<para>
If you want to make basic linear computation (like difference between fields, add/multiply by a constant &hellip;), you can simply put the following commands: <literal>a - b</literal><literal>numb1*a</literal><literal>a + numb</literal> or any command with the following format <literal>numb1*a + numb2*b  + numb3*c &hellip; + numb</literal> where numb1, numb2, &hellip; correspond to numbers and a, b, c &hellip; will be the data to read.
</para>
</sect3>
<sect3 xml:id="commandtext_anykind"><title>Any kind of computation</title>
<para>
If you want to make a computation more complicated than a basic linear you must designate the data you want to read between <keycap>"</keycap><keycap>"</keycap> (with anything in between the "). For example: <screen>"a"^2</screen><screen>"a" - abs("b")</screen><screen>grad("a", 'x')</screen> &hellip;
</para>
</sect3>
</sect2>

<sect2 xml:id="calendartxt"><title>Calendar</title>
<para>
The calendar is made up of two drop-lists, which allow specification of two dates, the beginning and end of a time series, or the period over which to average before plotting.</para>
<para>
    <figure xml:id="fig_xxx_0301">
      <title>Example: first plot in January, second plot is from January to December</title>
<mediaobject>
  <imageobject>
    <imagedata fileref="figpng/xxx_0301.png"/>
  </imageobject>
      </mediaobject>
    </figure>
</para>
</sect2>

<sect2 xml:id="domdeftxt"><title>Define the domain</title>
<para>
  A series of widgets that allow specification of the min/max limits of the domain in longitude/x-index, latitude/y-index, and depth in levels or meters.
  <figure xml:id="fig_xxx_0210_domain">
    <title>Domain by default</title>
<mediaobject>
    <imageobject>
      <imagedata fileref="figpng/xxx_0210.png"/>
    </imageobject>
      </mediaobject>
  </figure>
  <figure xml:id="fig_xxx_0401">
    <title>Change Domain area: zoom on Oceania</title>
<mediaobject>
  <imageobject>
    <imagedata fileref="figpng/xxx_0401.png"/>
  </imageobject>
      </mediaobject>
  </figure>
  <figure xml:id="fig_xxx_0402">
    <title>This configuration give us:</title>
<mediaobject>
    <imageobject>
      <imagedata fileref="figpng/xxx_0402.png"/>
    </imageobject>
      </mediaobject>
  </figure>
  <figure xml:id="fig_xxx_0403">
    <title>Change depth area: between depth 125 and 126</title>
<mediaobject>
    <imageobject>
      <imagedata fileref="figpng/xxx_0403.png"/>
    </imageobject>
      </mediaobject>
  </figure>
  <figure xml:id="fig_xxx_0404">
    <title>temperature of the ocean at depth 125 meters without proper land/sea mask</title>
<mediaobject>
    <imageobject>
      <imagedata fileref="figpng/xxx_0404.png"/>
    </imageobject>
      </mediaobject>
  </figure>
  As you can see, at this depth, we better define a land/sea mask when loading the grid. Cf <xref linkend="fig_xxx_0103"/>
</para>
</sect2>

<sect2 xml:id="specificationstxt"><title>Specify your plot</title>

<sect3 xml:id="minmaxintervaltxt"><title>Specify min, max and contour interval</title>
<para>
  <figure xml:id="fig_xxx_0501">
    <title>min, max, and contour interval specifications</title>
<mediaobject>
    <imageobject>
      <imagedata fileref="figpng/xxx_0501.png"/>
    </imageobject>
      </mediaobject>
  </figure>
  You can restore configuration by default by pressing the <menuchoice><guibutton>Default</guibutton></menuchoice> button.
  <note><para>The path of the file <link xl:href="../../ToBeReviewed/WIDGET/AUTOUR_de_XXX/definedefaultextra.pro"><filename>definedefaultextra.pro</filename></link> that defines the default values for each variable names is displayed when the cursor hovers over the button <menuchoice><guibutton>Default</guibutton></menuchoice>. This file contains a case statement based on the name of the variable and defining the min, max, contour interval and other keywords that should be used as default for the specified variable. You can copy this file in your own <filename class="directory">${HOME}/My_IDL/</filename> directory and easily modify it to suit your favorite default values.</para></note>
</para>
</sect3>

<sect3 xml:id="colortxt"><title>Specify the palette to be used</title>
<para>For the color palette, you can either specify the name or go search for one among the palettes available.</para>
<para>
    <figure xml:id="fig_xxx_0502">
      <title>The Color menu</title>
<mediaobject>
  <imageobject>
    <imagedata fileref="figpng/xxx_0502.png"/>
  </imageobject>
      </mediaobject>
    </figure>
</para>
</sect3>

<sect3 xml:id="kwdtxt"><title>Add any keyword</title>
<para>
  The <quote>keywords</quote> window allows specification of all desired keywords. There is a few examples of the use of this <quote>keywords</quote> window.
  <figure xml:id="fig_xxx_0209">
    <title>Without any additional keyword</title>
<mediaobject>
    <imageobject>
      <imagedata fileref="figpng/xxx_0209.png"/>
    </imageobject>
      </mediaobject>
  </figure>
  <figure xml:id="fig_xxx_0210a">
    <title>Add <varname>/realcont</varname> keyword</title>
<mediaobject>
    <imageobject>
      <imagedata fileref="figpng/xxx_0210a.png"/>
    </imageobject>
      </mediaobject>
  </figure>
  <figure xml:id="fig_xxx_0210_realcont">
    <title>Graphic with <varname>/realcont</varname> keyword</title>
<mediaobject>
    <imageobject>
      <imagedata fileref="figpng/xxx_0210.png"/>
    </imageobject>
      </mediaobject>
  </figure>
  <figure xml:id="fig_xxx_0211a">
    <title>Add <userinput>/realcont, map=[90,0,0], /ortho, cell_fill=2</userinput> keywords</title>
<mediaobject>
    <imageobject>
      <imagedata fileref="figpng/xxx_0211a.png"/>
    </imageobject>
      </mediaobject>
  </figure>
  <figure xml:id="fig_xxx_0211">
    <title>Graphic with <literal>/realcont, map=[90,0,0], /ortho, cell_fill=2</literal> keywords</title>
<mediaobject>
    <imageobject>
      <imagedata fileref="figpng/xxx_0211.png"/>
    </imageobject>
      </mediaobject>
  </figure>
</para>
</sect3>
</sect2>
</sect1>

<sect1 xml:id="mouseactions"><title>Mouse Actions</title>

<sect2 xml:id="mouse"><title>In the graphics window on a horizontal plot</title>
<para>
Select a domain and select the horizontal plot (<constant>plt</constant>), vertical plot
(<constant>pltz</constant>), or the hovmoeller plot (<constant>pltt</constant>):</para>
<para>
The domain we'd like to select for the plot is determined by one of
its diagonals, defined therefore by two points.
The first point is
defined when the mouse button is pushed, then the mouse is moved, and
the second point is defined as the mouse button is released
(click-drag).
The domains are thus defined by a long click (<abbrev>LC</abbrev>).
To determine which type of plot should be made of selection, use:
</para>
<para>
If the plot selector is on <constant>plt</constant>
<itemizedlist>
<listitem><para>the <mousebutton>left</mousebutton> mouse button to create horizontal plots (<constant>plt</constant>)</para></listitem>
<listitem><para>the <mousebutton>middle</mousebutton> mouse button to create vertical plots (<constant>pltz</constant>)</para></listitem>
<listitem><para>the <mousebutton>right</mousebutton> mouse button to create common hovmoellers for xt and yt cuts (<constant>pltt</constant>)</para></listitem>
</itemizedlist>
</para>

<para>In summary:</para>
<para>
<itemizedlist>
<listitem>
<para>
    <figure xml:id="fig_mousell">
      <title><abbrev>LCL</abbrev>---><constant>plt</constant></title>
      <mediaobject>
  <imageobject>
    <imagedata fileref="figpng/xxx_mousell.png"/>
  </imageobject>
      </mediaobject>
    </figure>
</para>
<para>
    <figure xml:id="fig_xxx_0701">
      <title>Horizontal Plot</title>
      <mediaobject>
  <imageobject>
    <imagedata fileref="figpng/xxx_0701.png"/>
  </imageobject>
      </mediaobject>
    </figure>
</para>

</listitem>
<listitem>
<para>
    <figure xml:id="fig_mouselm">
      <title><abbrev>LCM</abbrev>---><constant>pltz</constant></title>
      <mediaobject>
  <imageobject>
    <imagedata fileref="figpng/xxx_mouselm.png"/>
  </imageobject>
      </mediaobject>
    </figure>
</para>
<para>
    <figure xml:id="fig_xxx_0702">
      <title>Vertical Plot</title>
      <mediaobject>
  <imageobject>
    <imagedata fileref="figpng/xxx_0702.png"/>
  </imageobject>
      </mediaobject>
    </figure>
</para>

</listitem>
<listitem>
<para>
    <figure xml:id="fig_mouselr">
      <title><abbrev>LCR</abbrev>---><constant>pltt</constant></title>
      <mediaobject>
  <imageobject>
    <imagedata fileref="figpng/xxx_mouselr.png"/>
  </imageobject>
      </mediaobject>
    </figure>
</para>
<para>
    <figure xml:id="fig_xxx_0703">
      <title>Common hovmoeller for xt and yt cuts</title>
      <mediaobject>
  <imageobject>
    <imagedata fileref="figpng/xxx_0703.png"/>
  </imageobject>
      </mediaobject>
    </figure>
</para>

</listitem>
</itemizedlist>
</para>

<note><para>If the plot selector is on something other than <constant>plt</constant> the indicated plot type is made.</para></note>

</sect2>
<sect2 xml:id="multipleplots"><title>Create multiple plots on the same sheet and make them interact</title>

<para>
Select the number of columns and rows for the page.</para>
<para>
Create a first plot.
It will appear in the first frame.</para>
<para>
To create a plot in another frame double-click in the frame with the
<mousebutton>middle</mousebutton> button (<keycombo action="double-click"><mousebutton>DCM</mousebutton></keycombo>).
A black dotted frame will surround the designated frame, the <quote>target</quote> frame.
A black frame will surround the first plot.
This is the <quote>reference</quote> frame, in other words the one
that all the XXX widgets refer to.
Change for example the date and create a new plot.
With a <mousebutton>left</mousebutton> button double-click in the first
frame, all the widgets change and refer again to the first plot.
A double-click with the <mousebutton>right</mousebutton> button in the second frame will erase the
plot.</para>
<para>In summary: </para>
<itemizedlist>
<listitem>
<para>
    <figure xml:id="fig_mousedl">
      <title><abbrev>DCL</abbrev>---><quote>reference</quote> frame</title>
      <mediaobject>
  <imageobject>
    <imagedata fileref="figpng/xxx_mousedl.png"/>
  </imageobject>
      </mediaobject>
    </figure>
</para>
<para>
    <figure xml:id="fig_xxx_0801">
      <title>The <quote>reference</quote> frame is selected</title>
      <mediaobject>
  <imageobject>
    <imagedata fileref="figpng/xxx_0801.png"/>
  </imageobject>
      </mediaobject>
    </figure>
</para>

</listitem>
<listitem>
<para>
    <figure xml:id="fig_mousedm">
      <title><abbrev>DCM</abbrev>---><quote>target</quote> frame</title>
      <mediaobject>
  <imageobject>
    <imagedata fileref="figpng/xxx_mousedm.png"/>
  </imageobject>
      </mediaobject>
    </figure>
</para>
<para>
    <figure xml:id="fig_xxx_0802">
      <title>The <quote>target</quote> frame is selected</title>
      <mediaobject>
  <imageobject>
    <imagedata fileref="figpng/xxx_0802.png"/>
  </imageobject>
      </mediaobject>
    </figure>
</para>
</listitem>
<listitem>
<para>
    <figure xml:id="fig_mousedr">
      <title><abbrev>DCR</abbrev>--->erase the frame</title>
      <mediaobject>
  <imageobject>
    <imagedata fileref="figpng/xxx_mousedr.png"/>
  </imageobject>
      </mediaobject>
    </figure>

</para>
</listitem>
</itemizedlist>
<para>Here's a series of commands to show how this works.</para>
<procedure>
<step>
<para>
Load xxx with the command:
  <screen>
    <prompt>&promptidl;</prompt> <userinput><command>xxx</command>, <parameter>'Levitus98_1m_01_12_Temperature_Pot_ORCA05.nc'</parameter>, <parameter>'tst_initorca05'</parameter></userinput>
  </screen>
</para>
</step>
<step>
<para>
Select a 3-D field and create 6 frames for the sheet of paper.
</para>
</step>
<step>
<para>
Create a horizontal plot in Frame 1
</para>
</step>
<!-- je n'arrive pas à utliser <stepalternatives> -->
<step>
<para>
<abbrev>DCM</abbrev> in frame 2, <abbrev>LCL</abbrev> on the plot in frame 1 to create a horizontal zoom in frame 2.</para>
<para>
<abbrev>DCM</abbrev> in frame 3, <abbrev>LCM</abbrev> on the plot in frame 1 to create a vertical cut in frame 3.</para>
<para>
<abbrev>DCM</abbrev> in frame 4, <abbrev>LCR</abbrev> on the plot in frame 1 to create a hovmoeller in frame 4.
</para>
<para>
    <figure xml:id="fig_xxx_0901">
      <title>Frame with four plot</title>
      <mediaobject>
  <imageobject>
    <imagedata fileref="figpng/xxx_0901.png"/>
  </imageobject>
      </mediaobject>
    </figure>
</para>
</step>
</procedure>
<procedure>
<para>
To redo the hovmoeller with the keyword <literallayout>/nocontour</literallayout>
</para>
<step>
<para>
<abbrev>DCL</abbrev> in frame 4 which now becomes the reference and target frame.
</para>
</step>
<step>
<para>
Add the keyword
<literallayout>/nocontour</literallayout>
</para>
<para>
    <figure xml:id="fig_xxx_0902a">
      <title>Command text area</title>
      <mediaobject>
  <imageobject>
    <imagedata fileref="figpng/xxx_0902a.png"/>
  </imageobject>
      </mediaobject>
    </figure>
</para>
</step>
<step>
<para>
Click <guibutton>OK</guibutton>, and the plot is redone.
</para>
<para>
    <figure xml:id="fig_xxx_0902">
      <title>The fourth plot with the keyword "nocontour"</title>
      <mediaobject>
  <imageobject>
    <imagedata fileref="figpng/xxx_0902.png"/>
  </imageobject>
      </mediaobject>
    </figure>
</para>
</step>
</procedure>
<procedure>
<para>
In frame 5, let's create the same plot as in frame 2 except we use pltv instead of plt
</para>
<step>
<para>
<abbrev>DCL</abbrev> on frame 2
</para>
</step>
<step>
<para>
<abbrev>DCM</abbrev> on frame 5
</para>
</step>
<step>
<para>
Change plt for pltv
</para>
</step>
<step>
<para>
Click on <guibutton>OK</guibutton>
</para>
<para>
    <figure xml:id="fig_xxx_0903">
      <title>Frame with five plot</title>
      <mediaobject>
  <imageobject>
    <imagedata fileref="figpng/xxx_0903.png"/>
  </imageobject>
      </mediaobject>
    </figure>
</para>
</step>
</procedure>
</sect2>
</sect1>
<sect1 xml:id="crash"><title>What should I do when it breakdown</title>

<para>
<orderedlist>
<listitem>
<para>
In the IDL window type (as many time you click on a button since a problem occurs in xxx !!!),
  <screen>
<prompt>&promptidl;</prompt> <userinput>retall</userinput>
</screen>
</para></listitem>
<listitem>
<para>
In the IDL window, type
<screen>
 <prompt>&promptidl;</prompt> <userinput>domdef</userinput>
</screen>
</para></listitem>
<listitem>
<para><abbrev>DCR</abbrev> to erase the problem frame.
</para>
</listitem>
<listitem>
<para>change the orientation of the plot by pressing <menuchoice><guisubmenu>Flag options</guisubmenu> <guimenuitem>Portrait/Landscape</guimenuitem></menuchoice>. Cf <xref linkend="flagsubmenu"/>
</para>
</listitem>
<listitem>
<para>quit XXX cleanly using <guisubmenu>quit</guisubmenu> from the <guibutton>File</guibutton> menu. Cf <xref linkend="filesubmenu"/>
</para>
</listitem>
</orderedlist>
</para>
<note>
<para>
Always avoid if at all possible closing and killing the XXX
window, but rather select <guisubmenu>quit</guisubmenu> from the <guibutton>File</guibutton> menu.
XXX uses a large number of pointers, and want only killing the window will
leave a large number of unused variables in memory, which could in the end
overflow.
To clean up this memory:
<screen>
 <prompt>&promptidl;</prompt> <userinput>ptr_free, ptr_valid()</userinput>
</screen>
</para>
</note>
</sect1>
</article>