Menu
▾
▴
[Octave-cvsupdate] SF.net SVN: octave:[10660] trunk/octave-forge/extra/control-devel/inst/@ iddata
|
From: <par...@us...> - 2012-06-22 12:32:15
|
Revision: 10660
http://octave.svn.sourceforge.net/octave/?rev=10660&view=rev
Author: paramaniac
Date: 2012-06-22 12:32:09 +0000 (Fri, 22 Jun 2012)
Log Message:
-----------
control-devel: enhance docstrings of iddata methods
Modified Paths:
--------------
trunk/octave-forge/extra/control-devel/inst/@iddata/fft.m
trunk/octave-forge/extra/control-devel/inst/@iddata/get.m
trunk/octave-forge/extra/control-devel/inst/@iddata/ifft.m
trunk/octave-forge/extra/control-devel/inst/@iddata/plot.m
trunk/octave-forge/extra/control-devel/inst/@iddata/set.m
trunk/octave-forge/extra/control-devel/inst/@iddata/size.m
Modified: trunk/octave-forge/extra/control-devel/inst/@iddata/fft.m
===================================================================
--- trunk/octave-forge/extra/control-devel/inst/@iddata/fft.m 2012-06-22 11:06:07 UTC (rev 10659)
+++ trunk/octave-forge/extra/control-devel/inst/@iddata/fft.m 2012-06-22 12:32:09 UTC (rev 10660)
@@ -18,8 +18,8 @@
## -*- texinfo -*-
## @deftypefn {Function File} {@var{dat} =} fft (@var{dat})
## @deftypefnx {Function File} {@var{dat} =} fft (@var{dat}, @var{n})
-## Compute the discrete Fourier transform of @var{dat} using a Fast Fourier
-## Transform (FFT) algorithm.
+## Transform iddata objects from time to frequency domain
+## using a Fast Fourier Transform (FFT) algorithm.
##
## @strong{Inputs}
## @table @var
Modified: trunk/octave-forge/extra/control-devel/inst/@iddata/get.m
===================================================================
--- trunk/octave-forge/extra/control-devel/inst/@iddata/get.m 2012-06-22 11:06:07 UTC (rev 10659)
+++ trunk/octave-forge/extra/control-devel/inst/@iddata/get.m 2012-06-22 12:32:09 UTC (rev 10660)
@@ -16,9 +16,10 @@
## along with LTI Syncope. If not, see <http://www.gnu.org/licenses/>.
## -*- texinfo -*-
-## @deftypefn {Function File} get (@var{sys})
+## @deftypefn {Function File} get (@var{dat})
## @deftypefnx {Function File} {@var{value} =} get (@var{dat}, @var{"property"})
## Access property values of iddata objects.
+## Type @command{get(dat)} to display a list of available properties.
## @end deftypefn
## Author: Lukas Reichlin <luk...@gm...>
Modified: trunk/octave-forge/extra/control-devel/inst/@iddata/ifft.m
===================================================================
--- trunk/octave-forge/extra/control-devel/inst/@iddata/ifft.m 2012-06-22 11:06:07 UTC (rev 10659)
+++ trunk/octave-forge/extra/control-devel/inst/@iddata/ifft.m 2012-06-22 12:32:09 UTC (rev 10660)
@@ -17,11 +17,26 @@
## -*- texinfo -*-
## @deftypefn {Function File} {@var{dat} =} ifft (@var{dat})
-## @deftypefnx {Function File} {@var{dat} =} ifft (@var{dat}, @var{ord})
-## Detrend outputs and inputs of dataset @var{dat} by
-## 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.
+## Transform iddata objects from frequency to time domain.
+##
+## @strong{Inputs}
+## @table @var
+## @item dat
+## iddata set containing signals in frequency domain.
+## The frequency values must be distributed equally from 0
+## to the Nyquist frequency. The Nyquist frequency is
+## only included for even signal lengths.
+## @end table
+##
+## @strong{Outputs}
+## @table @var
+## @item dat
+## iddata identification dataset in time domain.
+## In order to preserve signal power and noise level,
+## the FFTs are normalized by multiplying each transform
+## by the square root of the signal length.
+## @end table
+##
## @end deftypefn
## Author: Lukas Reichlin <luk...@gm...>
Modified: trunk/octave-forge/extra/control-devel/inst/@iddata/plot.m
===================================================================
--- trunk/octave-forge/extra/control-devel/inst/@iddata/plot.m 2012-06-22 11:06:07 UTC (rev 10659)
+++ trunk/octave-forge/extra/control-devel/inst/@iddata/plot.m 2012-06-22 12:32:09 UTC (rev 10660)
@@ -17,7 +17,7 @@
## -*- texinfo -*-
## @deftypefn {Function File} plot (@var{dat})
-## Plot.
+## Plot iddata sets.
## @end deftypefn
## Author: Lukas Reichlin <luk...@gm...>
Modified: trunk/octave-forge/extra/control-devel/inst/@iddata/set.m
===================================================================
--- trunk/octave-forge/extra/control-devel/inst/@iddata/set.m 2012-06-22 11:06:07 UTC (rev 10659)
+++ trunk/octave-forge/extra/control-devel/inst/@iddata/set.m 2012-06-22 12:32:09 UTC (rev 10660)
@@ -17,10 +17,10 @@
## -*- texinfo -*-
## @deftypefn {Function File} set (@var{dat})
-## @deftypefnx {Function File} set (@var{retdat}, @var{"property"}, @var{value}, @dots{})
+## @deftypefnx {Function File} set (@var{dat}, @var{"property"}, @var{value}, @dots{})
## @deftypefnx {Function File} {@var{dat} =} set (@var{dat}, @var{"property"}, @var{value}, @dots{})
## Set or modify properties of iddata objects.
-## If no return argument @var{retdat} is specified, the modified LTI object is stored
+## If no return argument @var{dat} is specified, the modified LTI object is stored
## in input argument @var{dat}. @command{set} can handle multiple properties in one call:
## @code{set (dat, 'prop1', val1, 'prop2', val2, 'prop3', val3)}.
## @code{set (dat)} prints a list of the object's property names.
Modified: trunk/octave-forge/extra/control-devel/inst/@iddata/size.m
===================================================================
--- trunk/octave-forge/extra/control-devel/inst/@iddata/size.m 2012-06-22 11:06:07 UTC (rev 10659)
+++ trunk/octave-forge/extra/control-devel/inst/@iddata/size.m 2012-06-22 12:32:09 UTC (rev 10660)
@@ -16,15 +16,15 @@
## along with LTI Syncope. If not, see <http://www.gnu.org/licenses/>.
## -*- texinfo -*-
-## @deftypefn {Function File} {@var{nvec} =} size (@var{sys})
-## @deftypefnx {Function File} {@var{n} =} size (@var{sys}, @var{dim})
-## @deftypefnx {Function File} {[@var{n}, @var{p}, @var{m}, @var{ne}] =} size (@var{sys})
-## LTI model size, i.e. number of outputs and inputs.
+## @deftypefn {Function File} {@var{nvec} =} size (@var{dat})
+## @deftypefnx {Function File} {@var{ndim} =} size (@var{dat}, @var{dim})
+## @deftypefnx {Function File} {[@var{n}, @var{p}, @var{m}, @var{e}] =} size (@var{dat})
+## Return dimensions of iddata set @var{dat}.
##
## @strong{Inputs}
## @table @var
-## @item sys
-## LTI system.
+## @item dat
+## iddata set.
## @item dim
## If given a second argument, @command{size} will return the size of the
## corresponding dimension.
@@ -33,14 +33,19 @@
## @strong{Outputs}
## @table @var
## @item nvec
-## Row vector. The first element is the number of outputs (rows) and the second
-## element the number of inputs (columns).
+## Row vector. The first element is the total number of samples (rows of dat.y and dat.u).
+## The second element is the number of outputs (columns of dat.y) and the third element
+## the number of inputs (columns of dat.u). The fourth element is the number of experiments.
+## @item ndim
+## Scalar value. The size of the dimension @var{dim}.
## @item n
-## Scalar value. The size of the dimension @var{dim}.
+## Row vector containing the number of samples of each experiment.
## @item p
## Number of outputs.
## @item m
## Number of inputs.
+## @item e
+## Number of experiments.
## @end table
## @end deftypefn
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
