mth5.io.phoenix package
Subpackages
- mth5.io.phoenix.readers package
- Subpackages
- Submodules
- mth5.io.phoenix.readers.base module
TSReaderBase
TSReaderBase.base_dir
TSReaderBase.base_path
TSReaderBase.channel_metadata
TSReaderBase.close()
TSReaderBase.config_file_path
TSReaderBase.file_extension
TSReaderBase.file_name
TSReaderBase.file_size
TSReaderBase.get_channel_response_filter()
TSReaderBase.get_config_object()
TSReaderBase.get_dipole_filter()
TSReaderBase.get_lowpass_filter_name()
TSReaderBase.get_receiver_lowpass_filter()
TSReaderBase.get_receiver_metadata_object()
TSReaderBase.get_sensor_filter()
TSReaderBase.get_v_to_mv_filter()
TSReaderBase.instrument_id
TSReaderBase.max_samples
TSReaderBase.open_file_seq()
TSReaderBase.open_next()
TSReaderBase.recmeta_file_path
TSReaderBase.run_metadata
TSReaderBase.seq
TSReaderBase.sequence_list
TSReaderBase.station_metadata
TSReaderBase.update_channel_map_from_recmeta()
- mth5.io.phoenix.readers.header module
Header
Header.attenuator_gain
Header.battery_voltage_v
Header.board_model_main
Header.board_model_revision
Header.bytes_per_sample
Header.ch_board_model
Header.ch_board_serial
Header.ch_firmware
Header.channel_id
Header.channel_main_gain
Header.channel_type
Header.data_footer
Header.decimation_node_id
Header.detected_channel_type
Header.file_sequence
Header.file_type
Header.file_version
Header.frag_period
Header.frame_rollover_count
Header.frame_size
Header.frame_size_bytes
Header.future1
Header.future2
Header.get_channel_metadata()
Header.get_run_metadata()
Header.get_station_metadata()
Header.gps_elevation
Header.gps_horizontal_accuracy
Header.gps_lat
Header.gps_long
Header.gps_vertical_accuracy
Header.hardware_configuration
Header.header_length
Header.instrument_serial_number
Header.instrument_type
Header.intrinsic_circuitry_gain
Header.lp_frequency
Header.max_signal
Header.min_signal
Header.missing_frames
Header.preamp_gain
Header.recording_id
Header.recording_start_time
Header.sample_rate
Header.sample_rate_base
Header.sample_rate_exp
Header.saturated_frames
Header.timing_flags
Header.timing_sat_count
Header.timing_stability
Header.timing_status
Header.total_circuitry_gain
Header.total_selectable_gain
Header.unpack_header()
- mth5.io.phoenix.readers.phx_json module
- Module contents
DecimatedContinuousReader
DecimatedSegmentedReader
Header
Header.attenuator_gain
Header.battery_voltage_v
Header.board_model_main
Header.board_model_revision
Header.bytes_per_sample
Header.ch_board_model
Header.ch_board_serial
Header.ch_firmware
Header.channel_id
Header.channel_main_gain
Header.channel_type
Header.data_footer
Header.decimation_node_id
Header.detected_channel_type
Header.file_sequence
Header.file_type
Header.file_version
Header.frag_period
Header.frame_rollover_count
Header.frame_size
Header.frame_size_bytes
Header.future1
Header.future2
Header.get_channel_metadata()
Header.get_run_metadata()
Header.get_station_metadata()
Header.gps_elevation
Header.gps_horizontal_accuracy
Header.gps_lat
Header.gps_long
Header.gps_vertical_accuracy
Header.hardware_configuration
Header.header_length
Header.instrument_serial_number
Header.instrument_type
Header.intrinsic_circuitry_gain
Header.lp_frequency
Header.max_signal
Header.min_signal
Header.missing_frames
Header.preamp_gain
Header.recording_id
Header.recording_start_time
Header.sample_rate
Header.sample_rate_base
Header.sample_rate_exp
Header.saturated_frames
Header.timing_flags
Header.timing_sat_count
Header.timing_stability
Header.timing_status
Header.total_circuitry_gain
Header.total_selectable_gain
Header.unpack_header()
NativeReader
PhoenixCalibration
PhoenixConfig
PhoenixConfig.auto_power_enabled
PhoenixConfig.config
PhoenixConfig.empower_version
PhoenixConfig.fn
PhoenixConfig.has_obj()
PhoenixConfig.mtc150_reset
PhoenixConfig.network
PhoenixConfig.read()
PhoenixConfig.receiver
PhoenixConfig.schedule
PhoenixConfig.station_metadata()
PhoenixConfig.surveyTechnique
PhoenixConfig.timezone
PhoenixConfig.timezone_offset
PhoenixConfig.version
PhoenixReceiverMetadata
PhoenixReceiverMetadata.channel_map
PhoenixReceiverMetadata.e1_metadata
PhoenixReceiverMetadata.e2_metadata
PhoenixReceiverMetadata.fn
PhoenixReceiverMetadata.get_ch_index()
PhoenixReceiverMetadata.get_ch_metadata()
PhoenixReceiverMetadata.get_ch_tag()
PhoenixReceiverMetadata.h1_metadata
PhoenixReceiverMetadata.h2_metadata
PhoenixReceiverMetadata.h3_metadata
PhoenixReceiverMetadata.h4_metadata
PhoenixReceiverMetadata.h5_metadata
PhoenixReceiverMetadata.h6_metadata
PhoenixReceiverMetadata.has_obj()
PhoenixReceiverMetadata.instrument_id
PhoenixReceiverMetadata.lp_filter_base_name
PhoenixReceiverMetadata.read()
PhoenixReceiverMetadata.run_metadata
PhoenixReceiverMetadata.station_metadata
PhoenixReceiverMetadata.survey_metadata
TSReaderBase
TSReaderBase.base_dir
TSReaderBase.base_path
TSReaderBase.channel_metadata
TSReaderBase.close()
TSReaderBase.config_file_path
TSReaderBase.file_extension
TSReaderBase.file_name
TSReaderBase.file_size
TSReaderBase.get_channel_response_filter()
TSReaderBase.get_config_object()
TSReaderBase.get_dipole_filter()
TSReaderBase.get_lowpass_filter_name()
TSReaderBase.get_receiver_lowpass_filter()
TSReaderBase.get_receiver_metadata_object()
TSReaderBase.get_sensor_filter()
TSReaderBase.get_v_to_mv_filter()
TSReaderBase.instrument_id
TSReaderBase.max_samples
TSReaderBase.open_file_seq()
TSReaderBase.open_next()
TSReaderBase.recmeta_file_path
TSReaderBase.run_metadata
TSReaderBase.seq
TSReaderBase.sequence_list
TSReaderBase.station_metadata
TSReaderBase.update_channel_map_from_recmeta()
Submodules
mth5.io.phoenix.phoenix_collection module
Phoenix file collection
Created on Thu Aug 4 16:48:47 2022
@author: jpeacock
- class mth5.io.phoenix.phoenix_collection.PhoenixCollection(file_path=None, **kwargs)[source]
Bases:
Collection
A class to collect the various files in a Phoenix file system and try to organize them into runs.
- assign_run_names(df, zeros=4)[source]
Assign run names by looping through start times.
For continous data a single run is assigned as long as the start and end times of each file align. If there is a break a new run name is assigned.
For segmented data a new run name is assigned to each segment
- Parameters
df (
pandas.DataFrame
) – Dataframe returned by to_dataframe methodzeros (integer, optional) – Number of zeros in the run name, defaults to 4
- Returns
Dataframe with run names
- Return type
pandas.DataFrame
- get_runs(sample_rates, run_name_zeros=4, calibration_path=None)[source]
Get a list of runs contained within the given folder. First the dataframe will be developed from which the runs are extracted.
For continous data all you need is the first file in the sequence. The reader will read in the entire sequence.
For segmented data it will only read in the given segment, which is slightly different from the original reader.
- Parameters
sample_rates – list of sample rates to read, defaults to [150, 24000]
run_name_zeros (integer, optional) – Number of zeros in the run name, defaults to 4
- Returns
List of run dataframes with only the first block of files
- Return type
OrderedDict
- Example
>>> from mth5.io.phoenix import PhoenixCollection >>> phx_collection = PhoenixCollection(r"/path/to/station") >>> run_dict = phx_collection.get_runs(sample_rates=[150, 24000])
- to_dataframe(sample_rates=[150, 24000], run_name_zeros=4, calibration_path=None)[source]
Get a dataframe of all the files in a given directory with given columns. Loop over station folders.
- Parameters
sample_rates (list of integers, optional) – list of sample rates to read, defaults to [150, 24000]
run_name_zeros (integer, optional) – Number of zeros in the run name, defaults to 4
- Returns
Dataframe with each row representing a single file
- Return type
pandas.DataFrame
mth5.io.phoenix.read module
Created on Fri May 6 12:39:34 2022
@author: jpeacock
Module contents
- class mth5.io.phoenix.PhoenixCollection(file_path=None, **kwargs)[source]
Bases:
Collection
A class to collect the various files in a Phoenix file system and try to organize them into runs.
- assign_run_names(df, zeros=4)[source]
Assign run names by looping through start times.
For continous data a single run is assigned as long as the start and end times of each file align. If there is a break a new run name is assigned.
For segmented data a new run name is assigned to each segment
- Parameters
df (
pandas.DataFrame
) – Dataframe returned by to_dataframe methodzeros (integer, optional) – Number of zeros in the run name, defaults to 4
- Returns
Dataframe with run names
- Return type
pandas.DataFrame
- get_runs(sample_rates, run_name_zeros=4, calibration_path=None)[source]
Get a list of runs contained within the given folder. First the dataframe will be developed from which the runs are extracted.
For continous data all you need is the first file in the sequence. The reader will read in the entire sequence.
For segmented data it will only read in the given segment, which is slightly different from the original reader.
- Parameters
sample_rates – list of sample rates to read, defaults to [150, 24000]
run_name_zeros (integer, optional) – Number of zeros in the run name, defaults to 4
- Returns
List of run dataframes with only the first block of files
- Return type
OrderedDict
- Example
>>> from mth5.io.phoenix import PhoenixCollection >>> phx_collection = PhoenixCollection(r"/path/to/station") >>> run_dict = phx_collection.get_runs(sample_rates=[150, 24000])
- to_dataframe(sample_rates=[150, 24000], run_name_zeros=4, calibration_path=None)[source]
Get a dataframe of all the files in a given directory with given columns. Loop over station folders.
- Parameters
sample_rates (list of integers, optional) – list of sample rates to read, defaults to [150, 24000]
run_name_zeros (integer, optional) – Number of zeros in the run name, defaults to 4
- Returns
Dataframe with each row representing a single file
- Return type
pandas.DataFrame
- class mth5.io.phoenix.PhoenixConfig(fn=None, **kwargs)[source]
Bases:
object
A container for the config.json file used to control the recording
- property auto_power_enabled
- property config
- property empower_version
- property fn
- property mtc150_reset
- property network
- read(fn=None)[source]
read a config.json file that is in the Phoenix format
- Parameters
fn (TYPE, optional) – DESCRIPTION, defaults to None
- Returns
DESCRIPTION
- Return type
TYPE
- property receiver
- property schedule
- property surveyTechnique
- property timezone
- property timezone_offset
- property version
- class mth5.io.phoenix.PhoenixReceiverMetadata(fn=None, **kwargs)[source]
Bases:
object
A container for the recmeta.json file used to control the recording
- property channel_map
- property e1_metadata
- property e2_metadata
- property fn
- property h1_metadata
- property h2_metadata
- property h3_metadata
- property h4_metadata
- property h5_metadata
- property h6_metadata
- property instrument_id
- property lp_filter_base_name
- read(fn=None)[source]
read a config.json file that is in the Phoenix format
- Parameters
fn (TYPE, optional) – DESCRIPTION, defaults to None
- Returns
DESCRIPTION
- Return type
TYPE
- property run_metadata
- property station_metadata
- property survey_metadata