Simulink.sdi.report

シミュレーションデータインスペクターレポートを生成する

構文

Simulink.sdi.report

Simulink.sdi.report(Name,Value)

説明

Simulink.sdi.report は、シミュレーションデータインスペクターの [検査] ペインでプロットされた信号に対するプロットのスナップショットとメタデータを含むレポートを作成します。

Simulink.sdi.report(Name,Value) は 1 つ以上の Name,Value のペアの引数によって指定されたレポートを作成します。この構文を使用して、[検査] ペインでプロットされたデータのレポートまたは比較結果のレポートを作成できます。各レポートの詳細を指定できます。

例

すべて折りたたむ

プロットされた信号のレポートの作成

ライブスクリプトを開く

シミュレーションデータインスペクターの [検査] ペインでプロットされた信号に関する情報およびプロットが含まれるレポートを作成します。既定の設定では、レポートには [検査] ペインのテーブル内の信号に表示されるメタデータが含まれます。この例では、レポートに含めるメタデータを指定する方法を示します。

セッションファイルの読み込み

この例では、保存されたセッションファイルを読み込んで、シミュレーションデータインスペクターにデータおよびプロットされた信号を入力します。セッションファイルには信号データとプロットされた信号に関する情報およびプロットレイアウトが含まれます。セッションファイルを読み込みます。

Simulink.sdi.load('ex_sldemo_absbrake_slp_Ww.mldatx');

プロットされた信号のレポートの作成

レポートにはプロットされた信号のプロットおよびメタデータが含まれます。既定の設定では、レポートには [検査] ペインの信号テーブルに表示される列に対応するメタデータが含まれます。[検査] ペインにより多くの列を表示して、さらに多くのデータをレポートに含めることができます。'ColumnsToReport' の名前と値のペアおよび列挙型クラス Simulink.sdi.SignalMetaData を使用して、レポートに含める情報をプログラムで指定することもできます。

signalMetadata = [Simulink.sdi.SignalMetaData.Run, ...
    Simulink.sdi.SignalMetaData.Line, ... 
    Simulink.sdi.SignalMetaData.BlockName, ...
    Simulink.sdi.SignalMetaData.SignalName];

Simulink.sdi.report('ReportType','Inspect', 'ReportOutputFile', ...
    'absbrake_slp_report.html', 'ColumnsToReport', signalMetadata);

レポートには、プロットされた信号のメタデータのテーブルが実行別に整理されて、プロットのスナップショットの上に表示されます。

比較結果のレポートの作成

ライブスクリプトを開く

関数 Simulink.sdi.report を使用して比較結果のレポートを作成します。レポートは Web ベースの対話型であり、対話型ビューと印刷可能なビューを切り替えることができます。

比較結果の読み込み

この例では、関数 saveResult を使用して MLDATX ファイルに保存された、以前に計算された比較結果を読み込みます。データは入力フィルターのさまざまな時定数値を使用した slexAircraftExample モデルの 2 つのシミュレーションから取得されます。

Simulink.sdi.load('slexAircraftExampleTsComparison.mldatx');

比較レポートの作成

関数 Simulink.sdi.report を使用して比較結果が含まれるレポートを作成します。レポートヘッダーに表示されるレポートのタイトルと作成者を指定できます。

Simulink.sdi.report('ReportType','Compare', 'ReportTitle',...
    'Compare: Ts = 0.1 vs Ts = 1','ReportAuthor', 'Jane Smith');

レポートが生成されるとシステムブラウザーで開かれます。[プロパティ] ペインの信号のプロットとメタデータに表示される結果を確認する信号を選択します。レポート HTML ファイルは作業ディレクトリの sdireports フォルダーにあります。

入力引数

すべて折りたたむ

名前と値の引数

引数のオプションのペアを Name1=Value1,...,NameN=ValueN として指定します。Name は引数名、Value は対応する値です。名前と値の引数は他の引数の後に表示されなければなりませんが、ペアの順序は重要ではありません。

R2021a より前は、名前と値をそれぞれコンマを使って区切り、Name を引用符で囲みます。

例: 'ReportType','Compare','ShortenBlockPath',true

`ReportType` — 作成するレポートのタイプ
`'Inspect'` (既定値) | `'Compare'`

作成するレポートのタイプ。'ReportType' と 'Inspect' または 'Compare' で構成されるコンマ区切りのペアとして指定します。

