Skip to content
David Banas edited this page Apr 10, 2024 · 6 revisions

Modules

View API Users documentation.

The PyAMI package includes the following modules:

(Under construction; please, pardon our mess.)

(In the mean time, you can query for the documentation on any entity in this package, directly from the PyLab command prompt, as follows:)

In [1]: import pyibisami.amimodel as ami

In [2]: ami.AMIModel?
Type:		type
Base Class:	<type 'type'>
String Form:	<class 'pyibisami.amimodel.AMIModel'>
Namespace:	Interactive
File:		/usr/local/lib/python2.7/dist-packages/PyIBIS_AMI-0.1-py2.7.egg/pyibisami/amimodel.py
Docstring:
    Class defining the structure and behavior of a AMI Model.
    
    Public Methods:
      initialize()
      getWave()
    
    Additional Features:
    
      - Makes the calling of AMI_Close() automagic, by calling it
        from the destructor.

Constructor information:
Definition:	ami.AMIModel(self, filename)
Docstring:
    Load the dll and bind the 3 AMI functions.


In [3]: ami.AMIModel.initialize?
Type:		instancemethod
Base Class:	<type 'instancemethod'>
String Form:	<unbound method AMIModel.initialize>
Namespace:	Interactive
File:		/usr/local/lib/python2.7/dist-packages/PyIBIS_AMI-0.1-py2.7.egg/pyibisami/amimodel.py
Definition:	ami.AMIModel.initialize(self, init_object)
Docstring:
    Wraps the `AMI_Init' function.
    
    Takes an instance of `AMIModelInitializer' as its only argument.
    This allows model initialization data to be constructed once,
    and modified incrementally in between multiple calls of
    `initialize'. This is useful for PyLab command prompt testing.


In [4]: 
Clone this wiki locally