RSK¶
- class pyrsktools.RSK(fname: str, readHiddenChannels: bool = False)¶
The RSK class used to interact with a dataset produced by Ruskin.
- Parameters
Internal state attributes:
- filename¶
File name of the RSK database.
- Type
str
- version¶
The current pyRSKtools version.
- Type
str
- logs¶
A dictionary for holding logs of the major actions/methods conducted/invoked during the lifetime of the current RSK instance. The key of each element is the time the log was generated, while the value is the log entry itself. Defaults to {}.
- Type
Dict[np.datetime64, str]
Informational attributes:
- dbInfo¶
Todo. Populated by
RSK.open(). Defaults to None.- Type
DbInfo
- instrument¶
Primary instrument of the dataset. Populated by
RSK.open(). Defaults to None.- Type
- deployment¶
Deployment header of the dataset. Populated by
RSK.open(). Defaults to None.- Type
- calibrations¶
Todo. Defaults to [].
- Type
List[Calibration]
- parameterKeys¶
Todo. Defaults to [].
- Type
List[ParameterKey]
- appSettings¶
Todo. Defaults to [].
- Type
List[AppSetting]
- regions¶
Todo. NOTE: immutable tuple, see
RSK.removecasts()to remove cast type regions. Defaults to ().- Type
Tuple[Region]
Computational attributes:
- channelNames¶
The channel names of RSK.data, excluding “timestamp”, used to index into RSK.data.
- Type
List[str]
- data¶
Todo. Defaults to [].
- Type
npt.NDArray
- processedChannelNames¶
The channel names of RSK.processedData, excluding “timestamp”, used to index into RSK.processedData.
- Type
List[str]
- processedData¶
Todo. Defaults to [].
- Type
npt.NDArray
Example
>>> with RSK("/path/to/data.rsk") as rsk: ... # Read, process, view, or export data here ... rsk.readdata()