Few doc changes related to freqwin etc.

Kevin2599 · Dec 12, 2016 · 655b471 · 655b471
1 parent 4bb2369
commit 655b471
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 15 deletions.
diff --git a/sigproc/firwin.m b/sigproc/firwin.m
@@ -156,7 +156,7 @@
 %
 %     legend('Hann','Hamming','Blackman','Nuttall','Itersine');
 %
-%   See also:  pgauss, pbspline, firkaiser, normalize
+%   See also:  freqwin, pgauss, pbspline, firkaiser, normalize
 %
 %   References: opsc89 harris1978 nuttall1981 wesfreid1993
 

diff --git a/sigproc/freqfilter.m b/sigproc/freqfilter.m
@@ -1,7 +1,18 @@
 function gout=freqfilter(winname,bw,varargin)
+%FREQFILTER Construct filter in frequency domain
+%   Usage:   g=freqfilter(winname,bw)
+%            g=freqfilter(winname,bw,fc)
+%
+%   Input parameters:
+%      winname  : Name of prototype
+%      bw       : Effective support length of the prototype
+%      fc       : Center frequency
+%   
+%   `freqfilter`
+%
 % 
 % Authors: Nicki Holighaus & Zdenek Prusa
-% Date: September 15
+% Date: September 15, 2016 
 
 if ~iscell(winname), winname = {winname}; end
 
@@ -62,4 +73,4 @@
 
 if Nfilt==1
     gout=g;
-end;
+end;
diff --git a/sigproc/freqwin.m b/sigproc/freqwin.m
@@ -1,10 +1,10 @@
 function H = freqwin(name,L,bw,varargin)
-%FREQWIN 
+%FREQWIN Frequency response window
 %
 %   `freqwin(name,L,bw)` returns a frequency window *name* of length *L* 
-%   with the mainlobe -6dB bandwidth *bw*. It is intended to represent a
-%   frequency response of a band-pass filter/window with bandwidth *bw*.
-%   The bandwidth is given in normalised frequencies.
+%   with the mainlobe -6dB (half height) bandwidth *bw*. It is intended to
+%   represent frequency response of a band-pass filter/window with 
+%   bandwidth *bw*. The bandwidth is given in normalised frequencies.
 %
 %   The function is not periodically wrapped should it be nonzero outside
 %   of the *L* samples (as opposed to e.g. |pgauss|).
@@ -18,14 +18,16 @@
 %         Gammatone window of order *order*. The default order is 4.
 %
 %     'butterworth' or {'butterworth',order}
+%         Butterworth window of order *order*. The default order is 4.
+%
+%   `freqwin(name,L,bw,fs)` does the same as above except *bw* is expected
+%   to be in Hz given sampling frequency *fs*.
 %
-%     'roex'
-%         
 %   `freqwin` understands the following key-value pairs and flags at the end of 
 %   the list of input parameters:
 %
 %     'fs',fs      If the sampling frequency *fs* is specified then the *bw*
-%                  is expected to be on Hz.
+%                  is expected to be in Hz.
 %
 %     'shift',s    Shift the window by $s$ samples. The value can be a
 %                  fractional number.   
@@ -39,12 +41,8 @@
 %   Additionally, the function accepts flags to normalize the output. Please see
 %   the help of |normalize|. Default is to use `'peak'` normalization.
 %
-%   Examples
-%   --------
-%
-%   
 %
-%   See also: firwin, plotfft
+%   See also: firwin, normalize, plotfft
 
 % AUTHORS: Nicki Holighaus