summaryrefslogtreecommitdiff
path: root/macros/fir1.sci
diff options
context:
space:
mode:
authorbgtushar2017-11-30 17:33:15 +0530
committerbgtushar2017-11-30 17:33:15 +0530
commit8e9af4404bedd0fc7ff9c34bf8b794d6b8602b36 (patch)
treeb20459680962747b04c5e349df3740111613b47e /macros/fir1.sci
parentd97a4b7e2f0f25fb5cd94bd90a3b822592179d1e (diff)
downloadFOSSEE-Signal-Processing-Toolbox-8e9af4404bedd0fc7ff9c34bf8b794d6b8602b36.tar.gz
FOSSEE-Signal-Processing-Toolbox-8e9af4404bedd0fc7ff9c34bf8b794d6b8602b36.tar.bz2
FOSSEE-Signal-Processing-Toolbox-8e9af4404bedd0fc7ff9c34bf8b794d6b8602b36.zip
deleted html and added new functions
Diffstat (limited to 'macros/fir1.sci')
-rw-r--r--macros/fir1.sci36
1 files changed, 28 insertions, 8 deletions
diff --git a/macros/fir1.sci b/macros/fir1.sci
index e3ff152..70c95b7 100644
--- a/macros/fir1.sci
+++ b/macros/fir1.sci
@@ -1,7 +1,27 @@
function B = fir1(N, W, varargin)
-
+//Produce an order N FIR filter with the given frequency cutoff, returning the N+1 filter coefficients in B.
+//Calling Sequence
+//B = fir1(N, W)
+//B = fir1(N, W, TYPE)
+//B = fir1(N, W, TYPE, WINDOW)
+//B = fir1(N, W, TYPE, WINDOW, NOSCALE)
+//Parameters
+//N: Integer
+//W: Integer or Vector
+//Description
+// Produce an order N FIR filter with the given frequency cutoff W, returning the N+1 filter coefficients in B. If W is a scalar, it specifies the frequency cutoff for a lowpass or highpass filter. If W is a two-element vector, the two values specify the edges of a bandpass or bandstop filter. If W is an N-element vector, each value specifies a band edge of a multiband pass/stop filter.
+//
+//The filter TYPE can be specified with one of the following strings: "low", "high", "stop", "pass", "bandpass", "DC-0", or "DC-1". The default is "low" is W is a scalar, "pass" if W is a pair, or "DC-0" if W is a vector with more than 2 elements.
+//
+//An optional shaping WINDOW can be given as a vector with length N+1. If not specified, a Hamming window of length N+1 is used.
+//
+//With the option "noscale", the filter coefficients are not normalized. The default is to normalize the filter such that the magnitude response of the center of the first passband is 1.
+//Examples
+// fir1 (5, 0.4)
+//ans =
+// 9.2762e-05 9.5482e-02 4.0443e-01 4.0443e-01 9.5482e-02 9.2762e-05
funcprot(0);
-rhs = argn(2)
+rhs = argn(2);
if(rhs<2 | rhs>5)
error("Wrong number of input arguments.");
end
@@ -9,11 +29,11 @@ end
select(rhs)
case 2 then
B = callOctave("fir1", N, W);
- case 3 then
- B = callOctave("fir1", N, W, varargin(1));
- case 4 then
- B = callOctave("fir1", N, W, varargin(1), varargin(2));
- case 5 then
- B = callOctave("fir1", N, W, varargin(1), varargin(2), varargin(3));
+ case 3 then
+ B = callOctave("fir1", N, W, varargin(1));
+ case 4 then
+ B = callOctave("fir1", N, W, varargin(1), varargin(2));
+ case 5 then
+ B = callOctave("fir1", N, W, varargin(1), varargin(2), varargin(3));
end
endfunction