summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorSuraj Yerramilli2015-06-06 21:08:42 +0530
committerSuraj Yerramilli2015-06-06 21:08:42 +0530
commit17294fc2555e107198de5fbb27122e1fdddb6593 (patch)
treec6b080554d815bb77023998b3808b94c722df065 /man
parente4efc4e9fe9a5caaa53a30b206a1b0070edc80ff (diff)
downloadSysID-R-code-17294fc2555e107198de5fbb27122e1fdddb6593.tar.gz
SysID-R-code-17294fc2555e107198de5fbb27122e1fdddb6593.tar.bz2
SysID-R-code-17294fc2555e107198de5fbb27122e1fdddb6593.zip
Documenting idfrd
Diffstat (limited to 'man')
-rw-r--r--man/idfrd.Rd18
1 files changed, 18 insertions, 0 deletions
diff --git a/man/idfrd.Rd b/man/idfrd.Rd
index c44a83a..1a0b72e 100644
--- a/man/idfrd.Rd
+++ b/man/idfrd.Rd
@@ -6,7 +6,25 @@
\usage{
idfrd(response, freq, Ts)
}
+\arguments{
+\item{response}{complex vector/matrix containing the response}
+
+\item{freq}{the frequencies at which the response is observed/estimated}
+
+\item{Ts}{sampling time of data}
+}
+\value{
+an idfrd object
+}
\description{
S3 class for storing frequency response data
}
+\note{
+The class can currently store only SISO Responses. Future versions will
+have support for multivariate data
+}
+\seealso{
+\code{\link{plot.idfrd}} for generating bode plots; \code{\link{spa}} and
+\code{\link{etfe}} for estimating the frequency response given input/output data
+}