kpi summary

The KPI Summary show a global summary for each KPI over all evaluated files. This allows an simple an quick statistical analysis of the evaluated files at a glance.

Configuration

The summary functions can be de-/selected in the options menu. There are predefined summary functions, but also custom summary functions can be created using MATLAB code.

The following default summary functions are provided with MXeval directly:

MEAN	Average value
RMS	Root mean square value
STD	Standard deviation
BEST_FILE	Number of the file with the best value (Only available if assessment data is provided!)
BEST_VALUE	Value of the file with the best value (Only available if assessment data is provided!)
WORST_FILE	Number of the file with the worst value (Only available if assessment data is provided!)
WORST_VALUE	Value of the file with the worst value (Only available if assessment data is provided!)

The default summary functions cannot be edited or removed!

Custom Functions

Create custom summary functions by using MATLAB code (see Custom Code Limitations).

When creating a new custom function, the script template provides all relevant information.

% ========================================================================

% CUSTOM SUMMARY FUNCTION

% ========================================================================

% Available data:

% - IN_KPI: [1xN double] KPI values of current KPI

% - IN_BOUNDARY: [1x4 double] boundaries of current KPI

% (according to the KPI assessment)

% - IN_TESTID: [1xN char] current test ID

% - IN_FILENAME: [1xN cell] cell array of strings,

% containing evaluated filenames

% Required data:

% - OUT_VALUE: [1x1 double] summary value for current KPI

Example code for custom summary function:

OUT_VALUE = max(IN_KPI);	% maximum KPI value of all evaluated files
OUT_VALUE = mean(IN_KPI);	% mean KPI value of all evaluated files