o ֭j2 @sUdZddlmZddlZddlmZddlmZ gdZ Gdd d e Z Gd d d e Z Gd d d eZdddddddddd ZeeZeed< ddZddZdddd ZeZd!Zd"d#Zd/d%d&ZGd'd(d(ZGd)d*d*Zd+d,Zd-d.ZdS)0zf Base classes for MATLAB file stream reading. MATLAB is a registered trademark of the Mathworks inc. )FinalN)doccer)_byteordercodes) MatReadErrorMatReadWarning MatWriteErrorc@eZdZdZdS)rz"Exception indicating a read issue.N__name__ __module__ __qualname____doc__rrU/var/www/html/CropPilot/venv/lib/python3.10/site-packages/scipy/io/matlab/_miobase.pyrrc@r )rz#Exception indicating a write issue.Nr rrrrrrrc@r )rzWarning class for read issues.Nr rrrrrrrzfile_name : str Name of the mat file (do not need .mat extension if appendmat==True) Can also pass open file-like object.zappendmat : bool, optional True to append the .mat extension to the end of the given filename, if not already present. Default is True.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.) file_arg append_arg load_args struct_arg matstream_arg long_fieldsdo_compressiononed_asunicode_strings docfillercCs.|}|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)`` )copynpdtype newbyteorder)dtype_template order_codedtypeskrrrconvert_dtypessr$cCs"|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. rF)shaperbufferorder)itemsizerndarrayread) mat_streama_dtype num_bytesarrrrr read_dtypesr0T appendmatcCsDddlm}|||d }t|WdS1swYdS)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 ---------- file_name : str Name of the mat file (do not need .mat extension if appendmat==True). Can also pass open file-like object. appendmat : bool, optional True to append the .mat extension to the end of the given filename, if not already present. Default is True. 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 r)_open_file_contextr1N)_mior3_get_matfile_version) file_namer2r3fileobjrrrmatfile_versions %$r8cCs|d|t}t|tkrtd|dtkr#tdtdtjdtj|ddd}d|vr;|ddS|d |d}|dt |d d k}t ||}t |d |}||f}|d vrj|St dj |)Nrz Mat file appears to be truncatedz&Mat file appears to be corrupt (first z bytes == 0))r:r&rr'rr|Ir)rr>z%Unknown mat file type, version {}, {}) seekr+ _HDR_N_BYTESlenrcountrr*uint8int ValueErrorformat)r7 hdr_bytes mopt_intstst_strmaj_indmaj_valmin_valretrrrr5s,         r5columncCsb|j}|dkr dSt|dkr/|ddkrdS|dkr|dS|dkr'd|Std |d |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 -------- >>> import numpy as np >>> from scipy.io.matlab._miobase import matdims >>> 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<rO)rrowz 1-D option "z " is strange)r&rBrF)r/rr&rrrmatdimss?  rQc@s(eZdZdZddZddZddZdS) MatVarReaderz; Abstract class defining required interface for var readerscCsdS)Nr)self file_readerrrr__init__PszMatVarReader.__init__cCdS)z Returns header NrrSrrr read_headerSzMatVarReader.read_headercCrV)z Reads array given header Nr)rSheaderrrrarray_from_headerWrYzMatVarReader.array_from_headerN)r r r rrUrXr[rrrrrRNs  rRc@sFeZdZdZe        d 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 Cst||_i|_|s |}nt|}||_||_|r|n ||_||_ ||_ ||_ | |_ | r8d|_d|_dSdS)z Initializer for mat file reader mat_stream : file-like object with file API, open for reading %(load_args)s TFN) r,r"guess_byte_orderboc to_numpy_code byte_orderstruct_as_recordset_matlab_compatible squeeze_mechars_as_strings mat_dtype verify_compressed_data_integritysimplify_cells) rSr,r`rercrdmatlab_compatiblerarfrgrrrrUfs$    zMatFileReader.__init__cCsd|_d|_d|_dS)z4 Sets options to return arrays as MATLAB loads them TFN)rercrdrWrrrrbs z#MatFileReader.set_matlab_compatiblecCstjS)z9 As we do not know what file type we have, assume native )r^ native_coderWrrrr]szMatFileReader.guess_byte_ordercCs2|jd}|j}|j|dt|dkS)Nrr)r,r+tellr@rB)rSbcurposrrr end_of_streams   zMatFileReader.end_of_stream)NFFTFTTF) r r r rrrUrbr]rmrrrrr\\s  % r\cCst|jjddt|S)z3 Return dtype for given number of items per elementNr>)rrstr)r/numrrrarr_dtype_numbersrpcCst|j}|s dg}|t|jjddtj|t|d|d}|tj d|jdkg}t |s4|S| }d|t |<|S)z$ Convert string array to char array rr>Nr;)r ) listr&appendrErrnrr*rparrayanyrtuple)r/dimsemptiesrrr arr_to_charss   rz)rO)rtypingrnumpyr scipy._librrqrr^__all__ Exceptionrr UserWarningrdoc_dictfilldocr__annotations__r$r0r8get_matfile_versionrAr5rQrRr\rprzrrrrsB   4-* NA