5.14.1.2. eqcorrscan.utils.pre_processing.process

eqcorrscan.utils.pre_processing.process(tr, lowcut, highcut, filt_order, samp_rate, debug, starttime=False, clip=False, length=86400, seisan_chan_names=False, ignore_length=False)[source]

Basic function to process data, usually called by dayproc or shortproc.

Functionally, this will bandpass, downsample and check headers and length of trace to ensure files start at the start of a day and are daylong. This is a simple wrapper on obspy functions, we include it here to provide a system to ensure all parts of the dataset are processed in the same way.

Note

Usually this function is called via dayproc or shortproc.

Parameters:
  • tr (obspy.core.trace.Trace) – Trace to process
  • lowcut (float) – Low cut in Hz, if set to None and highcut is set, will use a lowpass filter.
  • highcut (float) – High cut in Hz, if set to None and lowcut is set, will use a highpass filter.
  • filt_order (int) – Number of corners for filter.
  • samp_rate (float) – Desired sampling rate in Hz.
  • debug (int) – Debug output level from 0-5, higher numbers = more output.
  • starttime (obspy.core.utcdatetime.UTCDateTime) – Desired start of trace
  • clip (bool) – Whether to expect, and enforce a set length of data or not.
  • length (float) – Use to set a fixed length for data from the given starttime.
  • seisan_chan_names (bool) – Whether channels are named like seisan channels (which are two letters rather than SEED convention of three) - defaults to True.
  • ignore_length (bool) – See warning in dayproc.
Returns:

Processed stream.

Type:

obspy.core.stream.Stream