Module `redvox.common`

Top level common members and functions.

Expand source code

"""
Top level common members and functions.
"""

import enum


class ApiVersion(enum.Enum):
    """
    API versions supported by this SDK
    """

    API900: int = 900
    API1000: int = 1_000

Sub-modules

redvox.common.api_conversions: Provides functionality for converting between API versions.
redvox.common.api_reader: Read Redvox data from a single directory Data files can be either API 900 or API 1000 data formats
redvox.common.api_reader_dw: For use with DataWindow specifically. Do NOT use with non-DataWindow objects Read Redvox data from a single directory Data files can be either API …
redvox.common.constants: This is an auxiliary file where regularly used constants can be stored and exported.
redvox.common.cross_stats: This module contains functions for computing the cross correlation between data sets of equal or unequal length.
redvox.common.data_window: This module creates specific time-bounded segments of data for users combines the base data files into a single composite object based on the user …
redvox.common.data_window_configuration: This module provides type-safe data window configuration using an external file
redvox.common.data_window_io: This module provides IO primitives for working with data windows.
redvox.common.date_time_utils: This module contains constants and helper functions for converting between different time bases. All time based functions take inputs and output in UTC.
redvox.common.errors: This module contains custom error definitions used within this SDK.
redvox.common.event_stream: This module provides classes to organize events recorded on a station. It will ignore machine learning events.
redvox.common.event_stream_io: This module provides IO primitives for working with EventStream data.
redvox.common.file_statistics: This module provides utility functions for determining statistics of well structured RedVox data.
redvox.common.gap_and_pad_utils: This module provides tools to fill gaps and pad the ends of timestamp arrays
redvox.common.gui
redvox.common.io: This module provides IO primitives for working with cross-API RedVox data.
redvox.common.offset_model: Offset model used to predict offset change over a period of time …
redvox.common.packet_to_pyarrow: Converts data from RedVox packets into pyarrow tables.
redvox.common.parallel_utils: Module that contains utilities for working with data in parallel.
redvox.common.reader_session_model: This module describes methods to store session models from different sources. This information can be utilized by users as they see fit
redvox.common.run_me: This file is designed to show the usage of the redvox SDK when loading DataWindows from existing files This file is expected to be in the same …
redvox.common.sensor_data: Defines generic sensor data and data for API-independent analysis all timestamps are integers in microseconds unless otherwise stated
redvox.common.sensor_io: This module provides IO primitives for working with sensor data.
redvox.common.sensor_reader_utils: This module loads sensor data from Redvox packets
redvox.common.session_io: This module provides IO primitives for working with session models.
redvox.common.session_model
redvox.common.session_model_utils: This module contains classes and functions that support SessionModel.
redvox.common.station: Defines generic station objects for API-independent analysis all timestamps are integers in microseconds unless otherwise stated Utilizes …
redvox.common.station_io: This module provides IO primitives for working with station data.
redvox.common.station_model: Prototype functions for station location and timing summary Provides an example of how to access the information from a Station object This module …
redvox.common.station_utils: Defines generic station metadata for API-independent analysis all timestamps are floats in microseconds unless otherwise stated
redvox.common.stats_helper: Support for computing statistics Requires numpy
redvox.common.timesync: Modules for extracting time synchronization statistics for API 900 and 1000 data. Expects API M packets due to versatility of the packet. Also …
redvox.common.timesync_io: This module provides IO primitives for working with timesync data.
redvox.common.tri_message_stats: Modules for extracting time synchronization statistics according to Tri-Message protocol. All functions assume payload for ONE data packet/decoder …
redvox.common.versioning: This module provides functionality for determining the version of RedVox compressed packets.

Classes

class ApiVersion (value, names=None, *, module=None, qualname=None, type=None, start=1)

API versions supported by this SDK

Expand source code

class ApiVersion(enum.Enum):
    """
    API versions supported by this SDK
    """

    API900: int = 900
    API1000: int = 1_000

Ancestors

enum.Enum

Class variables

var API1000 : int
var API900 : int