* Bug #12774 fixed - Fix various typos.
[scilab.git] / scilab / modules / signal_processing / macros / group.sci
index 3e238f0..42cb2f6 100644 (file)
 // Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 // Copyright (C) INRIA - 1988 - C. Bunks
-// 
+//
 // This file must be used under the terms of the CeCILL.
 // This source file is licensed as described in the file COPYING, which
 // you should have received as part of this distribution.  The terms
-// are also available at    
+// are also available at
 // http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
 
 function [tg,fr]=group(npts,a1i,a2i,b1i,b2i)
-//Calculate the group delay of a digital filter
-//with transfer function h(z).
-//The filter specification can be in coefficient form,
-//polynomial form, rational polynomial form, cascade
-//polynomial form, or in coefficient polynomial form.
-//  npts :Number of points desired in calculation of group delay
-//  a1i  :In coefficient, polynomial, rational polynomial, or
-//       :cascade polynomial form this variable is the transfer
-//       :function of the filter.  In coefficient polynomial
-//       :form this is a vector of coefficients (see below).
-//  a2i  :In coeff poly form this is a vector of coeffs
-//  b1i  :In coeff poly form this is a vector of coeffs
-//  b2i  :In coeff poly form this is a vector of coeffs
-//  tg   :Values of group delay evaluated on the grid fr
-//  fr   :Grid of frequency values where group delay is evaluated
-//
-//In the coefficient polynomial form the tranfer funtion is
-//formulated by the following expression:
-//
-//       h(z)=prod(a1i+a2i*z+z**2)/prod(b1i+b2i*z+z^2)
-//
-//!
-
-
-//get frequency grid values in [0,.5)
-   fr=(0:.5/npts:.5*(npts-1)/npts);
-//get the of arguments used to called group
-   [ns,ne]=argn(0);
-//if the number of arguments is 2 then
-//the case may be non-cascade
-   hcs=1;
-   if ne==2 then
-//get the type of h and the variable name
-      h=a1i;
-      ht=type(h);
-//if ht==1 then h is a vector containing filter coefficients
-      if ht==1 then
-//make h a rational polynomial
-         hs=max(size(h));
-         z=poly(0,'z');
-         h=poly(h,'z','c');
-         h=gtild(h,'d')*(1/z^(hs-1));
-         ht=16;
-      end,
-//if ht==16 then h is a rational polynomial
-//(perhaps in cascade form)
-      //-compat ht==15 retained for list/tlist compatibility
-      if ht==15|ht==16 then
-         z=varn(h(3));
-         hcs=max(size(h(2)));
-      end,
-//if the rational polynomial is not in cascade form then
-      if hcs==1 then
-//if ht==2 then h is a regular polynomial
-         if ht==2 then
-            z=varn(h);
-         end,
-//get the derivative of h(z)
-         hzd=derivat(h);
-//get the group delay of h(z)
-         z=poly(0,z);
-         tgz=-z*hzd/h;
-//evaluate tg
-         rfr=exp(2*%pi*%i*fr);
-         tg=real(freq(tgz(2),tgz(3),rfr));
-//done with non-cascade calculation of group delay
-      end,
-   end,
-//re-organize if h is in cascade form
-   if hcs>1 then
-      xc=[coeff(h(2)),coeff(h(3))];
-      a2i=xc(1:hcs);
-      a1i=xc(hcs+1:2*hcs);
-      b2i=xc(3*hcs+1:4*hcs);
-      b1i=xc(4*hcs+1:5*hcs);
-      ne=5;
-   end,
-//if implementation is in cascade form
-   if ne==5 then
-//a1i,a2i,b1i,b2i are the coefficients of a
-//second order decomposition of the filter
-//(i.e. in cascade form, see Deczky)
-      phi=2*%pi*fr;
-      z=poly(0,'z');
-      ejw=freq(z,1,exp(%i*phi));
-      emjw=freq(z,1,exp(-%i*phi));
-      a1=a1i'*ones(phi);
-      b1=b1i'*ones(phi);
-      a2=a2i'*ones(phi);
-      b2=b2i'*ones(phi);
-      ejw=ones(a1i)'*ejw;
-      emjw=ones(a1i)'*emjw;
-      aterm=(a1+2*ejw)./(a1+ejw+a2.*emjw);
-      bterm=(b1+2*ejw)./(b1+ejw+b2.*emjw);
-      tgi=real(bterm-aterm);
-      tg=ones(a1i)*tgi;
-//done with cascade calculation of group delay
-end
+    //Calculate the group delay of a digital filter
+    //with transfer function h(z).
+    //The filter specification can be in coefficient form,
+    //polynomial form, rational polynomial form, cascade
+    //polynomial form, or in coefficient polynomial form.
+    //  npts :Number of points desired in calculation of group delay
+    //  a1i  :In coefficient, polynomial, rational polynomial, or
+    //       :cascade polynomial form this variable is the transfer
+    //       :function of the filter.  In coefficient polynomial
+    //       :form this is a vector of coefficients (see below).
+    //  a2i  :In coeff poly form this is a vector of coeffs
+    //  b1i  :In coeff poly form this is a vector of coeffs
+    //  b2i  :In coeff poly form this is a vector of coeffs
+    //  tg   :Values of group delay evaluated on the grid fr
+    //  fr   :Grid of frequency values where group delay is evaluated
+    //
+    //In the coefficient polynomial form the tranfer function is
+    //formulated by the following expression:
+    //
+    //       h(z)=prod(a1i+a2i*z+z**2)/prod(b1i+b2i*z+z^2)
+    //
+    //!
+
+
+    //get frequency grid values in [0,.5)
+
+    fr=(0:.5/npts:.5*(npts-1)/npts);
+
+    //get the of arguments used to called group
+
+    [ns,ne]=argn(0);
+
+    //if the number of arguments is 2 then
+    //the case may be non-cascade
+
+    hcs=1;
+    if ne==2 then
+
+        //get the type of h and the variable name
+
+        h=a1i;
+        ht=type(h);
+
+        //if ht==1 then h is a vector containing filter coefficients
+
+        if ht==1 then
+
+            //make h a rational polynomial
+
+            hs=max(size(h));
+            z=poly(0,"z");
+            h=poly(h,"z","c");
+            h=gtild(h,"d")*(1/z^(hs-1));
+            ht=16;
+        end,
+
+        //if ht==16 then h is a rational polynomial
+        //(perhaps in cascade form)
+
+        //-compat ht==15 retained for list/tlist compatibility
+        if ht==15|ht==16 then
+            z=varn(h(3));
+            hcs=max(size(h(2)));
+        end,
+
+        //if the rational polynomial is not in cascade form then
+
+        if hcs==1 then
+
+            //if ht==2 then h is a regular polynomial
+
+            if ht==2 then
+                z=varn(h);
+            end,
+
+            //get the derivative of h(z)
+
+            hzd=derivat(h);
+
+            //get the group delay of h(z)
+
+            z=poly(0,z);
+            tgz=-z*hzd/h;
+
+            //evaluate tg
+
+            rfr=exp(2*%pi*%i*fr);
+            tg=real(freq(tgz(2),tgz(3),rfr));
+
+            //done with non-cascade calculation of group delay
+
+        end,
+    end,
+
+    //re-organize if h is in cascade form
+
+    if hcs>1 then
+        xc=[coeff(h(2)),coeff(h(3))];
+        a2i=xc(1:hcs);
+        a1i=xc(hcs+1:2*hcs);
+        b2i=xc(3*hcs+1:4*hcs);
+        b1i=xc(4*hcs+1:5*hcs);
+        ne=5;
+    end,
+
+    //if implementation is in cascade form
+
+    if ne==5 then
+
+        //a1i,a2i,b1i,b2i are the coefficients of a
+        //second order decomposition of the filter
+        //(i.e. in cascade form, see Deczky)
+
+        phi=2*%pi*fr;
+        z=poly(0,"z");
+        ejw=freq(z,1,exp(%i*phi));
+        emjw=freq(z,1,exp(-%i*phi));
+
+        a1=a1i'*ones(phi);
+        b1=b1i'*ones(phi);
+        a2=a2i'*ones(phi);
+        b2=b2i'*ones(phi);
+        ejw=ones(a1i)'*ejw;
+        emjw=ones(a1i)'*emjw;
+
+        aterm=(a1+2*ejw)./(a1+ejw+a2.*emjw);
+        bterm=(b1+2*ejw)./(b1+ejw+b2.*emjw);
+
+        tgi=real(bterm-aterm);
+        tg=ones(a1i)*tgi;
+
+        //done with cascade calculation of group delay
+    end
 endfunction