6.2.10.13. eqcorrscan.utils.plotting.subspace_detector_plot

eqcorrscan.utils.plotting.subspace_detector_plot(detector, stachans, **kwargs)[source]

Plotting for the subspace detector class.

Plot the output basis vectors for the detector at the given dimension.

Corresponds to the first n horizontal vectors of the V matrix.

Parameters:
  • stachans (list) – list of tuples of station, channel pairs to plot.

  • stachans – List of tuples of (station, channel) to use. Can set to ‘all’ to use all the station-channel pairs available. If detector is multiplexed, will just plot that.

  • title (str) – Title of figure

  • show (bool) – Whether to show the figure or not (defaults to True)

  • save (bool) – Whether to save the figure or not (defaults to False)

  • savefile (str) – Filename to save figure to, if save==True (defaults to “EQcorrscan_figure.png”)

  • return_figure (bool) – Whether to return the figure or not (defaults to True), if False then the figure will be cleared and closed.

  • size (tuple of float) – Figure size as (width, height) in inches. Defaults to (10.5, 7.5)

Returns:

Figure

Return type:

matplotlib.pyplot.Figure

Example

>>> from eqcorrscan.core import subspace
>>> import os
>>> detector = subspace.Detector()
>>> detector.read(os.path.join(
...    os.path.abspath(os.path.dirname(__file__)),
...    '..', 'tests', 'test_data', 'subspace',
...    'stat_test_detector.h5'))
Detector: Tester
>>> subspace_detector_plot(detector=detector, stachans='all', size=(10, 7),
...                        show=True) 

(Source code)