SequentialFilter.GetPreUpdateResidualStatistics(StringArray, Array, Array, Array, Variable) Method

Top 

Description

This method returns the number of measurement types for which statistics were calculated.

 

Timing Precision Mode

This page describes functionality in millisecond timing precision mode.

Click here to see the documentation for this object in nanosecond timing precision mode.

 

Method Signature

SequentialFilter.GetPreUpdateResidualStatistics(

StringArray measurementTypes,


Array residualMean,


Array residualSigma,


Array residualRMS,


Variable includeEditedMeasurements)

 

 

Arguments

measurementTypes


Description:

StringArray containing a list of all the measurement types included in the buffer.

 

 

residualMean


Description:

Array containing the mean residual for each measurement type.

Required Size:

At least 0

 

 

residualSigma


Description:

Array containing the standard deviation of the residual for each measurement type.

Required Size:

At least 0

 

 

residualRMS


Description:

Array containing the RMS of the residual for each measurement type.

Required Size:

At least 0

 

 

includeEditedMeasurements


Description:

Optional flag indicating whether or not to include measurements which have been edited out in the estimation process.

Valid Values:

Value

Label

0

false

1

true

 

 

 

 

Return Value

Type:

number

 

 

This method returns the number of measurement types for which statistics were calculated.

 

Syntax

myVariable1 = mySequentialFilter1.GetPreUpdateResidualStatistics(myStringArray1, myArray1, myArray2, myArray3, myVariable2);

 

 

See also

SequentialFilter Object

SequentialFilter.GetPreUpdateResidualStatistics