Engee documentation

evalRequirement

Page in progress.

Evaluates the fulfillment of requirements.

Library

EngeeDesignOptimization

Description

Function evalRequirement evaluates how well the signal meets the specified requirement. This function can be used when writing an objective function to evaluate the fulfillment of requirements. The function supports the requirement SignalTracking in the time domain: tracking the signal relative to the reference signal. This requirement can be useful for estimating model parameters.

Syntax

Function call

Arguments

Input arguments

# req — requirement

+ object

Details

A signal requirement set as an object EngeeDesignOptimization.SignalTracking.

Типы данных

EngeeDesignOptimization.SignalTracking

# TestPoint — time domain signal

+ the matrix | tabular data

Details

The monitored signal in the time domain, defined as a matrix or table, the first column of which contains the time, and the second — the real values of the signal.

Типы данных

Float64, DataFrame

# RefSignal — reference signal

+ the matrix | tabular data

Details

A reference signal defined as a matrix or table with the first column containing the time and the second column containing the real values of the signal.

If this argument is omitted, the signal defined in the object property will be used as the reference signal. ReferenceSignal.

Типы данных

Float64, DataFrame

Output arguments

# eval — the result of evaluating the fulfillment of the requirement

+ scalar | vector | the matrix

Details

The result of evaluating the fulfillment of a requirement, returned as a scalar, vector, or matrix.

The evaluation calculation depends on the properties of the object EngeeDesignOptimization.SignalTracking:

  • If the property Type it matters "==" Then eval characterizes how well the signal is being tracked. TestPoint corresponds to the reference signal. The algorithm for calculating the magnitude of the signal match is set using the object property Method.

  • If the property Type it matters ">=" or "⇐" Then eval It represents the distance from the monitored signal to the reference signal. Negative values indicate compliance with the restriction, and positive values indicate violation of it.

Function evalRequirement compares the reference and monitored signals only at those time points that fall within the definition range of both signals, using the interpolation method specified by the object property InterpolationTimes. Time points outside this range are ignored.

Типы данных

Float64