diff options
Diffstat (limited to 'doc/source/modules/io/specfile.rst')
| -rw-r--r-- | doc/source/modules/io/specfile.rst | 83 |
1 files changed, 83 insertions, 0 deletions
diff --git a/doc/source/modules/io/specfile.rst b/doc/source/modules/io/specfile.rst new file mode 100644 index 0000000..a937ca8 --- /dev/null +++ b/doc/source/modules/io/specfile.rst @@ -0,0 +1,83 @@ + +.. currentmodule:: silx.io + +:mod:`specfile`: Reading SpecFile +---------------------------------- + +.. automodule:: silx.io.specfile + :members: + :undoc-members: + +.. autoclass:: silx.io.specfile.SpecFile + :members: + :undoc-members: + + .. automethod:: __len__ + + .. automethod:: __iter__ + + .. automethod:: __getitem__ + +.. autoclass:: silx.io.specfile.Scan + :members: + :undoc-members: + +.. autoclass:: silx.io.specfile.MCA + :members: + :undoc-members: + + .. automethod:: __len__ + + .. automethod:: __iter__ + + .. automethod:: __getitem__ + +.. autoclass:: silx.io.specfile.SfError + +.. autoclass:: silx.io.specfile.SfErrMemoryAlloc + :show-inheritance: + +.. autoclass:: silx.io.specfile.SfErrFileOpen + :show-inheritance: + +.. autoclass:: silx.io.specfile.SfErrFileClose + :show-inheritance: + +.. autoclass:: silx.io.specfile.SfErrFileRead + :show-inheritance: + +.. autoclass:: silx.io.specfile.SfErrFileWrite + :show-inheritance: + +.. autoclass:: silx.io.specfile.SfErrLineNotFound + :show-inheritance: + +.. autoclass:: silx.io.specfile.SfErrScanNotFound + :show-inheritance: + +.. autoclass:: silx.io.specfile.SfErrHeaderNotFound + :show-inheritance: + +.. autoclass:: silx.io.specfile.SfErrLabelNotFound + :show-inheritance: + +.. autoclass:: silx.io.specfile.SfErrMotorNotFound + :show-inheritance: + +.. autoclass:: silx.io.specfile.SfErrPositionNotFound + :show-inheritance: + +.. autoclass:: silx.io.specfile.SfErrLineEmpty + :show-inheritance: + +.. autoclass:: silx.io.specfile.SfErrUserNotFound + :show-inheritance: + +.. autoclass:: silx.io.specfile.SfErrColNotFound + :show-inheritance: + +.. autoclass:: silx.io.specfile.SfErrMcaNotFound + :show-inheritance: + +.. autoclass:: silx.io.specfile.SfNoMcaError + :show-inheritance: |