[Octave-cvsupdate] SF.net SVN: octave:[8642] trunk/octave-forge/main/signal/inst

[<car...@us...>]

Revision: 8642
          http://octave.svn.sourceforge.net/octave/?rev=8642&view=rev
Author:   carandraug
Date:     2011-09-30 14:17:52 +0000 (Fri, 30 Sep 2011)
Log Message:
-----------
impinvar/invimpinvar: change API to use sampling frequency instead of sampling time to be compatible with MatLab

Modified Paths:
--------------
    trunk/octave-forge/main/signal/inst/impinvar.m
    trunk/octave-forge/main/signal/inst/invimpinvar.m

Modified: trunk/octave-forge/main/signal/inst/impinvar.m
===================================================================
--- trunk/octave-forge/main/signal/inst/impinvar.m	2011-09-30 14:08:01 UTC (rev 8641)
+++ trunk/octave-forge/main/signal/inst/impinvar.m	2011-09-30 14:17:52 UTC (rev 8642)
@@ -16,13 +16,13 @@
 ## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
 ## -*- texinfo -*-
-## @deftypefn{Function File} {[@var{b_out}, @var{a_out}] =} impinvar (@var{b}, @var{a}, @var{ts}, @var{tol})
-## @deftypefnx{Function File} {[@var{b_out}, @var{a_out}] =} impinvar (@var{b}, @var{a}, @var{ts})
+## @deftypefn{Function File} {[@var{b_out}, @var{a_out}] =} impinvar (@var{b}, @var{a}, @var{fs}, @var{tol})
+## @deftypefnx{Function File} {[@var{b_out}, @var{a_out}] =} impinvar (@var{b}, @var{a}, @var{fs})
 ## @deftypefnx{Function File} {[@var{b_out}, @var{a_out}] =} impinvar (@var{b}, @var{a})
 ## Converts analog filter with coefficients @var{b} and @var{a} to digital,
 ## conserving impulse response.
 ##
-## If @var{ts} is not specificied, or is an empty vector, it defaults to 1Hz.
+## If @var{fs} is not specificied, or is an empty vector, it defaults to 1Hz.
 ##
 ## If @var{tol} is not specified, it defaults to 0.0001 (0.1%)
 ## This function does the inverse of impinvar so that the following example should
@@ -47,6 +47,8 @@
   ## be used to get the default
   if (isempty(ts))
     ts = 1;
+  else
+    ts = 1/ts; # we should be using sampling frequencies to be compatible with Matlab
   endif
 
   [r_in, p_in, k_in] = residue(b_in, a_in); % partial fraction expansion

Modified: trunk/octave-forge/main/signal/inst/invimpinvar.m
===================================================================
--- trunk/octave-forge/main/signal/inst/invimpinvar.m	2011-09-30 14:08:01 UTC (rev 8641)
+++ trunk/octave-forge/main/signal/inst/invimpinvar.m	2011-09-30 14:17:52 UTC (rev 8642)
@@ -16,8 +16,8 @@
 ## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
 ## -*- texinfo -*-
-## @deftypefn{Function File} {[@var{b_out}, @var{a_out}] =} invimpinvar (@var{b}, @var{a}, @var{ts}, @var{tol})
-## @deftypefnx{Function File} {[@var{b_out}, @var{a_out}] =} invimpinvar (@var{b}, @var{a}, @var{ts})
+## @deftypefn{Function File} {[@var{b_out}, @var{a_out}] =} invimpinvar (@var{b}, @var{a}, @var{fs}, @var{tol})
+## @deftypefnx{Function File} {[@var{b_out}, @var{a_out}] =} invimpinvar (@var{b}, @var{a}, @var{fs})
 ## @deftypefnx{Function File} {[@var{b_out}, @var{a_out}] =} invimpinvar (@var{b}, @var{a})
 ## Converts digital filter with coefficients @var{b} and @var{a} to analog,
 ## conserving impulse response.
@@ -29,7 +29,7 @@
 ## [b, a] = invimpinvar (b, a);
 ## @end example
 ##
-## If @var{ts} is not specificied, or is an empty vector, it defaults to 1Hz.
+## If @var{fs} is not specificied, or is an empty vector, it defaults to 1Hz.
 ##
 ## If @var{tol} is not specified, it defaults to 0.0001 (0.1%)
 ##
@@ -47,6 +47,8 @@
   ## be used to get the default
   if (isempty(ts))
     ts = 1;
+  else
+    ts = 1/ts; # we should be using sampling frequencies to be compatible with Matlab
   endif
 
   [r_in, p_in, k_in] = residue(b_in, a_in); % partial fraction expansion

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.