pysolate.block.Parameter

class Parameter(*args, **kwargs)[source]

Bases: object

A container of parameters required to run Block

The Parameter class determines the appropriate processes to be applied to the seismograms.

Parameters

  • wave_type (str) – wavelet filter type, options are "morlet", "shannon", "mhat", "hhat". Default is "morlet".

  • nvoices (int) – number of voices, or the sampling of CWT in scale. Higher number of voices give finer resolution. Default is 16.

  • bandpass_blocking (bool) – Default value True will apply a band rejection filter where wavelet coefficients are modified over a scale bandpass.

  • scale_min (float) – minimum time scale for bandpass blocking. Default is 1.

  • scale_max (float) – maximum time scale for bandpass blocking. Default is 200.

  • block_threshhold – percent amplitude adjustment to the wavelet coefficients within scale_min and scale_max. For example a threshold of 5% means the wavelet cofficients in the band will be multipled by 0.05. Default is 0.

  • estimate_noise (bool) – flag to compute the noise model, default is True.

  • noise_starttime (float) – noise start time, default is 0.

  • noise_endtime (float) – noise end time, default is 60.

  • noise_threshold (str) – type of noise thresholding to be applied, the options are "hard" for hard thresholding and "soft" for soft thresholding. Default is None.

  • signal_threshold (str) – type of signal thresholding to be appied, the options are "hard" for hard thresholding, and "soft" for soft thresholding. Default is None.

  • nsigma_method (str, int, float) – method to determine the number of standard deviations for block thresholding. "donoho" for Donoho’s Threshold criterion and "ECDF" for empirical cumulative probability distribution method. You can also specify the number of standard deviations by entering a number. None ECDF method assumes Gaussian statistic. The default method "ECDF" is recommended.

  • snr_detection (bool) – Flag to apply the SNR detection method, default is False. If True it will be applied before hard thresholding.

  • snr_lowerbound (float) – Noise level percent lower bound. Default is 1.0.

Methods

keys

Returns a list of object attributes.

update