最新のリリースでは、このページがまだ翻訳されていません。 このページの最新版は英語でご覧になれます。

dsp.RMS

(削除予定) ベクトル要素の平方根平均二乗

説明

dsp.RMS オブジェクトは平方根平均二乗 (RMS) 値を計算します。

メモ

dsp.RMS System object™ は将来のリリースで削除される予定です。RMS を計算するには、関数 rms を使用します。移動 RMS を MATLAB® で計算するには、dsp.MovingRMS オブジェクトを使用します。詳細については、互換性の考慮事項を参照してください。

入力の RMS 値を計算するには、次のようにします。

  1. dsp.RMS オブジェクトを作成し、そのプロパティを設定します。

  2. 関数と同様に、引数を指定してオブジェクトを呼び出します。

System object の機能の詳細については、System object とは (MATLAB)を参照してください。

作成

説明

rms = dsp.RMS は、入力または入力のシーケンスの平方根平均二乗 (RMS) を指定した Dimension に沿って計算する System object、rms を返します。

rms = dsp.RMS(Name,Value) は、指定の各プロパティが指定の値に設定された RMS System object、rms を返します。

プロパティ

すべて展開する

特に指定がない限り、プロパティは "調整不可能" です。つまり、オブジェクトの呼び出し後に値を変更することはできません。オブジェクトは呼び出すとロックされ、ロックを解除するには関数 release を使用します。

プロパティが "調整可能" の場合、その値をいつでも変更できます。

プロパティ値の変更の詳細については、System object を使用した MATLAB でのシステム設計 (MATLAB)を参照してください。

このプロパティを true に設定して、オブジェクト アルゴリズムへの連続する呼び出しで RMS を計算できるようにします。

このプロパティを true に設定して、実行 RMS をリセットできるようにします。プロパティが true に設定されている場合、実行 RMS をリセットするにはオブジェクト アルゴリズムへのリセット入力を指定しなければなりません。

依存関係

このプロパティは、RunningRMS プロパティを true に設定した場合に適用されます。

実行 RMS をリセットするイベントを Rising edge Falling edgeEither edge または Non-zero のいずれかとして設定します。Non-zero は非ゼロ サンプルが取得されるたびに実行 RMS をリセットします。エッジの立ち上がりと立ち下がりの定義については、立ち上がりエッジと立ち下がりエッジを参照してください。

依存関係

このプロパティは、ResetInputPortプロパティを true に設定した場合に適用されます。

RMS を計算する対象の次元を AllRowColumn または Custom のいずれかとして指定します。Dimension プロパティを All に指定すると、入力全体に対する RMS 値が計算されます。

依存関係

このプロパティは、RunningRMS プロパティを false に設定した場合にのみ適用されます。

RMS を計算する対象となる入力信号の次元 (1 ベースのスカラー整数値) を指定します。入力信号の次元数を超えることはできません。

依存関係

このプロパティは、Dimensionプロパティを Custom に設定した場合に適用されます。

データ型: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

使用法

説明

y = rms(x) は、入力ベクトル x の平方根平均二乗 (RMS) 出力 y を計算します。RunningRMS プロパティが true である場合、y はオブジェクト アルゴリズムへの連続する呼び出しで入力要素の RMS に対応します。

y = rms(x,r) は、r の値、リセット信号、ResetCondition プロパティに基づいて実行 RMS の状態をリセットします。この計算は、RunningRMS プロパティと ResetInputPort プロパティの両方を true に設定した場合に使用できます。

入力引数

すべて展開する

データ入力。ベクトルまたは行列として指定します。x が行列の場合、各列が個別のチャネルとして扱われます。RMS は各チャネルに沿って計算されます。オブジェクトは可変サイズの入力も受け入れます。オブジェクトがロックされると、各入力チャネルのサイズを変更できます。

データ型: single | double
複素数のサポート: あり

実行 RMS のリセットに使用されるリセット信号。スカラー値として指定します。オブジェクトは、リセット信号が ResetCondition を満たす場合に実行 RMS をリセットします。

依存関係

この信号を有効にするには、RunningRMS プロパティを trueResetInputPort プロパティを true に設定します。

データ型: single | double | int8 | int16 | int32 | uint8 | uint16 | uint32 | logical

出力引数

すべて展開する

RMS 出力。スカラー、ベクトルまたは行列として返されます。RunningRMS の設定について以下に示します。

  • false –– オブジェクトは各入力チャネルの RMS 値を計算します。入力が列ベクトルである場合、出力はスカラーになります。入力がマルチチャネル信号である場合、出力信号は 1 行 N 列のベクトルです。ここで、N は入力チャネルの数です。

  • true –– オブジェクトは信号の実行 RMS を計算します。出力信号のサイズは入力信号のサイズと一致します。

データ型: single | double
複素数のサポート: あり

オブジェクト関数

オブジェクト関数を使用するには、System object を最初の入力引数として指定します。たとえば、obj という名前の System object のシステム リソースを解放するには、次の構文を使用します。

release(obj)

すべて展開する

stepSystem object のアルゴリズムの実行
releaseリソースを解放し、System object のプロパティ値と入力特性の変更を可能にします。
resetSystem object の内部状態のリセット

行列入力の RMS 値

メモ: R2016a 以前のリリースを使用している場合、それぞれのオブジェクトの呼び出しを等価な step 構文で置き換えてください。たとえば、obj(x)step(obj,x) になります。

Dimension プロパティを 'All' に設定して行列の RMS 値を計算します。

in2 = magic(4);
rms2d = dsp.RMS;
rms2d.Dimension = 'All';
y_rms2 = rms2d(in2)
y_rms2 = 9.6695

出力は、4 行 4 列の行列の形状を 16 行 1 列または 1 行 16 列のベクトルに変更してベクトルの RMS 値を計算することと等価です。

詳細

すべて展開する

アルゴリズム

このオブジェクトは、RMS ブロックのリファレンス ページで説明されているアルゴリズム、入力、および出力を実装しています。オブジェクト プロパティは Simulink® ブロック パラメーターに対応しますが、以下の場合を除きます。

  • [サンプルベースの行入力を列として処理] ブロック パラメーターは dsp.RMS オブジェクトでサポートされません。

  • [リセット端子] ブロック パラメーターは ResetCondition オブジェクト プロパティと ResetInputPort オブジェクト プロパティの両方に対応します。

互換性の考慮事項

すべて展開する

R2019b での開始で警告

拡張機能

R2012a で導入