The MVAOutputParameterType describes output paramaters of the MVAModelType and MVAPredictMethodType.
MVAOutputParameterType is formally defined in Table 117.
Table 117 – MVAOutputParameterType Definition
Attribute |
Value |
|||||
BrowseName |
MVAOutputParameterType |
|||||
IsAbstract |
False |
|||||
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
|
Subtype of the DataItemType defined in [OPC 10000-8] |
||||||
HasProperty |
Variable |
WarningLimits |
Range |
PropertyType |
Optional |
|
HasProperty |
Variable |
AlarmLimits |
Range |
PropertyType |
Optional |
|
HasProperty |
Variable |
AlarmState |
AlarmStateEnumeration |
PropertyType |
Mandatory |
|
HasProperty |
Variable |
VendorSpecificError |
String |
PropertyType |
Optional |
|
HasComponent |
Variable |
Statistics |
MVAOutputParameterType [] |
BaseDataVariableType |
OptionalPlaveholder |
WarningLimits and AlarmLimits describe the ranges used to determine the acceptable limits of the resulting numerical MVAOutputParameter value. These values shall be set for numerical values.
In terms of automation, if value is:
value ˂ AlarmLimits.Low → ALARM_LOW
WarningLimits.Low ≤ value ˂ AlarmLimits.Low → WARNING_LOW
WarningLimits.Low ≤ value ≤ WarningLimits.High → NORMAL
WarningLimits.High ˂ value ≤ AlarmLimits.High → WARNING_HIGH
AlarmLimits.High < value → ALARM_HIGH
AlarmState describes if the resulting MVAOutputParameter value is acceptable for example within the value limits. However, a value may be between the limits and still be in alarm due to other model consideration or for example, if a classification model is not able to classify a given sample.
Table 118 – AlarmStateEnumeration Values
Value |
Description |
NORMAL_0 |
Normal |
WARNING_LOW_1 |
In low warning range |
WARNING_HIGH_2 |
In high warning range |
WARNING_4 |
In warning range (low or high) or some other warning cause |
ALARM_LOW_8 |
In low alarm range |
ALARM_HIGH_16 |
In high alarm range |
ALARM_32 |
In alarm range (low or high) or some other alarm cause |
The Statistics is an array of statistics generated at the same time as the MVAOutputParameter that qualifies it.
The VendorSpecificError contains detailed vendor specific error message explaining the alarm state.
The DataType attribute of MVAOutputParameter may be:
- AnalogItemType for scalar value or unstructured array. In this case, WarningLimits and AlarmLimits shall be set. EngineeringUnits should be set.
- ArrayItemType subtype if parameters like spectrum.
- DataItemType for String
It is strongly recommended to express MVAModel parameters in terms of high level types, for example, a spectrometer produces spectra that are YArrayItemType. The address space should expose a single parameter for it rather than N scalar values where N is the number of data points in the spectrum. This may imply that models shall be built using some convention rules, but doing so, really simplify the interaction with the prediction service of the ADI server. For example:
- If all scalar variables defining an YArrayItemType are prefixed with something like "NIR_", then the SetConfiguration, LoadModel may easily detect it and create the right parameter type.
- Use a convention where the first variable is the MainData variable or prefixing the MainData variable variables with the "MainData_" prefix may help to automatically find the MainDataIndex.
The Predict method should be able to extract the required range from a high level type input parameter. For example, if the input parameter is a spectrum with a X axis range of 400cm-1 to 5000cm-1, it shall be possible to pass a spectrum with a range of 200cm-1 to 6000cm-1 to the Predict method and the Predict method shall be able to extract the right region.
To guarantee the correctness of the predictions, the server should apply some validation rules to verify that the input parameters are compatible with the model, for example, for spectral data, the validation may include:
- The alignment of the sampling grid of spectral data shall be compatible with the model.
- The spectral range of the input spectrum is wide enough to cover the range expected by the model.
Inputs and Outputs parameters shall not be a brutal dump of the API of the vendor predictor, but rather express in terms of what an end user needs to see. It does not forbid exposing the API structures, but often these structures are very difficult to use for "process clients" like DCS or SCADA.