.. _tiskitpy.SpectralDensity_example:

==============================
SpectralDensity example code
==============================

.. code-block:: python

    from obspy.core.stream import read
    from obspy.core.inventory import read_inventory
    from tiskitpy import SpectralDensity

    # read data and inventory
    stream = read('data/XS.S11D.LH.2016.12.11.mseed', 'MSEED')
    inv = read_inventory('data/XS.S11_decimated.station.xml', 'STATIONXML')

    # Calculate Spectral Density
    sd = SpectralDensity.from_stream(stream, inv=inv)

.. code-block:: none

    [INFO] z_threshold=3 rejected 4% of windows (3/84)

.. code-block:: python

    print(sd)

.. code-block:: none

    SpectralDensity object:
        channel_names=['XS.S11D..LDH', 'XS.S11D..LH1', 'XS.S11D..LH2', 'XS.S11D..LHZ']
        channel_units=['Pa', 'm/s^2', 'm/s^2', 'm/s^2']
        512 frequencies, from 0.000977 to 0.5Hz
        n_windows=81
        window_type=prol1pi

.. code-block:: python

    # plot results
    sd.plot()

.. image:: images/1_SpectralDensity_plot.png
   :width: 564
   
.. code-block:: python

    # plot results, overlaid
    sd.plot(overlay=True)

.. image:: images/1_SpectralDensity_plot_overlay.png
   :width: 564
   
.. code-block:: python

    # plot coherences
    sd.plot_coherences(display="full")

.. image:: images/1_SpectralDensity_coher_full.png
   :width: 564
   
.. code-block:: python

    # plot coherences, overlaid
    sd.plot_coherences(display="overlay")

.. image:: images/1_SpectralDensity_coher_overlay.png
   :width: 564

.. code-block:: python

    # plot coherences, sparse
    sd.plot_coherences(display="sparse")

.. image:: images/1_SpectralDensity_coher_sparse.png
   :width: 564

.. code-block:: python

    # plot coherences, minimal space
    sd.plot_coherences(display="minimal")

.. image:: images/1_SpectralDensity_coher_minimal.png
   :width: 564