LASP 1.0
Library for Acoustic Signal Processing
Loading...
Searching...
No Matches

Generate a sine wave. More...

#include <lasp_siggen_impl.h>

Inheritance diagram for Sine:
Collaboration diagram for Sine:

Public Member Functions

 Sine (const d freq_Hz)
 Create a sine wave generator.
 
 ~Sine ()=default
 
void setFreq (const d newFreq)
 
- Public Member Functions inherited from Siggen
virtual ~Siggen ()=default
 
void setFilter (const std::string &name, std::shared_ptr< Filter > f)
 Set a filter on the signal. For example to EQ the signal, or otherwise to shape the spectrum. Filters are stored in a map, and setFilter can be used to overwrite them, if a null pointer is given.
 
void setDCOffset (d offset)
 Set a linear DC offset value to the signal.
 
void setMute (bool mute=true)
 Mute the signal. Passes through the DC offset. No lock is hold. If it just works one block later, than that is just the case.
 
void setLevel (const d level, bool dB=true)
 Set the level of the signal generator.
 
void reset (const d newFs)
 Reset the signal generator. Should be called whenever the output is based on a different sampling frequency. Note that derived classes from this class should call the base class!
 
vd genSignal (const us nframes)
 Called whenever the implementation needs to create new samples.
 

Protected Member Functions

void resetImpl () override final
 
virtual vd genSignalUnscaled (const us nframes) override final
 

Additional Inherited Members

- Protected Attributes inherited from Siggen
std::mutex _mtx
 
_fs = 0
 

Detailed Description

Generate a sine wave.

Definition at line 37 of file lasp_siggen_impl.h.

Constructor & Destructor Documentation

◆ Sine()

Sine::Sine ( const d  freq_Hz)

Create a sine wave generator.

Parameters
freq_HzThe frequency in Hz

Definition at line 29 of file lasp_siggen_impl.cpp.

◆ ~Sine()

Sine::~Sine ( )
default

Member Function Documentation

◆ genSignalUnscaled()

vd Sine::genSignalUnscaled ( const us  nframes)
finaloverrideprotectedvirtual

Implements Siggen.

Definition at line 31 of file lasp_siggen_impl.cpp.

◆ resetImpl()

void Sine::resetImpl ( )
inlinefinaloverrideprotectedvirtual

Implements Siggen.

Definition at line 42 of file lasp_siggen_impl.h.

◆ setFreq()

void Sine::setFreq ( const d  newFreq)
inline

Definition at line 54 of file lasp_siggen_impl.h.


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