Документация Engee

rms

Среднеквадратичное значение.

Библиотека

EngeeDSP

Синтаксис

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

  • y = rms(x) — возвращает среднеквадратичное значение входного сигнала x.

    • Если x — вектор-строка или вектор-столбец, то y — вещественный скаляр.

    • Если x — матрица, то y — вектор-строка, содержащий среднеквадратичное значение для каждого столбца.

    • Если x — многомерный массив, то y содержит среднеквадратичное значение, вычисленное по первому измерению массива, размер которого не равен 1. Размер y в этом измерении равен 1, в то время как размеры всех остальных измерений остаются такими же, как у x.

  • y = rms(x, "all") — возвращает среднеквадратичное значение всех элементов в x.

  • y = rms(x, dim) — действует по размерности dim. Например, если x — матрица, то rms(x, 2) действует на элементы каждой строки и возвращает вектор-столбец, содержащий среднеквадратичное значение каждой строки.

  • y = rms(___, nanflag) — также задает, как обрабатывать значения NaN в x для любого из предыдущих синтаксисов. Например, rms(x, "omitnan") игнорирует значения NaN при вычислении среднеквадратичного значения. По умолчанию функция rms учитывает значения NaN.

Аргументы

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

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

Details

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

Типы данных

Float32, Float64

Поддержка комплексных чисел

Да

# dim — измерение, по которому выполняется операция
скаляр

Details

Измерение, по которому выполняется операция, заданное как положительный целочисленный скаляр. По умолчанию функция rms работает с первым измерением массива x размерностью больше 1.

Аргумент dim указывает измерение, длина которого уменьшается до 1. Размер size(y, dim) равен 1, в то время как размеры всех остальных измерений остаются такими же, как у x.

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

  • y = rms(x, 1) вычисляет среднеквадратичное значение элементов в каждом столбце матрицы x и возвращает вектор-строку размером 1 на .

  • y = rms(x, 2) вычисляет среднеквадратичное значение элементов в каждой строке матрицы x и возвращает вектор-столбец размером на 1.

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

Details

Условие отсутствия значения, заданное как:

  • "includemissing" или "includenan" — функция учитывает значения NaN в x при вычислении среднеквадратичного значения. Если какой-либо элемент в рабочем измерении — NaN, то соответствующие элементы в yNaN. Значения "includemissing" и "includenan" ведут себя одинаково.

  • "omitmissing" или "omitnan" — функция игнорирует значения NaN в x при вычислении среднеквадратичного значения. Если все элементы в рабочем измерении — NaN, то соответствующие элементы в yNaN. Значения "omitmissing" и "omitnan" ведут себя одинаково.

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

# y — среднеквадратичное значение
скаляр | вектор | матрица

Details

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

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

Среднеквадратичное значение

Details

Среднеквадратичное значение (RMS) определяется как

с суммированием по заданному измерению.

Литература

  1. IEEE® Standard on Transitions, Pulses, and Related Waveforms, IEEE Standard 181, 2003.