Data - ParamStatDoc
The ParamStatDoc document is a data document that contains the properties and statistics values for a parameter instance over a specified time range.
Field | Data Type | Required | Default | Description |
---|---|---|---|---|
id | String | Yes | - | A unique identifier that is referenced by all other documents see section Unique Id Generation. |
configDocId | String | Yes | - | The unique identifier (id) of the ConfigDoc document that this document is associated with. |
paramDefDocIds | String | Yes | - | The unique identifier (id) of the ParamDefinitionDocs associated with the data values stored in this document. |
startTime | 64-bit Long | Yes | - | A 64-bit Long timestamp specifying start time of the data that this configuration holds. The timestamp represents the number of nanoseconds since the reference time of midnight, 1st January 1970. |
endTime | 64-bit Long | Yes | - | A 64-bit Long timestamp specifying end time of the data that this configuration holds. The timestamp represents the number of nanoseconds since the reference time of midnight, 1st January 1970. |
intervalType | Fixed String | Yes | Experiment | A fixed string representing the interval type. Valid options are: Experiment, Time, Session, Lap, Corner, Straight, Run. |
statDocs | Array [StatDoc] | No | - | An Array of StatDoc that hold the calculated data associated with this document. |
type | Fixed String | Fixed | ParamStatDoc | The fixed value is always set to ParamStatDoc. |
When used with the Regno Platform, following stats are optionally auto-generated.
min: A 64-bit Double value representing the minimum sample value during the specified time range.
max: A 64-bit Double value representing the maximum sample value during the specified time range.
range: A 64-bit Double value representing the result of the (maximum – minimum) sample value during the specified time range.
mean: A 64-bit Double value representing the mean value for all samples during the specified time range.
meanOfAbsolutes: A 64-bit Double value representing the mean value for all samples during the specified time range. Each sample value is first converted to an absolute value before being used for the mean calculation.
geometricMean: A 64-bit Double value representing the geometric mean value of all samples during the specified time range.
start: A 64-bit Double value representing the first sample value at or after the specified startTime.
end: A 64-bit Double value representing the last sample value before the specified endTime. The time range is inclusive so the value could be the value at the specified endTime.
change: A 64-bit Double value representing the result of the (end – start) sample value during the specified time range.
standardDeviation: A 64-bit Double value representing the standard deviation of all samples during the specified time range.
linearRegressionSlope: A 64-bit Double value representing the slope of the linear regression of all samples in the specified time range.
linearRegressionIntercept: A 64-bit Double value representing the intercept value of the linear regression of all samples in the specified time range.
linearRegressionRSquared: A 64-bit Double value representing the statistical R Squared value of the linear regression of all samples in the specified time range.
min: A 64-bit Double value representing the minimum sample value during the specified time range.
max: A 64-bit Double value representing the maximum sample value during the specified time range.
range: A 64-bit Double value representing the result of the (maximum – minimum) sample value during the specified time range.
mean: A 64-bit Double value representing the mean value for all samples during the specified time range.
meanOfAbsolutes: A 64-bit Double value representing the mean value for all samples during the specified time range. Each sample value is first converted to an absolute value before being used for the mean calculation.
geometricMean: A 64-bit Double value representing the geometric mean value of all samples during the specified time range.
start: A 64-bit Double value representing the first sample value at or after the specified startTime.
end: A 64-bit Double value representing the last sample value before the specified endTime. The time range is inclusive so the value could be the value at the specified endTime.
change: A 64-bit Double value representing the result of the (end – start) sample value during the specified time range.
standardDeviation: A 64-bit Double value representing the standard deviation of all samples during the specified time range.
linearRegressionSlope: A 64-bit Double value representing the slope of the linear regression of all samples in the specified time range.
linearRegressionIntercept: A 64-bit Double value representing the intercept value of the linear regression of all samples in the specified time range.
linearRegressionRSquared: A 64-bit Double value representing the statistical R Squared value of the linear regression of all samples in the specified time range.