5.11.1.1. parameters.EQcorrscanParameters

class eqcorrscan.utils.parameters.EQcorrscanParameters(template_names, lowcut, highcut, filt_order, samp_rate, debug, startdate, enddate, archive, arc_type, cores, plotvar, plotdir, plot_format, tempdir, threshold, threshold_type, trigger_interval)[source]

Bases: object

Standard class for defining parameters in EQcorrscan.

These parameters are set using the quickstart script of EQcorrscan for matched-filter analysis. The quickstart functionality is currently in development.

Parameters:
  • template_names (list) – List of str of template names.
  • lowcut (float) – Low-cut iun Hz
  • highcut (float) – High-cut in Hz
  • filt_order (int) – Number of corners in filter
  • samp_rate (float) – Desired sampling rate in Hz
  • debug (int) – 0-5 debug level, higher number is more output
  • startdate (obspy.core.utcdatetime.UTCDateTime) – Start date for match-filter analysis.
  • enddate (obspy.core.utcdatetime.UTCDateTime) – End date for matched-filter analysis
  • archive (str) – Path to archive, or FDSN name
  • arc_type (str) – Type of archive (see eqcorrscan.utils.archive_read() for available options.
  • cores (int) – Number of cores to parallel over
  • plotvar (bool) – Whether to show plots or not
  • plotdir (str) – Output plot location
  • plot_format (str) – Output plot type
  • tempdir (str) – Location of temporary files (if needed)
  • threshold (float) – Threshold for matched-filter detection
  • threshold_type (str) – Threshold type for matched-filter detection, see eqcorrscan.core.match_filter.match_filter() for available types.
  • trigger_interval (float) – Minimum trigger interval in seconds.

Methods

write([outfile, overwrite]) Function to write the parameters to a file - user readable.
__init__(template_names, lowcut, highcut, filt_order, samp_rate, debug, startdate, enddate, archive, arc_type, cores, plotvar, plotdir, plot_format, tempdir, threshold, threshold_type, trigger_interval)[source]

Standard parameter options.

write(outfile=’../parameters/EQcorrscan_parameters.txt’, overwrite=False)[source]

Function to write the parameters to a file - user readable.

Parameters:
  • outfile (str) – Full path to filename to store parameters in.
  • overwrite (bool) – Whether to overwrite the old file or not.