[Octave-cvsupdate] SF.net SVN: octave:[10808] trunk/octave-forge/extra/control-devel/inst/@ iddata/filter.m

[<par...@us...>]

Revision: 10808
          http://octave.svn.sourceforge.net/octave/?rev=10808&view=rev
Author:   paramaniac
Date:     2012-08-03 20:30:42 +0000 (Fri, 03 Aug 2012)
Log Message:
-----------
control-devel: save work in progress

Modified Paths:
--------------
    trunk/octave-forge/extra/control-devel/inst/@iddata/filter.m

Modified: trunk/octave-forge/extra/control-devel/inst/@iddata/filter.m
===================================================================
--- trunk/octave-forge/extra/control-devel/inst/@iddata/filter.m	2012-08-03 19:49:11 UTC (rev 10807)
+++ trunk/octave-forge/extra/control-devel/inst/@iddata/filter.m	2012-08-03 20:30:42 UTC (rev 10808)
@@ -22,6 +22,35 @@
 ## removing the best fit of a polynomial of order @var{ord}.
 ## If @var{ord} is not specified, default value 0 is taken.
 ## This corresponds to removing a constant.
+##
+## @strong{Inputs}
+## @table @var
+## @item dat
+## iddata identification dataset containing signals in time-domain.
+## @item sys
+## LTI object containing the discrete-time filter.
+## @item b
+## Numerator polynomial of the discrete-time filter.
+## Must be a row vector containing the coefficients
+## of the polynomial in ascending powers of z^-1.
+## @item a
+## Denominator polynomial of the discrete-time filter.
+## Must be a row vector containing the coefficients
+## of the polynomial in ascending powers of z^-1.
+## @end table
+##
+## @strong{Outputs}
+## @table @var
+## @item dat
+## iddata identification dataset in frequency-domain.
+## In order to preserve signal power and noise level,
+## the FFTs are normalized by dividing each transform
+## by the square root of the signal length.
+## The frequency values are distributed equally from 0
+## to the Nyquist frequency.  The Nyquist frequency is
+## only included for even signal lengths.
+## @end table
+##
 ## @end deftypefn
 
 ## Author: Lukas Reichlin <luk...@gm...>
@@ -38,6 +67,10 @@
     error ("iddata: filter: first argument must be an iddata set");
   endif
 
+  if (! dat.timedomain)
+    error ("iddata: filter: require iddata set in time-domain");
+  endif
+
   if (isa (b, "lti"))               # filter (dat, sys)
     if (nargin > 3)
       print_usage ();

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