package scipy

  1. Overview
  2. Docs
package scipy
Legend:
Library
Module
Module type
Parameter
Class
Class type
type tag = [
  1. | `MatFile5Reader
]
type t = [ `MatFile5Reader | `Object ] Obj.t
val of_pyobject : Py.Object.t -> t
val to_pyobject : [> tag ] Obj.t -> Py.Object.t
val create : ?byte_order:Py.Object.t -> ?mat_dtype:Py.Object.t -> ?squeeze_me:Py.Object.t -> ?chars_as_strings:Py.Object.t -> ?matlab_compatible:Py.Object.t -> ?struct_as_record:Py.Object.t -> ?verify_compressed_data_integrity:Py.Object.t -> ?uint16_codec:Py.Object.t -> mat_stream:Py.Object.t -> unit -> t

Reader for Mat 5 mat files Adds the following attribute to base class

uint16_codec - char codec to use for uint16 char arrays (defaults to system default codec)

Uses variable reader that has the following stardard interface (see abstract class in ``miobase``::

__init__(self, file_reader) read_header(self) array_from_header(self)

and added interface::

set_stream(self, stream) read_full_tag(self)

val end_of_stream : [> tag ] Obj.t -> Py.Object.t

None

val get_variables : ?variable_names:Py.Object.t -> [> tag ] Obj.t -> Py.Object.t

get variables from stream as dictionary

variable_names - optional list of variable names to get

If variable_names is None, then get all variables in file

val guess_byte_order : [> tag ] Obj.t -> Py.Object.t

Guess byte order. Sets stream pointer to 0

val initialize_read : [> tag ] Obj.t -> Py.Object.t

Run when beginning read of variables

Sets up readers from parameters in `self`

val list_variables : [> tag ] Obj.t -> Py.Object.t

list variables from stream

val read_file_header : [> tag ] Obj.t -> Py.Object.t

Read in mat 5 file header

val read_var_array : ?process:Py.Object.t -> header:Py.Object.t -> [> tag ] Obj.t -> [ `ArrayLike | `Ndarray | `Object ] Np.Obj.t

Read array, given `header`

Parameters ---------- header : header object object with fields defining variable header process : True, False bool, optional If True, apply recursive post-processing during loading of array.

Returns ------- arr : array array with post-processing applied or not according to `process`.

val read_var_header : [> tag ] Obj.t -> Py.Object.t * int

Read header, return header, next position

Header has to define at least .name and .is_global

Parameters ---------- None

Returns ------- header : object object that can be passed to self.read_var_array, and that has attributes .name and .is_global next_position : int position in stream of next variable

val set_matlab_compatible : [> tag ] Obj.t -> Py.Object.t

Sets options to return arrays as MATLAB loads them

val to_string : t -> string

Print the object to a human-readable representation.

val show : t -> string

Print the object to a human-readable representation.

val pp : Format.formatter -> t -> unit

Pretty-print the object to a formatter.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct