Ignore:
Timestamp:
04/22/08 10:52:34 (16 years ago)
Author:
pinsard
Message:

some improvements in wiki production

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Documentation/xmldoc/firststeps.html

    r346 r354  
    4141       
    4242      <p> 
    43 Each IDL session using <span class="application">SAXO</span> must always start with: <code class="prompt">idl&gt;</code> <strong class="userinput"><code><span><strong class="command">@init</strong></span></code></strong>. 
     43Each IDL session using <span class="application">SAXO</span> must always start with: 
     44</p><pre class="screen"> 
     45 <code class="prompt">idl&gt;</code> <strong class="userinput"><code><span><strong class="command">@init</strong></span></code></strong> 
     46</pre><p> 
    4447      </p> 
    4548      <p> 
    4649<span class="emphasis"><em>The @ is equivalent to an include. It is used to execute a set of IDL commands that will be directly executed without any compilation (as it is the case for a procedure or a function). All variables defined and used in the @
 file will still be accessible after the execution of the @
 is finished (which is not the case for procedures and functions that ends with the return instruction).</em></span> 
     50</p> 
     51<p> 
    4752</p><pre class="screen"> 
    4853  <code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">cd</strong></span> <code class="filename">${HOME}/My_IDL/</code></code></strong> 
    … …  
    6873  <code class="prompt">idl&gt;</code> 
    6974</pre><p> 
    70 As an IDL session using <span class="application">SAXO</span> must always start with <code class="prompt">idl&gt;</code> <strong class="userinput"><code><span><strong class="command">@init</strong></span></code></strong>, it could be convenient to define the environment variable <code class="envar">IDL_STARTUP</code> to <code class="filename">${HOME}/My_IDL/init.pro</code>. In that way, <code class="filename">init.pro</code> will automatically been executed when starting IDL. This can be done with the following command: 
     75</p> 
     76<p> 
     77As an IDL session using <span class="application">SAXO</span> must always start with : 
     78</p><pre class="screen"> 
     79 <code class="prompt">idl&gt;</code> <strong class="userinput"><code><span><strong class="command">@init</strong></span></code></strong> 
     80</pre><p> 
     81, it could be convenient to define the environment variable <code class="envar">IDL_STARTUP</code> to <code class="filename">${HOME}/My_IDL/init.pro</code>. In that way, <code class="filename">init.pro</code> will automatically been executed when starting IDL. This can be done with the following command: 
    7182      </p><div class="variablelist"><dl><dt><span class="term"><span><strong class="command">csh</strong></span></span></dt><dd><pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">setenv</strong></span> <code class="envar">IDL_STARTUP</code> <code class="filename">${HOME}/My_IDL/init.pro</code></code></strong></pre></dd><dt><span class="term"><span><strong class="command">ksh</strong></span></span></dt><dd><pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">export</strong></span> <code class="envar">IDL_STARTUP</code>=<code class="filename">${HOME}/My_IDL/init.pro</code></code></strong></pre></dd></dl></div><p> 
    7283      </p> 
    … …  
    8596   <code class="prompt">idl&gt;</code> <strong class="userinput"><code><span><strong class="command">plot, y</strong></span></code></strong> <a href="./figpng/basic_plot.png" target="_top"><span class="inlinemediaobject"><img src="images/showfig.png" alt="show result" /></span></a> 
    8697</pre> 
    87           <div class="calloutlist"><table border="0" summary="Callout list"><tr><td width="5%" valign="top" align="left"><img src="images/callouts/1.png" alt="1" border="0" /></td><td valign="top" align="left"> 
    88       <p> 
    89 <span><strong class="command">findgen</strong></span> stands for 
    90 <span class="bold"><strong>f</strong></span>loat <span class="bold"><strong>ind</strong></span>ex <span class="bold"><strong>gen</strong></span>erator. 
     98   <div class="calloutlist"><table border="0" summary="Callout list"><tr><td width="5%" valign="top" align="left"><img src="images/callouts/1.png" alt="1" border="0" /></td><td valign="top" align="left"> 
     99      <p> 
     100<span><strong class="command">findgen</strong></span> stands for <span class="bold"><strong>f</strong></span>loat <span class="bold"><strong>ind</strong></span>ex <span class="bold"><strong>gen</strong></span>erator. 
    91101</p><pre class="screen"> 
    92102  <code class="prompt">idl&gt;</code> <strong class="userinput"><code><span><strong class="command">print, findgen(6)</strong></span></code></strong> 
    … …  
    164174</pre><p> 
    165175      </p> 
    166       <p><a name="splot_description" id="splot_description"></a> 
     176<p><a name="splot_description" id="splot_description"></a> 
    167177<span><strong class="command">splot</strong></span> accepts the same keywords as <span><strong class="command">plot</strong></span> (<code class="computeroutput"><a name="plot_kwd" id="plot_kwd"></a>/ISOTROPIC, MAX_VALUE=value, MIN_VALUE=value, NSUM=value, /POLAR, THICK=value, /XLOG, /YLOG, /YNOZERO</code>), including the graphics keywords (<code class="computeroutput"><a name="gr_kwd" id="gr_kwd"></a>BACKGROUND, CHARSIZE, CHARTHICK, CLIP, COLOR, DATA, DEVICE, FONT, LINESTYLE, NOCLIP, NODATA, NOERASE, NORMAL, POSITION, PSYM, SUBTITLE, SYMSIZE, T3D, THICK, TICKLEN, TITLE, [XYZ]CHARSIZE, [XYZ]GRIDSTYLE, [XYZ]MARGIN, [XYZ]MINOR, [XYZ]RANGE, [XYZ]STYLE, [XYZ]THICK, [XYZ]TICKFORMAT, [XYZ]TICKINTERVAL, [XYZ]TICKLAYOUT, [XYZ]TICKLEN, [XYZ]TICKNAME, [XYZ]TICKS, [XYZ]TICKUNITS, [XYZ]TICKV, [XYZ]TICK_GET, [XYZ]TITLE, ZVALUE</code>). 
    168       </p> 
    169       <p> 
     178</p> 
     179<p> 
    170180It can therefore be customized <span class="emphasis"><em>as much as you want</em></span>. See this short example: 
    171       </p> 
    172       <p> 
     181</p> 
     182<p> 
    173183</p><pre class="screen"> 
    174184  <code class="prompt">idl&gt;</code> <strong class="userinput"><code><span><strong class="command">splot, y, y^2, linestyle = 2, thick = 2, title = 'y = x^2', /portrait</strong></span></code></strong> <a href="./figpng/basic_splot2.png" target="_top"><span class="inlinemediaobject"><img src="images/showfig.png" alt="show result" /></span></a> 
    … …  
    203213       
    204214      <p> 
    205 Following <span><strong class="command"><a href="#basic_splot" title="2.2.1.  splot">splot</a></strong></span> example, we provide <span><strong class="command">scontour</strong></span> as a "super <span><strong class="command">contour</strong></span>". 
     215Following <span><strong class="command"><a href="#basic_splot" title="2.2.1.  splot">splot</a></strong></span> example, we provide <span><strong class="command">scontour</strong></span> as a “<span class="quote">super <span><strong class="command">contour</strong></span></span>”. 
    206216</p><pre class="screen"> 
    207217  <code class="prompt">idl&gt;</code> <strong class="userinput"><code><span><strong class="command">z = dist(n)</strong></span></code></strong> 
    … …  
    247257      </div> 
    248258 
    249       <div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="tvplus" id="tvplus"></a>2.2.3.  Quick look and explore 2D arrays: tvplus </h4></div></div></div> 
     259      <div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="tvplus" id="tvplus"></a>2.2.3.  Quick look and explore 2D arrays: <span><strong class="command">tvplus</strong></span> </h4></div></div></div> 
    250260 
    251261<p> 
    252262  <span><strong class="command">tvplus</strong></span> is a enhanced version of <span><strong class="command">tvscl</strong></span> and allow you to have a quick look and perform basic exploration of 2D arrays. 
    253   </p><pre class="screen"> 
    254   <code class="prompt">idl&gt;</code> <strong class="userinput"><code><span><strong class="command">tvplus, dist(20)</strong></span></code></strong> <a href="./figpng/tvplus.png" target="_top"><span class="inlinemediaobject"><img src="images/showfig.png" alt="show result" /></span></a> 
    255   <code class="computeroutput">left button  : mouse position and associated array value</code> 
    256   <code class="computeroutput">middle button: use it twice to define a zoom box</code> 
    257   <code class="computeroutput">right button : quit</code> 
    258   <code class="computeroutput">(x, y) = (  5,   5), value = 7.07107</code> 
    259   <code class="computeroutput">(x, y) = ( 12,   8), value = 11.3137</code> 
    260   </pre><p> 
    261   For more informations on <span><strong class="command">tvplus</strong></span>, try: 
    262   </p><pre class="screen"> 
    263   <code class="prompt">idl&gt;</code> <strong class="userinput"><code><span><strong class="command">xhelp, 'tvplus'</strong></span></code></strong> 
    264   </pre><p> 
    265   To see the source code of <span><strong class="command">tvplus</strong></span>, try: 
    266   </p><pre class="screen"> 
    267   <code class="prompt">idl&gt;</code> <strong class="userinput"><code><span><strong class="command">xfile, 'tvplus'</strong></span></code></strong> 
    268   </pre><p> 
    269   </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">New Feature</h3><p> 
    270   If you use an IDL 6.2 or later revision, you can simply get the help of any command by typing ?<em class="replaceable"><code>command_name</code></em>, for example: 
    271   </p><pre class="screen"> 
    272   <code class="prompt">idl&gt;</code> <strong class="userinput"><code><span><strong class="command">?tvplus</strong></span></code></strong> 
    273   </pre><p> 
    274   </p></div><p> 
    275 </p> 
    276       </div> 
     263</p><pre class="screen"> 
     264 <code class="prompt">idl&gt;</code> <strong class="userinput"><code><span><strong class="command">tvplus, dist(20)</strong></span></code></strong> <a href="./figpng/tvplus.png" target="_top"><span class="inlinemediaobject"><img src="images/showfig.png" alt="show result" /></span></a> 
     265 <code class="computeroutput">left button  : mouse position and associated array value</code> 
     266 <code class="computeroutput">middle button: use it twice to define a zoom box</code> 
     267 <code class="computeroutput">right button : quit</code> 
     268 <code class="computeroutput">(x, y) = (  5,   5), value = 7.07107</code> 
     269 <code class="computeroutput">(x, y) = ( 12,   8), value = 11.3137</code> 
     270 </pre><p> 
     271</p> 
     272<p> 
     273For more informations on <span><strong class="command">tvplus</strong></span>, try: 
     274</p><pre class="screen"> 
     275 <code class="prompt">idl&gt;</code> <strong class="userinput"><code><span><strong class="command">xhelp, 'tvplus'</strong></span></code></strong> 
     276</pre><p> 
     277</p> 
     278<p> 
     279To see the source code of <span><strong class="command">tvplus</strong></span>, try: 
     280</p><pre class="screen"> 
     281 <code class="prompt">idl&gt;</code> <strong class="userinput"><code><span><strong class="command">xfile, 'tvplus'</strong></span></code></strong> 
     282</pre><p> 
     283</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">New Feature</h3> 
     284<p> 
     285If you use an IDL 6.2 or later revision, you can simply get the help of any command by typing ?<em class="replaceable"><code>command_name</code></em>, for example: 
     286</p><pre class="screen"> 
     287 <code class="prompt">idl&gt;</code> <strong class="userinput"><code><span><strong class="command">?tvplus</strong></span></code></strong> 
     288</pre><p> 
     289</p> 
     290</div><p> 
     291</p> 
     292</div> 
    277293 
    278294      <div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="pltv" id="pltv"></a>2.2.4.  Formal quick look at 2D arrays: pltv </h4></div></div></div> 
    … …  
    374390    </div> 
    375391 
    376     <div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="pltz" id="pltz"></a>3.3.  Vertical sections </h3></div></div></div> 
    377        
     392<div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="pltz" id="pltz"></a>3.3.  Vertical sections </h3></div></div></div> 
     393 
    378394<p> 
    379395  A quick presentation of vertical sections is shown in <a href="../../Tests/tst_pltz.pro" target="_top">tst_pltz</a>. After loading any of the grid (for example with one of the <a href="#load_grid" title="3.1.  Load the data grid">above examples</a>). Just try: 
    … …  
    404420    </div> 
    405421 
    406     <div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="plt1d" id="plt1d"></a>3.5.  1D plots </h3></div></div></div> 
    407        
    408         <p> 
    409   To be continued 
 
    410 </p> 
    411    </div> 
    412  
    413  
    414   </div> 
     422<div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="plt1d" id="plt1d"></a>3.5.  1D plots </h3></div></div></div> 
     423 
     424<p> 
     425To be continued 
 
     426</p> 
     427</div> 
     428 
     429 
     430</div> 
    415431 
    416432</div> 
Note: See TracChangeset for help on using the changeset viewer.