'Inspect' –– シミュレーションデータインスペクターの [検査] ペインでプロットされた信号に対するプロットのスナップショットとメタデータを含むレポートを作成します。
'Compare' –– 比較結果をまとめたレポートを作成します。比較レポートは対話型であり、比較結果のプロットのスナップショットおよび比較対象の信号のメタデータを含みます。

例: 'ReportType','Compare'

`ReportTitle` — 比較レポートのヘッダーに表示されるレポートタイトル
`'Compare: <Baseline Run> vs. <Compare To Run>'` (既定値) | 文字ベクトル

比較レポートのヘッダーに表示されるレポートタイトル。'ReportTitle' と文字ベクトルで構成されるコンマ区切りのペアとして指定します。

比較レポートに対して指定できるのはレポートタイトルのみです。

例: 'ReportTitle','Trial 1 vs. Trial 2'

`ReportAuthor` — 比較レポートのヘッダーに表示されるレポート作成者
`'<username>'` (既定値) | 文字ベクトル

比較レポートのヘッダーに表示されるレポート作成者。'ReportAuthor' と文字ベクトルで構成されるコンマ区切りのペアとして指定します。

比較レポートに指定できるのはレポート作成者のみです。

例: 'ReportAuthor','John Smith'

`ReportOutputFolder` — レポートを保存するフォルダー
`'<current working folder>/sdireports'` (既定値) | `path`

レポートが保存されるフォルダー。'ReportOutputFolder' および文字ベクトルで構成されるコンマ区切りのペアとして指定します。

例: 'ReportOutputFolder','C:\Users\user1\Desktop'

`ReportOutputFile` — レポートファイル名
`'SDI_report.html'` (既定値) | 文字ベクトル

レポートのファイル名。'ReportOutputFile' および文字ベクトルで構成されるコンマ区切りのペアとして指定します。

例: 'ReportOutputFile','MyReport.html'

`PreventOverwritingFile` — レポートファイルの上書きを防ぐかどうか
`true` (既定値) | `false`

レポートファイルの上書きを防ぐかどうか。'PreventOverwritingFile' と true または false で構成されるコンマ区切りのペアとして指定します。

true はファイル上書き保護を有効にする。
false はファイル上書き保護を無効にする。

ファイル上書き保護は、レポートを生成するたびにインクリメントする数値を含むファイル名を付加することで、シミュレーションデータインスペクターによる既存ファイルの上書きを防止します。ファイル上書き保護を無効にすると、一意のファイル名を指定しない限り、シミュレーションデータインスペクターは既存のレポートファイルを上書きします。

例: 'PreventOverwritingFile',false

`ColumnsToReport` — プロットされた信号のレポートに含める信号メタデータ
配列

シミュレーションデータインスペクターの [検査] ペインでプロットされた信号のレポートに含める信号メタデータ。'ColumnsToReport' および配列で構成されるコンマ区切りのペアとして指定します。既定では、Inspect レポートには、プロットされた各信号に関するブロックパス、名前、ラインのスタイルと色およびデータソースパラメーターが含まれます。

メモ

ColumnsToReport 入力は比較レポートに影響しません。比較レポートには常にすべての信号メタデータが含まれ、比較レポートの上部の概要には常に信号名、絶対許容誤差、相対許容誤差、最大の差異、および各信号比較の結果が含まれます。

列挙型クラス Simulink.sdi.SignalMetaData を使用して、含めるメタデータを配列として指定します。たとえば、シミュレーション実行の名前と信号名を含めるには、次のようにします。

signal_metadata = [Simulink.sdi.SignalMetaData.Run,...
                    Simulink.sdi.SignalMetaData.SignalName];

次に、ColumnsToReport を名前と値のペアで signal_metadata として指定します。

Simulink.sdi.report('ColumnsToReport',signal_metadata)

次の表は、Inspect レポートで利用可能なメタデータをまとめたものです。

