Skip to content
Snippets Groups Projects
Verified Commit b90af831 authored by Björn Ludwig's avatar Björn Ludwig
Browse files

feat(data_types): introduce one aggregated data type to specify the sample size of extracted data

parent ea274a78
No related branches found
No related tags found
No related merge requests found
"""This module contains type aliases and data types for type hints"""
__all__ = ["RealMatrix", "RealVector", "UncertainArray"]
__all__ = ["RealMatrix", "RealVector", "SampleSize", "UncertainArray"]
from typing import NamedTuple, TypeAlias
......@@ -20,3 +20,25 @@ class UncertainArray(NamedTuple):
"""the corresponding values"""
uncertainties: RealMatrix | RealVector
"""... and their associated uncertainties"""
class SampleSize(NamedTuple):
"""A tuple to specify the size of the extracted data"""
idx_first_cycle: int = 0
"""index of first sample to be extracted
defaults to 0 and must be between 0 and 4765
"""
n_cycles: int = 1
"""number of cycles extracted from the dataset
each cycle contains the first :attr:`datapoints_per_cycle` readings from each of
the eleven sensors for one of the cycles with associated standard uncertainties,
defaults to 1 and must be between 1 and 4766 - :attr:`idx_first_cycle`"""
datapoints_per_cycle: int = 1
"""number of sensor readings from each of the individual sensors per sample/cycle
defaults to 1 and should be between 1 and 2000, as there are only 2000 readings
per cycle, higher values will be clipped to 2000
"""
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment