Configuring the Correlation Matrix Block

Right-click on the correlation matrix block. This will open up the Properties page, which can be edited as follows:

Calculation trigger

Specify a calculation trigger. Valid options are:

  • On every execute: Calculation is triggered on every execute.

  • On value change: If the "On value change" option is selected, you must select a trigger field from the list of available fields on the parameter port. Correlation values are calculated only if the selected field value changes across good samples.  Changes in quality alone do not trigger an execute. Bad quality samples are ignored.

Data window
  1. Size: Enter the desired data window size in the Size edit box. This is the number of input samples over which the block performs each correlation calculation.

  2. Quality: Enter the desired % quality level for the data window in the Quality edit box. This indicates the percentage of samples in the data window that are required to produce a result of good quality. A 100% quality threshold means that all input samples in the data window need to be of good quality to produce a result of good quality. Reducing the quality level means that correspondingly fewer input samples of good quality are required for a result of good quality.

Average history
  1. Size: Enter the desired number of samples for the correlation average of each field pair in the Size edit box. This is the number of correlations to be included in the calculation of the average correlation.

  2. Quality: Enter the desired quality level for the correlation average in the Quality edit box. This indicates the percentage of samples in the average history that are required to be of good quality to produce a result of good quality. A 100% quality threshold means that all samples in the average history need to be of good quality to produce a result of good quality. Reducing the quality level means that correspondingly fewer average history samples of good quality are required for a result of good quality.

Correlation output
  1. Top number: Specify the top number of pairs with highest (+ or -) correlation for which the timestamps, qualities, and correlation values are output.

  2. Name field prefix: Specify the prefix used for the output name field of the correlation.

    The name field will be of the form <PREFIX>_<TOPNUMBER>, where
    - <PREFIX> is the prefix defined here and
    - <TOPNUMBER> is the integer representing the position that the field pair has in the list of top correlations.

    For example: Corr_N_20 is the field containing the name of the 20th top field pair correlation, for the configured Name field prefix of "Corr_N".

  3. Value field prefix: Specify the prefix used for the output value field of the correlation.

    The value field will be of the form <PREFIX>_<TOPNUMBER>, where
    - <PREFIX> is the prefix defined here and
    - <TOPNUMBER> is the integer representing the position that the field pair has in the list of top correlations.

    For example: Corr_V_20 is the field containing the value of the 20th top field pair correlation, for the configured Value field prefix of "Corr_V".

  4. Limit field occurrences: Optionally, if you wish to restrict the number of times a field may occur in the results, select this check box and specify an Occurrence limit.

Average correlation output

  1. Top number: Specify the top number of pairs with highest (+ or -) average correlation (for the given history size) for which the timestamps, qualities, and average correlation values are output.

  2. Name field prefix: Specify the prefix used for the output name field of the average correlation.

    The name field will be of the form <PREFIX>_<TOPNUMBER>, where
    - <PREFIX> is the prefix defined here and
    - <TOPNUMBER> is the integer representing the position that the field pair has in the list of top average correlations.

    For example: Avg_N_20 is the field containing the name of the 20th top field pair average correlation, for the configured Name field prefix of "Avg_N".

  3. Value field prefix: Specify the prefix used for the output value field of the average correlation.

    The value field will be of the form <PREFIX>_<TOPNUMBER>, where
    - <PREFIX> is the prefix defined here and
    - <TOPNUMBER> is the integer representing the position that the field pair has in the list of top average correlations.

    For example: Avg_V_20 is the field containing the value of the 20th top field pair average correlation, for the configured Value field prefix of "Avg_V".

  4. Limit field occurrences: Optionally, if you wish to restrict the number of times a field may occur in the results, select this check box and specify an Occurrence limit.

Deviation from previous average output

  1. Top number: Specify the top number of pairs with highest (+ or -) deviations from their previous calculated average correlations for which the timestamps, qualities, and deviations from those average values are output.

  2. Name field prefix: Specify the prefix used for the output name field of the deviations from previous calculated average.

    The name field will be of the form <PREFIX>_<TOPNUMBER>, where
    - <PREFIX> is the prefix defined here and
    - <TOPNUMBER> is the integer representing the position that the field pair has in the list of top deviations from corresponding previous calculated average correlations.

    For example: Dev_N_20 is the field containing the name of the 20th top field pair deviation from previous calculated average correlation, for the configured Name field prefix of "Dev_N".

  3. Value field prefix: Specify the prefix used for the output value field of the deviations from previous calculated average.

    The value field will be of the form <PREFIX>_<TOPNUMBER>, where
    - <PREFIX> is the prefix defined here and
    - <TOPNUMBER> is the integer representing the position that the field pair has in the list of top deviations from corresponding previous calculated average correlations.

    For example: Dev_V_20 is the field containing the value of the 20th top field pair deviation from average correlation, for the configured Value field prefix of "Dev_V".

  4. Limit field occurrences: Optionally, if you wish to restrict the number of times a field may occur in the results, select this check box and specify an Occurrence limit.

NOTE:

  • Careful consideration should go into the following when configuring the block: number of input fields passed into the block, data window size, average history size. As these factors increase, the amount of memory and processing time required can quickly escalate.

  • The input port takes any type, but string fields are ignored. In order for this block to run, the input port must be connected to a source with at least two integer or double fields.

  • If you specify a top number which is greater than the total number of unique pairs, output fields will be created for the total number of unique pairs.

    • For example, if you specify a top number of 5000 but there are only 5 input fields, only 10 output fields will be created (since there are only 10 unique pairs), not 5000.

  • If you specify a top number which is greater than the total number of unique pairs with the occurrence limit applied, the block will set the quality of the excess fields to bad.

    • For example, if you have 3 inputs, and if you specify a top number of 3 and an occurrence limit of 1, the block will create 3 output fields, but only the first pair will display a field name and field value, while the other two pairs will display a blank field name, field values of zero, and bad quality.

Return to top


Related topics:

  

CSense 2023- Last updated: June 24,2025