nk 1.0.0
C++ Numerical Computing Runtime
Loading...
Searching...
No Matches
signal_stats.hpp
Go to the documentation of this file.
1
3// toolboxes/signal/include/nk/signal/measurements/signal_stats.hpp
4//
5// Signal-side reductions: rms, rssq, peak2peak, peak2rms.
6
7#pragma once
8
9#include <memory_resource>
10#include <nk/value/value.hpp>
11
12namespace nk::signal {
13
16
17
29Value rms(const Value & x,
30 int dim = 0,
31 std::pmr::memory_resource * mr = nullptr);
32
43Value rssq(const Value & x,
44 int dim = 0,
45 std::pmr::memory_resource * mr = nullptr);
46
56Value peak2peak(const Value & x,
57 int dim = 0,
58 std::pmr::memory_resource * mr = nullptr);
59
71Value peak2rms(const Value & x,
72 int dim = 0,
73 std::pmr::memory_resource * mr = nullptr);
74
75
77} // namespace nk::signal
nk::Value
Core MATLAB-compatible multidimensional array and scalar value type.
Definition value.hpp:61
nk::signal::peak2peak
Value peak2peak(const Value &x, int dim=0, std::pmr::memory_resource *mr=nullptr)
Peak-to-peak amplitude along a dimension.
nk::signal::peak2rms
Value peak2rms(const Value &x, int dim=0, std::pmr::memory_resource *mr=nullptr)
Peak-to-RMS ratio along a dimension.
nk::signal::rssq
Value rssq(const Value &x, int dim=0, std::pmr::memory_resource *mr=nullptr)
Root-sum-of-squares along a dimension.
nk::signal::rms
Value rms(const Value &x, int dim=0, std::pmr::memory_resource *mr=nullptr)
Root-mean-square along a dimension.