TimeSeries
This class generates a series of points in time. The series is always sorted in ascending order. Depending of the application the series is interpreted as list of points or as intervals between the points.
UniformSampling
Generates a time series with uniform sampling. The first point in time will be timeStart. The last generated point in time will be less or equal timeEnd. The time step between generated points in time is given by sampling.
Name | Type | Annotation |
---|---|---|
timeStart | time | first point in time |
timeEnd | time | last point in time will be less or equal timeEnd |
sampling | time | time step between points in time |
UniformInterval
Generates a time series with uniform sampling between timeStart and timeEnd. intervallCount gives the count of intervals. This class generates count+1 points in time inclusive timeStart and timeEnd.
Name | Type | Annotation |
---|---|---|
timeStart | time | 1st point of the time series |
timeEnd | time | last point of the time series |
intervalCount | uint | count of intervals, count+1 points in time will generated |
Irregular
The points of the time series are given explicitly with time.
Name | Type | Annotation |
---|---|---|
time | time | explicit list of points in time |
Monthly
If monthMiddle is set, time points are generated at mid of each month inclusively the monthStart in yearStart and monthEnd in yearEnd. Otherwise times are given at the first of each month and a time point after the last month.
Name | Type | Annotation |
---|---|---|
monthStart | uint | |
yearStart | uint | |
monthEnd | uint | |
yearEnd | uint | |
useMonthMiddle | boolean | time points are mid of months, otherwise the 1st of each month + a time point behind the last month |
Yearly
If yearMiddle is set, time points are generated at mid of each year inclusively yearStart and yearEnd. Otherwise times are given at the first of each year and a time point after the last year.
Name | Type | Annotation |
---|---|---|
yearStart | uint | |
yearEnd | uint | |
useYearMiddle | boolean | time points are mid of years, otherwise the 1st of each year + a time point behind the last year |
EveryMonth
Generates a time series with monthly sampling. The first point in time will be timeStart and the following points are generated for each month at the same day and time in month. The last generated point in time will be less or equal timeEnd.
Name | Type | Annotation |
---|---|---|
timeStart | time | first point in time |
timeEnd | time | last point in time will be less or equal timeEnd |
EveryYear
Generates a time series with yearly sampling. The first point in time will be timeStart and the following points are generated for each year at the same day and time in year. The last generated point in time will be less or equal timeEnd.
Name | Type | Annotation |
---|---|---|
timeStart | time | first point in time |
timeEnd | time | last point in time will be less or equal timeEnd |
Instrument
Read a time series (epochs) from an instrument file. The time series can be restricted to the interval starting from timeStart and before timeEnd.
Name | Type | Annotation |
---|---|---|
inputfileInstrument | filename | |
timeStart | time | exclude peochs before this epoch |
timeEnd | time | only epochs before this time are used |
InstrumentArcIntervals
Reconstruct a time series from an instrument file. The time series is the first epoch of each arc plus one time step beyond the last epoch of the last arc (using median sampling).
Name | Type | Annotation |
---|---|---|
inputfileInstrument | filename | Must be regular. Time series is first epoch of each arc plus one time step extrapolated from last epoch of last arc. |
Revolution
Reads an orbit file and create a time stamp for each ascending equator crossing. The time series can be restricted to the interval starting from timeStart and before timeEnd.
Name | Type | Annotation |
---|---|---|
inputfileOrbit | filename | |
timeStart | time | exclude peochs before this epoch |
timeEnd | time | only epochs before this time are used |
Exclude
In a first step a timeSeries is generated. In a second step all times are removed which are in range before or after excludeMargin seconds of the times given by timeSeriesExclude.
Name | Type | Annotation |
---|---|---|
timeSeries | timeSeries | time series to be created |
timeSeriesExclude | timeSeries | exclude this time points from time series (within margin) |
excludeMargin | double | on both sides [seconds] |
Conditional
Only times for which the condition is met are included in the time series. The variableLoopTime is set to every time and the condition is evaluated.
Name | Type | Annotation |
---|---|---|
timeSeries | timeSeries | only times for which condition is met will be included |
variableLoopTime | string | variable with time of each loop |
condition | condition | test for each time |
Interpolate
Interpolates nodeInterpolation count points between the given timeSeries uniformly.
Name | Type | Annotation |
---|---|---|
timeSeries | timeSeries | time series to be created |
nodeInterpolation | uint | interpolates count points in each time interval given by the time series |