Added some comments, first change to doxyfile

This commit is contained in:
Anne de Jong 2018-12-29 13:57:32 +01:00 committed by J.A. de Jong - ASCEE
parent c830891f66
commit 21d9efc139
5 changed files with 19 additions and 21 deletions

View File

@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8
# title of most generated pages and in a few other places. # title of most generated pages and in a few other places.
# The default value is: My Project. # The default value is: My Project.
PROJECT_NAME = "ASCEE Beamforming" PROJECT_NAME = LASP
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version # could be handy for archiving the generated documentation or if some version

View File

@ -1,9 +1,8 @@
# Library for Acoustic Signal Processing # Library for Acoustic Signal Processing
Welcome to LASP: Library for Acoustic Signal Processing. LASP is a C Welcome to LASP: Library for Acoustic Signal Processing. LASP is a C library
library - currently still under heavy development - with a Python with a Python interface which is supposed to process (multi-) microphone
interface which is supposed to process (multi-) microphone acoustic acoustic data in real time on a PC and output results.
data in real time and output results.
The main goal of this library will be the processing of data from an The main goal of this library will be the processing of data from an
array of microphones real time, on a Raspberry PI. At the point in array of microphones real time, on a Raspberry PI. At the point in
@ -14,7 +13,7 @@ is finished, we have a new faster generation :).
Current features that are implemented: Current features that are implemented:
- Compile-time determination of the floating-point accuracy (32/64 bit) - Compile-time determination of the floating-point accuracy (32/64 bit)
- Fast convolution FIR filter implementation - Fast convolution FIR filter implementation
- Decimation of the sample rate by an integer factor of 4. - Sample rate decimation by an integer factor of 4.
- Octave filterbank FIR filters designed to comply with IEC 61260 - Octave filterbank FIR filters designed to comply with IEC 61260
(1995). (1995).
- Averaged power spectra and power spectral density determination - Averaged power spectra and power spectral density determination
@ -23,15 +22,15 @@ Current features that are implemented:
- A thread-safe job queue including routines to create worker threads. - A thread-safe job queue including routines to create worker threads.
- Several linear algebra routines (wrappers around BLAS and LAPACK). - Several linear algebra routines (wrappers around BLAS and LAPACK).
- A nice debug tracer implementation - A nice debug tracer implementation
- Third octave filter bank FIR filters designed to comply with IEC 61260
Some of the near future features: (1995).
- Third octave filter bank
- Slow and fast time updates of (A/C/Z) weighted sound pressure levels - Slow and fast time updates of (A/C/Z) weighted sound pressure levels
- Conventional and delay-and-sum beamforming algorithms
Future features (wish-list)
- Conventional and delay-and-sum beam-forming algorithms
For now, the source code is well-documented but it requires some For now, the source code is well-documented but it requires some
additional documentation (the math behind it). This will be published additional documentation (the math behind it). This will be published
in a sister repository in a later stage. in a sister repository in a later stage.
If you have any question, please feel free to contact us: info@ascee.nl. If you have any question(s), please feel free to contact us: info@ascee.nl.

View File

@ -1,6 +1,7 @@
# We borrow Numpy's implementation for doing the Fast Fourier Transform.
# This FFT code appears to be faster than KISSFFT.
add_library(fftpack add_library(fftpack
fftpack.c fftpack.c
) )
# Ling fft to math
target_link_libraries(fftpack m) target_link_libraries(fftpack m)

View File

@ -40,7 +40,7 @@ def init_backend(report_quality=False):
global _init global _init
if not _init: if not _init:
import matplotlib import matplotlib
matplotlib.use('Qt5Agg') matplotlib.use('Qt5Agg', warn=False, force=True)
init_matplotlib(report_quality) init_matplotlib(report_quality)
_init = True _init = True
import matplotlib.pyplot as plt import matplotlib.pyplot as plt

View File

@ -5,8 +5,8 @@
""" """
from setuptools import setup from setuptools import setup
descr = "Python wrappers around several C++ optimized beamforming codes" descr = """Library for Acoustic Signal Processing. This Python module contains
tools and code for common operations on acoustic signals."""
setup( setup(
name="LASP", name="LASP",
@ -14,12 +14,10 @@ setup(
packages=['lasp'], packages=['lasp'],
author='J.A. de Jong - ASCEE', author='J.A. de Jong - ASCEE',
author_email="j.a.dejong@ascee.nl", author_email="j.a.dejong@ascee.nl",
# Project uses reStructuredText, so ensure that the docutils get
# installed or upgraded on the target machine
install_requires=['matplotlib>=1.0', 'scipy>=1.0', 'numpy>=1.0'], install_requires=['matplotlib>=1.0', 'scipy>=1.0', 'numpy>=1.0'],
license='MIT', license='MIT',
description=descr, description=descr,
keywords="", keywords="",
url="http://www.ascee.nl/lasp/", # project home page, if any url="https://www.ascee.nl/lasp/", # project home page, if any
) )