analysis_data_summary

analysis_data_summary(data, plotting_parameter=0.0)

Run the plotting-position and threshold cascade over an observation frame.

The plotting positions are the Hirsch-Stedinger censored positions, so interval and threshold observations shift the positions of the systematic record even though they carry no plotting ordinate themselves.

Parameters

Name Type Description Default
data AnalysisData or array_like The observation frame, or a plain sequence of observations. required
plotting_parameter float The plotting-position parameter in [0, 1): 0 is Weibull, 0.40 Cunnane, 0.44 Gringorten, 0.50 Hazen. 0.0

Returns

Name Type Description
dict index, value, plotting_position, and is_low_outlier are parallel lists over the exact series; number_of_low_outliers, low_outlier_threshold, plotting_parameter, lambda (events per index), total_record_length, zero_value_relative_frequency, and the four series counts are scalars.

Examples

>>> s = analysis_data_summary([12500, 15300, 8900, 22100])
>>> s["plotting_position"]
[0.4, 0.2, 0.6, 0.2]