Version:

salvus.modules.waveform_db.waveform_db

salvus.modules.waveform_db.waveform_db salvus modules waveform_db waveform_db
Waveform databases for Salvus.

Classes

WaveformDB

Initialize a waveform database object from a database on disc.
SIGNATURE
class WaveformDB(builtins.object):
    def __init__(self, filename: pathlib.Path | str): ...
ARGUMENTS
Required
filename
Type:pathlib.Path | str
Description:
Path of the database.

Properties

  • database_sampling_rate(float)-The sampling rate in Hertz for all waveforms in the database.
  • database_start_time(obspy.UTCDateTime)-Time of the first sample for all waveforms in the database.
  • gll_points_per_element(int)-The number of GLL points per element.
  • meta_json(dict)-Return a copy of the meta.json dictionary of the Salvus run creating the original volume data.
  • ndim(int)-The dimensionality of the database.
  • polynomial_order(int)-The polynomial order of the wavefield.
  • receiver_fields(set[str])-The receiver fields available in the database.

Methods

WaveformDB.get_waveform_data()
Get waveforms from the database.
SIGNATURE
def get_waveform_data(
    self,
    receiver: simple_config.receiver._Base,
    receiver_field: str | None = None,
    sampling_rate: float | None = None,
) -> obspy.Stream: ...
ARGUMENTS
Required
receiver
Type:simple_config.receiver._Base
Description:
Salvus receiver object.
Optional
receiver_field
Type:str | None
Default value:None
Description:
The receiver field to extract. If the receiver object only contains a single receiver field this does not have to be specified.
Optional
sampling_rate
Type:float | None
Default value:None
Description:
Optionally resample to a chosen sampling rate. Cannot downsample.
PAGE CONTENTS