列の値	説明
`SignalName` (既定の設定)	信号名
`Line` (既定の設定)	信号線のスタイルと色
`SID`	自動的に割り当てられる Simulink^® 識別子
`Units`	信号の測定単位
`SigDataType`	信号のデータ型
`SigSampleTime`	信号のサンプリングに使用されるメソッド
`Model`	信号を生成したモデルの名前
`BlockName`	信号のソースブロックの名前
`BlockPath`	信号のソースブロックへのパス
`Port`	ブロックの出力端子上の信号のインデックス
`Dimensions`	信号が含まれている行列の次元
`Channel`	行列内の信号のインデックス
`Run`	信号が含まれているシミュレーション実行の名前
`AbsTol`	信号に関する絶対許容誤差
`RelTol`	信号に関する相対許容誤差
`OverrideGlobalTol`	信号の許容誤差がグローバルな許容誤差よりも優先されるかどうかを指定するプロパティ
`TimeTol`	信号に関する時間の許容誤差
`InterpMethod`	内挿法
`SyncMethod`	比較用に信号を調整するために使用される同期メソッド
`TimeSeriesRoot`	MATLAB^® ワークスペースからインポートされた信号の信号に関連付けられた変数の名前
`TimeSource`	MATLAB ワークスペースからインポートされた信号の時間データを含む配列の名前
`DataSource`	MATLAB ワークスペースからインポートされた信号の信号データを含む配列の名前

例: 'ColumnsToReport',metadata

`ShortenBlockPath` — レポート内でブロックパスを短縮化するかどうか
`true` (既定値) | `false`

レポート内でブロックパスを短縮化するかどうか。'ShortenBlockPath' と true または false で構成されるコンマ区切りのペアとして指定します。

true –– レポート内では短縮されたブロックパスを使用する。
false –– ブロックの絶対パスをレポートに含める。

例: 'ShortenBlockPath',false

`LaunchReport` — 作成時にレポートを開くかどうか
`true` (既定値) | `false`

作成時にレポートを開くかどうか。'LaunchReport' と true または false で構成されるコンマ区切りのペアとして指定します。

true –– 作成時にレポートを開く。
false –– レポートを自動的に開かない。

例: 'LaunchReport',false

`SignalsToReport` — 比較レポートに含める信号
`'ReportOnlyMismatchedSignals'` (既定値) | `'ReportAllSignals'`

比較レポートに含める信号。'SignalsToReport' と 'ReportOnlyMismatchedSignals' または 'ReportAllSignals' で構成されるコンマ区切りのペアとして指定します。

ReportOnlyMismatchedSignals –– 許容誤差から外れている比較結果をもつ信号のみを含める。
ReportAllSignals –– すべての信号を含める。

例: 'SignalsToReport','ReportAllSignals'

バージョン履歴

R2011b で導入

すべて展開する

R2020b: 無視される `ReportStyle` 入力

R2020b 以降、ReportStyle の名前と値のペアの入力は無視されます。

R2020a では、関数 Simulink.sdi.report を使用して 2 つの個別の比較レポートを作成でき、ReportStyle の名前と値のペアを使用して作成するレポートのタイプを示すことができました。

R2020b から、シミュレーションデータインスペクターで生成できるのは 1 つの比較レポートのみです。レポート内で対話型ビューと印刷可能なビューを切り替えることができます。

参考

Simulink.sdi.createRun | Simulink.sdi.compareSignals | Simulink.sdi.compareRuns | Simulink.sdi.Signal

Simulink.sdi.report

構文

説明

例

プロットされた信号のレポートの作成

比較結果のレポートの作成

入力引数

名前と値の引数

ReportType — 作成するレポートのタイプ 'Inspect' (既定値) | 'Compare'

ReportTitle — 比較レポートのヘッダーに表示されるレポート タイトル 'Compare: <Baseline Run> vs. <Compare To Run>' (既定値) | 文字ベクトル

ReportAuthor — 比較レポートのヘッダーに表示されるレポート作成者 '<username>' (既定値) | 文字ベクトル

ReportOutputFolder — レポートを保存するフォルダー '<current working folder>/sdireports' (既定値) | path

ReportOutputFile — レポート ファイル名 'SDI_report.html' (既定値) | 文字ベクトル

PreventOverwritingFile — レポート ファイルの上書きを防ぐかどうか true (既定値) | false

ColumnsToReport — プロットされた信号のレポートに含める信号メタデータ 配列

ShortenBlockPath — レポート内でブロック パスを短縮化するかどうか true (既定値) | false

LaunchReport — 作成時にレポートを開くかどうか true (既定値) | false

SignalsToReport — 比較レポートに含める信号 'ReportOnlyMismatchedSignals' (既定値) | 'ReportAllSignals'