root/MGET/Branches/Jason/PythonPackage/dist/TracOnlineDocumentation/Documentation/PythonReference/Method_GeoEco.DataManagement.NetCDFs.NetCDF.ExtractHeaderTable.html @ 307

Revision 307, 14.1 KB (checked in by jjr8, 5 years ago)

Rebuilt MGET 0.6b1 with no changes as 0.6. This will be merged into the Trunk and released as the final build of MGET 0.6.
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><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>ExtractHeaderTable Method</title><link rel="stylesheet" type="text/css" href="lib.css?format=raw" /><style xml:space="preserve">
4            td.metadataTitle { font-size: 80%; font-weight: bold; font-family: avantgarde, sans-serif; }
5            td.metadataValue { padding-left: 0.5em; }
6          </style></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="ExtractHeaderList Method" href="Method_GeoEco.DataManagement.NetCDFs.NetCDF.ExtractHeaderList.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="NetCDF Class" href="Class_GeoEco.DataManagement.NetCDFs.NetCDF.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="FindAndExtractHeaders Method" href="Method_GeoEco.DataManagement.NetCDFs.NetCDF.FindAndExtractHeaders.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DataManagement.NetCDFs.NetCDF.ExtractHeaderList.html?format=raw">ExtractHeaderList Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DataManagement.NetCDFs.NetCDF.html?format=raw">NetCDF Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DataManagement.NetCDFs.NetCDF.FindAndExtractHeaders.html?format=raw">FindAndExtractHeaders Method</a> </div><hr /></div></div><h1><tt class="member">ExtractHeaderTable</tt> Method</h1><p>Extracts the headers of netCDF files in a table and saves them to text files.</p><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td class="metadataTitle">Class:</td><td class="metadataValue"><tt class="class"><a href="Class_GeoEco.DataManagement.NetCDFs.NetCDF.html?format=raw">NetCDF</a></tt></td></tr><tr valign="baseline"><td class="metadataTitle">Intended use:</td><td class="metadataValue">Recommended for external callers</td></tr><tr valign="baseline"><td class="metadataTitle">COM:</td><td class="metadataValue">Not exposed by a COM class</td></tr><tr valign="baseline"><td class="metadataTitle">ArcGIS:</td><td class="metadataValue">Not exposed as an ArcGIS geoprocessing tool</td></tr><tr valign="baseline"><td class="metadataTitle">Method type:</td><td class="metadataValue">Classmethod</td></tr></table><h3>Usage</h3><table cellpadding="0" cellspacing="0"><tr valign="baseline"><td style="white-space: nowrap;"><b><tt class="method">NetCDF.ExtractHeaderTable</tt></b>(</td><td><var>connection</var><var>, table</var><var>, inputFileField</var><var>, outputFileField</var><big>[</big><var>, where</var><big>[</big><var>, orderBy</var><big>[</big><var>, directions</var><big>[</big><var>, skipExisting</var><big>[</big><var>, overwriteExisting</var><big>[</big><var>, basePath</var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table><h3>Arguments</h3><dl><dt><var>connection</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">GeoEco.DatabaseAccess.DatabaseConnection</tt></td></tr></table><p>Connection opened to the database that contains the table.</p></dd></dl><dl><dt><var>table</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr></table><p>Name of the table to query.</p></dd></dl><dl><dt><var>inputFileField</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr></table><p>Field containing the paths of the input netCDF files.</p><p>At the time this class was developed, two major versions of netCDF
7were under development: NetCDF-3, which was at release 3.6.2, and
8NetCDF-4, which was at release 4.0 beta 1. The current implementation
9of this class can process NetCDF-3 files but not NetCDF-4 files.
10NetCDF-4 support will be added in the near future.</p><p>For more information on netCDF, please see
11<a href="http://www.unidata.ucar.edu/software/netcdf/">http://www.unidata.ucar.edu/software/netcdf/</a></p><p>If you provide compressed files in a supported compression format,
12they will be automatically decompressed. If files are compressed in an
13archive format (e.g. .zip or .tar), each archive must contain exactly
14one file, which must not be in a subdirectory.</p></dd></dl><dl><dt><var>outputFileField</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr></table><p>Field containing the paths of the text files to create.</p></dd></dl><dl><dt><var>where</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt> or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr></table><p>SQL WHERE clause expression that specifies the subset of rows to
15process. If this parameter is not provided, all of the rows will be
16processed. If this parameter is provided but the underlying database
17does not support WHERE clauses, an error will be raised.</p><p>The exact syntax of this expression depends on the underlying database
18and the type of connection used to access it. If you are using the
19ArcGIS geoprocessor to access the database, ESRI recommends you
20reference fields using the following syntax:</p><ul><li>If you're querying ArcInfo coverages, shapefiles, INFO tables or
21dBASE tables (.dbf files), enclose field names in double quotes in
22the SQL expression: "MY_FIELD".</li><li>If you're querying Microsoft Access tables or personal
23geodatabase tables, enclose field names in square brackets:
24[MY_FIELD].</li><li>If you're querying ArcSDE geodatabase tables, an ArcIMS feature
25class, or an ArcIMS image service sublayer, don't enclose field
26names: MY_FIELD.</li></ul></dd></dl><dl><dt><var>orderBy</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">list</tt> of <tt class="class">unicode</tt>, or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">0</td></tr></table><p>Fields that will be used to sort the rows (i.e., the columns
27specified in the ORDER BY clause of a SQL SELECT statement). If no
28fields are provided, the rows will be sorted in the default order
29determined by the underlying database. If this parameter is provided
30but the underlying database does not support ORDER BY clauses, an
31error will be raised.</p><p>In addition to specifying the ORDER BY fields, you must also specify
32the sort direction for each field.</p></dd></dl><dl><dt><var>directions</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">list</tt> of <tt class="class">unicode</tt>, or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">0</td></tr></table><p>List of strings, either 'Ascending' or 'Descending', that specify
33the sort directions for the ORDER BY fields. If this parameter is
34provided but the underlying database does not support ORDER BY
35clauses, an error will be raised.</p></dd></dl><dl><dt><var>skipExisting</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>False</code></td></tr></table><p>If True, processing will be skipped for text files that already exist.</p></dd></dl><dl><dt><var>overwriteExisting</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">bool</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><code>False</code></td></tr></table><p>If True and skipExisting is False, existing text files will be overwritten.</p></dd></dl><dl><dt><var>basePath</var></dt><dd><table cellpadding="0" cellspacing="0" style="margin-top: 1.0em;"><tr valign="baseline"><td class="metadataTitle">Python type:</td><td class="metadataValue"><tt class="class">unicode</tt> or <tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Default value:</td><td class="metadataValue"><tt class="class">None</tt></td></tr><tr valign="baseline"><td class="metadataTitle">Minimum length:</td><td class="metadataValue">1</td></tr><tr valign="baseline"><td class="metadataTitle">Maximum length:</td><td class="metadataValue">255</td></tr><tr valign="baseline"><td class="metadataTitle">Must exist:</td><td class="metadataValue">No</td></tr></table><p>Base path to prepend to relative paths.</p><p>If any of the input paths (or output paths, if this method has
36outputs) obtained from the table are relative paths, they will be
37converted to absolute paths prior to processing, as follows:</p><ul><li>If a base path is provided, it will be prepended to the relative
38path.</li><li>Otherwise, if the ArcGIS geoprocessor has been initialized and the
39geoprocessing workspace has been set (i.e. the Workspace property of
40the geoprocessor is not empty), it will be prepended to the relative
41path.</li><li>Otherwise, the current working directory for the executing process
42will be prepended to the path. If you have not explicitly changed
43the working directory, it is usually the directory that contains the
44Python interpreter (e.g., on Windows computers, it would be
45C:\Python24, if you're running Python 2.4).</li></ul></dd></dl><div class="navigation"><div class="online-navigation"><p></p><hr /><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="ExtractHeaderList Method" href="Method_GeoEco.DataManagement.NetCDFs.NetCDF.ExtractHeaderList.html?format=raw"><img src="previous.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Previous Page" /></a></td><td class="online-navigation"><a title="NetCDF Class" href="Class_GeoEco.DataManagement.NetCDFs.NetCDF.html?format=raw"><img src="up.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Up one Level" /></a></td><td class="online-navigation"><a title="FindAndExtractHeaders Method" href="Method_GeoEco.DataManagement.NetCDFs.NetCDF.FindAndExtractHeaders.html?format=raw"><img src="next.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Next Page" /></a></td><td align="center" width="100%">GeoEco Python Reference</td><td class="online-navigation"><a title="Table of Contents" href="TableOfContents.html?format=raw"><img src="contents.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Table of Contents" /></a></td><td class="online-navigation"><a title="Module Index" href="ModuleIndex.html?format=raw"><img src="modules.png?format=raw" border="0" align="bottom" height="32" width="32" alt="Module Index" /></a></td><td class="online-navigation"><img src="blank.png?format=raw" border="0" align="bottom" height="32" width="32" alt="" /></td></tr></table><div class="online-navigation"><b class="navlabel">Previous:</b> <a class="sectref" href="Method_GeoEco.DataManagement.NetCDFs.NetCDF.ExtractHeaderList.html?format=raw">ExtractHeaderList Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DataManagement.NetCDFs.NetCDF.html?format=raw">NetCDF Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DataManagement.NetCDFs.NetCDF.FindAndExtractHeaders.html?format=raw">FindAndExtractHeaders Method</a> </div><hr /><span class="release-info">Marine Geospatial Ecology Tools version 0.6</span></div></div></body></html>
Note: See TracBrowser for help on using the browser.