Skip to content

Commit

Permalink
doc(dsp): improve doc for overloaded DSP functions
Browse files Browse the repository at this point in the history
  • Loading branch information
mchitre committed Aug 18, 2023
1 parent 111e3b0 commit b2578ea
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion src/dsp.jl
Original file line number Diff line number Diff line change
Expand Up @@ -382,7 +382,9 @@ end

"""
sfilt(f, x[, si])
filt(f, x::SampledSignal[, si])
sfilt(b, a, x[, si])
filt(b, a, x::SampledSignal[, si])
Same as [`filt`](https://docs.juliadsp.org/stable/filters/#DSP.filt),
but retains sampling rate information.
Expand All @@ -393,14 +395,17 @@ sfilt(b::AbstractVector{<:Number}, a::Union{Number,AbstractVector}, x::AbstractV
sfilt(b::AbstractVector{<:Number}, a::Union{Number,AbstractVector}, x::AbstractVector, si) = signal(filt(b, a, samples(x), si), framerate(x))

"""
$(SIGNATURES)
sfiltfilt(coef, x)
filtfilt(coef, x::SampledSignal)
Same as [`filtfilt`](https://docs.juliadsp.org/stable/filters/#DSP.Filters.filtfilt),
but retains sampling rate information.
"""
sfiltfilt(coef, x) = signal(filtfilt(coef, samples(x)), framerate(x))

"""
sresample(x, rate[, coef])
resample(x::SampledSignal, rate[, coef])
Same as [`resample`](https://docs.juliadsp.org/stable/filters/#DSP.Filters.resample),
but correctly handles sampling rate conversion.
Expand Down

0 comments on commit b2578ea

Please sign in to comment.