ftools_usage.html 3.18 KB
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html lang="en"><head>
<meta content="text/html; charset=ISO-8859-1" http-equiv="content-type"><title>Basic FTOOL Parameter Usage</title>

<link rel="stylesheet" type="text/css" media="screen,print" href="ctools.css">
<meta content="Jurgen Knodlseder" name="author">
<meta content="Basic FTOOL Parameter Usage" name="description">
</head>
<body>
<p class="Header">Basic FTOOL Parameter Usage</p>
<br>
<p class="Title">Automatic Parameters:</p>
<table class="Body" border="0" cellpadding="0" cellspacing="0" width="600">
<tbody>
<tr>
<td width="50">&nbsp;</td>
<td colspan="2"><span class="irafpar"><strong>par_name
[ = value ]
&lt;valid values&gt; type</strong></span></td>
</tr>
<tr>
<td width="50">&nbsp;</td>
<td width="25">&nbsp;</td>
<td width="525">Where <code>par_name</code>
is the name of the parameter, <code>value</code> is the
default value,
<code>valid values</code> are valid parameter values,
separated by <code>|</code> characters,
and <code>type</code> is the type of the parameter. The
type is enclosed in square
brackets. </td>
</tr>
</tbody>
</table>
<br>
<p class="Title">Hidden Parameters:</p>
<table class="Body" border="0" cellpadding="0" cellspacing="0" width="600">
<tbody>
<tr>
<td width="50">&nbsp;</td>
<td colspan="2"><span class="irafpar"><strong>(par_name
= value ) type</strong></span></td>
</tr>
<tr>
<td width="50">&nbsp;</td>
<td width="25">&nbsp;</td>
<td width="525">Where <code>par_name</code>
is the name of the parameter, <code>value</code> is the
default value,
and <code>type</code> is the type of the parameter. The
type is enclosed in square
brackets. </td>
</tr>
</tbody>
</table>
<br>
<p class="Title">Examples:</p>
<table class="Body" border="0" cellpadding="0" cellspacing="0" width="600">
<tbody>
<tr>
<td>&nbsp;</td>
<td colspan="2"><span class="irafpar"><strong>infile
[file]</strong></span></td>
</tr>
<tr>
<td width="50">&nbsp;</td>
<td width="25">&nbsp;</td>
<td width="525">Describes an
automatic (queried) file-type parameter with no default value.</td>
</tr>
<tr>
<td width="50">&nbsp;</td>
<td>&nbsp;</td>
<td width="525">&nbsp;</td>
</tr>
<tr>
<td width="50">&nbsp;</td>
<td colspan="2"><span class="irafpar"><strong>irf
= kb_E_50h_v3 &lt;kb_E_50h_v3|kb_H_50h_v3&gt; [string]</strong></span></td>
</tr>
<tr>
<td width="50">&nbsp;</td>
<td>&nbsp;</td>
<td width="525">Describes an automatic (quiered)
string-type parameter with two value options.</td>
</tr>
<tr>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
</tr>
<tr>
<td width="50">&nbsp;</td>
<td colspan="2"><span class="irafpar"><strong>(plot
= yes) [bool]</strong></span></td>
</tr>
<tr>
<td width="50">&nbsp;</td>
<td>&nbsp;</td>
<td width="525">Describes a
hidden bool-type parameter named plot, whose default value is yes
(true).</td>
</tr>
<tr>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
</tr>
<tr>
<td colspan="3">
<p><strong>Note: To set hidden parameters at runtime,</strong>
specify them explicitly at the command line; for example:</p>
<blockquote>
<p class="irafpar">gtobssim start_time=900</p>
</blockquote>
</td>
</tr>
</tbody>
</table>
<br>
<hr size="1">
<p class="Body">Last updated by: J&uuml;rgen Kn&ouml;dlseder 8 March
2011
</p>
<br>
</body></html>