Main Content

movsum

移動合計値

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

構文

M = movsum(A,k)
M = movsum(A,[kb kf])
M = movsum(___,dim)
M = movsum(___,nanflag)
M = movsum(___,Name,Value)

説明

例

M = movsum(A,k) は局所 k 点における合計値の配列を返します。各合計値は、長さ k のスライディング ウィンドウにわたる A の隣接要素から計算されます。k が奇数である場合、ウィンドウは現在位置にある要素を中心にして配置されます。k が偶数である場合、ウィンドウは現在の要素および直前の要素を中心にして配置されます。ウィンドウを埋めるのに十分な数の要素がない場合、ウィンドウ サイズは自動的に端点で打ち切られます。ウィンドウが打ち切られた場合、合計値はウィンドウを埋めている要素のみから取得されます。M は A と同じサイズです。

  • A がベクトルである場合、movsum はベクトル A の長さに沿って演算します。

  • A が多次元配列の場合、movsum は、サイズが 1 に等しくない A の最初の次元に沿って演算します。

例

M = movsum(A,[kb kf]) は長さが kb+kf+1 のウィンドウにおける合計値を計算します。このウィンドウには現在位置の要素、kb 個前までの要素、kf 個後までの要素が含まれます。

例

M = movsum(___,dim) は、前述の任意の構文について、演算の対象とする A の次元を指定します。たとえば、A が行列である場合、movsum(A,k,2) は A の列に沿って動作し、各行の k 個の要素の移動合計値を計算します。

例

M = movsum(___,nanflag) は、前述の任意の構文について NaN 値を計算に含めるか省略するかを指定します。movsum(A,k,'includenan') はすべての NaN 値を計算に含め、movsum(A,k,'omitnan') はこれらを無視するため、より少ない点で合計値を計算します。

例

M = movsum(___,Name,Value) は、名前と値のペアの引数を 1 つ以上使用して合計値に追加のパラメーターを指定します。たとえば、x が時間ベクトルである場合、movsum(A,k,'SamplePoints',x) は x を基準として A の移動合計値を計算します。

例

すべて折りたたむ

ライブ スクリプトを開く

行ベクトルの 3 点の中心移動合計値を計算します。端点でウィンドウ内の要素数が 3 より少ない場合、使用可能な要素の合計値を取得します。

A = [4 8 6 -1 -2 -3 -1 3 4 5];
M = movsum(A,3)
M = 1×10

    12    18    13     3    -6    -6    -1     6    12     9
ライブ スクリプトを開く

行ベクトルの 3 点の末尾移動合計値を計算します。端点でウィンドウ内の要素数が 3 より少ない場合、movsum は使用可能な要素の合計値を取得します。

A = [4 8 6 -1 -2 -3 -1 3 4 5];
M = movsum(A,[2 0])
M = 1×10

     4    12    18    13     3    -6    -6    -1     6    12
ライブ スクリプトを開く

行列の各行に対して 3 点の中心移動合計値を計算します。ウィンドウは最初の行で始まり、行の終わりまで横方向にスライドし、それから 2 行目に移動して同様に繰り返します。次元引数は 2 であるため、ウィンドウは A の列を横断する方向にスライドします。

A = [4 8 6; -1 -2 -3; -1 3 4]
A = 3×3

     4     8     6
    -1    -2    -3
    -1     3     4


M = movsum(A,3,2)
M = 3×3

    12    18    14
    -3    -6    -5
     2     6     7
ライブ スクリプトを開く

NaN 要素を 2 つ含む行ベクトルの 3 点の中心移動合計値を計算します。

A = [4 8 NaN -1 -2 -3 NaN 3 4 5];
M = movsum(A,3)
M = 1×10

    12   NaN   NaN   NaN    -6   NaN   NaN   NaN    12     9

NaN 値を除外して合計値を再計算します。movsum が NaN 要素を破棄する場合、ウィンドウ内の残りの要素から合計値が取得されます。

M = movsum(A,3,'omitnan')
M = 1×10

    12    12     7    -3    -6    -5     0     7    12     9
ライブ スクリプトを開く

時間ベクトル t に従って、A のデータの 3 時間中心移動合計値を計算します。 

A = [4 8 6 -1 -2 -3];
k = hours(3);
t = datetime(16,1,1,0,0,0) + hours(0:5)
t = 1x6 datetime
Columns 1 through 3

   01-Jan-0016 00:00:00   01-Jan-0016 01:00:00   01-Jan-0016 02:00:00

