eseis (version 0.6.0)

aux_organisecentaurfiles: Reorganise seismic files recorded by Nanometrics Centaur loggers

Description

This function optionally converts mseed files to sac files and organises these in a coherent directory structure, by year, Julian day, (station, hour and channel). It depends on the cubetools or gipptools software package (see details). The function is at an experimental stage and only used for data processing at the GFZ Geomorphology section, currently.

Usage

aux_organisecentaurfiles(
  stationfile,
  input_dir,
  output_dir,
  format = "sac",
  channel_name = "bh",
  cpu,
  gipptools,
  file_key = "miniseed",
  network
)

Value

A set of hourly seismic files written to disk.

Arguments

stationfile

Character value, file name of the station info file, with extension. See aux_stationinfofile.

input_dir

Character value, path to directory where all files to be processed as stored. Each set of files from one logger must be stored in a separate sub-directory named after the logger ID (which in turn must be the four digit number of the logger).

output_dir

Character value, path to directory where output data is written to.

format

Character value, output file format. One out of "mseed" and "sac". Default is "sac".

channel_name

Character value, output file extension. One out of "bh" and "p". Default is "bh".

cpu

Numeric value, fraction of CPUs to use for parallel processing. If omitted, one CPU is used.

gipptools

Character value, path to gipptools or cubetools directory.

file_key

Character value, file name extension of the files to process. Only files with this extension will be processed. Default is "miniseed".

network

Character value, optional seismic network code.

Author

Michael Dietze

Details

The function assumes that the Nanometrics Centaur data logger directory contains only hourly mseed files. These hourly files are organised in a coherent directory structure which is organised by year and Julian day. In each Julian day directory the hourly files are placed and named according to the following scheme: STATIONID.YEAR.JULIANDAY.HOUR.MINUTE.SECOND.CHANNEL.
The function requires that the software cubetools (http://www.omnirecs.de/documents.html) or gipptools (http://www.gfz-potsdam.de/en/section/geophysical-deep-sounding/infrastructure/geophysical-instrument-pool-potsdam-gipp/software/gipptools/) are installed.
Specifying an input directory (input_dir) is mandatory. This input directory must only contain the subdirectories with mseed data for each Centaur logger. The subdirectory must be named after the four digit Centaur ID and contain only mseed files, regardless if further subdirectories are used (e.g., for calendar days).

In the case a six-channel Centaur is used to record signals from two sensors, in the station info file (cf. aux_stationinfofile()) the logger ID field must contain the four digit logger ID and the channel qualifiers, e.g., "AH" (first three channels) or "BH" (last three channels), separated by an underscore.

Examples

if (FALSE) {

## basic example with minimum effort
aux_organisecentaurfiles(stationfile = "output/stationinfo.txt", 
                         input_dir = "input", 
                         gipptools = "software/gipptools-2015.225/")

}