package scipy

  1. Overview
  2. Docs
package scipy
Legend:
Library
Module
Module type
Parameter
Class
Class type
type tag = [
  1. | `MatFile4Reader
]
type t = [ `MatFile4Reader | `Object ] Obj.t
val of_pyobject : Py.Object.t -> t
val to_pyobject : [> tag ] Obj.t -> Py.Object.t
val create : ?kwargs:(string * Py.Object.t) list -> mat_stream:Py.Object.t -> Py.Object.t list -> t

Reader for Mat4 files

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

None

val get_variables : ?variable_names:[ `Sequence_of_str of Py.Object.t | `S of string ] -> [> tag ] Obj.t -> Py.Object.t

get variables from stream as dictionary

Parameters ---------- variable_names : None or str or sequence of str, optional variable name, or sequence of variable names to get from Mat file / file stream. If None, then get all variables in file

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

As we do not know what file type we have, assume native

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_var_array : ?process:bool -> 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, 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 and return header, next position

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