__init__.py 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. """
  2. MATLAB® file utilies (:mod:`scipy.io.matlab`)
  3. =============================================
  4. .. currentmodule:: scipy.io.matlab
  5. This submodule is meant to provide lower-level file utilies related to reading
  6. and writing MATLAB files.
  7. .. autosummary::
  8. :toctree: generated/
  9. matfile_version - Get the MATLAB file version
  10. MatReadError - Exception indicating a read issue
  11. MatReadWarning - Warning class for read issues
  12. MatWriteError - Exception indicating a write issue
  13. mat_struct - Class used when ``struct_as_record=False``
  14. .. autosummary::
  15. :toctree: generated/
  16. :template: autosummary/ndarray_subclass.rst
  17. :nosignatures:
  18. MatlabObject - Class for a MATLAB object
  19. MatlabOpaque - Class for a MATLAB opaque matrix
  20. MatlabFunction - Class for a MATLAB function object
  21. The following utilities that live in the :mod:`scipy.io`
  22. namespace also exist in this namespace:
  23. .. autosummary::
  24. :toctree: generated/
  25. loadmat - Read a MATLAB style mat file (version 4 through 7.1)
  26. savemat - Write a MATLAB style mat file (version 4 through 7.1)
  27. whosmat - List contents of a MATLAB style mat file (version 4 through 7.1)
  28. Notes
  29. -----
  30. MATLAB(R) is a registered trademark of The MathWorks, Inc., 3 Apple Hill
  31. Drive, Natick, MA 01760-2098, USA.
  32. """
  33. # Matlab file read and write utilities
  34. from ._mio import loadmat, savemat, whosmat
  35. from ._mio5 import MatlabFunction
  36. from ._mio5_params import MatlabObject, MatlabOpaque, mat_struct
  37. from ._miobase import (matfile_version, MatReadError, MatReadWarning,
  38. MatWriteError)
  39. # Deprecated namespaces, to be removed in v2.0.0
  40. from .import (mio, mio5, mio5_params, mio4, byteordercodes,
  41. miobase, mio_utils, streams, mio5_utils)
  42. __all__ = [
  43. 'loadmat', 'savemat', 'whosmat', 'MatlabObject',
  44. 'matfile_version', 'MatReadError', 'MatReadWarning',
  45. 'MatWriteError', 'mat_struct', 'MatlabOpaque', 'MatlabFunction'
  46. ]
  47. from scipy._lib._testutils import PytestTester
  48. test = PytestTester(__name__)
  49. del PytestTester