Changeset 1088

Show
Ignore:
Timestamp:
07/01/08 14:20:50 (2 months ago)
Author:
fcady
Message:

improvements to the html documentation

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/pyhdf/doc/pyhdf.SD.html

    r1082 r1088  
    1010><td align=right valign=bottom 
    1111><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/lib/python2.4/site-packages/pyhdf/SD.py">/usr/lib/python2.4/site-packages/pyhdf/SD.py</a></font></td></tr></table> 
    12     <p><tt>A&nbsp;module&nbsp;of&nbsp;the&nbsp;pyhdf&nbsp;package&nbsp;implementing&nbsp;the&nbsp;<a href="#SD">SD</a>&nbsp;(scientific<br> 
    13 dataset)&nbsp;API&nbsp;of&nbsp;the&nbsp;NCSA&nbsp;HDF4&nbsp;library.<br> 
     12    <p><tt>A module of the pyhdf package implementing the <a href="#SD">SD</a> (scientific<br> 
     13dataset) API of the NCSA HDF4 library.<br> 
    1414(see:&nbsp;hdf.ncsa.uiuc.edu)<br> 
    1515&nbsp;<br> 
    16 Author:&nbsp;Andre&nbsp;Gosselin<br> 
    17 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Maurice&nbsp;Lamontagne&nbsp;Institute<br> 
     16Author: Andre Gosselin<br> 
     17&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Maurice Lamontagne Institute<br> 
    1818&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Andre.Gosselin@dfo-mpo.gc.ca<br> 
    19 &nbsp;<br> 
    20 Maintainer:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Enthough,&nbsp;Inc.<br> 
    21 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Austin,&nbsp;TX<br> 
     19 <br> 
     20Maintainer:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Enthough, Inc.<br> 
     21&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Austin, TX<br> 
    2222&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;enthought-dev@mail.enthought.com<br> 
    2323&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br> 

  • trunk/pyhdf/doc/pyhdf.odl_parser.html

    r1087 r1088  
    1616<!-- AUTHOR INFORMATION --> 
    1717Maintainer:&nbsp;Enthought, Inc.<br> 
    18 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Asutin, TX<br> 
     18&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Austin, TX<br> 
    1919&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;enthought-dev@mail.enthought.com<br> 
    2020&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br> 
    2121Version:&nbsp;0.8<br> 
    22 Date:&nbsp;&nbsp;&nbsp;&nbsp;July&nbsp;1&nbsp;2008<br> 
     22Date:&nbsp;&nbsp;&nbsp;&nbsp;July 1 2008<br> 
    2323&nbsp;<br>  
    2424 
    …… 
    2727------------<br> 
    2828A large amount of HDF data is stored in ODL (Object Description Language).  For this reason, pyhdf includes a simple parser in the pyhdf.odl_parser module. 
     29 
     30The main function in pyhdf.odl_parser is parse_odl.  parse_odl is passed ODL text as a string, and returns a dictionary-of-dictionaries, where the keys are either group names or object names.  The value of an object name is a dictionary containing its attributes.  The value of a group name is a dictionary containing its objects or subgroups. 
     31 
     32Note that the parser is not perfect; while it supports all commonly-used aspects of the ODL language, more esoteric aspects (such as arbitrary bases) are not supported.  Also, a BEGIN_GROUP can be closed by an END_OBJECT, and vice versa. 

  • trunk/pyhdf/examples/odl_parsing/README_odl.txt

    r1078 r1088  
    11This example demonstrates the use of the ODL (Object Description Language) parser module in pyhdf.  The sample file provided comes from the ASTER satellite instrument (see the aster example's README for more information).  It returns a dictionary-of-dictionaries, where the keys are either group names or object names.  The value of an object name is a dictionary containing its attributes.  The value of a group name is a dictionary containing its objects or subgroups. 
    22 
    3 Note that the parser in pyhdf is not perfect; while it supports all commonly-used aspects of the ODL language, mor esoteric aspects (such as arbitrary bases) are not supported.  Also, a BEGIN_GROUP can be closed by an END_OBJECT, and vice versa. 
     3Note that the parser in pyhdf is not perfect; while it supports all commonly-used aspects of the ODL language, more esoteric aspects (such as arbitrary bases) are not supported.  Also, a BEGIN_GROUP can be closed by an END_OBJECT, and vice versa. 
    44 
    55TODO: update parser to support full specifications of ODL language.