Changeset 1121 for trunk/bindings/python/nxs

Timestamp:

25/10/08 00:34:52 (4 years ago)

Author:

Paul Kienzle

Message:

python: repackaging (step 2). Refs #101.

Location:

trunk/bindings/python/nxs

Files:

• . (added)
• __init__.py (moved) (moved from trunk/bindings/python/__init__.py)
• napi.py (moved) (moved from trunk/bindings/python/nxs.py) (1 diff)
• tree.py (moved) (moved from trunk/bindings/python/nexus.py) (4 diffs)
• unit.py (moved) (moved from trunk/bindings/python/nxsunit.py) (2 diffs)

trunk/bindings/python/nxs/napi.py

@@ -123 +123 @@
 .. _NAPI:  http://www.nexusformat.org/Application_Program_Interface
 """
-__all__ = ['MAXNAMELEN','MAXPATHLEN','NeXus','open']
+__all__ = ['UNLIMITED', 'MAXRANK', 'MAXNAMELEN','MAXPATHLEN','NeXus','open']
 
 import sys, os, numpy, ctypes

trunk/bindings/python/nxs/tree.py

@@ -14 +14 @@
 
     import nxs
-    tree = nxs.read('file.nxs')   # loads a structure from a file
-    nxs.write('copy.nxs', tree)   # saves a structure to a file
+    tree = nxs.load('file.nxs')   # loads a structure from a file
+    nxs.save('copy.nxs', tree)    # saves a structure to a file
     nxs.dir('copy.nxs')           # display the contents of a file
 
 
-The tree returned from read() has an entry for each group, field and
+The tree returned from load() has an entry for each group, field and
 attribute.  You can traverse the hierarchy using the names of the
 groups.  For example, tree.Histogram1.instrument.detector.distance
@@ -68 +68 @@
 retrieve them in meters using::
     entry.instrument.detector.distance.nxdata_as('m')
-See help for nxsunit for more details on the unit formats supported.
+See `nxs.unit` for more details on the unit formats supported.
 
 The slab interface to field data works by opening the file handle
@@ -108 +108 @@
 to the data group and title is the title of the NXentry, if available.
 
-The read() and write() functions are implemented within a specialized
-NeXus class which allows all the usual API functions.  You can subclass
-this with your own definitions for NXgroup(), NXattr(), SDS() and NXlink()
-if you want to change the nature of the tree.  The properties of these
-classes are closely coupled to the behaviour of readfile/writefile so 
-refer to the source if you need to do this.
+The load() and save() functions are implemented within 
+`nxs.tree.NeXusTree`, a subclass of `nxs.napi.NeXus` which allows 
+all the usual API functions.  You can subclass NeXusTree with your
+own version that defines, e.g., a NXmonitor() method to return an
+NXmonitor object when an NXmonitor class is read.  Your NXmonitor
+class should probably be a subclass of NXgroup.
+
+You can also specialize the definitions for the basic types 
+NXgroup(), NXattr(), SDS() and NXlink() if you want to make
+radical changes to the returned structure.  The properties of 
+these classes are closely coupled to the behaviour of the readfile
+and writefile methods so refer to the source if you need to do this.
 """
 __all__ = ['read', 'write', 'dir', 'NeXusTree']
@@ -614 +620 @@
         else:
             units = None
-        self._converter = nxsunit.Converter(units)
+        self._converter = nxs.unit.Converter(units)
         self.nxslab = NXslab_context(file, path, self._converter)
 

trunk/bindings/python/nxs/unit.py

@@ -45 +45 @@
 """
 
-__all__ = ['Converter']
-
 # TODO: Add udunits to NAPI rather than reimplementing it in python
 # TODO: Alternatively, parse the udunits database directly
@@ -55 +53 @@
 
 from __future__ import division
+
+__all__ = ['Converter']
+
 import math