validate: Validate a TransferFunction by applying some simple Tests

Description Usage Arguments Value See Also

View source: R/TransferFunction.R

Description

Each TransferFunction object is actually a list of so-called elementary transfer functions; for details on this see composition(). This validate() applies an internal validate() function to each elementary function individually. The internal validate() function generates some points in the domain of the function and checks that all points are transfered into the range of the function. If the function is also invertible, it checks that the inverse transfers back to the original point.

Usage

1
2
## S3 method for class 'TransferFunction'
validate( TF, points=1300, tol=5.e-7, domain=NULL )

Arguments

TF

a TransferFunction object with dimension N, and consisting of M elementary transfer functions

points

the number of points to test, in each elementary function

tol

the numerical tolerance for the inversion test - this is relative to the length of the corresponding side of the domain box

domain

a 2xN matrix to use as an alternate domain, for the first elementary function in the list only. domain can also be a vector of length 2, which is then replicated to a 2xN matrix.

Value

The function returns a logical vector of length M. The value of the i'th element is the validation status of the i'th elementary function. The returned vector has the attribute 'message' which is a list of length M with explanatory text. For nicely formatted text see print().

See Also

TransferFunction, identity.TF, composition(), print.TransferFunction()


spacesRGB documentation built on Dec. 11, 2021, 9:58 a.m.