diff options
-rw-r--r-- | R/idframe.R | 16 | ||||
-rw-r--r-- | man/idfrd.Rd | 18 |
2 files changed, 33 insertions, 1 deletions
diff --git a/R/idframe.R b/R/idframe.R index 2bdd4ce..b06d0ba 100644 --- a/R/idframe.R +++ b/R/idframe.R @@ -170,7 +170,21 @@ print.summary.idframe <- function(object,...){ } #' S3 class for storing frequency response data -#' +#' +#' @param response complex vector/matrix containing the response +#' @param freq the frequencies at which the response is observed/estimated +#' @param Ts sampling time of data +#' +#' @return an idfrd object +#' +#' @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 +#' #' @export idfrd <- function(response,freq,Ts){ out <- list(response=response,freq=freq,Ts=Ts) 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 +} |