franc.evaluation.common

Shared functionality for all other modules

Functions

total_power(a)	calculate the total power of a signal (square or RMS)
rms(a)	Calculate the root mean square value of an array

Module Contents

franc.evaluation.common.total_power(a)

calculate the total power of a signal (square or RMS)

>>> import franc, numpy
>>> signal = numpy.ones(10) * 2
>>> franc.evaluation.total_power(signal)
4.0

Parameters:

a (collections.abc.Sequence[float] | numpy.typing.NDArray[numpy.floating]) –

Return type:

float

franc.evaluation.common.rms(a)

Calculate the root mean square value of an array

Parameters:

a (collections.abc.Sequence[float] | numpy.typing.NDArray[numpy.floating]) –

Return type:

float