GaussFitInterval

Advanced Analysis Library Only

AnalysisLibErrType GaussFitInterval (double arrayX[], double arrayY[], double weight[], int numberOfElements, int intervalType, double confidenceLevel, double amplitude, double center, double standardDeviation, double upperBound[], double lowerBound[], double *deltaAmplitude, double *deltaCenter, double *deltaDeviation);

Purpose

Calculates the confidence interval for the best Gaussian fitting function or the prediction interval for the observations. The confidence interval refers to the interval within which the actual function is expected to fall. The prediction interval refers to the interval within which the y values are expected to fall in repeated measurements.

Parameters

Input
Name Type Description
arrayX double-precision array The x value of the data set (x, y).
arrayY double-precision array The y value of the data set (x, y).
weight double-precision array The weight of each data point. If weight is NULL, the function assumes all the weights are 1.
numberOfElements integer The length of arrayX, arrayY, and weight.
intervalType integer The type of interval. intervalType must be one of the following values:
  • CONFIDENCE_INTVL (0)
  • PREDICTION_INTVL (1)
deltaAmplitude, deltaCenter, and deltaDeviation are not referenced if intervalType is PREDICTION_INTVL.
confidenceLevel double-precision The level of certainty for the confidence interval or prediction interval. For the confidence interval, confidenceLevel specifies the probability that the actual function lies within the confidence interval. For the prediction interval, confidenceLevel specifies the probability that the arrayY values lie within the prediction interval in repeated measurements. confidenceLevel must be between 0 and 1.
amplitude double-precision The amplitude of the fitted Gaussian model calculated using the Least Square method.
center double-precision The center of the fitted Gaussian model calculated using the Least Square method.
standardDeviation double-precision The standard deviation of the fitted Gaussian model calculated using the Least Square method.
Output
Name Type Description
upperBound double-precision array The upper bound of the confidence interval or prediction interval.
lowerBound double-precision array The lower bound of the confidence interval or prediction interval.
deltaAmplitude double-precision The uncertainty radius of amplitude. deltaAmplitude is available only when intervalType is CONFIDENCE_INTVL.
deltaCenter double-precision The uncertainty radius of center. deltaCenter is available only when intervalType is CONFIDENCE_INTVL.
deltaDeviation double-precision The uncertainty radius of standardDeviation. deltaDeviation is available only when intervalType is CONFIDENCE_INTVL.

Return Value

Name Type Description
status AnalysisLibErrType A value that specifies the type of error that occurred. Refer to analysis.h for definitions of these constants.