# Environmental Seismology Toolbox

## Documentation for package ‘eseis’ version 0.8.1

- DESCRIPTION file
- Package NEWS

## Help Pages

A E F G L M N P R S T W

eseis-package | eseis: Environmental Seismology Toolbox

## -- A --

aux_checkfiles | Check structured seismic files for consistency
aux_commondt | Identify highest common sampling interval
aux_cubeinfo | Get cube file information
aux_eseisobspy | Convert eseis object to ObsPy stream object
aux_fixmseed | Fix corrupt miniseed files
aux_getevent | Load seismic data of a user-defined event
aux_getFDSNdata | Download seismic data from FDSN data base
aux_getFDSNstation | Query FDSN data base for stations
aux_gettemperature | Extract temperature data from cube files.
aux_getxml | Download and/or read station XML file
aux_hvanalysis | Perform H-V-spectral ratio analysis of a seismic data set
aux_initiateeseis | Initiate an eseis object
aux_obspyeseis | Convert ObsPy object to eseis object
aux_organisecentaurfiles | Reorganise seismic files recorded by Nanometrics Centaur loggers
aux_organisecubefiles | Convert Datacube files and organise them in directory structure
aux_picknetwork | Pick seismic events with a sensor network approach
aux_picknetworkparallel | Pick seismic events with a sensor network approach, parallel version
aux_psdsummary | Calculate aggregated PSDs over long time periods
aux_sonifysignal | Convert seismic signal to sound (sonification)
aux_splitcubechannels | Create multiple single-component files from multi-component files
aux_stationinfofile | Create station info file from cube files.

## -- E --

earthquake | Seismic traces of a small earthquake
eseis | eseis: Environmental Seismology Toolbox

## -- F --

fmi_inversion | Invert fluvial data set based on reference spectra catalogue
fmi_parameters | Create reference model reference parameter catalogue
fmi_spectra | Create reference model spectra catalogue

## -- G --

gui_models | Start GUI with seismic models

## -- L --

list_logger | List library with data logger information.
list_sacparameters | List all header parameters of a sac file.
list_sensor | List sensor library.

## -- M --

model_amplitude | Model source amplitude by amplitude-distance model fitting
model_bedload | Model the seismic spectrum due to bedload transport in rivers
model_turbulence | Model the seismic spectrum due to hydraulic turbulence

## -- N --

ncc_correlate | Noise Cross Correlation routine
ncc_stretch | Estimate relativ wave velocity change (dv/v) by correlation stretching

## -- P --

pick_correlation | Signal correlation based event picking
pick_kurtosis | Kutosis based event picking
pick_stalta | Calculate stal-lta-ratio.
plot_components | Plot three seismic components against each other
plot_correlogram | Plot a correlogram from noise cross correlation analysis
plot_event | Create a comprehensive multi panel plot of a seismic waveform
plot_ppsd | Plot a probabilistic power spectral density estimate (PPSD)
plot_signal | Plot a seismic signal
plot_spectrogram | Plot spectrograms (power spectral density estimates)
plot_spectrum | Plot a spectrum of a seismic signal

## -- R --

read_data | Load seismic data from an archive
read_fdsn | Download and import seismic data from an FDSN service provider
read_mseed | Read mseed files.
read_sac | Read sac files.
rockfall | Seismic trace of a rockfall event.
rockfall_eseis | Seismic trace of a rockfall event.
rockfall_t | Seismic trace of a rockfall event.
rockfall_z | Seismic trace of a rockfall event.

## -- S --

s | Seismic traces of a small earthquake
signal_aggregate | Aggregate a signal vector
signal_clip | Clip signal based on time vector.
signal_correlation | Calculate signal cross-correlation values
signal_cut | Cut signal amplitude at standard deviation-defined level.
signal_deconvolve | Deconvolve a signal vector.
signal_demean | Remove mean of signal vector.
signal_detrend | Detrend a signal vector.
signal_differentiate | Differentiate a signal vector
signal_envelope | Calculate signal envelope.
signal_fill | Fill NA-gaps of a signal
signal_filter | Filter a seismic signal in the time or frequency domain
signal_hilbert | Calculate Hilbert transform.
signal_hvratio | Calculate h-v-ratio of seismic components
signal_integrate | Integrate a seismic signal
signal_interpolate | Interpolate a signal vector
signal_kurtosis | Calculate signal kurtosis
signal_merge | Merge several signal streams into one
signal_motion | Calculate particle motion parameters
signal_pad | Pad signal with zeros.
signal_rotate | Rotate signal vectors using a 3-D rotation matrix.
signal_sign | Convert amplitude signal to one bit signed signal
signal_snr | Calculate signal-to-noise-ratio (SNR).
signal_spectrogram | Calculate spectrograms (power spectral density estimates) from time series.
signal_spectrum | Calculate the spectrum of a time series
signal_stalta | Calculate the short-time-average to long time average ratio
signal_stats | Calculate signal statistics
signal_sum | Calculate signal vector sum.
signal_taper | Taper a signal vector.
signal_whiten | Perform spectral whitening of a signal vector
spatial_amplitude | Locate the source of a seismic event by modelling amplutide attenuation
spatial_clip | Clip values of spatial data.
spatial_convert | Convert coordinates between reference systems
spatial_crop | Crop extent of spatial data.
spatial_distance | Calculate topography-corrected distances for seismic waves.
spatial_migrate | Migrate signals of a seismic event through a grid of locations.
spatial_parabola | Locate signals of a seismic event by time difference parabola overlay
spatial_pmax | Get most likely source location
spatial_track | Track a spatially mobile seismic source

## -- T --

t | Seismic traces of a small earthquake
time_aggregate | Aggregate a time series
time_clip | Clip time vector.
time_convert | Convert Julian Day to Date and vice versa
time_jd | Convert time string to Julian Day

## -- W --

write_mseed | Write seismic traces as mseed file to disk.
write_report | Create a HTML report for (RLum) objects
write_sac | Write seismic traces as sac file to disk.