mth5.io.phoenix.readers.contiguous package
Submodules
mth5.io.phoenix.readers.contiguous.decimated_continuous_reader module
Module to read and parse native Phoenix Geophysics data formats of the MTU-5C Family.
This module implements Streamed readers for decimated continuos time series formats of the MTU-5C family.
- author
Jorge Torres-Solis
Revised 2022 by J. Peacock
- class mth5.io.phoenix.readers.contiguous.decimated_continuous_reader.DecimatedContinuousReader(path, num_files=1, report_hw_sat=False, **kwargs)[source]
Bases:
TSReaderBaseClass to create a streamer for continuous decimated time series, i.e. ‘td_150’, ‘td_30’
These files have no sub header information.
- read()[source]
Read in the full data from the file given.
- Returns
single channel data array
- Return type
numpy.ndarray
- read_sequence(start=0, end=None)[source]
Read a sequence of files
- Parameters
start (integer, optional) – starting index in the sequence, defaults to 0
end (integer, optional) – eneding index in the sequence to read, defaults to None
- Returns
data within the given sequence range
- Return type
numpy.ndarray
- property segment_end_time
estimate end time
The first sequence starts 1 second later than the set start time due to initiation within the data logger
- Returns
estimated end time from number of samples
- Return type
mt_metadata.utils.mttime.MTime
- property segment_start_time
estimate the segment start time based on sequence number
The first sequence starts 1 second later than the set start time due to initiation within the data logger
- Returns
start time of the recording
- Return type
mt_metadata.utils.mttime.MTime
Module contents
- class mth5.io.phoenix.readers.contiguous.DecimatedContinuousReader(path, num_files=1, report_hw_sat=False, **kwargs)[source]
Bases:
TSReaderBaseClass to create a streamer for continuous decimated time series, i.e. ‘td_150’, ‘td_30’
These files have no sub header information.
- read()[source]
Read in the full data from the file given.
- Returns
single channel data array
- Return type
numpy.ndarray
- read_sequence(start=0, end=None)[source]
Read a sequence of files
- Parameters
start (integer, optional) – starting index in the sequence, defaults to 0
end (integer, optional) – eneding index in the sequence to read, defaults to None
- Returns
data within the given sequence range
- Return type
numpy.ndarray
- property segment_end_time
estimate end time
The first sequence starts 1 second later than the set start time due to initiation within the data logger
- Returns
estimated end time from number of samples
- Return type
mt_metadata.utils.mttime.MTime
- property segment_start_time
estimate the segment start time based on sequence number
The first sequence starts 1 second later than the set start time due to initiation within the data logger
- Returns
start time of the recording
- Return type
mt_metadata.utils.mttime.MTime