 |  |  | GeoEco Python Reference |  |  |  |
| | | GeoEco Python Reference | | | |
Extracts the headers of HDF files in a table and saves them to text files.
| Class: | HDF |
| Intended use: | Recommended for external callers |
| COM: | Exposed as the ExtractHeaderArcGISTable method of COM class GeoEco.HDF |
| ArcGIS: | Exposed as the Extract Headers of HDFs Listed in Table geoprocessing tool |
| Method type: | Classmethod |
| outputTable = HDF.ExtractHeaderArcGISTable( | table, inputFileField, outputFileField[, where[, orderBy[, directions[, skipExisting[, overwriteExisting[, basePath]]]]]]) |
| Python type: | unicode |
| Minimum length: | 1 |
| Maximum length: | 255 |
| Must exist: | Yes |
Table to query.
| Python type: | unicode |
| Minimum length: | 1 |
| Maximum length: | 255 |
| Must exist: | No |
Field containing the paths of the input HDF files.
At the time this tool was written, two major versions of HDF were under continuing development: HDF, which was at release 4.2r1, and HDF5, which was at release 5-1.6.5. This tool can process HDF files but not HDF5 files. It can also process HDF-EOS, a specialized version of HDF, but not HDF5-EOS.
For more information on HDF formats, please see http://www.hdfgroup.org.
If you provide compressed files in a supported compression format, they will be automatically decompressed. If files are compressed in an archive format (e.g. .zip or .tar), each archive must contain exactly one file, which must not be in a subdirectory.
| Python type: | unicode |
| Minimum length: | 1 |
| Maximum length: | 255 |
| Must exist: | No |
Field containing the paths of the text files to create.
| Python type: | unicode or None |
| Default value: | None |
| Minimum length: | 1 |
SQL WHERE clause expression that specifies the subset of rows to process. If this parameter is not provided, all of the rows will be processed. If this parameter is provided but the underlying database does not support WHERE clauses, an error will be raised.
The exact syntax of this expression depends on the underlying database. ESRI recommends you reference fields using the following syntax:
| Python type: | list of unicode, or None |
| Default value: | None |
| Minimum length: | 0 |
Fields that will be used to sort the rows (i.e., the columns specified in the ORDER BY clause of a SQL SELECT statement). If no fields are provided, the rows will be sorted in the default order determined by the underlying database. If this parameter is provided but this computer is not running ArcGIS 9.2 or later or the underlying database does not support ORDER BY clauses, an error will be raised.
In addition to specifying the ORDER BY fields, you must also specify the sort direction for each field.
| Python type: | list of unicode, or None |
| Default value: | None |
| Minimum length: | 0 |
List of strings, either 'Ascending' or 'Descending', that specify the sort directions for the ORDER BY fields. If this parameter is provided but this computer is not running ArcGIS 9.2 or later or the underlying database does not support ORDER BY clauses, an error will be raised.
| Python type: | bool |
| Default value: | False |
If True, processing will be skipped for text files that already exist.
| Python type: | bool |
| Default value: | False |
If True and skipExisting is False, existing text files will be overwritten.
| Python type: | unicode or None |
| Default value: | None |
| Minimum length: | 1 |
| Maximum length: | 255 |
| Must exist: | No |
Base path to prepend to relative paths.
If a base path is provided, it will be prepended to any relative paths that are obtained from the fields that list the inputs (and outputs, if this tool has outputs). If a base path is not provided, the workspace containing the table will be prepended instead.
| Python type: | unicode |
| Minimum length: | 1 |
| Maximum length: | 255 |
| Must exist: | No |
Processed table.
| | | GeoEco Python Reference | | | |