From b90af8311a5c7a297e49b5dd10597bd2e77438b7 Mon Sep 17 00:00:00 2001
From: Bjoern Ludwig <bjoern.ludwig@ptb.de>
Date: Sat, 21 Jan 2023 15:28:06 +0100
Subject: [PATCH] feat(data_types): introduce one aggregated data type to
specify the sample size of extracted data
---
src/zema_emc_annotated/data_types.py | 24 +++++++++++++++++++++++-
1 file changed, 23 insertions(+), 1 deletion(-)
diff --git a/src/zema_emc_annotated/data_types.py b/src/zema_emc_annotated/data_types.py
index 97288b3..a529d8c 100644
--- a/src/zema_emc_annotated/data_types.py
+++ b/src/zema_emc_annotated/data_types.py
@@ -1,6 +1,6 @@
"""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
+ """
--
GitLab