このページの内容は最新ではありません。最新版の英語を参照するには、ここをクリックします。
Simulink.sdi.constraints.MatchesSignal クラス
名前空間: Simulink.sdi.constraints
スーパークラス: matlab.unittest.constraints.Constraint
シミュレーション データ インスペクターを使用した時系列データと許容誤差との比較を行う制約
説明
Simulink.sdi.constraints.MatchesSignal の制約を使用して、テストの一部として時系列データを想定される値と比較します。この制約を、比較のため、絶対許容誤差、相対許容誤差、時間の許容誤差の値の組わせを使用するよう構成できます。Simulink.sdi.constraints.MatchesSignalOptions オブジェクトを使用して、または 1 つ以上の名前と値のペアの引数を使用して、比較の動作を構成する追加のオプションを指定することもできます。許容誤差とアライメント オプションが比較にどのように影響するかの詳細については、シミュレーション データ インスペクターでデータを比較する方法を参照してください。
メモ
MatchesSignal 制約は、シミュレーション データ インスペクターを使用して比較を実行します。以下のいずれかの製品ライセンスが必要です。
Simulink®
Signal Processing Toolbox™
MATLAB® Coder™
Fixed-Point Designer™
プロパティ
例
この例では、Simulink.sdi.constraints.MatchesSignal 制約を使用して、ワークスペースで生成されたデータを使用した時系列データを比較する方法を示します。MatchesSignal 制約を使用して、ファイル内の測定されたテスト データやログに記録されているシミュレーション出力など、多数のソースからデータを比較します。
MatchesSignal 制約を使用する場合、絶対許容誤差、相対許容誤差、および時間許容誤差を比較で使用するよう指定できます。MatchesSignal 制約は、整列および同期のステップが含まれるシミュレーション データ インスペクターの比較アルゴリズムを使用します。アルゴリズムの詳細については、シミュレーション データ インスペクターでデータを比較する方法を参照してください。
MatchesSignal 制約は、時系列比較にシミュレーション データ インスペクターを使用します。次のいずれかの製品が必要です。
Simulink®
Signal Processing Toolbox™
MATLAB Coder™
Fixed-Point Designer™
時系列データの作成
この例では、わかりやすく説明する目的でのみ timeseries 形式でワークスペース データを生成します。MatchesSignal 制約を使用して、シミュレーション出力またはテスト データが含まれるファイルなど、その他のソースからのデータを比較できます。また、この制約はシミュレーション データ インスペクターでサポートされている任意の形式で時系列データを比較できます。
この例では、最初の信号は Wave Data という名前をもつ正弦波のデータが含まれる timeseries オブジェクトです。
time = 0:0.1:20;
sig1vals = sin(2*pi/5*time);
sig1_ts = timeseries(sig1vals,time);
sig1_ts.Name = 'Wave Data';2 つ目の信号も、わずかな減衰があり、異なるレートでサンプリングされる同じ周波数の正弦波です。MatchesSignal 制約の比較アルゴリズムには同期ステップが含まれるため、異なる時間ベクトルをもつこれら 2 つの信号を比較しても、結果が常にテスト エラーになるとは限りません。2 つ目の信号は Wave Data とも呼ばれるため、整列アルゴリズムでは、比較するために信号をペアにすることができます。
time2 = 0:0.05:20;
sig2vals = 0.98*sin(2*pi/5*time2);
sig2_ts = timeseries(sig2vals,time2);
sig2_ts.Name = 'Wave Data';テスト ケースの作成および信号の比較
この例では、わかりやすく説明する目的で対話型テストを使用します。MATLAB テスト フレームワークでその他のユニット テストのタイプをもつ MatchesSignal 制約を使用できます。たとえば、クラス ベースのユニット テストを書き込む方法については、クラスを使用する単純なテスト ケースの記述を参照してください。
対話型で使用する TestCase のインスタンスを作成します。
import matlab.unittest.TestCase
testCase = TestCase.forInteractiveUse;MatchesSignal 制約を使用して sig1_ts と sig2_ts を比較します。MatchesSignal 制約のインスタンスの想定される値に sig1_ts を使用します。
import Simulink.sdi.constraints.MatchesSignal
testCase.verifyThat(sig2_ts,MatchesSignal(sig1_ts));Verification failed.
---------------------
Framework Diagnostic:
---------------------
MatchesSignal(<Value>) failed.
--> The following aligned signals did not match:
Name ActualSignals ExpectedSignals
_________ _____________ _______________
Wave Data <Actual>.Data <Expected>.Data
Comparison results have been saved to:
--> /tmp/Bdoc25a_2843526_3412082/comparisonResults_2bee473e-d3df-4bce-bfdb-e5c0a3cc86a1.mldatx
------------------
Stack Information:
------------------
In /tmp/Bdoc25a_2843526_3412082/tpd0cc88a1/simulink-ex22803619/TestTimeSeriesDataWithTimeToleranceExample.mlx (TestTimeSeriesDataWithTimeToleranceExample) at 14
In /mathworks/devel/bat/filer/batfs2566-0/Bdoc25a.2843526/build/runnable/matlab/toolbox/matlab/codetools/embeddedoutputs/+matlab/+internal/+editor/evaluateRegions.p (evaluateRegions)
In /mathworks/devel/bat/filer/batfs2566-0/Bdoc25a.2843526/build/runnable/matlab/toolbox/matlab/codetools/embeddedoutputs/+matlab/+internal/+editor/EvaluationOutputsService.p (EvaluationOutputsService.evalRegions)
In /mathworks/devel/bat/filer/batfs2566-0/Bdoc25a.2843526/build/runnable/matlab/toolbox/matlab/codetools/+matlab/+internal/+liveeditor/@LiveEditorUtilities/doExecute.m (doExecute) at 85
In /mathworks/devel/bat/filer/batfs2566-0/Bdoc25a.2843526/build/runnable/matlab/toolbox/matlab/codetools/+matlab/+internal/+liveeditor/@LiveEditorUtilities/execute.m (execute) at 27
In /mathworks/devel/bat/filer/batfs2566-0/Bdoc25a.2843526/build/runnable/matlab/tools/examples/exampletools/+mwtools/liveCodeToDocbook.m (doRun) at 454
In /mathworks/devel/bat/filer/batfs2566-0/Bdoc25a.2843526/build/runnable/matlab/tools/examples/exampletools/+mwtools/liveCodeToDocbook.m (doRunConvert) at 369
In /mathworks/devel/bat/filer/batfs2566-0/Bdoc25a.2843526/build/runnable/matlab/tools/examples/exampletools/+mwtools/liveCodeToDocbook.m (liveCodeToDocbook) at 156
In /mathworks/devel/bat/filer/batfs2566-0/Bdoc25a.2843526/build/matlab/tools/build_using_matlab/BML.m (BML) at 13
診断情報は検証が失敗したことを示しています。テストに失敗すると、比較結果および元の実行データがシミュレーション データ インスペクターのセッション ファイルに保存されます。MLDATX ファイルのリンクをクリックしてシミュレーション データ インスペクターでセッションを開きます。ここでは、テストで比較されたデータと、その比較結果を調べることができます。結果を調べると、減衰により差動が生じ、比較の失敗の原因となることがわかります。
比較に使用する MatchesSignal 制約のインスタンスの絶対許容誤差 0.02 を指定します。
testCase.verifyThat(sig2_ts,MatchesSignal(sig1_ts,'AbsTol',0.02));Verification passed.
この例では、Simulink.sdi.constraints.MatchesSignalOptions オブジェクトを使用した Simulink.sdi.constraints.MatchesSignal 制約の比較の動作を構成する方法を示します。MatchesSignalOptions オブジェクトを使用して、MatchesSignal インスタンスの構築で単一の名前と値のペアの入力をもつ複数の比較プロパティを構成できます。
時系列データの作成
この例では、わかりやすく説明する目的でのみ、使用するワークスペース データを作成します。MatchesSignal 制約を使用して、シミュレーション出力またはテスト データが含まれるファイルなど、その他のソースからのデータを比較できます。また、この制約はシミュレーション データ インスペクターでサポートされている任意の形式で時系列データを比較できます。
この例では、最初の信号は正弦波のデータを含む Wave Data という名前の timeseries オブジェクトです。
time = 0:0.1:20;
sig1vals = sin(2*pi/5*time);
sig1_ts = timeseries(sig1vals,time);
sig1_ts.Name = 'Wave Data';2 つ目の信号も、わずかな減衰があり、異なるレートでサンプリングされる同じ周波数の正弦波です。MatchesSignal 制約の比較アルゴリズムには同期ステップが含まれるため、異なる時間ベクトルをもつこれら 2 つの信号を比較しても、結果が必ずしもテスト エラーになるとは限りません。2 番目の信号は single データ型にキャストされ、Wave Data とも呼ばれるため、整列アルゴリズムでは、比較するために信号をペアにすることができます。
time2 = 0:0.1:22;
sig2vals = single(0.98*sin(2*pi/5*time2));
sig2_ts = timeseries(sig2vals,time2);
sig2_ts.Name = 'Wave Data';MatchesSignal インスタンスの構成およびデータの比較
MatchesSignalOptions オブジェクトを使用して、MatchesSignal 制約のインスタンスがデータ型の不一致などの条件を処理する方法と、実際のデータセットと想定されるデータセットとの間で信号が整列される方法を指定できます。書き込むテストに合わせて MatchesSignalOptions オブジェクトのプロパティを指定できます。たとえば、テストでさまざまな型のデータを比較し、データ型の一致が機能的に関連しない場合、IgnoreDataTypes プロパティを true に設定することもできます。
MatchesSignalOptions オブジェクトを作成して、データ型の不一致や、実際の信号と想定される信号が共有する時間間隔外のデータ サンプルを無視する MatchesSignal インスタンスを作成します。
import Simulink.sdi.constraints.MatchesSignalOptions opts = MatchesSignalOptions('IgnoringDataTypes',true,'IgnoringExtraData',true);
対話型で使用する TestCase インスタンスを作成し、MatchesSignal 制約、MatchesSignalOptions オブジェクト、0.02 の絶対許容誤差を使用して、sig1_ts と sig2_ts を比較します。
import matlab.unittest.TestCase testCase = TestCase.forInteractiveUse; import Simulink.sdi.constraints.MatchesSignal testCase.verifyThat(sig2_ts,MatchesSignal(sig1_ts,'AbsTol',0.02,'WithOptions',opts))
Verification passed.
テストにパスします。MatchesSignalOptions オブジェクトで定義されたオプションなしで、同じテストを再実行すると、データ型の不一致が原因でテストは失敗します。
testCase.verifyThat(sig2_ts,MatchesSignal(sig1_ts,'AbsTol',0.02))Verification failed.
---------------------
Framework Diagnostic:
---------------------
MatchesSignal(<Value>,'AbsTol',0.02) failed.
--> Data types do not match for the following aligned signals:
Name ActualSignals ActualDataType ExpectedSignals ExpectedDataType
_________ _____________ ______________ _______________ ________________
Wave Data <Actual>.Data single <Expected>.Data double
------------------
Stack Information:
------------------
In /tmp/Bdoc25a_2843526_3415440/tpe86ef97c/simulink-ex71177165/ConfigureMatchesSignalConstraintBehaviorExample.mlx (ConfigureMatchesSignalConstraintBehaviorExample) at 16
In /mathworks/devel/bat/filer/batfs2566-0/Bdoc25a.2843526/build/runnable/matlab/toolbox/matlab/codetools/embeddedoutputs/+matlab/+internal/+editor/evaluateRegions.p (evaluateRegions)
In /mathworks/devel/bat/filer/batfs2566-0/Bdoc25a.2843526/build/runnable/matlab/toolbox/matlab/codetools/embeddedoutputs/+matlab/+internal/+editor/EvaluationOutputsService.p (EvaluationOutputsService.evalRegions)
In /mathworks/devel/bat/filer/batfs2566-0/Bdoc25a.2843526/build/runnable/matlab/toolbox/matlab/codetools/+matlab/+internal/+liveeditor/@LiveEditorUtilities/doExecute.m (doExecute) at 85
In /mathworks/devel/bat/filer/batfs2566-0/Bdoc25a.2843526/build/runnable/matlab/toolbox/matlab/codetools/+matlab/+internal/+liveeditor/@LiveEditorUtilities/execute.m (execute) at 27
In /mathworks/devel/bat/filer/batfs2566-0/Bdoc25a.2843526/build/runnable/matlab/tools/examples/exampletools/+mwtools/liveCodeToDocbook.m (doRun) at 454
In /mathworks/devel/bat/filer/batfs2566-0/Bdoc25a.2843526/build/runnable/matlab/tools/examples/exampletools/+mwtools/liveCodeToDocbook.m (doRunConvert) at 369
In /mathworks/devel/bat/filer/batfs2566-0/Bdoc25a.2843526/build/runnable/matlab/tools/examples/exampletools/+mwtools/liveCodeToDocbook.m (liveCodeToDocbook) at 156
In /mathworks/devel/bat/filer/batfs2566-0/Bdoc25a.2843526/build/matlab/tools/build_using_matlab/BML.m (BML) at 13
