Home Explore Help
Register Sign In
yichael
/
image-match
1
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Branch: master
Branches Tags
image-match
/
python
/
py
/
Lib
/
site-packages
/
scipy
/
io
/
matlab
/
__init__.py

__init__.py 2.2 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566 
  1. """
    2. 

  2. MATLAB® file utilities (:mod:`scipy.io.matlab`)
    3. 

  3. ===============================================
    4. 

  4. 

  5. .. currentmodule:: scipy.io.matlab
    6. 

  6. 

  7. This submodule is meant to provide lower-level file utilities related to reading
    8. 

  8. and writing MATLAB files.
    9. 

  9. 

  10. .. autosummary::
    11. 

  11.    :toctree: generated/
    12. 

  12. 

  13.    matfile_version - Get the MATLAB file version
    14. 

  14.    MatReadError - Exception indicating a read issue
    15. 

  15.    MatReadWarning - Warning class for read issues
    16. 

  16.    MatWriteError - Exception indicating a write issue
    17. 

  17.    MatWriteWarning - Warning class for write issues
    18. 

  18.    mat_struct - Class used when ``struct_as_record=False``
    19. 

  19.    varmats_from_mat - Pull variables out of mat 5 file as a sequence of mat file objects
    20. 

  20. 

  21. .. autosummary::
    22. 

  22.    :toctree: generated/
    23. 

  23.    :template: autosummary/ndarray_subclass.rst
    24. 

  24.    :nosignatures:
    25. 

  25. 

  26.    MatlabObject - Class for a MATLAB object
    27. 

  27.    MatlabOpaque - Class for a MATLAB opaque matrix
    28. 

  28.    MatlabFunction - Class for a MATLAB function object
    29. 

  29. 

  30. The following utilities that live in the :mod:`scipy.io`
    31. 

  31. namespace also exist in this namespace:
    32. 

  32. 

  33. .. autosummary::
    34. 

  34.    :toctree: generated/
    35. 

  35. 

  36.    loadmat - Read a MATLAB style mat file (version 4 through 7.1)
    37. 

  37.    savemat - Write a MATLAB style mat file (version 4 through 7.1)
    38. 

  38.    whosmat - List contents of a MATLAB style mat file (version 4 through 7.1)
    39. 

  39. 

  40. Notes
    41. 

  41. -----
    42. 

  42. MATLAB® is a registered trademark of The MathWorks, Inc., 3 Apple Hill
    43. 

  43. Drive, Natick, MA 01760-2098, USA.
    44. 

  44. 

  45. """
    46. 

  46. # Matlab file read and write utilities
    47. 

  47. from ._mio import loadmat, savemat, whosmat
    48. 

  48. from ._mio5 import MatlabFunction, varmats_from_mat
    49. 

  49. from ._mio5_params import MatlabObject, MatlabOpaque, mat_struct
    50. 

  50. from ._miobase import (matfile_version, MatReadError, MatReadWarning,
    51. 

  51.                       MatWriteError, MatWriteWarning)
    52. 

  52. 

  53. # Deprecated namespaces, to be removed in v2.0.0
    54. 

  54. from .import (mio, mio5, mio5_params, mio4, byteordercodes,
    55. 

  55.             miobase, mio_utils, streams, mio5_utils)
    56. 

  56. 

  57. __all__ = [
    58. 

  58.     'loadmat', 'savemat', 'whosmat', 'MatlabObject',
    59. 

  59.     'matfile_version', 'MatReadError', 'MatReadWarning',
    60. 

  60.     'MatWriteError', 'MatWriteWarning', 'mat_struct', 'MatlabOpaque',
    61. 

  61.     'MatlabFunction', 'varmats_from_mat',
    62. 

  62. ]
    63. 

  63. 

  64. from scipy._lib._testutils import PytestTester
    65. 

  65. test = PytestTester(__name__)
    66. 

  66. del PytestTester
    67.