Statistic
DatatypeDraftv1.0.0-rc.2
A statistic: how an amount sums up data, such as a mean, a maximum or an exceedance level.
https://opendevelopmentstandards.org/schema/1.0.0-rc.2/core/Statistic.json
Fields
typeRequiredOne ofthe codes belowWhich statistic it is.
mean- The arithmetic mean.
energy_mean- The mean of the powers that levels in decibels stand for, given as a level: the equivalent continuous level (Leq).
median- The middle value.
minimum- The smallest value.
maximum- The largest value.
sum- The arithmetic sum.
energy_sum- The sum of the powers that levels in decibels stand for, given as a level, such as an octave band from its three third-octave bands.
count- The number of values.
standard_deviation- The sample standard deviation, with n − 1 in the denominator.
standard_error- The standard error of the mean: the sample standard deviation divided by the square root of the count.
root_mean_square- The square root of the mean of the squares.
percentile- The value at or below which `percent` of the values fall, such as the 99.9th percentile of 1-hour means.
exceedance- The value that the data exceed for `percent` of the time, such as L90 (percent 90). An exceedance level of p is the percentile of 100 − p.
percentnumberat least 0at most 100For a percentile or an exceedance level: the percent, such as 90 for L90.
- When
typeispercentileorexceedance, it needspercent; otherwisepercentis not allowed.
Links
Held by Records that embed this one, with their field that holds it.
- AxisDatatypeBins.statisticOne dimension of a Value's amount, such as frequency, time, height or wind speed. It gives the coordinate of each element along it.
- CriterionPartstatisticOne rule that must be checked. It compares a metric, summed up by a statistic over a period, with a limit, for the features it applies to.
- ValueDatatypestatisticAn amount with its unit and uncertainty. A list amount can lie along axes (a spectrum, a time series, a profile, a grid), and a large amount can sit in a File. Measured, calculated and set values all use it.
Examples
An id that another example defines opens that record.
Example 3
{
"type": "percentile",
"percent": 99.9
}Show 2 more examplesHide the other examples
Example 1
{
"type": "energy_mean"
}Example 2
{
"type": "exceedance",
"percent": 90
}Changes and file
Changes
- 0.1.0 First version.
Schema file
Show the JSON SchemaHide the JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://opendevelopmentstandards.org/schema/1.0.0-rc.2/core/Statistic.json",
"title": "Statistic",
"description": "A statistic: how an amount sums up data, such as a mean, a maximum or an exceedance level.",
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"mean",
"energy_mean",
"median",
"minimum",
"maximum",
"sum",
"energy_sum",
"count",
"standard_deviation",
"standard_error",
"root_mean_square",
"percentile",
"exceedance"
],
"description": "Which statistic it is.",
"x-ods-options": [
{
"value": "mean",
"title": "Mean",
"description": "The arithmetic mean."
},
{
"value": "energy_mean",
"title": "Energy mean",
"description": "The mean of the powers that levels in decibels stand for, given as a level: the equivalent continuous level (Leq)."
},
{
"value": "median",
"title": "Median",
"description": "The middle value."
},
{
"value": "minimum",
"title": "Minimum",
"description": "The smallest value."
},
{
"value": "maximum",
"title": "Maximum",
"description": "The largest value."
},
{
"value": "sum",
"title": "Sum",
"description": "The arithmetic sum."
},
{
"value": "energy_sum",
"title": "Energy sum",
"description": "The sum of the powers that levels in decibels stand for, given as a level, such as an octave band from its three third-octave bands."
},
{
"value": "count",
"title": "Count",
"description": "The number of values."
},
{
"value": "standard_deviation",
"title": "Standard deviation",
"description": "The sample standard deviation, with n − 1 in the denominator."
},
{
"value": "standard_error",
"title": "Standard error",
"description": "The standard error of the mean: the sample standard deviation divided by the square root of the count."
},
{
"value": "root_mean_square",
"title": "Root mean square",
"description": "The square root of the mean of the squares."
},
{
"value": "percentile",
"title": "Percentile",
"description": "The value at or below which `percent` of the values fall, such as the 99.9th percentile of 1-hour means."
},
{
"value": "exceedance",
"title": "Exceedance level",
"description": "The value that the data exceed for `percent` of the time, such as L90 (percent 90). An exceedance level of p is the percentile of 100 − p."
}
]
},
"percent": {
"type": "number",
"minimum": 0,
"maximum": 100,
"description": "For a percentile or an exceedance level: the percent, such as 90 for L90."
}
},
"required": [
"type"
],
"allOf": [
{
"if": {
"properties": {
"type": {
"enum": [
"percentile",
"exceedance"
]
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"percent": true
},
"required": [
"percent"
]
},
"else": {
"not": {
"properties": {
"percent": true
},
"required": [
"percent"
]
}
}
}
],
"patternProperties": {
"^x-": {}
},
"unevaluatedProperties": false,
"examples": [
{
"type": "energy_mean"
},
{
"type": "exceedance",
"percent": 90
},
{
"type": "percentile",
"percent": 99.9
}
],
"x-ods-status": "draft",
"x-ods-kind": "datatype",
"x-ods-module": "core",
"x-ods-changes": {
"0.1.0": "First version."
}
}