Show
Ignore:
Timestamp:
06/18/07 19:54:33 (6 years ago)
Author:
jjr8
Message:

* Implemented batch processing versions of most existing tools.
* Fixed several bugs in the functions that generate the batch processing versions.

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • MGET/Branches/Jason/PythonPackage/dist/TracOnlineDocumentation/Documentation/PythonReference/Method_GeoEco.DataManagement.BinaryRasters.BinaryRaster.ToArcInfoASCIIGrid.html

    r74 r85  
    44            td.metadataTitle { font-size: 80%; font-weight: bold; font-family: avantgarde, sans-serif; } 
    55            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="ToArcGISRaster Method" href="Method_GeoEco.DataManagement.BinaryRasters.BinaryRaster.ToArcGISRaster.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="BinaryRaster Class" href="Class_GeoEco.DataManagement.BinaryRasters.BinaryRaster.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="GeoEco.DataManagement.Directories Module" href="Module_GeoEco.DataManagement.Directories.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.BinaryRasters.BinaryRaster.ToArcGISRaster.html?format=raw">ToArcGISRaster Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DataManagement.BinaryRasters.BinaryRaster.html?format=raw">BinaryRaster Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Module_GeoEco.DataManagement.Directories.html?format=raw">GeoEco.DataManagement.Directories Module</a> </div><hr /></div></div><h1><tt class="member">ToArcInfoASCIIGrid</tt> Method</h1><p>Creates an ArcGIS ASCII Grid file from a 2D binary raster.</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.BinaryRasters.BinaryRaster.html?format=raw">BinaryRaster</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">Exposed as the <a style="font-family: verdana, sans serif; font-size: small;" href="../COMReference/Method_GeoEco.BinaryRaster.ToArcInfoASCIIGrid.html?format=raw">ToArcInfoASCIIGrid</a> method of COM class <a style="font-family: verdana, sans serif; font-size: small;" href="../COMReference/Class_GeoEco.BinaryRaster.html?format=raw">GeoEco.BinaryRaster</a></td></tr><tr valign="baseline"><td class="metadataTitle">ArcGIS:</td><td class="metadataValue">Exposed as the <a style="font-family: verdana, sans serif; font-size: small;" href="../ArcGISReference/BinaryRaster.ToArcInfoASCIIGrid.html?format=raw">Binary Raster to ArcInfo ASCII Grid</a> 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">BinaryRaster.ToArcInfoASCIIGrid</tt></b>(</td><td><var>inputFile</var><var>, outputFile</var><var>, dataType</var><var>, columnCount</var><var>, rowCount</var><var>, xLowerLeftCorner</var><var>, yLowerLeftCorner</var><var>, cellSize</var><big>[</big><var>, nodataValue</var><big>[</big><var>, swapBytes</var><big>[</big><var>, overwriteExisting</var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table><h3>Arguments</h3><dl><dt><var>inputFile</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><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">Yes</td></tr></table><p>Input binary raster.</p><p>The raster must have two dimensions. The cells must be ordered left-to-right, 
     6          </style></head><body><div class="navigation"><div><table align="center" width="100%" cellpadding="0" cellspacing="2"><tr><td class="online-navigation"><a title="ToArcGISRasterTable Method" href="Method_GeoEco.DataManagement.BinaryRasters.BinaryRaster.ToArcGISRasterTable.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="BinaryRaster Class" href="Class_GeoEco.DataManagement.BinaryRasters.BinaryRaster.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="ToArcInfoASCIIGridArcGISTable Method" href="Method_GeoEco.DataManagement.BinaryRasters.BinaryRaster.ToArcInfoASCIIGridArcGISTable.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.BinaryRasters.BinaryRaster.ToArcGISRasterTable.html?format=raw">ToArcGISRasterTable Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DataManagement.BinaryRasters.BinaryRaster.html?format=raw">BinaryRaster Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DataManagement.BinaryRasters.BinaryRaster.ToArcInfoASCIIGridArcGISTable.html?format=raw">ToArcInfoASCIIGridArcGISTable Method</a> </div><hr /></div></div><h1><tt class="member">ToArcInfoASCIIGrid</tt> Method</h1><p>Creates an ArcGIS ASCII Grid file from a 2D binary raster.</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.BinaryRasters.BinaryRaster.html?format=raw">BinaryRaster</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">Exposed as the <a style="font-family: verdana, sans serif; font-size: small;" href="../COMReference/Method_GeoEco.BinaryRaster.ToArcInfoASCIIGrid.html?format=raw">ToArcInfoASCIIGrid</a> method of COM class <a style="font-family: verdana, sans serif; font-size: small;" href="../COMReference/Class_GeoEco.BinaryRaster.html?format=raw">GeoEco.BinaryRaster</a></td></tr><tr valign="baseline"><td class="metadataTitle">ArcGIS:</td><td class="metadataValue">Exposed as the <a style="font-family: verdana, sans serif; font-size: small;" href="../ArcGISReference/BinaryRaster.ToArcInfoASCIIGrid.html?format=raw">Binary Raster to ArcInfo ASCII Grid</a> 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">BinaryRaster.ToArcInfoASCIIGrid</tt></b>(</td><td><var>inputFile</var><var>, outputFile</var><var>, dataType</var><var>, columnCount</var><var>, rowCount</var><var>, xLowerLeftCorner</var><var>, yLowerLeftCorner</var><var>, cellSize</var><big>[</big><var>, nodataValue</var><big>[</big><var>, swapBytes</var><big>[</big><var>, overwriteExisting</var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table><h3>Arguments</h3><dl><dt><var>inputFile</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><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">Yes</td></tr></table><p>Input binary raster.</p><p>The raster must have two dimensions. The cells must be ordered left-to-right, 
    77top-to-bottom, with columns increasing before rows. The upper-left cell is the 
    8 first cell in the file, followed by the cell its right, and so on to the end of 
     8first cell in the file, followed by the cell to its right, and so on to the end of 
    99the first row. The second row comes next, and so on to the end of the file. The 
    1010lower-right cell is the last cell in the file.</p><p>If you provide a compressed file in a supported compression format, it will 
    1111be automatically decompressed. If it is an archive (e.g. .zip or .tar), it must 
    12 contain exactly one file, which must not be in a subdirectory.</p></dd></dl><dl><dt><var>outputFile</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><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>Output ArcInfo ASCII Grid file.</p><p>It is recommended, but not required, that you give the output file a .asc 
    13 extension.</p><p>Search the internet for "ASCII grid format" for more information on the 
    14 format of the output file.</p></dd></dl><dl><dt><var>dataType</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">Allowed values:</td><td class="metadataValue"><code>u'int8'</code>, <code>u'uint8'</code>, <code>u'int16'</code>, <code>u'uint16'</code>, <code>u'int32'</code>, <code>u'uint32'</code>, <code>u'float'</code>, <code>u'double'</code></td></tr></table><p>Data type of the binary raster.</p><p>This may be one of the following values:</p><ul><li>int8 - 8-bit signed integer, range -128 to 127</li><li>uint8 - 8-bit unsigned integer, range 0 to 255</li><li>int16 - 16-bit signed integer, range -32768 to 32767</li><li>uint16 - 16-bit unsigned integer, range 0 to 65535</li><li>int32 - 32-bit signed integer, range -2147483648 to 2147483647</li><li>uint32 - 32-bit unsigned integer, range 0 to 4294967295</li><li>float - 32-bit single-precision floating point</li><li>double - 64-bit double-precision floating point</li></ul><p>The exact format, precision and range of the floating types depend on the 
     12contain exactly one file, which must not be in a subdirectory.</p></dd></dl><dl><dt><var>outputFile</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><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>Output ArcInfo ASCII Grid file.</p><p>It is recommended, but not required, that you give the output file a 
     13.asc extension. Search the Internet for "ASCII Grid format" for more 
     14information on the format of the output file.</p></dd></dl><dl><dt><var>dataType</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">Allowed values:</td><td class="metadataValue"><code>u'int8'</code>, <code>u'uint8'</code>, <code>u'int16'</code>, <code>u'uint16'</code>, <code>u'int32'</code>, <code>u'uint32'</code>, <code>u'float'</code>, <code>u'double'</code></td></tr></table><p>Data type of the binary raster.</p><p>This may be one of the following values:</p><ul><li>int8 - 8-bit signed integer, range -128 to 127</li><li>uint8 - 8-bit unsigned integer, range 0 to 255</li><li>int16 - 16-bit signed integer, range -32768 to 32767</li><li>uint16 - 16-bit unsigned integer, range 0 to 65535</li><li>int32 - 32-bit signed integer, range -2147483648 to 2147483647</li><li>uint32 - 32-bit unsigned integer, range 0 to 4294967295</li><li>float - 32-bit single-precision floating point</li><li>double - 64-bit double-precision floating point</li></ul><p>The exact format, precision and range of the floating types depend on the 
    1515processor architecture of your computer. Most processors implement the IEEE 
    1616Standard for Binary Floating-Point Arithmetic (IEEE 754).</p><p>Binary rasters that use the float or double data type must not contain 
    … …  
    5252720 columns and 360 rows, it would have a cell size of 0.5, corresponding to 
    53531/2 of a geographic degree.</p><p>The underlying data format requires the cells be square. It is not possible to 
    54 specify a cell size for each dimension.</p></dd></dl><dl><dt><var>nodataValue</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">float</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></table><p>Value that indicates a cell has no data.</p></dd></dl><dl><dt><var>swapBytes</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, the byte ordering of the input file will be reversed prior to 
    55 creating the output file.</p><p>This option is ignored if the raster data type is int8 or uint8.</p><p>This option is useful if the input file was produced on computer with a 
     54specify a cell size for each dimension.</p></dd></dl><dl><dt><var>nodataValue</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">float</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></table><p>Value that indicates a cell has no data.</p></dd></dl><dl><dt><var>swapBytes</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, the byte ordering of the input binary raster will be reversed prior 
     55to creating the output file.</p><p>This option is ignored if the raster data type is int8 or uint8.</p><p>This option is useful if the input file was produced on computer with a 
    5656processor architecture that uses a different byte ordering than your computer. 
    5757For example, if you are running on an Intel x86 processor, which uses "little 
    5858endian" byte ordering, you might use this option to process data produced by a 
    59 Sun SPARC processor, which uses "big endian" byte ordering.</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, the output file will be overwritten, if it exists.</p><p>If False, a ValueError will be raised if the output file exists.</p></dd></dl><h3>Remarks</h3><p>Search the internet for "ASCII grid format" for more information on the 
    60 format of the output file.</p><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="ToArcGISRaster Method" href="Method_GeoEco.DataManagement.BinaryRasters.BinaryRaster.ToArcGISRaster.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="BinaryRaster Class" href="Class_GeoEco.DataManagement.BinaryRasters.BinaryRaster.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="GeoEco.DataManagement.Directories Module" href="Module_GeoEco.DataManagement.Directories.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.BinaryRasters.BinaryRaster.ToArcGISRaster.html?format=raw">ToArcGISRaster Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DataManagement.BinaryRasters.BinaryRaster.html?format=raw">BinaryRaster Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Module_GeoEco.DataManagement.Directories.html?format=raw">GeoEco.DataManagement.Directories Module</a> </div></div></div></body></html> 
     59Sun SPARC processor, which uses "big endian" byte ordering.</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, the output file will be overwritten, if it exists.</p><p>If False, a ValueError will be raised if the output file exists.</p></dd></dl><h3>Remarks</h3><p>Search the internet for "ASCII Grid format" for more information on the 
     60format of the output file.</p><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="ToArcGISRasterTable Method" href="Method_GeoEco.DataManagement.BinaryRasters.BinaryRaster.ToArcGISRasterTable.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="BinaryRaster Class" href="Class_GeoEco.DataManagement.BinaryRasters.BinaryRaster.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="ToArcInfoASCIIGridArcGISTable Method" href="Method_GeoEco.DataManagement.BinaryRasters.BinaryRaster.ToArcInfoASCIIGridArcGISTable.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.BinaryRasters.BinaryRaster.ToArcGISRasterTable.html?format=raw">ToArcGISRasterTable Method</a> <b class="navlabel">Up:</b> <a class="sectref" href="Class_GeoEco.DataManagement.BinaryRasters.BinaryRaster.html?format=raw">BinaryRaster Class</a> <b class="navlabel">Next:</b> <a class="sectref" href="Method_GeoEco.DataManagement.BinaryRasters.BinaryRaster.ToArcInfoASCIIGridArcGISTable.html?format=raw">ToArcInfoASCIIGridArcGISTable Method</a> </div></div></div></body></html>