Source code for gmprocess.waveform_processing.zero_crossings

"""Module for zero-crossing QA check."""

import numpy as np
from gmprocess.waveform_processing.processing_step import processing_step




@processing_step
def check_zero_crossings(st, min_crossings=0.1, config=None):
    """Requires a minimum zero crossing rate.

    This is intended to screen out instrumental failures or resetting.
    Value determined empirically from observations on the GeoNet network
    by R Lee.

    Args:
        st (StationStream):
            StationStream object.
        min_crossings (float):
            Minimum average number of zero crossings per second for the full
            trace.
        config (dict):
            Configuration dictionary (or None). See get_config().

    Returns:
        StationStream: With zero crossing rate criteria applied.
    """

    zero_count_tr = []
    delta_t = st[0].stats.delta
    dur = (st[0].stats.npts - 1) * delta_t

    for tr in st:
        # Make a copy of the trace to trim it before counting crossings; we do
        # not want to modify the trace but we only want to count the crossings
        # within the trimmed window

        if tr.has_parameter("signal_end") and tr.passed:
            etime = tr.get_parameter("signal_end")["end_time"]
            split_time = tr.get_parameter("signal_split")["split_time"]

            sig_start = int((split_time - tr.stats.starttime) / tr.stats.delta)
            sig_end = int((etime - tr.stats.starttime) / tr.stats.delta)
            tr_data = tr.data[sig_start:sig_end]

            zarray = np.multiply(tr_data[0:-1], tr_data[1:])
            zindices = [i for (i, z) in enumerate(zarray) if z < 0]
            zero_count_tr = len(zindices)

            z_rate = zero_count_tr / dur

            # Put results back into the original trace, not the copy
            tr.set_parameter("ZeroCrossingRate", {"crossing_rate": z_rate})

            # Fail if zero crossing rate is too low
            if z_rate <= min_crossings:
                tr.fail("Zero crossing rate too low.")

    return st