SciPy 0.6.0 API Documentation Generated by Endo, 2007-10-17

Function summary

• find_mat_file(file_name, appendmat = True)
• loadmat(file_name, mdict = None, appendmat = True, basename = 'raw', **kwargs)
• mat_reader_factory(file_name, appendmat = True, **kwargs)
• savemat(file_name, mdict, appendmat = True)

Functions

• find_mat_file(file_name, appendmat = True)

  Try to find .mat file on system path

  file_name - file name string append_mat - If True, and file_name does not end in '.mat', appends it

• loadmat(file_name, mdict = None, appendmat = True, basename = 'raw', **kwargs)

  Load Matlab(tm) file
  
  file_name          - Name of the mat file
                       (do not need .mat extension if appendmat==True)
                       If name not a full path name, search for the file on
                       the sys.path list and use the first one found (the
                       current directory is searched first).
                       Can also pass open file-like object
  m_dict             - optional dictionary in which to insert matfile variables 
  appendmat          - True to append the .mat extension to the end of the
                       given filename, if not already present
  base_name          - base name for unnamed variables (unused in code)
  byte_order         - byte order ('native', 'little', 'BIG')
                        in ('native', '=')
                        or in ('little', '<')
                        or in ('BIG', '>')
  mat_dtype          - return arrays in same dtype as loaded into matlab
                        (instead of the dtype with which they are saved)
  squeeze_me         - whether to squeeze matrix dimensions or not
  chars_as_strings   - whether to convert char arrays to string arrays
  mat_dtype          - return matrices with datatype that matlab would load as
                        (rather than in the datatype matlab saves as)
  matlab_compatible   - returns matrices as would be loaded by matlab
                        (implies squeeze_me=False, chars_as_strings=False,
                        mat_dtype=True)
  
  v4 (Level 1.0), v6 and v7.1 matfiles are supported.  
  
  

• mat_reader_factory(file_name, appendmat = True, **kwargs)

  Create reader for matlab (TM) .mat format files

  See docstring for loadmat for input options

• savemat(file_name, mdict, appendmat = True)

  Save a dictionary of names and arrays into the MATLAB-style .mat file.

  This saves the arrayobjects in the given dictionary to a matlab Version 4 style .mat file.

  @appendmat - if true, appends '.mat' extension to filename, if not present

Imported Names