a a/ @sdZddlZddlZddlZddlmZddlmZ Gddde Z Gdd d e Z Gd d d e Zd d dddddddd ZeeZddZddZddZd'ddZGdd d ZGd!d"d"Zd#d$Zd%d&ZdS)(zf Base classes for MATLAB file stream reading. MATLAB is a registered trademark of the Mathworks inc. N)doccer)byteordercodesc@s eZdZdS) MatReadErrorN__name__ __module__ __qualname__r r g/Users/vegardjervell/Documents/master/model/venv/lib/python3.9/site-packages/scipy/io/matlab/miobase.pyrsrc@s eZdZdS) MatWriteErrorNrr r r r r sr c@s eZdZdS)MatReadWarningNrr r r r r sr zfile_name : str Name of the mat file (do not need .mat extension if appendmat==True) Can also pass open file-like object.z|appendmat : bool, optional True to append the .mat extension to the end of the given filename, if not already present.abyte_order : str or None, optional None by default, implying byte order guessed from mat file. Otherwise can be one of ('native', '=', 'little', '<', 'BIG', '>'). mat_dtype : bool, optional If True, return arrays in same dtype as would be loaded into MATLAB (instead of the dtype with which they are saved). squeeze_me : bool, optional Whether to squeeze unit matrix dimensions or not. chars_as_strings : bool, optional Whether to convert char arrays to string arrays. matlab_compatible : bool, optional Returns matrices as would be loaded by MATLAB (implies squeeze_me=False, chars_as_strings=False, mat_dtype=True, struct_as_record=True).abstruct_as_record : bool, optional Whether to load MATLAB structs as NumPy record arrays, or as old-style NumPy arrays with dtype=object. Setting this flag to False replicates the behavior of SciPy version 0.7.x (returning numpy object arrays). The default setting is True, because it allows easier round-trip load and save of MATLAB files.zAmat_stream : file-like Object with file API, open for reading.along_field_names : bool, optional * False - maximum field name length in a structure is 31 characters which is the documented maximum length. This is the default. * True - maximum field name length in a structure is 63 characters which works for MATLAB 7.6z[do_compression : bool, optional Whether to compress matrices on write. Default is False.zoned_as : {'row', 'column'}, optional If 'column', write 1-D NumPy arrays as column vectors. If 'row', write 1D NumPy arrays as row vectors.zbunicode_strings : bool, optional If True, write strings as Unicode, else MATLAB usual encoding.) Zfile_argZ append_argZ load_argsZ struct_argZ matstream_argZ long_fieldsZdo_compressiononed_asZunicode_stringscCs.|}|D]}t|||||<q |S)a Convert dtypes in mapping to given order Parameters ---------- dtype_template : mapping mapping with values returning numpy dtype from ``np.dtype(val)`` order_code : str an order code suitable for using in ``dtype.newbyteorder()`` Returns ------- dtypes : mapping mapping where values have been replaced by ``np.dtype(val).newbyteorder(order_code)`` )copynpdtypeZ newbyteorder)Zdtype_templateZ order_codedtypeskr r r convert_dtypessrcCs"|j}tjd|||dd}|S)af Generic get of byte stream data of known type Parameters ---------- mat_stream : file_like object MATLAB (tm) mat file stream a_dtype : dtype dtype of array to read. `a_dtype` is assumed to be correct endianness. Returns ------- arr : ndarray Array of dtype `a_dtype` read from stream. r F)shaperbufferorder)itemsizerndarrayread) mat_streamZa_dtype num_bytesarrr r r read_dtypesrcCs|d|d}t|dkr(tdtjdtj|d}d|vrP|ddS|d|d}|dt|dd k}t||}t|d |}||f}|d vr|Std |d S)a Return major, minor tuple depending on apparent mat file type Where: #. 0,x -> version 4 format mat files #. 1,x -> version 5 format mat files #. 2,x -> version 7.3 format mat files (HDF format) Parameters ---------- fileobj : file_like object implementing seek() and read() Returns ------- major_version : {0, 1, 2} major MATLAB File format version minor_version : int minor MATLAB file format version Raises ------ MatReadError If the file is empty. ValueError The matfile version is unknown. Notes ----- Has the side effect of setting the file read pointer to 0 rzMat file appears to be empty)r rrrrr|Ir)rr$z%Unknown mat file type, version %s, %sN) seekrlenrrrZuint8int ValueError)fileobjZ mopt_bytesZ mopt_intsZtst_strZmaj_indZmaj_valZmin_valretr r r get_matfile_versions$"        r,columncCs^|j}|dkrdSt|dkrZ|ddkr.dS|dkr>|dS|dkrNd|Std ||S) a Determine equivalent MATLAB dimensions for given array Parameters ---------- arr : ndarray Input array oned_as : {'column', 'row'}, optional Whether 1-D arrays are returned as MATLAB row or column matrices. Default is 'column'. Returns ------- dims : tuple Shape tuple, in the form MATLAB expects it. Notes ----- We had to decide what shape a 1 dimensional array would be by default. ``np.atleast_2d`` thinks it is a row vector. The default for a vector in MATLAB (e.g., ``>> 1:12``) is a row vector. Versions of scipy up to and including 0.11 resulted (accidentally) in 1-D arrays being read as column vectors. For the moment, we maintain the same tradition here. Examples -------- >>> matdims(np.array(1)) # NumPy scalar (1, 1) >>> matdims(np.array([1])) # 1-D array, 1 element (1, 1) >>> matdims(np.array([1,2])) # 1-D array, 2 elements (2, 1) >>> matdims(np.array([[2],[3]])) # 2-D array, column vector (2, 1) >>> matdims(np.array([[2,3]])) # 2-D array, row vector (1, 2) >>> matdims(np.array([[[2,3]]])) # 3-D array, rowish vector (1, 1, 2) >>> matdims(np.array([])) # empty 1-D array (0, 0) >>> matdims(np.array([[]])) # empty 2-D array (0, 0) >>> matdims(np.array([[[]]])) # empty 3-D array (0, 0, 0) Optional argument flips 1-D shape behavior. >>> matdims(np.array([1,2]), 'row') # 1-D array, 2 elements (1, 2) The argument has to make sense though >>> matdims(np.array([1,2]), 'bizarre') Traceback (most recent call last): ... ValueError: 1-D option "bizarre" is strange r )rrrrr"r-)rrowz1-D option "%s" is strange)rr'r))rrrr r r matdimss=  r/c@s(eZdZdZddZddZddZdS) MatVarReaderz; Abstract class defining required interface for var readerscCsdS)Nr )selfZ file_readerr r r __init__9szMatVarReader.__init__cCsdS)z Returns header Nr r1r r r read_header<szMatVarReader.read_headercCsdS)z Reads array given header Nr )r1headerr r r array_from_header@szMatVarReader.array_from_headerN)rrr __doc__r2r4r6r r r r r07sr0c @s6eZdZdZed ddZddZd d Zd d ZdS) MatFileReadera  Base object for reading mat files To make this class functional, you will need to override the following methods: matrix_getter_factory - gives object to fetch next matrix from stream guess_byte_order - guesses file byte order from file NFTc Csp||_i|_|s|}n t|}||_||_|r>|n||_||_ ||_ ||_ | |_ | rld|_d|_dS)z Initializer for mat file reader mat_stream : file-like object with file API, open for reading %(load_args)s TFN) rrguess_byte_orderbocZ to_numpy_code byte_orderstruct_as_recordset_matlab_compatible squeeze_mechars_as_strings mat_dtype verify_compressed_data_integritysimplify_cells) r1rr;r@r>r?Zmatlab_compatibler<rArBr r r r2Os"   zMatFileReader.__init__cCsd|_d|_d|_dS)z4 Sets options to return arrays as MATLAB loads them TFN)r@r>r?r3r r r r=usz#MatFileReader.set_matlab_compatiblecCstjS)z9 As we do not know what file type we have, assume native )r:Z native_coder3r r r r9{szMatFileReader.guess_byte_ordercCs2|jd}|j}|j|dt|dkS)Nrr)rrtellr&r')r1bZcurposr r r end_of_streams  zMatFileReader.end_of_stream)NFFTFTTF) rrr r7 docfillerr2r=r9rEr r r r r8Es  %r8cCst|jjddt|S)z3 Return dtype for given number of items per elementNr$)rrstr)rnumr r r arr_dtype_numbersrIcCstt|j}|sdg}|t|jjddtj|t|d|d}|dkg}t |s\|S| }d|t |<|S)z$ Convert string array to char array rr$Nr! ) listrappendr(rrGrrrIanyrtuple)rdimsZemptiesr r r arr_to_charss    rQ)r-)r7operator functoolsZnumpyrZ scipy._librrJrr: Exceptionrr UserWarningr Zdoc_dictZfilldocrFrrr,r/r0r8rIrQr r r r s8  4 /9 MA