Datatypes

Image

class pyrsktools.datatypes.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

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

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

class pyrsktools.datatypes.DiagnosticsChannels

id

Defaults to None.

Type:

int

name

Defaults to None.

Type:

str

unit

Defaults to None.

Type:

str

DiagnosticsData

class pyrsktools.datatypes.DiagnosticsData

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

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

Defaults to None.

Type:

int

shortName

Defaults to None.

Type:

str

longName

Defaults to None.

Type:

str

unitsPlainText

Defaults to None.

Type:

str

longNamePlainText

(str): 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

availableGains

Defaults to None.

Type:

str

channelOrder

Defaults to None.

Type:

int

Epoch

class pyrsktools.datatypes.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

Defaults to None.

Type:

int

instrumentID

Defaults to None.

Type:

int

mode

Defaults to None.

Type:

str

gate

Defaults to None.

Type:

str

label

Defaults to None.

Type:

str

ScheduleInfo

class pyrsktools.datatypes.ScheduleInfo

scheduleID

Defaults to None.

Type:

int

WaveInfo

class pyrsktools.datatypes.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

Inherits all the fields of ScheduleInfo.

continuousID

Defaults to None.

Type:

int

samplingPeriod

Defaults to None.

Type:

int

BurstInfo

class pyrsktools.datatypes.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

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

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

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

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

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. The offset and slope are customer added offset and slope for Gen4 instruments.

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]

offset

Defaults to None.

Type:

np.floating

slope

Defaults to None.

Type:

np.floating

Parameter

class pyrsktools.datatypes.Parameter

parameterID

Defaults to None.

Type:

int

tstamp

Defaults to None.

Type:

datetime64

ParameterKey

class pyrsktools.datatypes.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

Defaults to None.

Type:

int

ruskinVersion

Defaults to None.

Type:

str

Range

class pyrsktools.datatypes.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

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

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

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

Inherits all the fields of Region.

regionProfileID

Defaults to None.

Type:

int

regionType

Defaults to None.

Type:

str

RegionProfile

class pyrsktools.datatypes.RegionProfile

Inherits all the fields of Region.

RegionComment

class pyrsktools.datatypes.RegionComment

Inherits all the fields of Region.

content

Defaults to None.

Type:

str

RegionExclude

class pyrsktools.datatypes.RegionExclude

Inherits all the fields of Region.

enable

Defaults to None.

Type:

bool

regionType

Defaults to None.

Type:

str

RegionGeoData

class pyrsktools.datatypes.RegionGeoData

Inherits all the fields of Region.

latitude

Defaults to None.

Type:

float

longitude

Defaults to None.

Type:

float

RegionPlateau

class pyrsktools.datatypes.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

Inherits all the fields of Region.

pressure

Defaults to None.

Type:

float

unit

Defaults to None.

Type:

str