kb1vc / sodasignals

Simple Signal Processing library

SoDaSignals Simple signal processing classes

To get to doxygen generated documentation that is more detailed than the following summary, go here

SoDaSignals contains classes that provide: . an interface to FFTW for complex DFT and IDFT . a filter class for complex signals . a digital down converter and up converter

Dependencies

SoDaSignals requires very little in terms of libraries and other stuff. . git . cmake . FFTW3: both double and single precision versions. If your distribution distinguishes between "normal" kits and "devel" kits, install the "devel" package. . C++: Any version supporting the C++11 standard

and that's it.

For Fedora 34:

dnf install gcc-c++ n
dnf install git cmake
dnf install fftw-devel

Optionally, to get nice documentation in html form

dnf install doxygen

For Unbuntu 21

apt install g++
apt install git
apt install cmake
apt install fftw3-dev

And the optional doxygen kit:

apt install doxygen

SoDaSignals also requires the SoDaUtils library. It will attempt to
build the library itself and install it in the same destination
directory.

## Installing

Just like any other CMake project.  For instance, to install the
package in /usr/local ... From this directory

mkdir build cd build cmake -DCMAKE_INSTALL_PREFIX=/usr/local make sudo make install

This will install the libraries in /usr/local/lib or lib64 as appropriate
and the includes in /usr/local/include/SoDa

It will also write doxygen output that starts at /usr/local/share/SoDaSignals/

### Installing Without root
It is possible to install the library in a private directory (without needing root) like this: 

mkdir build cd build cmake -DCMAKE_INSTALL_PREFIX=${HOME}/my_tools/ ../ make sudo make install

If you've installed SoDaUtils without root or in some non-standard directory like ${HOME}/my_tools you'll need to add this to the cmake command:

cmake -DCMAKE_INSTALL_PREFIX=${HOME}/my_tools/ -DCMAKE_PREFIX_PATH=${HOME}/my_tools ../

This should work just fine, but if you do, then any build that *uses*
SoDaSignals needs to add this to its cmake

cmake -DCMAKE_PREFIX_PATH=${HOME}/my_tools ../

 
That will tell cmake to look in your directory for the relevant cmake
files that describe where to find the libraries and headers.

### Installing Without root
It is possible to install the library in a private directory (without needing root) like this: 

mkdir build cd build cmake -DCMAKE_INSTALL_PREFIX=${HOME}/my_tools/ make sudo make install

This should work just fine, but if you do, then any build that *uses*
SoDaSignals needs to add this to its cmake

cmake -DCMAKE_PATH_PREFIX=${HOME}/my_tools

That will tell cmake to look in your directory for the relevant cmake
files that describe where to find the libraries and headers.

### MacOS

Mac users should probably use "/opt/local" as the install prefix. This
will put the library where macports puts other libraries and such.

For reasons I can't fully comprehend, some installations (especially
for MacOS BigSur) have trouble finding the FFTW package with cmake. As
ugly as it is, you can fix this problem like this: (in the build
directory) ``` FFTW3f_DIR=/opt/local/lib/cmake/fftw3 cmake ../ ```
Replace /opt/local/lib/cmake/fftw3 with the directory containing the
file "FFTW3Config.cmake"

Additionally, the macports FFTW3 installation is broken.  It is
missing "FFTW3fLibraryDepends.cmake" If you are stuck, you can copy
the file in "cmake/macports_fix/FFTW3LibraryDepends.cmake" to the
directory mentioned above. ("/opt/local....fftw3" or whatever)

### Linux

No trouble reported yet

### Windows

I have no idea.  


## Testing and Using it all

Take a look at the CMakeLists.txt file and FilterExample.cxx in the
example directory.  If the installation has gone right, then you
should be able to do this from this directory.

cd example mkdir build cd build cmake ../ make ./FilterExample

Did that work?

If so, congratulations.  And you can use the "CMakeLists.txt" file in
the example directory as a starting point for including the library in
your own cmake based projects.