C_OpenExtremeStatistics

C_OpenExtremeStatistics is used together with C_FitExtremeStatistics, C_QueryExtremeStatistics, C_CalculateExtremeStatisticsExcessesOverThreshold, C_SimulateToleranceIntervals and C_CloseExtremeStatistics to perform extreme value statistical analyses.

A typical sequence of calls to perform such an analysis is as follows:

• Call C_GetTimeHistory2 to extract a time history for an OrcaFlex results variable.
• Call C_OpenExtremeStatistics passing in the time history and the sample interval. A handle is returned which is then used in the subsequent calls to extreme statistics analysis functions.
• Optionally call C_CalculateExtremeStatisticsExcessesOverThreshold (potentially multiple times) to help choose a threshold for the peaks over threshold based Weibull and GPD distributions.
• Call C_FitExtremeStatistics to fit the specified extreme value statistical model to the time history.
• Call C_QueryExtremeStatistics (potentially multiple times) to extract results from the fitted statistical model.
• Finally, call C_CloseExtremeStatistics is called to dispose of the resources associated with the handle.

Parameters

NumberOfValues (IN)

The number of values in the lpValues array.

lpValues (IN)

Points to the array of values. Typically, but not necessarily, this will be generated by a call to C_GetTimeHistory2.

SampleInterval (IN)

The interval in seconds between each consecutive value of lpValues.

lpExtremeStatisticsHandle (OUT)

Points to a variable in which the extreme statistics handle will be returned.

lpStatus (OUT)

Points to a variable in which the status result for the function call will be returned.

See also

C_FitExtremeStatistics, C_QueryExtremeStatistics, C_CalculateExtremeStatisticsExcessesOverThreshold, C_SimulateToleranceIntervals , C_CloseExtremeStatistics.