movmad

Скользящее среднее абсолютное отклонение.

Библиотека

EngeeDSP

Синтаксис

Вызов функции

M = movmad(A,k) — возвращает локальные средние абсолютные отклонения (Median Absolute Deviation, MAD) по k точкам, где каждое среднее (абсолютное) отклонение вычисляется в скользящем окне длины k, которое перемещается по соседним элементам массива A. M имеет тот же размер, что и A.

Если k нечетное, окно центрируется относительно элемента в текущей позиции. Если k четное, окно центрируется относительно текущего и предыдущего элементов. Размер окна автоматически усекается в конечных точках, когда элементов недостаточно для его заполнения. При усечении окна среднее отклонение берется только для элементов, заполняющих окно.
- Если A — вектор, то movmad действует по длине вектора A.
- Если A — многомерный массив, то movmad действует по первому измерению A, размер которого не равен 1.

M = movmad(A,[kb kf]) — вычисляет среднее отклонение с окном длины kb+kf+1, которое включает элемент в текущей позиции, kb элементов назад и kf элементов вперед.

M = movmad(___,dim) — определяет размерность матрицы A, по которой выполняется операция для любого из предыдущих вариантов синтаксиса. Например, movmad(A,k,2) для матрицы A выполняет операцию по столбцам матрицы A, вычисляя скользящее среднее отклонение по k элементам для каждой строки.

M = movmad(___,nanflag) — определяет, следует ли включать или исключать значения NaN в массив A. Например, movmad(A,k,"omitnan") игнорирует значения NaN при вычислении каждого среднего отклонения. По умолчанию movmad включает значения NaN.

M = movmad(___,Name,Value) — задает дополнительные параметры скользящего среднего отклонения, используя один или несколько аргументов типа «имя-значение».

Аргументы

Входные аргументы

# A — входные данные
вектор | матрица | многомерный массив

Details

Входные данные, заданные как вектор, матрица или многомерный массив.

Типы данных

Float32, Float64, Int8, Int16, Int32, Int64, UInt8, UInt16, UInt32, UInt64, Bool

# k — длина окна
скаляр

Details

Длина окна, заданная как скаляр. Если k — положительное целое число, центрированное среднее абсолютное значение включает элемент в текущей позиции и его соседей.

Например, movmad(A,3) вычисляет массив значений локального трехточечного среднего отклонения.

movmad 1

# [kb kf] — длина направленного окна
двухэлементный вектор-строка

Details

Длина направленного окна, заданная как вектор-строка, содержащий два элемента. Если kb и kf — положительные целые числа, вычисление выполняется по kb+kf+1 элементам. Вычисление включает элемент в текущей позиции, kb элементов до текущей позиции и kf элементов после текущей позиции.

Например, movmad(A,[2 1]) вычисляет массив значений локального четырехточечного среднего отклонения.

movmad 2

# dim — измерение, вдоль которого выполняется операция
положительный целочисленный скаляр

Details

Измерение, вдоль которой выполняется операция, задается как положительный целочисленный скаляр. Если измерение не указано, по умолчанию используется первое измерение массива, размер которого не равен 1.

Рассмотрим входную матрицу A размером m на n:

movmad(A,k,1) вычисляет скользящее среднее отклонение по k элементам для каждого столбца A и возвращает матрицу размером m на n.
movmad(A,k,2) вычисляет скользящее среднее отклонение по k элементам для каждой строки матрицы A и возвращает матрицу размером m на n.

# nanflag — условие пропущенного значения
"includemissing" (по умолчанию) | "includenan" | "omitmissing" | "omitnan"

Details

Условие обработки пропущенного значения, заданное одним из следующих значений:

"includemissing" или "includenan" — включить значения NaN в A при вычислении каждого среднего отклонения. Если какой-либо элемент в окне — NaN, то соответствующий элемент в M — NaN. Значения "includemissing" и "includenan" ведут себя одинаково.
"omitmissing" или "omitnan" — игнорировать все значения NaN в A и вычислять каждое среднее отклонение по меньшему количеству точек. Если все элементы в окне — NaN, то соответствующий элемент в M — NaN. Значения "omitmissing" и "omitnan" ведут себя одинаково.

Входные аргументы «имя-значение»

