isce3::math::Stats< T > Struct Template Reference

Statistics struct. More...

#include <Stats.h>

Public Types
using	type = T
	Expected element type of input data.
using	T_real = typename isce3::real<T>::type

Public Member Functions
T_real	sample_stddev () const
void	update (const Stats< T > &other)
	Update statistics with independent data using Chan's method.
void	update (const T &value)
	Accumulate a data point using Welford's online algorithm.
void	update (const T *values, size_t size, size_t stride=1)
	Calculate stats of a new block of data using Welford's algorithm and update current estimate with Chan's method.
	Stats (const T *values, size_t size, size_t stride=1)
	Initialize stats from block of data.

Public Attributes
T	min = std::numeric_limits<T_real>::quiet_NaN()
T	max = std::numeric_limits<T_real>::quiet_NaN()
T	mean = 0
long long	n_valid = 0

Detailed Description

template<class T>
struct isce3::math::Stats< T >

Statistics struct.

For complex T, min and max are complex but they are selected using the elements' magnitudes. The sample standard deviation is real-valued calculated using the elements' magnitudes.

---

The documentation for this struct was generated from the following files:

• /home/runner/work/isce3/isce3/cxx/isce3/math/Stats.h
• /home/runner/work/isce3/isce3/cxx/isce3/math/Stats.cpp