Add Remez Filter Order Estimation (#429) (#481)

JuliaDSP · Nov 22, 2022 · b9c0925 · b9c0925
1 parent 356a5f5
commit b9c0925
Show file tree

Hide file tree

Showing 4 changed files with 137 additions and 84 deletions.
diff --git a/docs/src/filters.md b/docs/src/filters.md
@@ -86,7 +86,8 @@ The design method is [`Butterworth`](@ref), [`Chebyshev1`](@ref), [`Chebyshev2`]
 necessary parameters for the method that affect the shape of the response,
 such as filter order, ripple, and attenuation. [Filter order estimation methods](@ref order-est-methods) 
 are available in [`buttord`](@ref), [`cheb1ord`](@ref), [`cheb2ord`](@ref), 
-and [`ellipord`](@ref) if the corner frequencies for different IIR filter types are known.
+and [`ellipord`](@ref) if the corner frequencies for different IIR filter types are known. [`remezord`](@ref) 
+can be used for an initial FIR filter order estimate.
 
 ```@docs
 analogfilter
@@ -121,7 +122,9 @@ Chebyshev2
 Elliptic
 ```
 
-### [IIR filter order estimation methods](@id order-est-methods)
+### [Filter order estimation methods](@id order-est-methods)
+
+#### IIR filter order estimation methods
 
 ```@docs
 buttord
@@ -130,6 +133,12 @@ cheb2ord
 ellipord
 ```
 
+#### FIR filter order estimation methods
+
+```@docs
+remezord
+```
+
 #### FIR filter design methods
 
 ```@docs

diff --git a/src/Filters/Filters.jl b/src/Filters/Filters.jl
@@ -21,15 +21,15 @@ export FilterCoefficients,
         coefb
 
 include("filt.jl")
-export  DF2TFilter,
+export DF2TFilter,
         filtfilt,
         tdfilt,
         tdfilt!,
         fftfilt,
         fftfilt!
 
 include("design.jl")
-export  FilterType,
+export FilterType,
         Butterworth,
         Chebyshev1,
         Chebyshev2,
@@ -46,21 +46,22 @@ export  FilterType,
         resample_filter
 
 include("filt_order.jl")
-export  buttord,
+export buttord,
         ellipord,
         cheb1ord,
-        cheb2ord
+        cheb2ord,
+        remezord
 
 
 include("response.jl")
-export  freqresp,
+export freqresp,
         phaseresp,
         grpdelay,
         impresp,
         stepresp
 
 include("stream_filt.jl")
-export  FIRFilter,
+export FIRFilter,
         outputlength,
         inputlength,
         reset!,
@@ -69,7 +70,7 @@ export  FIRFilter,
         timedelay
 
 include("remez_fir.jl")
-export  remez,
+export remez,
         RemezFilterType,
         filter_type_bandpass,
         filter_type_differentiator,