tiskitpy.PeriodicTransient

class tiskitpy.PeriodicTransient(name, period, dp, clips, transient_starttime)

Bases: object

Class to determine parameters for and remove a periodic transient

The program will make transient slices starting between transient_starttime and 1/3 of self.period earlier

transient_starttime must not be too late, a few seconds early is ok

Parameters:

  • name (str) – name of this periodic transient (e.g., ‘hourly’)

  • period (float) – seconds between each transient

  • dp (float) – how many seconds to change the period by when testing for better values

  • clips (tuple) – clip values outside of this range (low, high). Should contain the max range of the transient

  • transient_starttime (str or ~class obspy.core.UTCDateTime) – onset time of earliest transient.

calc_timing(trace, eq_spans)

Calculate transient time parameters

Parameters:

  • trace (class obspy.core.Trace) – data

  • eq_spans (TimeSpans) – times spans in which to zero data

calc_transient(trace, eq_spans, match=True, plots=False)

Calculate transient for a given trace and transient parameters

Parameters:

  • trace (obspy.core.stream.Trace) – input data trace

  • eq_spans (TimeSpans) – times spans in which to zero data

  • match (bool) – match and cancel each pulse separately

  • plots (bool) – plot results

remove_transient(trace, match=True, plots=False)

Remove transient from trace

Parameters:

  • trace (obspy.Trace) – input data

  • match (bool) – match each transient individually

Returns:

output data

Return type:

(obspy.Trace)