.. mermaid::

    %%{init: { 'logLevel': 'debug', 'theme': 'base' } }%%
    graph LR
        waveform[Get Data] --> correlate(Correlation)
        correlate:::active -->|save| corrdb[(CorrDB/hdf5)]
        corrdb --> monitor
        monitor[Measure dv] -->|save| dv{{DV}}
        click waveform "../trace_data.html" "trace_data"
        click correlate "../correlate.html" "correlate"
        click monitor "../monitor.html" "monitor"
        click corrdb "../corrdb.html" "CorrDB"
        click dv "../monitor/dv.html" "DV"
        classDef active fill:#f666, stroke-width:4px, stroke:#f06;

CorrTrace, CorrStream, and CorrBulk classes
-------------------------------------------

Once the correlations are actually computed, they are assigned as :py:class:`~seismic.correlate.stream.CorrTrace`
and :py:class:`~seismic.correlate.stream.CorrStream` objects.
Both inherit most of their methods and attributes from their `obspy <https://docs.obspy.org/>`_ parents. However, there are some extra attributes and functionalities.

CorrTrace
+++++++++

Most notably a new Header object (:py:class:`~seismic.correlate.stats.CorrStats`) with different attributes is associated to this type of trace.
The header takes care of saving vital information like lag times (``start_lag`` and ``end_lag``),
the start- and the endtime of the waveforms that were used to compute the correlation (``corr_start`` and ``corr_end``, respectively),
and information about the coordinates of the stations.

:py:class:`~seismic.correlate.stream.CorrTrace` does also come with its own plotting method :py:meth:`~seismic.correlate.stream.CorrTrace.plot`
(check it for details). It can produce plots akin to this one:

.. image:: ../../figures/corrtr.svg

CorrStream
++++++++++

Essentially, this class is just a fancy list of :py:class:`~seismic.correlate.stream.CorrTrace` objects.
However, it has methods to stack (:py:meth:`~seismic.correlate.stream.CorrStream.stack`),
select (:py:meth:`~seismic.correlate.stream.CorrStream.select_corr_time`), or slide (:py:meth:`~seismic.correlate.stream.CorrStream.slide`) time windows.
It also enables us to create section stacks, sorted by interstation distance or time:

.. image:: ../../figures/cst.png


CorrBulk
++++++++

:py:class:`~seismic.correlate.stream.CorrStream` does also have a method to create a :py:class:`~seismic.correlate.stream.CorrBulk` object
(:py:meth:`~seismic.correlate.stream.CorrStream.create_corr_bulk`). Instead of relying on a list of traces, this object is based on numpy arrays,
which makes all sorts of computations cheaper. Check out :py:class:`~seismic.correlate.stream.CorrBulk` for available functions.
This is also the object that SeisMIC's own monitoring workflow is based on.