Columns 4 through 6

   01-Jan-0016 03:00:00   01-Jan-0016 04:00:00   01-Jan-0016 05:00:00


M = movsum(A,k,'SamplePoints',t)
M = 1×6

    12    18    13     3    -6    -5
ライブ スクリプトを開く

行ベクトルの 3 点の中心移動合計値を計算しますが、使用する要素が 3 点より少ない計算を出力から破棄します。言い換えれば、3 要素をすべて含むウィンドウから計算された合計値のみを返し、端点での計算を破棄します。

A = [4 8 6 -1 -2 -3 -1 3 4 5];
M = movsum(A,3,'Endpoints','discard')
M = 1×8

    18    13     3    -6    -6    -1     6    12

入力引数

すべて折りたたむ

入力配列。ベクトル、行列または多次元配列として指定します。

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

ウィンドウの長さ。数値または duration スカラーとして指定します。k が正の整数値スカラーである場合、中心合計値には現在位置の要素とその周囲の要素が含まれます。

たとえば、movsum(A,3) は局所 3 点における合計値の配列を計算します。

movsum(A,3) computation. The elements in the sample window are 1, 3, and 5, so the resulting local sum is 9.

方向指定ウィンドウの長さ。2 つの要素を含む数値または duration 行ベクトルとして指定します。kb と kf が正の整数値スカラーの場合、計算は kb+kf+1 個の要素に対して行われます。この計算には、現在位置にある要素、その前にある kb 個の要素、その後にある kf 個の要素が含まれます。

たとえば、movsum(A,[2 1]) は局所 4 点における合計値の配列を計算します。

movsum(A,[2 1]) computation. The elements in the sample window are 4, 1, 3, and 5, so the resulting local sum is 13.

演算の対象の次元。正の整数のスカラーとして指定します。次元を指定しない場合、既定値はサイズが 1 より大きい最初の配列次元です。

次元 dim は movsum が沿って動作する次元、つまり指定されたウィンドウがスライドする方向を示します。

m 行 n 列の入力行列 A を考えます。

  • movsum(A,k,1) は、A の各列について k 要素の移動合計値を計算し、m 行 n 列の行列を返します。

    movsum(A,k,1) column-wise operation

  • movsum(A,k,2) は、A の各行について k 要素の移動合計値を計算し、m 行 n 列の行列を返します。

    movsum(A,k,2) row-wise operation

NaN の条件。次の値のいずれかとして指定します。

  • 'includenan' — 和の計算に NaN 値を含めます。結果は NaN になります。

  • 'omitnan' — 入力にあるすべての NaN 値を無視します。ウィンドウに NaN 値しか含まれていない場合、movsum は 0 を返します。

名前と値の引数

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

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

例: M = movsum(A,k,'Endpoints','fill')

先頭および末尾のウィンドウを処理する方法。次のいずれかのオプションとして指定します。

'Endpoints' 値説明
'shrink'入力の端点付近のウィンドウのサイズを縮小し、既存の要素のみを含めます。
'discard'既存な要素とウィンドウが完全にオーバーラップしない場合、合計値を出力しません。
'fill'存在しない要素を NaN に置き換えます。
数値または論理スカラー存在しない要素を指定した数値または論理値に置き換えます。

合計値を計算するためのサンプル点。ベクトルとして指定します。サンプル点は A のデータの位置を表します。サンプル点は等間隔でサンプリングされている必要はありません。既定では、サンプル点ベクトルは [1 2 3 ... ] です。

移動ウィンドウはサンプル点を基準として定義されます。サンプル点は並べ替えられていなければならず、また一意の要素を含んでいなければなりません。たとえば、t が入力データに対応する時間のベクトルである場合、movsum(rand(1,10),3,'SamplePoints',t) には t(i)-1.5 から t(i)+1.5 までの時間間隔を表すウィンドウがあります。

サンプル点ベクトルのデータ型が datetime または duration である場合、移動ウィンドウの長さの型は duration でなければなりません。

サンプル点の間隔が不均一で、'Endpoints' の名前と値のペアを指定する場合、値は 'shrink' でなければなりません。

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

拡張機能

バージョン履歴

R2016a で導入

参考

| | | | |