Mercurial > forge

comparison extra/control-devel/inst/@iddata/iddata.m @ 9945:5291eef2375e octave-forge

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
control-devel: texinfo help for iddata
author paramaniac
date Mon, 02 Apr 2012 15:17:42 +0000
parents f0001b666a66
children 35a9395eb191
comparison
equal deleted inserted replaced
9944:4f74edffa72c 9945:5291eef2375e
14 ## 14 ##
15 ## You should have received a copy of the GNU General Public License 15 ## You should have received a copy of the GNU General Public License
16 ## along with LTI Syncope. If not, see <http://www.gnu.org/licenses/>. 16 ## along with LTI Syncope. If not, see <http://www.gnu.org/licenses/>.
17 17
18 ## -*- texinfo -*- 18 ## -*- texinfo -*-
19 ## @deftypefn{Function File} {@var{dat} =} iddata (@var{y}, @var{u}) 19 ## @deftypefn{Function File} {@var{dat} =} iddata (@var{y})
20 ## @deftypefnx{Function File} {@var{dat} =} iddata (@var{y}, @var{u}, @var{tsam}) 20 ## @deftypefnx{Function File} {@var{dat} =} iddata (@var{y}, @var{u})
21 ## Fit frequency response data with a state-space system. 21 ## @deftypefnx{Function File} {@var{dat} =} iddata (@var{y}, @var{u}, @var{tsam}, @dots{})
22 ## If requested, the returned system is stable and minimum-phase. 22 ## @deftypefnx{Function File} {@var{dat} =} iddata (@var{y}, @var{u}, @var{[]}, @dots{})
23 ## Create identification dataset of output and input signals.
23 ## 24 ##
24 ## @strong{Inputs} 25 ## @strong{Inputs}
25 ## @table @var 26 ## @table @var
26 ## @item dat 27 ## @item y
27 ## LTI model containing frequency response data of a SISO system. 28 ## Real matrix containing the output signal in time-domain.
28 ## @item n 29 ## For a system with @var{p} outputs and @var{n} samples,
29 ## The desired order of the system to be fitted. @code{n <= length(dat.w)}. 30 ## @var{y} is a n-by-p matrix.
30 ## @item flag 31 ## For data from multiple experiments, @var{y} becomes a
31 ## The flag controls whether the returned system is stable and minimum-phase. 32 ## e-by-1 or 1-by-e cell vector of n(i)-by-p matrices,
32 ## @table @var 33 ## where @var{e} denotes the number of experiments
33 ## @item 0 34 ## and n(i) the individual number of samples for each experiment.
34 ## The system zeros and poles are not constrained. Default value. 35 ## @item u
35 ## @item 1 36 ## Real matrix containing the input signal in time-domain.
36 ## The system zeros and poles will have negative real parts in the 37 ## For a system with @var{m} inputs and @var{n} samples,
37 ## continuous-time case, or moduli less than 1 in the discrete-time case. 38 ## @var{u} is a n-by-m matrix.
38 ## @end table 39 ## For data from multiple experiments, @var{u} becomes a
40 ## e-by-1 or 1-by-e cell vector of n(i)-by-m matrices,
41 ## where @var{e} denotes the number of experiments
42 ## and n(i) the individual number of samples for each experiment.
43 ## @item tsam
44 ## Sampling time.
45 ## @item @dots{}
46 ## Optional pairs of properties and values.
39 ## @end table 47 ## @end table
40 ## 48 ##
41 ## @strong{Outputs} 49 ## @strong{Outputs}
42 ## @table @var 50 ## @table @var
43 ## @item sys 51 ## @item dat
44 ## State-space model of order @var{n}, fitted to frequency response data @var{dat}. 52 ## iddata identification dataset.
45 ## @item n
46 ## The order of the obtained system. The value of @var{n}
47 ## could only be modified if inputs @code{n > 0} and @code{flag = 1}.
48 ## @end table 53 ## @end table
49 ## 54 ##
50 ## @strong{Algorithm}@*
51 ## Uses SLICOT SB10YD by courtesy of
52 ## @uref{http://www.slicot.org, NICONET e.V.}
53 ## @end deftypefn 55 ## @end deftypefn
54 56
55 ## Author: Lukas Reichlin <lukas.reichlin@gmail.com> 57 ## Author: Lukas Reichlin <lukas.reichlin@gmail.com>
56 ## Created: October 2011 58 ## Created: October 2011
57 ## Version: 0.1 59 ## Version: 0.1