root/MGET/Branches/Jason/PythonPackage/dist/TracOnlineDocumentation/Documentation/ArcGISReference/SIRFile.ExtractHeaderArcGISTable.html @ 842

Revision 842, 8.5 KB (checked in by jjr8, 19 months ago)

Rebuilt installation packages again. This will be merged with the Trunk and released as MGET 0.8a28.
Line 
1<?xml version="1.0" encoding="utf-8"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml"><head><link rel="stylesheet" type="text/css" href="81help.css?format=raw" /><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Extract Headers of SIR Files Listed in Table</title></head><body><table style="margin-top:-1em; margin-bottom:0; padding:0; margin-left:-1em"><tr><td style="background:white"><img width="875" height="70" alt="ArcToolbox banner" src="AHBanner_ArcToolbox.gif?format=raw" /></td></tr></table><h1>Extract Headers of SIR Files Listed in Table</h1><p></p><p>Extracts the headers of SIR files in a table and saves them to text files.</p><br /><p><h2><img width="11" height="11" border="0" src="sm_arrow_down.gif?format=raw" /> Command line syntax</h2></p><div Class="expand" id="id103139">SIRFileExtractHeaderArcGISTable_GeoEco &lt;table&gt; &lt;sirFileField&gt; &lt;outputFileField&gt; {where} {orderBy;orderBy...} {directions;directions...} {skipExisting} {basePath} <br /><br /><b>Parameters</b><br /><table width="100%" border="0" cellpadding="5"><tbody><tr><th width="40%"><b>Expression</b></th><th width="60%"><b>Explanation</b></th></tr><tr><td class="info">&lt;table&gt;</td><td class="info" align="left"><p>Table to query.</p></td></tr><tr><td class="info">&lt;sirFileField&gt;</td><td class="info" align="left"><p>Field containing the paths of SIR files.</p><p>The SIR format was designed by the Brigham Young University MERS lab.
4MERS publishes various products derived from scatterometers bourne by
5satellites such as QuikSCAT. These products include sea surface wind
6vectors, sea ice masks, and raw scatterometer sigma-0 values, which
7correlate with the roughness of the ocean surface.</p><p>Compressed files in a supported compression format will be
8automatically decompressed. Archives (e.g. .zip or .tar) must contain
9exactly one file, which must not be in a subdirectory.</p></td></tr><tr><td class="info">&lt;outputFileField&gt;</td><td class="info" align="left"><p>Field containing the paths of the text files to create.</p></td></tr><tr><td class="info">{where}</td><td class="info" align="left"><p>SQL WHERE clause expression that specifies the subset of rows to
10process. If this parameter is not provided, all of the rows will be
11processed. If this parameter is provided but the underlying database
12does not support WHERE clauses, an error will be raised.</p><p>The exact syntax of this expression depends on the underlying
13database. ESRI recommends you reference fields using the following
14syntax:</p><ul><li><p>If you're querying ArcInfo coverages, shapefiles, INFO tables or
15dBASE tables (.dbf files), enclose field names in double quotes in
16the SQL expression: "MY_FIELD".</p></li></ul><ul><li><p>If you're querying Microsoft Access tables or personal
17geodatabase tables, enclose field names in square brackets:
18[MY_FIELD].</p></li></ul><ul><li><p>If you're querying ArcSDE geodatabase tables, an ArcIMS feature
19class, or an ArcIMS image service sublayer, don't enclose field
20names: MY_FIELD.</p></li></ul></td></tr><tr><td class="info">{orderBy;orderBy...}</td><td class="info" align="left"><p>Fields that will be used to sort the rows (i.e., the columns
21specified in the ORDER BY clause of a SQL SELECT statement). If no
22fields are provided, the rows will be sorted in the default order
23determined by the underlying database. If this parameter is provided
24but this computer is not running ArcGIS 9.2 or later or the underlying
25database does not support ORDER BY clauses, an error will be raised.</p><p>In addition to specifying the ORDER BY fields, you must also specify
26the sort direction for each field.</p></td></tr><tr><td class="info">{directions;directions...}</td><td class="info" align="left"><p>List of strings, either 'Ascending' or 'Descending', that specify
27the sort directions for the ORDER BY fields. If this parameter is
28provided but this computer is not running ArcGIS 9.2 or later or the
29underlying database does not support ORDER BY clauses, an error will
30be raised.</p></td></tr><tr><td class="info">{skipExisting}</td><td class="info" align="left"><p>If True, processing will be skipped for text files that already exist.</p></td></tr><tr><td class="info">{basePath}</td><td class="info" align="left"><p>Base path to prepend to relative paths.</p><p>If a base path is provided, it will be prepended to any relative paths
31that are obtained from the fields that list the inputs (and outputs,
32if this tool has outputs). If a base path is not provided, the
33workspace containing the table will be prepended instead.</p></td></tr></tbody></table></div><p><h2><img width="11" height="11" border="0" src="sm_arrow_down.gif?format=raw" /> Scripting syntax</h2></p><div Class="expand" id="TEST">SIRFileExtractHeaderArcGISTable_GeoEco (table, sirFileField, outputFileField, where, orderBy, directions, skipExisting, basePath) <br /><br /><b>Parameters</b><br /><table width="100%" border="0" cellpadding="5"><tbody><tr><th width="40%"><b>Expression</b></th><th width="60%"><b>Explanation</b></th></tr><tr><td class="info">Table (Required) </td><td class="info" align="left"><p>Table to query.</p></td></tr><tr><td class="info">SIR file field (Required) </td><td class="info" align="left"><p>Field containing the paths of SIR files.</p><p>The SIR format was designed by the Brigham Young University MERS lab.
34MERS publishes various products derived from scatterometers bourne by
35satellites such as QuikSCAT. These products include sea surface wind
36vectors, sea ice masks, and raw scatterometer sigma-0 values, which
37correlate with the roughness of the ocean surface.</p><p>Compressed files in a supported compression format will be
38automatically decompressed. Archives (e.g. .zip or .tar) must contain
39exactly one file, which must not be in a subdirectory.</p></td></tr><tr><td class="info">Output text file field (Required) </td><td class="info" align="left"><p>Field containing the paths of the text files to create.</p></td></tr><tr><td class="info">Where clause (Optional) </td><td class="info" align="left"><p>SQL WHERE clause expression that specifies the subset of rows to
40process. If this parameter is not provided, all of the rows will be
41processed. If this parameter is provided but the underlying database
42does not support WHERE clauses, an error will be raised.</p><p>The exact syntax of this expression depends on the underlying
43database. ESRI recommends you reference fields using the following
44syntax:</p><ul><li><p>If you're querying ArcInfo coverages, shapefiles, INFO tables or
45dBASE tables (.dbf files), enclose field names in double quotes in
46the SQL expression: "MY_FIELD".</p></li></ul><ul><li><p>If you're querying Microsoft Access tables or personal
47geodatabase tables, enclose field names in square brackets:
48[MY_FIELD].</p></li></ul><ul><li><p>If you're querying ArcSDE geodatabase tables, an ArcIMS feature
49class, or an ArcIMS image service sublayer, don't enclose field
50names: MY_FIELD.</p></li></ul></td></tr><tr><td class="info">Order By fields (Optional) </td><td class="info" align="left"><p>Fields that will be used to sort the rows (i.e., the columns
51specified in the ORDER BY clause of a SQL SELECT statement). If no
52fields are provided, the rows will be sorted in the default order
53determined by the underlying database. If this parameter is provided
54but this computer is not running ArcGIS 9.2 or later or the underlying
55database does not support ORDER BY clauses, an error will be raised.</p><p>In addition to specifying the ORDER BY fields, you must also specify
56the sort direction for each field.</p></td></tr><tr><td class="info">Order By directions (Optional) </td><td class="info" align="left"><p>List of strings, either 'Ascending' or 'Descending', that specify
57the sort directions for the ORDER BY fields. If this parameter is
58provided but this computer is not running ArcGIS 9.2 or later or the
59underlying database does not support ORDER BY clauses, an error will
60be raised.</p></td></tr><tr><td class="info">Skip existing outputs (Optional) </td><td class="info" align="left"><p>If True, processing will be skipped for text files that already exist.</p></td></tr><tr><td class="info">Base path (Optional) </td><td class="info" align="left"><p>Base path to prepend to relative paths.</p><p>If a base path is provided, it will be prepended to any relative paths
61that are obtained from the fields that list the inputs (and outputs,
62if this tool has outputs). If a base path is not provided, the
63workspace containing the table will be prepended instead.</p></td></tr></tbody></table></div></body></html>
Note: See TracBrowser for help on using the browser.