matlab.engine.MatlabEngine

命名空间: matlab.engine

Python 对象使用 MATLAB 作为 Python 会话中的计算引擎

描述

MatlabEngine 类使用 MATLAB^® 进程作为 Python^® 的计算引擎。您可以将 MATLAB 函数作为 MatlabEngine 对象的方法调用，因为这些函数在您调用时会被动态调用。您还可以调用您定义的函数和脚本。您可以向与 MatlabEngine 对象关联的 MATLAB 工作区发送数据，以及从中检索数据。

创建对象

matlab.engine.start_matlab 方法在每次被调用时都会创建一个 MatlabEngine 对象。无需调用 matlab.engine.MatlabEngine() 来创建您自己的 MatlabEngine 对象。

属性

属性	描述
`workspace`	Python 字典包含对 MATLAB 变量的引用。您可以通过 `workspace` 向 MATLAB 变量赋予数据以及从中获取数据。您创建的每个 MATLAB 变量的名称都成为 `workspace` 字典中的一个键。`workspace` 中的键必须是有效的 MATLAB 标识符（例如，您不能将数字用作键）。

方法

全部展开

公共方法

`matlab.engine.start_matlab`	启动 MATLAB。
`matlab.engine.find_matlab`	查找共享的 MATLAB 会话以连接到 MATLAB Engine for Python。
`matlab.engine.connect_matlab`	连接到共享 MATLAB 会话。

专用运算符和函数

您可以将任何 MATLAB 函数作为 MatlabEngine 对象的方法调用。当您调用 MATLAB 函数时，引擎会动态调用它。语法显示函数调用的位置参量、关键字参量和输出参量。

ret = MatlabEngine.matlabfunc(*args,nargout=1,background=False,stdout=sys.stdout,stderr=sys.stderr)

将 matlabfunc 替换为任何 MATLAB 函数的名称（例如 isprime 或 sqrt）。将 *args 替换为您调用的 MATLAB 函数的输入参量。关键字参量指定：

函数返回的输出参量数目
引擎是否异步调用函数
引擎将来自函数的标准输出和标准错误发送到哪里

仅当指定与语法中显示的默认值不同的值时，才指定关键字参量。

MATLAB 函数的输入参量

参量	描述	Python 类型
`*args`	MATLAB 函数的输入参量，指定为位置参量	引擎可以转换为 MATLAB 类型的任何 Python 类型

引擎的关键字参量

参量	描述	Python 类型
`nargout`	MATLAB 函数的输出参量数目	`int` 默认值： `1`
`background`	异步调用 MATLAB 函数的标志 `background` 是 `async` 的别名。不过，从 Python 版本 3.7 开始，`async` 是关键字，不能用作参量。对于 Python 的所有受支持版本，请使用 `background` 参量而不是 `async`。	`bool` 默认值： `False`
`stdout`	标准输出	`io.StringIO` 对象默认值：`sys.stdout`
`stderr`	标准错误	`io.StringIO` 对象默认值：`sys.stderr`

输出参量

输出类型	描述	必需的关键字参量
Python 变量	从 MATLAB 函数返回一个输出参量	默认值
`tuple`	从 MATLAB 函数返回多个输出参量	`nargout=n`（其中 `n > 1`）
`None`	不从 MATLAB 函数返回任何输出参量	`nargout=0`
`FutureResult` 对象	对 MATLAB 函数的异步调用返回的输出参量的占位符	`background=True`

异常

异常	描述
`MatlabExecutionError`	函数调用无法执行
`RejectedExecutionError`	MATLAB 引擎已终止
`SyntaxError`	函数调用中的语法错误
`TypeError`	输入或输出参量的数据类型不受支持

示例

全部折叠

通过 Python 调用 MATLAB 函数

使用引擎从 Python 调用 MATLAB sqrt 函数。

import matlab.engine
eng = matlab.engine.start_matlab()
ret = eng.sqrt(4.0)
print(ret)

2.0

将数组放入 MATLAB 工作区中

在 Python 中创建一个数组并将其放入 MATLAB 工作区中。

import matlab.engine
eng = matlab.engine.start_matlab()
px = eng.linspace(0.0,6.28,1000)

px 是一个 MATLAB 数组，但 eng.linspace 将其返回到 Python。要在 MATLAB 中使用它，请将该数组放入 MATLAB 工作区中。

eng.workspace['mx'] = px

当您向引擎 workspace 字典添加一个条目时，您也会创建一个 MATLAB 变量。引擎将数据转换为一个 MATLAB 数据类型。

从 MATLAB 工作区获取数据

从 MATLAB 工作区获取 pi 并将其复制到一个 Python 变量。

import matlab.engine
eng = matlab.engine.start_matlab()
eng.eval('a = pi;',nargout=0)
mpi = eng.workspace['a']
print(mpi)

3.14159265359

版本历史记录

在 R2014b 中推出

另请参阅

matlab.engine.start_matlab | matlab.engine.connect_matlab | matlab.engine.find_matlab | matlab.engine.FutureResult