class::dsp::SignalQ15

class dsp::SignalQ15
  : public dsp::SignalData< SignalQ15, q15_t, q63_t >

This class holds signal data in the q1.15 fixed-point format.

Summary

[SignalQ15](#classdsp_1_1_signal_q15_1a2844728521882017f0d113cb7a578ab4)(  

const arg::Count count
)

[SignalQ15](#classdsp_1_1_signal_q15_1a386bd7690f09e766bb9b4c2dda38e3a4)()

virtual SignalQ15 abs() const

void abs(

SignalQ15 & output
) const

SignalQ15 add(

q15_t offset_value
) const

virtual SignalQ15 add(

const SignalQ15 & a
) const

SignalQ15 & add_assign(

q15_t offset_value
)

virtual SignalQ15 & add_assign(

const SignalQ15 & a
)

SignalQ15 convolve(

const SignalQ15 & a
) const

void convolve(

SignalQ15 & output,
const SignalQ15 & a
) const

q63_t dot_product(

const SignalQ15 & a
) const

SignalQ15 filter(

const FirFilterQ15 & filter
) const

void filter(

SignalQ15 & output,
const FirFilterQ15 & filter
) const

SignalQ15 filter(

const BiquadFilterQ15 & filter
) const

void filter(

SignalQ15 & output,
const BiquadFilterQ15 & filter
) const

virtual bool is_api_available() const

virtual q15_t max() const

virtual q15_t max(

u32 & idx
) const

virtual q15_t mean() const

virtual q15_t min() const

virtual q15_t min(

u32 & idx
) const

SignalQ15 multiply(

q15_t value
) const

virtual SignalQ15 multiply(

const SignalQ15 & a
) const

SignalQ15 & multiply_assign(

q15_t value
)

virtual SignalQ15 & multiply_assign(

const SignalQ15 & a
)

virtual SignalQ15 negate() const

void negate(

SignalQ15 & output
) const

virtual q63_t power() const

virtual q15_t rms() const

SignalQ15 scale(

q15_t scale_fraction,
s8 shift
) const

void scale(

SignalQ15 & output,
q15_t scale_fraction,
s8 shift
) const

void shift(

SignalQ15 & output,
s8 value
) const

virtual SignalQ15 shift(

s8 value
) const

virtual SignalQ15 & shift_assign(

s8 value
)

virtual q15_t std() const

virtual SignalQ15 subtract(

const SignalQ15 & a
) const

virtual SignalQ15 & subtract_assign(

const SignalQ15 & a
)

virtual q15_t variance() const

static SignalQ15 create_sin_wave(

u32 wave_freauency,
u32 sampling_frequency,
u32 nsamples,
q15_t phase
)

Members

SignalQ15(

const arg::Count count
)


SignalQ15()

virtual SignalQ15 abs() const

Calculates the absolute value of each value in the signal.

Returns

A new signal containing the absolute value of this signal.

This method will allocate a new signal and return it.


void abs(

SignalQ15 & output
) const


SignalQ15 add(

q15_t offset_value
) const


virtual SignalQ15 add(

const SignalQ15 & a
) const


SignalQ15 & add_assign(

q15_t offset_value
)


virtual SignalQ15 & add_assign(

const SignalQ15 & a
)


SignalQ15 convolve(

const SignalQ15 & a
) const


void convolve(

SignalQ15 & output,
const SignalQ15 & a
) const


q63_t dot_product(

const SignalQ15 & a
) const


SignalQ15 filter(

const FirFilterQ15 & filter
) const


void filter(

SignalQ15 & output,
const FirFilterQ15 & filter
) const


SignalQ15 filter(

const BiquadFilterQ15 & filter
) const


void filter(

SignalQ15 & output,
const BiquadFilterQ15 & filter
) const


virtual bool is_api_available() const

virtual q15_t max() const

Calculates and returns the maximum value of the signal.

This method utilizes the arm_max_q15() function.


virtual q15_t max(

u32 & idx
) const

Calculates and returns the maximum value of the signal.

Parameters

  • idx A reference to the index value of the maximum. This parameter will be written with the location of the maximum value.

This method utilizes the arm_max_q15() function.


virtual q15_t mean() const

Returns the mean value of the signal.

SignalQ31 data(16);

data.fill(10);
printf("Mean is %ld\n", data.mean());

virtual q15_t min() const

Calculates and returns the minimum value of the signal.

This method utilizes the arm_min_q15() function.


virtual q15_t min(

u32 & idx
) const

Calculates and returns the minimum value of the signal.

Parameters

  • idx A reference to the index value of the minimum. This parameter will be written with the location of the minimum value.

This method utilizes the arm_min_q15() function.


SignalQ15 multiply(

q15_t value
) const


virtual SignalQ15 multiply(

const SignalQ15 & a
) const


SignalQ15 & multiply_assign(

q15_t value
)


virtual SignalQ15 & multiply_assign(

const SignalQ15 & a
)


virtual SignalQ15 negate() const

Returns a new signal that a negated copy of this signal.

This method uses dynamic memory allocation.


void negate(

SignalQ15 & output
) const


virtual q63_t power() const

virtual q15_t rms() const

Calculates the RMS value of the signal.


SignalQ15 scale(

q15_t scale_fraction,
s8 shift
) const


void scale(

SignalQ15 & output,
q15_t scale_fraction,
s8 shift
) const


void shift(

SignalQ15 & output,
s8 value
) const


virtual SignalQ15 shift(

s8 value
) const


virtual SignalQ15 & shift_assign(

s8 value
)


virtual q15_t std() const

Calculates and returns the standard deviation value of the signal.

This method utilizes the arm_std_q15() function.


virtual SignalQ15 subtract(

const SignalQ15 & a
) const


virtual SignalQ15 & subtract_assign(

const SignalQ15 & a
)


virtual q15_t variance() const

Calculates and returns the variance value of the signal.

This method utilizes the arm_var_q15() function.


static SignalQ15 create_sin_wave(

u32 wave_freauency,
u32 sampling_frequency,
u32 nsamples,
q15_t phase
)


X

Thanks for Coming!

Subscribe to news and updates