Changeset 1087

Show
Ignore:
Timestamp:
07/01/08 11:41:53 (2 months ago)
Author:
fcady
Message:

added html documentation for pyhdf.odl_parser

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • trunk/pyhdf/doc/pyhdf.HDF.html

    r1082 r1087  
    1414(see:&nbsp;hdf.ncsa.uiuc.edu)<br> 
    1515&nbsp;<br> 
     16 
     17<!-- AUTHOR INFORMATION --> 
    1618Author:&nbsp;Andre&nbsp;Gosselin<br> 
    1719&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Maurice-Lamontagne&nbsp;Institute<br> 
    1820&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;gosselina@dfo-mpo.gc.ca<br> 
    1921&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br> 
    20 Version:&nbsp;0.7-3<br> 
    21 Date:&nbsp;&nbsp;&nbsp;&nbsp;July&nbsp;13&nbsp;2005<br> 
    22 &nbsp;<br> 
     22 
     23<!-- MAINTAINER INFORMATION --> 
     24Maintainer:&nbsp;Enthought, Inc.<br> 
     25&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Asutin, TX<br> 
     26&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;enthought-dev@mail.enthought.com<br> 
     27&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br> 
     28Version:&nbsp;0.8<br> 
     29Date:&nbsp;&nbsp;&nbsp;&nbsp;July&nbsp;1&nbsp;2008<br> 
     30&nbsp;<br>  
     31 
     32<!-- INTRODUCTION --> 
    2333Introduction<br> 
    2434------------<br> 
     
    3343closing&nbsp;methods,&nbsp;whereas&nbsp;VS&nbsp;uses&nbsp;methods&nbsp;of&nbsp;the&nbsp;<a href="#HDF">HDF</a>.<a href="#HDF">HDF</a>&nbsp;class&nbsp;for&nbsp;that.<br> 
    3444&nbsp;<br> 
     45 
     46<!-- FUNCTIONS AND CLASSES SUMMARY --> 
    3547Functions&nbsp;and&nbsp;classes&nbsp;summary<br> 
    3648-----------------------------<br> 
  • trunk/pyhdf/doc/pyhdf.HDF.txt

    r1082 r1087  
    1616            gosselina@dfo-mpo.gc.ca 
    1717             
    18     Version: 0.7-3 
    19     Date:    July 13 2005 
     18    Maintainer: Enthought, Inc. 
     19                Austin, TX 
     20                enthought-dev@mail.enthought.com 
    2021     
    2122    Introduction 
  • trunk/pyhdf/doc/pyhdf.V.html

    r1082 r1087  
    1414(see:&nbsp;hdf.ncsa.uiuc.edu)<br> 
    1515&nbsp;<br> 
     16 
     17<!-- AUTHOR INFORMATION --> 
    1618Author:&nbsp;Andre&nbsp;Gosselin<br> 
    1719&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Maurice-Lamontagne&nbsp;Institute<br> 
    1820&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;gosselina@dfo-mpo.gc.ca<br> 
    1921&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br> 
    20 Version:&nbsp;0.7-3<br> 
    21 Date:&nbsp;&nbsp;&nbsp;&nbsp;july&nbsp;13&nbsp;2005<br> 
    22 &nbsp;<br> 
     22 
     23<!-- MAINTAINER INFORMATION --> 
     24Maintainer:&nbsp;Enthought, Inc.<br> 
     25&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Asutin, TX<br> 
     26&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;enthought-dev@mail.enthought.com<br> 
     27&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br> 
     28Version:&nbsp;0.8<br> 
     29Date:&nbsp;&nbsp;&nbsp;&nbsp;July&nbsp;1&nbsp;2008<br> 
     30&nbsp;<br>  
     31 
     32<!-- TABLE OF CONTENTS --> 
    2333Table&nbsp;of&nbsp;contents<br> 
    2434-----------------<br> 
     
    3848&nbsp;<br> 
    3949&nbsp;<br> 
     50 
     51<!-- INTRODUCTION --> 
    4052Introduction<br> 
    4153------------<br> 
     
    88100difficult&nbsp;to&nbsp;pick&nbsp;up&nbsp;"user&nbsp;defined"&nbsp;vgroups&nbsp;when&nbsp;browsing&nbsp;an&nbsp;HDF&nbsp;file.<br> 
    89101&nbsp;<br> 
     102 
     103<!-- ACCESSING THE MODULE --> 
    90104Accessing&nbsp;the&nbsp;<a href="#V">V</a>&nbsp;module<br> 
    91105-----------------------<br> 
     
    105119&nbsp;<br> 
    106120&nbsp;<br> 
     121 
     122<!-- PACKAGE COMPONENTS --> 
    107123Package&nbsp;components<br> 
    108124------------------<br> 
     
    132148&nbsp;<br> 
    133149&nbsp;<br> 
     150 
     151<!-- PREREQUISITES --> 
    134152Prerequisites<br> 
    135153-------------<br> 
     
    147165&nbsp;<br> 
    148166&nbsp;<br> 
     167 
     168<!-- SUMMARY OF DIFFERENCES --> 
    149169Summary&nbsp;of&nbsp;differences&nbsp;between&nbsp;the&nbsp;pyhdf&nbsp;and&nbsp;C&nbsp;<a href="#V">V</a>&nbsp;API<br> 
    150170-----------------------------------------------------<br> 
     
    161181&nbsp;&nbsp;&nbsp;&nbsp;C&nbsp;function&nbsp;argument&nbsp;list.<br> 
    162182&nbsp;&nbsp;&nbsp;<br> 
     183 
     184<!-- ERROR HANDLING --> 
    163185Error&nbsp;handling<br> 
    164186--------------<br> 
     
    192214&nbsp;<br> 
    193215&nbsp;<br> 
     216 
     217<!-- CLASSES SUMMARY --> 
    194218Classes&nbsp;summary<br> 
    195219---------------<br> 
     
    300324&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;size<br> 
    301325&nbsp;<br> 
     326 
     327<!-- ATTRIBUTE ACCESS --> 
    302328Attribute&nbsp;access:&nbsp;low&nbsp;and&nbsp;high&nbsp;level<br> 
    303329------------------------------------<br> 
     
    384410attributes&nbsp;constant.&nbsp;<br> 
    385411&nbsp;<br> 
     412 
     413<!-- PREDEFINED ATTRIBUTES --> 
    386414Predefined&nbsp;attributes<br> 
    387415---------------------<br> 
     
    407435&nbsp;<br> 
    408436&nbsp;<br> 
     437 
     438<!-- PROGRAMMING MODELS --> 
    409439Programming&nbsp;models<br> 
    410440------------------<br> 
     
    521551&nbsp;<br> 
    522552&nbsp;<br> 
     553 
     554<!- READING A VGROUP --> 
    523555Reading&nbsp;a&nbsp;vgroup<br> 
    524556----------------<br> 
  • trunk/pyhdf/doc/pyhdf.V.txt

    r1082 r1087  
    1616            gosselina@dfo-mpo.gc.ca 
    1717             
    18     Version: 0.7-3 
    19     Date:    july 13 2005 
     18    Maintainer: Enthought, Inc. 
     19                Austin, TX 
     20                enthought-dev@mail.enthought.com 
     21 
     22    Version: 0.8 
     23    Date:    july 1 2008 
    2024     
    2125    Table of contents 
  • trunk/pyhdf/doc/pyhdf.VS.html

    r1082 r1087  
    1414(see:&nbsp;hdf.ncsa.uiuc.edu)<br> 
    1515&nbsp;<br> 
     16 
     17<!-- AUTHOR INFORMATION --> 
    1618Author:&nbsp;Andre&nbsp;Gosselin<br> 
    1719&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Maurice-Lamontagne&nbsp;Institute<br> 
    1820&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;gosselina@dfo-mpo.gc.ca<br> 
    1921&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br> 
    20 Version:&nbsp;0.7-3<br> 
    21 Date:&nbsp;&nbsp;&nbsp;&nbsp;July&nbsp;13&nbsp;2005<br> 
    22 &nbsp;<br> 
     22 
     23<!-- MAINTAINER INFORMATION --> 
     24Maintainer:&nbsp;Enthought, Inc.<br> 
     25&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Asutin, TX<br> 
     26&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;enthought-dev@mail.enthought.com<br> 
     27&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br> 
     28Version:&nbsp;0.8<br> 
     29Date:&nbsp;&nbsp;&nbsp;&nbsp;July&nbsp;1&nbsp;2008<br> 
     30&nbsp;<br> 
     31 
     32<!-- TABLE OF CONTENTS --> 
    2333Table&nbsp;of&nbsp;contents<br> 
    2434-----------------<br> 
     
    4555&nbsp;<br> 
    4656&nbsp;<br> 
     57 
     58<!-- INTRODUCTION --> 
    4759Introduction<br> 
    4860------------<br> 
     
    103115vdata&nbsp;as&nbsp;if&nbsp;it&nbsp;were&nbsp;a&nbsp;python&nbsp;sequence.<br> 
    104116&nbsp;<br> 
     117 
     118<!-- VS MODULE KEY FEATURES --> 
    105119<a href="#VS">VS</a>&nbsp;module&nbsp;key&nbsp;features<br> 
    106120----------------------<br> 
     
    125139&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;Easy&nbsp;creation&nbsp;of&nbsp;vdatas.<br> 
    126140&nbsp;<br> 
     141 
     142<!-- ACCESSING THE VS MODULE --> 
    127143Accessing&nbsp;the&nbsp;<a href="#VS">VS</a>&nbsp;module<br> 
    128144-----------------------<br> 
     
    141157&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;from&nbsp;HDF&nbsp;import&nbsp;*<br> 
    142158&nbsp;<br> 
     159 
     160<!-- PACKAGE COMPONENTS --> 
    143161Package&nbsp;components<br> 
    144162------------------<br> 
     
    167185directly.&nbsp;Only&nbsp;HDF&nbsp;and&nbsp;<a href="#VS">VS</a>&nbsp;should&nbsp;be&nbsp;imported&nbsp;by&nbsp;the&nbsp;user&nbsp;program.<br> 
    168186&nbsp;<br> 
     187 
     188<!-- PREREQUISITES --> 
    169189Prerequisites<br> 
    170190-------------<br> 
     
    181201Numeric&nbsp;is&nbsp;also&nbsp;needed&nbsp;by&nbsp;the&nbsp;SD&nbsp;module.&nbsp;See&nbsp;the&nbsp;SD&nbsp;module&nbsp;documentation.<br> 
    182202&nbsp;<br> 
     203 
     204<!-- DOCUMENTATION --> 
    183205Documentation<br> 
    184206-------------<br> 
     
    215237&nbsp;&nbsp;%&nbsp;pydoc&nbsp;pyhdf.<a href="#VS">VS</a>.<a href="#VD">VD</a>.read&nbsp;&nbsp;&nbsp;&nbsp;#&nbsp;doc&nbsp;for&nbsp;the&nbsp;<a href="#VD">VD</a>.read&nbsp;method<br> 
    216238&nbsp;&nbsp;<br> 
     239 
     240<!-- SUMMARY OF DIFFERENCES --> 
    217241Summary&nbsp;of&nbsp;differences&nbsp;between&nbsp;the&nbsp;pyhdf&nbsp;and&nbsp;C&nbsp;<a href="#VS">VS</a>&nbsp;API<br> 
    218242-----------------------------------------------------<br> 
     
    229253&nbsp;&nbsp;&nbsp;&nbsp;C&nbsp;function&nbsp;argument&nbsp;list.<br> 
    230254&nbsp;&nbsp;&nbsp;<br> 
     255 
     256<!-- ERROR HANDLING --> 
    231257Error&nbsp;handling<br> 
    232258--------------<br> 
     
    259285&nbsp;&nbsp;&gt;&gt;&gt;&nbsp;hdfFile.close()&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;#&nbsp;close&nbsp;HDF&nbsp;file<br> 
    260286&nbsp;<br> 
     287 
     288<!-- CLASSES SUMMARY --> 
    261289Classes&nbsp;summary<br> 
    262290---------------<br> 
     
    382410&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;info()&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;retrieve&nbsp;info&nbsp;about&nbsp;the&nbsp;attribute<br> 
    383411&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br> 
     412 
     413<!-- DATA TYPES --> 
    384414Data&nbsp;types<br> 
    385415----------<br> 
     
    405435with&nbsp;spaces&nbsp;if&nbsp;necessary).<br> 
    406436&nbsp;<br> 
     437 
     438<!-- ATTRIBUTE ACCESS --> 
    407439Attribute&nbsp;access:&nbsp;low&nbsp;and&nbsp;high&nbsp;level<br> 
    408440------------------------------------<br> 
     
    492524attributes&nbsp;constant.&nbsp;Examples&nbsp;below&nbsp;show&nbsp;simple&nbsp;ways&nbsp;how&nbsp;this&nbsp;can&nbsp;be&nbsp;done.<br> 
    493525&nbsp;<br> 
     526 
     527<!-- PREDEFINED ATTRIBUTES --> 
    494528Predefined&nbsp;attributes<br> 
    495529---------------------<br> 
     
    535569&nbsp;&nbsp;&nbsp;&nbsp;<br> 
    536570&nbsp;<br> 
     571 
     572<!-- RECORD ACCESS --> 
    537573Record&nbsp;access:&nbsp;low&nbsp;and&nbsp;high&nbsp;level<br> 
    538574---------------------------------<br> 
     
    601637&nbsp;<br> 
    602638&nbsp;<br> 
     639 
     640<!-- PROGRAMMING MODELS --> 
    603641Programming&nbsp;models<br> 
    604642------------------<br> 
     
    658696assign&nbsp;to&nbsp;the&nbsp;attribute.<br> 
    659697&nbsp;<br> 
     698 
     699<!-- APPENDING RECORDS TO VDATA --> 
    660700Appending&nbsp;records&nbsp;to&nbsp;a&nbsp;vdata<br> 
    661701----------------------------<br> 
     
    695735as&nbsp;the&nbsp;start&nbsp;of&nbsp;the&nbsp;slice,&nbsp;the&nbsp;records&nbsp;are&nbsp;appended&nbsp;to&nbsp;the&nbsp;vdata.<br> 
    696736&nbsp;<br> 
     737 
     738<!-- UPDATING RECORDS IN A VDATA --> 
    697739Updating&nbsp;records&nbsp;in&nbsp;a&nbsp;vdata<br> 
    698740---------------------------<br> 
     
    731773&nbsp;&nbsp;&nbsp;&nbsp;f.close()&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;#&nbsp;close&nbsp;the&nbsp;HDF&nbsp;file<br> 
    732774&nbsp;<br> 
     775 
     776<!-- READING A VDATA --> 
    733777Reading&nbsp;a&nbsp;vdata<br> 
    734778---------------<br> 
  • trunk/pyhdf/doc/pyhdf.VS.txt

    r1082 r1087  
    1515            Maurice-Lamontagne Institute 
    1616            gosselina@dfo-mpo.gc.ca 
     17 
     18    Maintainer: Enthought, Inc. 
     19                Austin, TX 
     20                enthought-dev@mail.enthought.com 
    1721             
    18     Version: 0.7-3 
    19     Date:    July 13 2005 
     22    Version: 0.8 
     23    Date:    July 1 2008 
    2024     
    2125    Table of contents