mth5.io.phoenix.readers.segmented package

Submodules

mth5.io.phoenix.readers.segmented.decimated_segmented_reader module

Module to read and parse native Phoenix Geophysics data formats of the MTU-5C Family

This module implements Streamed readers for segmented-decimated time series: formats of the MTU-5C family.

author: Jorge Torres-Solis

Revised 2022 by J. Peacock

class mth5.io.phoenix.readers.segmented.decimated_segmented_reader.DecimatedSegmentCollection(path, num_files=1, report_hw_sat=False, **kwargs)[source]

Bases: TSReaderBase

Class to create a streamer for segmented decimated time series, i.e. ‘td_24k’

These files have a sub header

read_segments(metadata_only=False)[source]

Read the whole file in

Returns: DESCRIPTION
Return type: TYPE

to_channel_ts()[source]

convert to a ChannelTS object

Returns: DESCRIPTION
Return type: TYPE

class mth5.io.phoenix.readers.segmented.decimated_segmented_reader.DecimatedSegmentedReader(path, num_files=1, report_hw_sat=False, **kwargs)[source]

Bases: TSReaderBase

Class to create a streamer for segmented decimated time series, i.e. ‘td_24k’

These files have a sub header

read_segment(metadata_only=False)[source]

Read in a single segment

Parameters: metadata_only (TYPE, optional) – DESCRIPTION, defaults to False
Returns: DESCRIPTION
Return type: TYPE

to_channel_ts()[source]

convert to a ChannelTS object

Returns: DESCRIPTION
Return type: TYPE

class mth5.io.phoenix.readers.segmented.decimated_segmented_reader.Segment(stream, **kwargs)[source]

Bases: SubHeader

A segment class to hold a single segment

read_segment(metadata_only=False)[source]

Read the whole file in

Returns: DESCRIPTION
Return type: TYPE

property segment_end_time

estimate end time

Returns: DESCRIPTION
Return type: TYPE

property segment_start_time

estimate the segment start time based on sequence number

Returns: DESCRIPTION
Return type: TYPE

class mth5.io.phoenix.readers.segmented.decimated_segmented_reader.SubHeader(**kwargs)[source]

Bases: object

Class for subheader of segmented files

property gps_time_stamp

property missing_count

property n_samples

property saturation_count

unpack_header(stream)[source]

property value_max

property value_mean

property value_min

Module contents

class mth5.io.phoenix.readers.segmented.DecimatedSegmentedReader(path, num_files=1, report_hw_sat=False, **kwargs)[source]

Bases: TSReaderBase

Class to create a streamer for segmented decimated time series, i.e. ‘td_24k’

These files have a sub header

read_segment(metadata_only=False)[source]

Read in a single segment

Parameters: metadata_only (TYPE, optional) – DESCRIPTION, defaults to False
Returns: DESCRIPTION
Return type: TYPE

to_channel_ts()[source]

convert to a ChannelTS object

Returns: DESCRIPTION
Return type: TYPE