Datatypes

Image

class pyrsktools.datatypes.Image(x: ndarray[Any, dtype[ScalarType]], y: ndarray[Any, dtype[ScalarType]], channelNames: List[str], channelUnits: List[int], profiles: Union[int, Collection[int]], direction: str, data: ndarray[Any, dtype[ScalarType]], reference: str, referenceUnit: str)

Image.

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: Optional[int] = None, serialID: Optional[int] = None, model: Optional[str] = None, firmwareVersion: Optional[str] = None, firmwareType: Optional[int] = None, partNumber: Optional[str] = None)

Instrument.

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: Optional[int] = None, instrumentID: Optional[int] = None, comment: Optional[str] = None, loggerStatus: Optional[str] = None, loggerTimeDrift: Optional[int] = None, timeOfDownload: Optional[datetime64] = None, name: Optional[str] = None, sampleSize: Optional[int] = None, dataStorage: int = 0, loggerInitialStatus: int = 0)

Deployment.

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

Channel

class pyrsktools.datatypes.Channel(channelID: Optional[int] = None, shortName: Optional[str] = None, longName: Optional[str] = None, unitsPlainText: Optional[str] = None, isMeasured: Optional[int] = None, isDerived: Optional[int] = None, units: Optional[str] = None, label: str = '', feModuleType: str = '', feModuleVersion: int = 0, _dbName: Optional[str] = None)

Channel.

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

class pyrsktools.datatypes.Epoch(deploymentID: Optional[int] = None, startTime: Optional[datetime64] = None, endTime: Optional[datetime64] = None)

Epoch.

deploymentID

Defaults to None.

Type

int

startTime

Defaults to None.

Type

datetime64

endTime

Defaults to None.

Type

datetime64

Schedule

class pyrsktools.datatypes.Schedule(scheduleID: Optional[int] = None, instrumentID: Optional[int] = None, mode: Optional[str] = None, gate: Optional[str] = None)

Schedule.

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: Optional[int] = None)

ScheduleInfo.

scheduleID

Defaults to None.

Type

int

WaveInfo

class pyrsktools.datatypes.WaveInfo(scheduleID: Optional[int] = None, waveID: Optional[int] = None, samplingPeriod: Optional[int] = None, repetitionPeriod: Optional[int] = None, samplingCount: Optional[int] = None)

WaveInfo. 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: Optional[int] = None, continuousID: Optional[int] = None, samplingPeriod: Optional[int] = None)

ContinuousInfo. Inherits all the fields of ScheduleInfo.

continuousID

Defaults to None.

Type

int

samplingPeriod

Defaults to None.

Type

int

BurstInfo

class pyrsktools.datatypes.BurstInfo(scheduleID: Optional[int] = None, burstID: Optional[int] = None, samplingPeriod: Optional[int] = None, repetitionPeriod: Optional[int] = None, samplingCount: Optional[int] = None)

BurstInfo. 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: Optional[int] = None, tideID: Optional[int] = None, samplingPeriod: Optional[int] = None, repetitionPeriod: Optional[int] = None, samplingCount: Optional[int] = None)

TideInfo. 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: Optional[int] = None, averageID: Optional[int] = None, samplingPeriod: Optional[int] = None, repetitionPeriod: Optional[int] = None, samplingCount: Optional[int] = None)

AverageInfo. 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: Optional[int] = None, directionalID: Optional[int] = None, direction: Optional[str] = None, fastPeriod: Optional[int] = None, slowPeriod: Optional[int] = None, fastThreshold: Optional[float] = None, slowThreshold: Optional[float] = None)

DirectionalInfo. Inherits all the fields of ScheduleInfo.

directionalID

= 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: Optional[int] = 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)

Power.

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: Optional[int] = None, channelOrder: Optional[int] = None, instrumentID: Optional[int] = None, type: Optional[str] = None, tstamp: Optional[datetime64] = None, equation: Optional[str] = None, c: Optional[Dict[int, floating]] = None, x: Optional[Dict[int, floating]] = None, n: Optional[Dict[int, integer]] = None)

Calibration.

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, and c3 coefficients with values 10.0, NULL, 50.0; then Calibration.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

class pyrsktools.datatypes.Parameter(parameterID: Optional[int] = None, tstamp: Optional[datetime64] = None)

Parameter.

parameterID

Defaults to None.

Type

int

tstamp

Defaults to None.

Type

datetime64

ParameterKey

class pyrsktools.datatypes.ParameterKey(parameterID: Optional[int] = None, key: Optional[str] = None, value: Optional[str] = None)

ParameterKey.

parameterID

Defaults to None.

Type

int

key

Defaults to None.

Type

str

value

Defaults to None.

