matlab.engine.start_matlab

Python 用 MATLAB エンジンの開始

ページ内をすべて折りたたむ

構文

eng = matlab.engine.start_matlab()
eng = matlab.engine.start_matlab(option)
eng = matlab.engine.start_matlab(background)
eng = matlab.engine.start_matlab(async)
eng = matlab.engine.start_matlab(___)

説明

eng = matlab.engine.start_matlab() は、新しい MATLAB® プロセスを開始して Python® 変数 eng を返します。これは、MATLAB プロセスと通信するための MatlabEngine オブジェクトです。

MATLAB を起動できない場合、エンジンは EngineError 例外を発行します。

例

eng = matlab.engine.start_matlab(option) は、option で指定された起動オプションを使用します。

たとえば、matlab.engine.start_matlab('-desktop') を呼び出すと Python から MATLAB デスクトップが起動されます。

例

background が True の場合、eng = matlab.engine.start_matlab(background) により MATLAB が非同期的に起動します。

例

async が True の場合、eng = matlab.engine.start_matlab(async) により MATLAB が非同期的に起動します。推奨されません。代わりに background 引数を使用してください。Python Version 3.7 以降には使用しないでください。詳細については、バージョン履歴を参照してください。

eng = matlab.engine.start_matlab(___) には、前述の構文にある任意の入力引数を含めることができます。

例

例

すべて折りたたむ

Python コマンド ラインからエンジンと新しい MATLAB プロセスを開始します。

import matlab.engine
eng = matlab.engine.start_matlab()

各エンジンからそれぞれ異なる MATLAB プロセスを開始します。

import matlab.engine
eng1 = matlab.engine.start_matlab()
eng2 = matlab.engine.start_matlab()

MATLAB デスクトップでエンジンを起動します。

import matlab.engine
eng = matlab.engine.start_matlab("-desktop")

エンジンを起動した後にデスクトップを起動することもできます。

import matlab.engine
eng = matlab.engine.start_matlab()
eng.desktop(nargout=0)

メモ

MATLAB 関数はデスクトップと Python の両方から呼び出せます。

background=True を使用してエンジンを起動します。MATLAB の起動時に、Python コマンド ラインでコマンドを入力することができます。

import matlab.engine
future = matlab.engine.start_matlab(background=True)
eng = future.result()
eng.sqrt(4.)
2.0

入力引数

すべて折りたたむ

MATLAB プロセスの起動オプション。文字列で指定されます。複数の起動オプションを指定できます。エンジンは制限に記載されているオプションを除くすべての MATLAB 起動オプションをサポートしています。オプションのリストについては、プラットフォーム固有の matlab (Windows) コマンド、matlab (macOS) コマンド、または matlab (Linux) コマンドを参照してください。

デスクトップで MATLAB を起動するには、'-desktop' オプションを使用します。

例: matlab.engine.start_matlab('-desktop -r "format short"') で Python からデスクトップを起動します。エンジンは '-r "format short"' を MATLAB に渡します。

MATLAB を同期的または非同期的に起動します。logical のキーワード引数として指定します。background は async のエイリアスです。

例: matlab.engine.start_matlab(background=True)

MATLAB を同期的または非同期的に起動します。logical のキーワード引数として指定します。推奨されません。代わりに background 引数を使用してください。詳細については、バージョン履歴を参照してください。

出力引数

すべて折りたたむ

MATLAB と通信するための Python 変数。async または background が False に設定されている場合は MatlabEngine オブジェクトとして返され、async または background が True に設定されている場合は FutureResult オブジェクトとして返されます。

matlab.engine.start_matlab を呼び出すたびに、新しい MATLAB プロセスが開始されます。

制限

エンジンは次の MATLAB 起動オプションをサポートしていません。

  • -h

  • -help

  • -?

  • -n

  • -e

  • -logfile

MATLAB の起動オプションの詳細については、よく使われる起動オプションを参照してください。

バージョン履歴

R2014b で導入

すべて展開する

参考

| |

トピック