The function generates an empty eseis object, starting with processing step 0. The object contains no data and the history only contains the system information.
aux_initiateeseis()S3 list object of class eseis.
Michael Dietze
The S3 object class eseis contains the data vector ($signal),
a meta information list ($meta) with all essential seismic meta data -
such as sampling interval, station ID, component, start time of the stream
or file name of the input file - a list with header data of the seismic
source file ($header), and a history list ($history), which
records all data manipulation steps of an (eseis) object. The element
($meta) will be used by functions of the package to look for
essential information to perform data manipulations (e.g., the sampling
interval). Thus, working with (eseis) objects is convenient and less
prone to user related errors/bugs, given that the meta information is
correct and does not change during the processing chain; package functions
will update the meta information whenever necessary (e.g.,
signal_aggregate). The element $header will only be
present if a seismic source file has been imported.
The history element is the key feature for transparent and reproducable
research using this R package. An eseis object records a history of
every function it has been subject to, including the time stamp, the
function call, all used function arguments and their associated values,
and the overall processing duration in seconds. The history is updated
whenever an eseis object is manipulated with one of the functions
of this package (with a few exceptions, mainly from the aux_... category).
## initiate eseis object
aux_initiateeseis()
Run the code above in your browser using DataLab