pulse_metrics.hpp

Go to the documentation of this file.

// toolboxes/signal/include/nk/signal/measurements/pulse_metrics.hpp
//
// Pulse and transition metrics for digital / step-shaped time-series.
// The pulse-metric family: `risetime / falltime / overshoot /
// undershoot / settlingtime / dutycycle / midcross / pulsewidth /
// pulseperiod / pulsesep / slewrate / statelevels` family.
//
// Conventions:
//   * `x` is a real, sampled time-series (1-D vector).
//   * `fs` is the sample rate in Hz. `Value::Empty` (default) → fs = 1,
//     so samples are the time unit. When supplied, returned times are in
//     seconds.
//   * Reference levels come from `statelevels(x)` unless explicit levels
//     are supplied. State boundaries use the canonical defaults:
//     10% / 90% for rise / fall, 50% for mid-state, 2% for "settled".
//   * Outputs are column vectors; empty when no transition / pulse found.
 
#pragma once
 
#include <memory_resource>
#include <nk/value/value.hpp>
 
namespace nk::signal {

 

Value statelevels(const Value &                x,
                  std::pmr::memory_resource *  mr = nullptr);

Value midcross(const Value &                x,
               const Value &                fs = Value::Empty,
               std::pmr::memory_resource *  mr = nullptr);

Value risetime(const Value &                x,
               const Value &                fs = Value::Empty,
               std::pmr::memory_resource *  mr = nullptr);

Value falltime(const Value &x, const Value &fs = Value::Empty,
               std::pmr::memory_resource *mr = nullptr);

Value slewrate(const Value &                x,
               const Value &                fs = Value::Empty,
               std::pmr::memory_resource *  mr = nullptr);

Value overshoot(const Value &x, const Value &fs = Value::Empty,
                std::pmr::memory_resource *mr = nullptr);

Value undershoot(const Value &x, const Value &fs = Value::Empty,
                 std::pmr::memory_resource *mr = nullptr);

Value settlingtime(const Value &                x,
                   const Value &                fs = Value::Empty,
                   double                       tol = 0.02,
                   std::pmr::memory_resource *  mr  = nullptr);

Value pulsewidth(const Value &                x,
                 const Value &                fs = Value::Empty,
                 std::pmr::memory_resource *  mr = nullptr);

Value pulseperiod(const Value &x, const Value &fs = Value::Empty,
                  std::pmr::memory_resource *mr = nullptr);

Value pulsesep(const Value &x, const Value &fs = Value::Empty,
               std::pmr::memory_resource *mr = nullptr);

Value dutycycle(const Value &                x,
                const Value &                fs = Value::Empty,
                std::pmr::memory_resource *  mr = nullptr);
 

} // namespace nk::signal