Укажите необязательные пары аргументов в формате Name, Value, где Name — имя аргумента, а Value — соответствующее значение. Аргументы типа «имя-значение» должны располагаться после других аргументов, но порядок пар не имеет значения.

Используйте запятые для разделения имени и значения, а Name заключите в кавычки.

Пример: M = movmad(A,k,"Endpoints","fill").

# Endpoints — метод обработки окон вблизи конечных точек
"shrink" (по умолчанию) | "discard" | "fill" | скаляр

Details

Метод обработки окон вблизи конечных точек, заданный одним из следующих вариантов:

Значение Описание

Значение	Описание
`"shrink"`	Уменьшить размер окна вблизи конечных точек входных данных, чтобы включить только существующие элементы.
`"discard"`	Не выводить никакие значения среднего абсолютного отклонения, если окно не полностью перекрывает существующие элементы.
`"fill"`	Заменить несуществующие элементы на `NaN`.
`скаляр`	Заменить несуществующие элементы указанным числовым или логическим значением.

"shrink"

Уменьшить размер окна вблизи конечных точек входных данных, чтобы включить только существующие элементы.

"discard"

Не выводить никакие значения среднего абсолютного отклонения, если окно не полностью перекрывает существующие элементы.

"fill"

Заменить несуществующие элементы на NaN.

скаляр

Заменить несуществующие элементы указанным числовым или логическим значением.

Выходные аргументы

# M — выходные данные
вектор | матрица | многомерный массив

Details

Выходные данные, возвращаемые в виде вектора, матрицы или многомерного массива.

Примеры

Центрированное скользящее среднее отклонение вектора

Details

Вычислим трехточечное центрированное скользящее среднее отклонение вектора-строки. Если в окне на концах массива меньше трех элементов, вычисление выполняется по доступным элементам.

import EngeeDSP.Functions: movmad

A = [1 2 4 -1 -2 -3 -1 3 2 1]
M = movmad(A, 3)

1×10 Matrix{Float64}:
 0.5  1.0  2.0  1.0  1.0  1.0  2.0  1.0  1.0  0.5

Скользящее среднее отклонение матрицы

Details

Вычислим трехточечное центрированное скользящее среднее отклонение для каждой строки матрицы. Аргумент размерности равен двум, что позволяет скользить по столбцам матрицы A. Окно начинается с первой строки, скользит горизонтально до конца строки, затем перемещается ко второй строке и так далее.

A = [1 2 1; -1 -2 -3; -1 3 4]

3×3 Matrix{Int64}:
  1   2   1
 -1  -2  -3
 -1   3   4

import EngeeDSP.Functions: movmad

M = movmad(A, 3, 2)

3×3 Matrix{Float64}:
 0.5  0.0  0.5
 0.5  1.0  0.5
 2.0  1.0  0.5

Скользящее среднее отклонение без учета пропущенных значений

Details

Создадим вектор-строку, содержащую значения NaN.

A = [4 8 NaN -1 -2 -3 NaN 3 4 5];

Вычислим трехточечное центрированное скользящее среднее отклонение вектора, исключая значения NaN. Для окон, содержащих любое значение NaN, функция movmad вычисляет значение с учетом всех элементов, кроме NaN.

import EngeeDSP.Functions: movmad

M = movmad(A, 3, "omitnan")

1×10 Matrix{Float64}:
 2.0  2.0  4.5  0.5  1.0  0.5  3.0  0.5  1.0  0.5

Возврат только средних отклонений полного окна

Details

Вычислим трехточечное центрированное скользящее среднее отклонение вектора-строки, но отбросим все вычисления, использующие менее трех точек из выходных данных. Другими словами, вернем только средние отклонения, вычисленные для полного трехэлементного окна, отбросив вычисления в конечных точках.

import EngeeDSP.Functions: movmad

A = [1 2 1 -1 -2 -3 -1 3 4 1];
M = movmad(A, 3, "Endpoints", "discard")

1×8 Matrix{Float64}:
 0.0  1.0  1.0  1.0  1.0  2.0  1.0  1.0

Дополнительно

Среднее абсолютное отклонение

Details

Для вектора конечной длины, состоящего из скалярных наблюдений, среднее абсолютное отклонение определяется как

при .