TraceHeader-class: Class '"TraceHeader"'

In IRISSeismic: Classes and Methods for Seismic Data Analysis

Class "TraceHeader"

Description

A container for metadata associated with a Trace object. Originally populated by information in the miniseed trace header; it now has the option of including additional station and channel metadata.

Objects from the Class

Objects can be created by calls of the form new("TraceHeader", headerList, headerLine, ...). The stats slot of a Trace object will contain a TraceHeader object, typically populated by a webservice request. (see IrisClient-class)

Slots

sampling_rate:

Object of class "numeric": Sampling rate in hertz.

delta:

Object of class "numeric": Sample interval in seconds.

calib:

Object of class "numeric": Calibration factor.

npts:

Object of class "integer": Number of sample points.

network:

Object of class "character": Seismic network name.

location:

Object of class "character": Location code.

station:

Object of class "character": Station name.

channel:

Object of class "character": Channel code.

quality:

Object of class "character": Data quality code.

starttime:

Object of class "POSIXct": Start time.

endtime:

Object of class "POSIXct": End time.

latitude:

Object of class "numeric": Latitude.

longitude:

Object of class "numeric": Longitude.

elevation:

Object of class "numeric": Elevation.

depth:

Object of class "numeric": Depth.

azimuth:

Object of class "numeric": Azimuth.

dip:

Object of class "numeric": Dip.

processing:

Object of class "list": Information strings describing processing applied to this trace.

Methods

as.headerLine

signature(obj = "TraceHeader"): Prints out the information in the TraceHeader as an ascii header line, not including any station and channel metadata not found in the miniseed trace header, e.g.,

    TIMESERIES LD_POTS__HHZ_M, 351 samples, 100.503 sps, \
    2012-01-29T00:00:00.006000, SLIST, INTEGER, COUNTS

show

signature(object = "TraceHeader"): Prettyprints the information in the TraceHeader

Note

The TraceHeader object is inspired by the Stats class found in the python ObsPy package (https://docs.obspy.org/packages/autogen/obspy.core.trace.Stats.html).

Retaining the ObsPy class name Stats would have generated a tremendous amount of confusion in the context of R. Instead, the name TraceHeader has been adopted. Nevertheless, the TraceHeader object still lives in the Trace@stats slot to retain as much similarity to ObsPy as possible.

Author(s)

Jonathan Callahan [e-mail]

Examples

## Not run: 
# Open a connection to IRIS DMC webservices
iris <- new("IrisClient")

starttime <- as.POSIXct("2012-01-24", tz="GMT")
endtime <- as.POSIXct("2012-01-25", tz="GMT")

# Get the waveform
st <- getDataselect(iris,"AK","PIN","","BHZ",starttime,endtime)

# Get the first trace and show the associated metadata
tr1 <- st@traces[[1]]
show(tr1@stats)

## End(Not run)

IRISSeismic documentation built on Oct. 16, 2022, 1:09 a.m.