lasprs/src/lib.rs

61 lines
1.8 KiB
Rust
Raw Normal View History

2023-11-22 13:40:16 +00:00
//! # Library for acoustic signal processing
//!
2024-07-11 19:10:38 +00:00
//! This crate contains structures and functions to perform acoustic
//! measurements, interact with data acquisition devices and apply common
//! acoustic analysis operations on them.
//!
2024-07-11 19:10:38 +00:00
//! You will find the following stuff in this crate:
//!
2024-07-11 19:10:38 +00:00
//! - Data acquisition, recording, signal generation
//! - Power spectra estimation, transfer function estimation tools.
//! - Sound Level Meter implementation.
//! - Filter design tools, maybe borrowed from other crates?
2024-07-11 19:11:58 +00:00
//! - Tools for real time displaying of sensor data
2024-07-11 19:10:38 +00:00
//!
//! ## Note to potential users
//!
//! **This crate is still under heavy development. API changes happen on the
//! fly. Documentation is not finished. Use with caution and expect things to be
2024-07-11 19:10:38 +00:00
//! broken and buggy. Use at your own risk and responsibility.**
//!
//! ## Author information
//!
//! The main developer is J.A. de Jong from [ASCEE](https://www.ascee.nl). In
//! case of bug reports, please file them to [info@ascee.nl](info@ascee.nl).
//!
//! If you have particular interest in this library, please also contact us.
2024-07-11 19:10:38 +00:00
//!
#![warn(missing_docs)]
#![allow(non_snake_case)]
#![allow(non_upper_case_globals)]
#![allow(unused_imports)]
mod config;
2024-04-19 12:09:32 +00:00
use config::*;
2024-04-19 12:09:32 +00:00
pub use config::Flt;
pub mod daq;
2024-07-11 19:10:38 +00:00
pub mod filter;
pub mod ps;
pub mod siggen;
2024-04-19 12:09:32 +00:00
use filter::*;
pub mod rt;
/// A Python module implemented in Rust.
#[cfg(feature = "python-bindings")]
#[pymodule]
2024-07-11 19:10:38 +00:00
#[pyo3(name = "_lasprs")]
fn lasprs(m: &Bound<'_, PyModule>) -> PyResult<()> {
daq::add_py_classses(m)?;
// Add filter submodule
m.add_class::<filter::Biquad>()?;
m.add_class::<filter::SeriesBiquad>()?;
m.add_class::<filter::BiquadBank>()?;
m.add_class::<siggen::Siggen>()?;
m.add_class::<filter::FilterSpec>()?;
m.add_class::<filter::ZPKModel>()?;
Ok(())
}