Type

str

AppSetting

class pyrsktools.datatypes.AppSetting(deploymentID: Optional[int] = None, ruskinVersion: Optional[str] = None)

AppSetting.

deploymentID

Defaults to None.

Type

int

ruskinVersion

Defaults to None.

Type

str

Range

class pyrsktools.datatypes.Range(instrumentID: Optional[int] = None, channelID: Optional[int] = None, channelOrder: Optional[int] = None, mode: Optional[str] = None, gain: Optional[float] = None, availableGains: Optional[str] = None)

Range.

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: Optional[int] = None, sensorID: Optional[int] = None, channelOrder: Optional[int] = None, serialID: Optional[int] = None, details: Optional[str] = None)

InstrumentSensor.

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: Optional[int] = None, regionID: Optional[int] = None, type: Optional[str] = None, tstamp1: Optional[datetime64] = None, tstamp2: Optional[datetime64] = None, label: Optional[str] = None, description: Optional[str] = None, collapsed: bool = False)

Region.

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: Optional[int] = None, regionID: Optional[int] = None, type: Optional[str] = None, tstamp1: Optional[datetime64] = None, tstamp2: Optional[datetime64] = None, label: Optional[str] = None, description: Optional[str] = None, collapsed: bool = False, plateauSize: Optional[int] = None, channelID: Optional[int] = None, sourceID: Optional[int] = None)

RegionCal. 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: Optional[int] = None, regionID: Optional[int] = None, type: Optional[str] = None, tstamp1: Optional[datetime64] = None, tstamp2: Optional[datetime64] = None, label: Optional[str] = None, description: Optional[str] = None, collapsed: bool = False, regionProfileID: Optional[int] = None, regionType: Optional[str] = None)

RegionCast. Inherits all the fields of Region.

regionProfileID

Defaults to None.

Type

int

regionType

Defaults to None.

Type

str

RegionProfile

class pyrsktools.datatypes.RegionProfile(datasetID: Optional[int] = None, regionID: Optional[int] = None, type: Optional[str] = None, tstamp1: Optional[datetime64] = None, tstamp2: Optional[datetime64] = None, label: Optional[str] = None, description: Optional[str] = None, collapsed: bool = False)

RegionProfile. Inherits all the fields of Region.

RegionComment

class pyrsktools.datatypes.RegionComment(datasetID: Optional[int] = None, regionID: Optional[int] = None, type: Optional[str] = None, tstamp1: Optional[datetime64] = None, tstamp2: Optional[datetime64] = None, label: Optional[str] = None, description: Optional[str] = None, collapsed: bool = False, content: Optional[str] = None)

RegionComment. Inherits all the fields of Region.

RegionExclude

class pyrsktools.datatypes.RegionExclude(datasetID: Optional[int] = None, regionID: Optional[int] = None, type: Optional[str] = None, tstamp1: Optional[datetime64] = None, tstamp2: Optional[datetime64] = None, label: Optional[str] = None, description: Optional[str] = None, collapsed: bool = False, enable: Optional[bool] = None, regionType: Optional[str] = None)

RegionExclude. Inherits all the fields of Region.

enable

Defaults to None.

Type

bool

regionType

Defaults to None.

Type

str

RegionGeoData

class pyrsktools.datatypes.RegionGeoData(datasetID: Optional[int] = None, regionID: Optional[int] = None, type: Optional[str] = None, tstamp1: Optional[datetime64] = None, tstamp2: Optional[datetime64] = None, label: Optional[str] = None, description: Optional[str] = None, collapsed: bool = False, latitude: Optional[float] = None, longitude: Optional[float] = None)

RegionGeoData. Inherits all the fields of Region.

latitude

Defaults to None.

Type

float

longitude

Defaults to None.

Type

float

RegionPlateau

class pyrsktools.datatypes.RegionPlateau(datasetID: Optional[int] = None, regionID: Optional[int] = None, type: Optional[str] = None, tstamp1: Optional[datetime64] = None, tstamp2: Optional[datetime64] = None, label: Optional[str] = None, description: Optional[str] = None, collapsed: bool = False, regionCalID: int = 0, refValue: Optional[float] = None, refUnit: Optional[str] = None)

RegionPlateau. 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: Optional[int] = None, regionID: Optional[int] = None, type: Optional[str] = None, tstamp1: Optional[datetime64] = None, tstamp2: Optional[datetime64] = None, label: Optional[str] = None, description: Optional[str] = None, collapsed: bool = False, pressure: Optional[float] = None, unit: Optional[str] = None)

RegionAtmosphere. Inherits all the fields of Region.

pressure

Defaults to None.

Type

float

unit

Defaults to None.

Type

str