sdo.requirements.SignalTracking class
Package: sdo.requirements
Reference signal to track
Description
Specify a tracking requirement on a time-domain signal. You
can then optimize the model response to track the reference using sdo.optimize
.
You can specify an equality, upper or lower bound requirement.
Construction
creates an track_req
= sdo.requirements.SignalTrackingsdo.requirements.SignalTracking
object and
assigns default values to its properties.
uses additional options specified by one or more
track_req
=
sdo.requirements.SignalTracking(Name,Value
)Name,Value
pair arguments.
Name
is a property name and
Value
is the corresponding value.
Name
must appear inside single quotes
(''
). You can specify several name-value pair
arguments in any order as Name1,Value1,...,NameN,ValueN
.
Input Arguments
Name-Value ArgumentsSpecify optional pairs of arguments as
Name1=Value1,...,NameN=ValueN
, where Name
is
the argument name and Value
is the corresponding value.
Name-value arguments must appear after other arguments, but the order of the
pairs does not matter.
Before R2021a, use commas to separate each name and value, and enclose
Name
in quotes.
Use Name,Value
arguments to specify properties of the
requirement object during object creation. For example, requirement
= sdo.requirements.SignalTracking('Type','>=')
creates
an sdo.requirements.SignalTracking
object
and specifies the Type
property as a lower bound.
Properties
|
Absolute tolerance used to determine bounds as the signal approaches the reference signal. The bounds on the reference signal are given by: yu = (1 + RelTol)yr + AbsTol yl = (1 –RelTol)yr – AbsTol where yr is the value of the reference at a certain time, yu and yl are the upper and lower tolerance bounds corresponding to that time point. Default: | ||||||||||||
|
Requirement description, specified as a character vector. For
example, Default: | ||||||||||||
|
Time points to use when comparing reference and testpoint signals, specified as one of the following values:
Linear interpolation is used to compare the signals at the same timepoints. Default: | ||||||||||||
|
Algorithm for evaluating the requirement when the
When the requirement is evaluated using Default: | ||||||||||||
|
Requirement name, specified as a character vector. Default: | ||||||||||||
|
Enable or disable normalization when evaluating the requirement.
The maximum absolute value of the reference signal is used for normalization.
Must be Default: | ||||||||||||
|
Reference signal to track. Must be a MATLAB® Default: | ||||||||||||
|
Relative tolerance used to determine bounds as the signal approaches the reference signal. The bounds on the reference signal are given by: yu = (1 + RelTol)yr + AbsTol yl = (1 — RelTol)yr— AbsTol Default: | ||||||||||||
|
Enable or disable robust treatment of outliers when evaluating the requirement. The software uses a Huber loss function to handle the outliers in the cost function and improves the fit quality. This option reduces the influence of outliers on the estimation without you manually modifying your data. Must be one of the following:
Default: | ||||||||||||
|
Tracking requirement type, specified as one of the following values:
Default: | ||||||||||||
|
Weights to use when evaluating the tracking error between the reference and testpoint signals. Use weights to increase or decrease the significance of different time points. Must be real finite positive vector with the same number of
elements as the |
Methods
evalRequirement | Evaluate tracking requirement |
Copy Semantics
Handle. To learn how handle classes affect copy operations, see Copying Objects.
Examples
Construct a signal tracking object and specify a reference signal.
r = sdo.requirements.SignalTracking; r.ReferenceSignal = timeseries(1-exp(-(0:10)'));
Alternatively, you can specify the reference signal during construction.
r = sdo.requirements.SignalTracking(... 'ReferenceSignal',timeseries(1-exp(-(0:10)')));
Alternatives
Use getbounds
to get the
bounds specified in a Check Against Reference block.