uataq.instruments.Instrument#

class uataq.instruments.Instrument(SID, name, loggers, config)[source]#

Abstract base class for instrument objects.

Variables:

  • SID (str) – Site ID where the instrument is installed.

  • name (str) – Name of the instrument.

  • groups (list[str]) – Research groups that operate the instrument.

  • group_dates (dict[str, TimeRange]) – When each group’s archive holds this instrument’s data, for the groups whose archive covers less than the whole installation (config group_dates). A group not listed covers the whole installation.

  • loggers (set[str]) – Loggers used by the research groups to record data.

  • config (dict) – Configuration settings for the instrument.

__init__(SID, name, loggers, config)[source]#

Initialize the Instrument object.

Parameters:

  • SID (str) – Site ID where the instrument is installed.

  • name (str) – Name of the instrument.

  • loggers (dict) – Dictionary of loggers used by different research groups.

  • config (dict) – Configuration settings for the instrument.

Attributes

active_range

When this instrument was installed at the site and when it was removed.

model

Model of the instrument, the key of catalog that names its class, such as "lgr_ugga".

Methods

clip_to_active(time_range)

Narrow a requested time range to when this instrument was installed.

get_datafiles(group, lvl, time_range[, pattern])

Get data files for the given level and time range from the groupspace.

get_files(group, lvl)

Get list of file paths for a given level.

get_highest_lvl(group)

Get the highest data level for the instrument.

plan_reads([group, time_range])

Plan which group to read each part of a time range from.

read_data(group[, lvl, time_range, ...])

Read and parse data files for the given level and time range.

resolve_group([group])

Pick which research group's data to read this instrument from.

standardize_data(group, data)

Standardize the data across research groups.