Datatypes¶
Image¶
- class pyrsktools.datatypes.Image(x: ndarray[Any, dtype[_ScalarType_co]], y: ndarray[Any, dtype[_ScalarType_co]], channelNames: List[str], channelUnits: List[int], profiles: int | Collection[int], direction: str, data: ndarray[Any, dtype[_ScalarType_co]], reference: str, referenceUnit: str)¶
- x¶
X axis list.
- Type:
npt.NDArray
- y¶
Y axis list.
- Type:
npt.NDArray
- channelNames¶
Channel names for the generated data.
- Type:
List[str]
- channelUnits¶
Units associated with each channel.
- Type:
List[str]
- profiles¶
Profile number(s) for data that are generated.
- Type:
Union[int, Collection[int]]
- direction¶
Direction for data that are generated (‘up’ or ‘down’).
- Type:
str
- data¶
Data matrix with dimension in x, y and number of channels.
- Type:
npt.NDArray
- reference¶
Reference channel name.
- Type:
str
- reference_unit¶
Reference channel unit.
- Type:
str
Instrument¶
- class pyrsktools.datatypes.Instrument(instrumentID: int | None = None, serialID: int | None = None, model: str | None = None, firmwareVersion: str | None = None, firmwareType: int | None = None, partNumber: str | None = None)¶
- instrumentID¶
Defaults to None.
- Type:
int
- serialID¶
Defaults to None.
- Type:
int
- model¶
Defaults to None.
- Type:
str
- firmwareVersion¶
Defaults to None.
- Type:
str
- firmwareType¶
Defaults to None.
- Type:
str
- partNumber¶
Defaults to None.
- Type:
str
Deployment¶
- class pyrsktools.datatypes.Deployment(deploymentID: int | None = None, instrumentID: int | None = None, comment: str | None = None, loggerStatus: str | None = None, loggerTimeDrift: int | None = None, timeOfDownload: datetime64 | None = None, name: str | None = None, sampleSize: int | None = None, dataStorage: int | None = None, loggerInitialStatus: int | None = None)¶
- deploymentID¶
Defaults to None.
- Type:
int
- instrumentID¶
Defaults to None.
- Type:
int
- comment¶
Defaults to None.
- Type:
str
- loggerStatus¶
Defaults to None.
- Type:
str
- loggerTimeDrift¶
Defaults to None.
- Type:
str
- timeOfDownload¶
Defaults to None.
- Type:
str
- name¶
Defaults to None.
- Type:
str
- sampleSize¶
Defaults to None.
- Type:
int
- dataStorage¶
Defaults to None.
- Type:
int
- loggerInitialStatus¶
Defaults to None.
- Type:
int
DiagnosticsChannels¶
DiagnosticsData¶
- class pyrsktools.datatypes.DiagnosticsData(tstamp: datetime64 | None = None, channelid: str | None = None, value: float | None = None, instrumentID: int | None = None, deviceIndex: int | None = None)¶
- tstamp¶
Defaults to None.
- Type:
datetime64
- channelid¶
Defaults to None.
- Type:
str
- value¶
Defaults to None.
- Type:
float
- instrumentID¶
Default to None.
- Type:
int
- deviceIndex¶
Default to None.
- Type:
int
GeoData¶
- class pyrsktools.datatypes.GeoData(tstamp: datetime64 | None = None, latitude: float | None = None, longitude: float | None = None, accuracy: float | None = None, accuracyType: str | None = None)¶
- tstamp¶
Defaults to None.
- Type:
datetime64
- latitude¶
Defaults to None.
- Type:
float
- longitude¶
Defaults to None.
- Type:
float
- accuracy¶
Defaults to None.
- Type:
float
- accuracyType¶
Defaults to None.
- Type:
str
Channel¶
- class pyrsktools.datatypes.Channel(channelID: int | None = None, shortName: str | None = None, longName: str | None = None, unitsPlainText: str | None = None, isMeasured: int | None = None, isDerived: int | None = None, units: str | None = None, label: str = '', feModuleType: str = '', feModuleVersion: int = 0, _dbName: str | None = None)¶
- channelID¶
Defaults to None.
- Type:
int
- shortName¶
Defaults to None.
- Type:
str
- longName¶
Defaults to None.
- Type:
str
- unitsPlainText¶
Defaults to None.
- Type:
str
- isMeasured¶
Defaults to None.
- Type:
int
- isDerived¶
Defaults to None.
- Type:
int
- units¶
Defaults to None.
- Type:
str
- label¶
Defaults to “”.
- Type:
str
- feModuleType¶
Defaults to “”.
- Type:
str
- feModuleVersion¶
Defaults to 0.
- Type:
int
Epoch¶
Schedule¶
- class pyrsktools.datatypes.Schedule(scheduleID: int | None = None, instrumentID: int | None = None, mode: str | None = None, gate: str | None = None)¶
- scheduleID¶
Defaults to None.
- Type:
int
- instrumentID¶
Defaults to None.
- Type:
int
- mode¶
Defaults to None.
- Type:
str
- gate¶
Defaults to None.
- Type:
str
ScheduleInfo¶
- class pyrsktools.datatypes.ScheduleInfo(scheduleID: int | None = None)¶
- scheduleID¶
Defaults to None.
- Type:
int
WaveInfo¶
- class pyrsktools.datatypes.WaveInfo(scheduleID: int | None = None, waveID: int | None = None, samplingPeriod: int | None = None, repetitionPeriod: int | None = None, samplingCount: int | None = None)¶
Inherits all the fields of
ScheduleInfo
.- waveID¶
Defaults to None.
- Type:
int
- samplingPeriod¶
Defaults to None.
- Type:
int
- repetitionPeriod¶
Defaults to None.
- Type:
int
- samplingCount¶
Defaults to None.
- Type:
int
ContinuousInfo¶
- class pyrsktools.datatypes.ContinuousInfo(scheduleID: int | None = None, continuousID: int | None = None, samplingPeriod: int | None = None)¶
Inherits all the fields of
ScheduleInfo
.- continuousID¶
Defaults to None.
- Type:
int
- samplingPeriod¶
Defaults to None.
- Type:
int
BurstInfo¶
- class pyrsktools.datatypes.BurstInfo(scheduleID: int | None = None, burstID: int | None = None, samplingPeriod: int | None = None, repetitionPeriod: int | None = None, samplingCount: int | None = None)¶
Inherits all the fields of
ScheduleInfo
.- burstID¶
Defaults to None.
- Type:
int
- samplingPeriod¶
Defaults to None.
- Type:
int
- repetitionPeriod¶
Defaults to None.
- Type:
int
- samplingCount¶
Defaults to None
- Type:
int
TideInfo¶
- class pyrsktools.datatypes.TideInfo(scheduleID: int | None = None, tideID: int | None = None, samplingPeriod: int | None = None, repetitionPeriod: int | None = None, samplingCount: int | None = None)¶
Inherits all the fields of
ScheduleInfo
.- tideID¶
Defaults to None.
- Type:
int
- samplingPeriod¶
Defaults to None.
- Type:
int
- repetitionPeriod¶
Defaults to None.
- Type:
int
- samplingCount¶
Defaults to None
- Type:
int
AverageInfo¶
- class pyrsktools.datatypes.AverageInfo(scheduleID: int | None = None, averageID: int | None = None, samplingPeriod: int | None = None, repetitionPeriod: int | None = None, samplingCount: int | None = None)¶
Inherits all the fields of
ScheduleInfo
.- averageID¶
Defaults to None.
- Type:
int
- samplingPeriod¶
Defaults to None.
- Type:
int
- repetitionPeriod¶
Defaults to None.
- Type:
int
- samplingCount¶
Defaults to None
- Type:
int
DirectionalInfo¶
- class pyrsktools.datatypes.DirectionalInfo(scheduleID: int | None = None, directionalID: int | None = None, direction: str | None = None, fastPeriod: int | None = None, slowPeriod: int | None = None, fastThreshold: float | None = None, slowThreshold: float | None = None)¶
Inherits all the fields of
ScheduleInfo
.- directionalID¶
Defaults to None.
- Type:
int
- direction¶
Defaults to None.
- Type:
str
- fastPeriod¶
Defaults to None.
- Type:
int
- slowPeriod¶
Defaults to None.
- Type:
int
- fastThreshold¶
Defaults to None.
- Type:
float
- slowThreshold¶
Defaults to None.
- Type:
float
Power¶
- class pyrsktools.datatypes.Power(deploymentID: int | None = None, internalBatteryType: int = 0, externalBatteryType: int = 100, internalBatteryCapacity: float = 0.0, externalBatteryCapacity: float = 0.0, internalEnergyUsed: float = 0.0, externalEnergyUsed: float = 0.0, e1: float = 0.0, p1: float = 0.0, p2: float = 0.0, p3: float = 0.0, powerSupplyPartNumber: str = '', cellCount: int = 0)¶
- deploymentID¶
Defaults to None.
- Type:
int
- internalBatteryType¶
Defaults to 0.
- Type:
int
- externalBatteryType¶
Defaults to 100.
- Type:
int
- internalBatteryCapacity¶
Defaults to 0.0.
- Type:
float
- externalBatteryCapacity¶
Defaults to 0.0.
- Type:
float
- internalEnergyUsed¶
Defaults to 0.0.
- Type:
float
- externalEnergyUsed¶
Defaults to 0.0.
- Type:
float
- e1¶
Defaults to 0.0.
- Type:
float
- p1¶
Defaults to 0.0.
- Type:
float
- p2¶
Defaults to 0.0.
- Type:
float
- p3¶
Defaults to 0.0.
- Type:
float
- powerSupplyPartNumber¶
Defaults to “”.
- Type:
str
- cellCount¶
Defaults to 0.
- Type:
int
Calibration¶
- class pyrsktools.datatypes.Calibration(calibrationID: int | None = None, channelOrder: int | None = None, instrumentID: int | None = None, type: str | None = None, tstamp: datetime64 | None = None, equation: str | None = None, c: Dict[int, floating] | None = None, x: Dict[int, floating] | None = None, n: Dict[int, integer] | None = None)¶
The c, x, and n attributes are dictionaries where each key maps the calibration coefficient number, e.g., 0, 2, 10, etc, to its respective coefficient value.
Taking the c attributes as an example, suppose we had calibration data with the
c0
,c1
, andc3
coefficients with values10.0
,NULL
,50.0
; thenCalibration.c
would look like:{ 0: 10.0, 1: nan, 3: 50.0, }
- calibrationID¶
Defaults to None.
- Type:
int
- channelOrder¶
Defaults to None.
- Type:
int
- instrumentID¶
Defaults to None
- Type:
int
- type¶
Defaults to None.
- Type:
str
- tstamp¶
Defaults to None.
- Type:
datetime64
- equation¶
Defaults to None.
- Type:
str
- c¶
Dictionary containing c coefficients. Defaults to None.
- Type:
Dict[int, np.floating]
- x¶
Dictionary containing x coefficients. Defaults to None.
- Type:
Dict[int, np.floating]
- n¶
Dictionary containing n coefficients. Defaults to None.
- Type:
Dict[int, np.integer]
Parameter¶
ParameterKey¶
AppSetting¶
Range¶
- class pyrsktools.datatypes.Range(instrumentID: int | None = None, channelID: int | None = None, channelOrder: int | None = None, mode: str | None = None, gain: float | None = None, availableGains: str | None = None)¶
- instrumentID¶
Defaults to None.
- Type:
int
- channelID¶
Defaults to None.
- Type:
int
- channelOrder¶
Defaults to None.
- Type:
int
- mode¶
Defaults to None.
- Type:
str
- gain¶
Defaults to None.
- Type:
float
- availableGains¶
Defaults to None.
- Type:
str
InstrumentSensor¶
- class pyrsktools.datatypes.InstrumentSensor(instrumentID: int | None = None, sensorID: int | None = None, channelOrder: int | None = None, serialID: int | None = None, details: str | None = None)¶
- instrumentID¶
Defaults to None.
- Type:
int
- sensorID¶
Defaults to None.
- Type:
int
- channelOrder¶
Defaults to None.
- Type:
int
- serialID¶
Defaults to None.
- Type:
int
- details¶
Defaults to None.
- Type:
str
Region¶
- class pyrsktools.datatypes.Region(datasetID: int | None = None, regionID: int | None = None, type: str | None = None, tstamp1: datetime64 | None = None, tstamp2: datetime64 | None = None, label: str | None = None, description: str | None = None, collapsed: bool = False)¶
- datasetID¶
Defaults to None.
- Type:
int
- regionID¶
Defaults to None.
- Type:
int
- type¶
Defaults to None.
- Type:
str
- tstamp1¶
Defaults to None.
- Type:
datetime64
- tstamp2¶
Defaults to None.
- Type:
datetime64
- label¶
Defaults to None.
- Type:
str
- description¶
Defaults to None.
- Type:
str
- collapsed¶
Defaults to False.
- Type:
bool
RegionCal¶
- class pyrsktools.datatypes.RegionCal(datasetID: int | None = None, regionID: int | None = None, type: str | None = None, tstamp1: datetime64 | None = None, tstamp2: datetime64 | None = None, label: str | None = None, description: str | None = None, collapsed: bool = False, plateauSize: int | None = None, channelID: int | None = None, sourceID: int | None = None)¶
Inherits all the fields of
Region
.- plateauSize¶
Defaults to None.
- Type:
int
- channelID¶
Defaults to None.
- Type:
int
- sourceID¶
Defaults to None.
- Type:
int
RegionCast¶
- class pyrsktools.datatypes.RegionCast(datasetID: int | None = None, regionID: int | None = None, type: str | None = None, tstamp1: datetime64 | None = None, tstamp2: datetime64 | None = None, label: str | None = None, description: str | None = None, collapsed: bool = False, regionProfileID: int | None = None, regionType: str | None = None)¶
Inherits all the fields of
Region
.- regionProfileID¶
Defaults to None.
- Type:
int
- regionType¶
Defaults to None.
- Type:
str
RegionProfile¶
- class pyrsktools.datatypes.RegionProfile(datasetID: int | None = None, regionID: int | None = None, type: str | None = None, tstamp1: datetime64 | None = None, tstamp2: datetime64 | None = None, label: str | None = None, description: str | None = None, collapsed: bool = False)¶
Inherits all the fields of
Region
.
RegionComment¶
- class pyrsktools.datatypes.RegionComment(datasetID: int | None = None, regionID: int | None = None, type: str | None = None, tstamp1: datetime64 | None = None, tstamp2: datetime64 | None = None, label: str | None = None, description: str | None = None, collapsed: bool = False, content: str | None = None)¶
Inherits all the fields of
Region
.- content¶
Defaults to None.
- Type:
str
RegionExclude¶
- class pyrsktools.datatypes.RegionExclude(datasetID: int | None = None, regionID: int | None = None, type: str | None = None, tstamp1: datetime64 | None = None, tstamp2: datetime64 | None = None, label: str | None = None, description: str | None = None, collapsed: bool = False, enable: bool | None = None, regionType: str | None = None)¶
Inherits all the fields of
Region
.- enable¶
Defaults to None.
- Type:
bool
- regionType¶
Defaults to None.
- Type:
str
RegionGeoData¶
- class pyrsktools.datatypes.RegionGeoData(datasetID: int | None = None, regionID: int | None = None, type: str | None = None, tstamp1: datetime64 | None = None, tstamp2: datetime64 | None = None, label: str | None = None, description: str | None = None, collapsed: bool = False, latitude: float | None = None, longitude: float | None = None)¶
Inherits all the fields of
Region
.- latitude¶
Defaults to None.
- Type:
float
- longitude¶
Defaults to None.
- Type:
float
RegionPlateau¶
- class pyrsktools.datatypes.RegionPlateau(datasetID: int | None = None, regionID: int | None = None, type: str | None = None, tstamp1: datetime64 | None = None, tstamp2: datetime64 | None = None, label: str | None = None, description: str | None = None, collapsed: bool = False, regionCalID: int = 0, refValue: float | None = None, refUnit: str | None = None)¶
Inherits all the fields of
Region
.- regionCalID¶
Defaults to 0.
- Type:
int
- refValue¶
Defaults to None.
- Type:
float
- refUnit¶
Defaults to None.
- Type:
str
RegionAtmosphere¶
- class pyrsktools.datatypes.RegionAtmosphere(datasetID: int | None = None, regionID: int | None = None, type: str | None = None, tstamp1: datetime64 | None = None, tstamp2: datetime64 | None = None, label: str | None = None, description: str | None = None, collapsed: bool = False, pressure: float | None = None, unit: str | None = None)¶
Inherits all the fields of
Region
.- pressure¶
Defaults to None.
- Type:
float
- unit¶
Defaults to None.
- Type:
str