read_mseed: Read mseed files.

In coffeemuggler/eseis: Environmental Seismology Toolbox

Read mseed files.

Description

This function reads mseed files. If append = TRUE, all files will be appended to the first one in the order as they are provided. In the append-case the function returns a either a list with the elements signal, time, meta and header or a list of the class eseis (see documentation of aux_initiateeseis()). If append = FALSE and more than one file is provided, the function returns a list of the length of the input files, each containing the above elements.

Usage

read_mseed(
  file,
  append = TRUE,
  signal = TRUE,
  time = TRUE,
  meta = TRUE,
  header = TRUE,
  eseis = TRUE,
  type = "waveform"
)

Arguments

file	Character vector, input file name(s), with extension.
append	Logical value, option to append single files to one continuous file, keeping only the header information of the first file, default is TRUE.
signal	Logical value, option to import the signal vector, default is TRUE.
time	Logical value, option to create the time vector. The timezone is automatically set to "UTC", default is TRUE.
meta	Logical value, option to append the meta data part, default is TRUE.
header	Logical value, option to append the header part, default is TRUE.
eseis	Logical value, option to read data to an eseis object (recommended, see documentation of aux_initiateeseis), default is TRUE
type	Character value, type keyword of the data. One out of "waveform", "envelope", "fft", "spectrum", "spectrogram", "other", hilbert, hvratio. Default is "waveform".

Details

The mseed data format is read based on C code that was part of the now CRAN-archived package IRISSeismic v. 1.6.6 (https://cran.r-project.org/src/contrib/Archive/IRISSeismic/). The C code and wrapper are a simplified version of the material from IRISSeismic written by Jonathan Callahan. A future version of read_mseed may use a further simplified version, restricting the header information to the pure information, required by eseis to build its meta information.

Value

List object, optionally of class eseis

Author(s)

Michael Dietze

Examples

## Not run: 

## read mseed file with default options
x <- read_mseed(file = "input.miniseed")

## read mseed file, only signal trace, not as eseis object
x <- read_mseed(file = "input.miniseed",
                time = FALSE,
                meta = FALSE,
                header = FALSE,
                eseis = FALSE)

## read more than one mseed files and append traces
x <- read_mseed(file = c("input_1.miniseed", "input_2.miniseed"))

## End(Not run)

coffeemuggler/eseis documentation built on Nov. 25, 2024, 8:31 p.m.