DSP IIR实时C++滤波器库使用与技术文档

本文档旨在帮助用户安装、使用和详细了解DSP IIR实时C++滤波器库。本文将涵盖以下内容：

1. 安装指南
2. 项目使用说明
3. 项目API使用文档
4. 项目安装方式

1. 安装指南

使用CMake进行编译

该库使用cmake作为构建工具，可生成适用于不同平台的Makefile或项目文件。

Linux / Mac

运行以下命令生成Makefile：

cmake .

然后执行以下命令进行编译和安装：

make
sudo make install

这将库安装到/usr/local/lib和/usr/local/include。

Windows

使用以下命令生成Visual Studio的解决方案文件：

cmake -G "Visual Studio 16 2019" -A x64 .

然后在Visual Studio中打开生成的解决方案文件，编译生成DLL和LIB文件。

单元测试

运行以下命令执行单元测试：

make test

或直接使用：

ctest

2. 项目使用说明

实例化滤波器

首先需要指定滤波器的阶数，然后使用setup函数设置参数，之后即可进行实时样本处理。

实例化滤波器

使用模板参数在编译时分配内存，以避免使用new命令。以下是一个低通滤波器的例子：

const int order = 4; // 4阶（=2个二阶节）
Iir::Butterworth::LowPass<order> f;

设置滤波器参数：setup

所有滤波器均提供低通、高通、带通和带阻/陷波滤波器。Butterworth/Chebyshev还提供带通/带阻 shelf滤波器，具有指定的通带增益和0dB的阻带增益。

频率可以是模拟频率除以采样率，也可以是归一化频率（在0到1/2之间，其中1/2是奈奎斯特频率）。归一化频率为f = F/Fs，单位为1/样本。库内部使用归一化频率，setup命令仅将给定频率除以采样率。选择以下方式之一：

1. setup：采样率和模拟截止频率
2. setupN：归一化频率（在0到1/2之间）

以下是一个低通滤波器的示例：

Butterworth滤波器

const int order = 4; // 4阶
Iir::Butterworth::LowPass<order> f;
const float samplingrate = 1000; // Hz
const float cutoff_frequency = 5; // Hz
f.setup(samplingrate, cutoff_frequency);

或使用归一化频率：

f.setupN(norm_cutoff_frequency);

实时样本处理

样本逐个处理。以下是一个样本x通过filter命令处理并存储在y中的示例：

y = f.filter(x);

对每个输入样本重复此操作。

错误处理

向setup()提供无效值或将导致系数为NAN的参数将抛出异常。可以通过定义IIR1_NO_EXCEPTIONS来禁用异常处理。

3. 项目API使用文档

本项目提供了多种类型的滤波器，包括Butterworth、Chebyshev I/II和RBJ滤波器。以下是一些基本的使用示例：

Butterworth滤波器

const int order = 4; // 4阶
Iir::Butterworth::LowPass<order> f;
const float samplingrate = 1000; // Hz
const float cutoff_frequency = 5; // Hz
f.setup(samplingrate, cutoff_frequency);
float y = f.filter(x);

Chebyshev I滤波器

const int order = 4; // 4阶
Iir::ChebyshevI::LowPass<order> f;
const float passband_ripple_in_db = 5;
f.setup(samplingrate, cutoff_frequency, passband_ripple_in_db);
float y = f.filter(x);

Chebyshev II滤波器

const int order = 4; // 4阶
Iir::ChebyshevII::LowPass<order> f;
const float stopband_ripple_in_db = 20;
f.setup(samplingrate, cutoff_frequency, stopband_ripple_in_db);
float y = f.filter(x);

RBJ滤波器

Iir::RBJ::LowPass f;
const float cutoff_frequency = 100;
const float Q_factor = 5;
f.setup(samplingrate, cutoff_frequency, Q_factor);
float y = f.filter(x);

使用Python的scipy.signal设计滤波器

const double coeff[][6] = {
    // 系数...
};
const int nSOS = sizeof(coeff) / sizeof(coeff[0]); // 这里：nSOS = 2 = 阶数 / 2
Iir::Custom::SOSCascade<nSOS> cust(coeff);
float y = cust.filter(x);

4. 项目安装方式

使用CMake

如果使用CMake作为构建系统，只需在CMakeLists.txt中添加以下内容：

动态库

find_package(iir)
target_link_libraries(... iir::iir)

静态库

find_package(iir)
target_link_libraries(... iir::iir_static)

链接设置

根据系统不同，链接时需要指定动态库或静态库：

• 动态库（Unix/Mac: -liir，Windows: iir.lib）
• 静态库（Unix/Mac: libiir_static.a，Windows: libiir_static.lib）

通过本文档，用户应能更好地理解如何安装、使用和集成DSP IIR实时C++滤波器库到自己的项目中。