:py:mod:`pickax.seismogram_iterator`
====================================

.. py:module:: pickax.seismogram_iterator

.. autodoc2-docstring:: pickax.seismogram_iterator
   :allowtitles:

Module Contents
---------------

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`SeismogramIterator <pickax.seismogram_iterator.SeismogramIterator>`
     - .. autodoc2-docstring:: pickax.seismogram_iterator.SeismogramIterator
          :summary:
   * - :py:obj:`MDLSeismogramIterator <pickax.seismogram_iterator.MDLSeismogramIterator>`
     - .. autodoc2-docstring:: pickax.seismogram_iterator.MDLSeismogramIterator
          :summary:
   * - :py:obj:`CacheSeismogramIterator <pickax.seismogram_iterator.CacheSeismogramIterator>`
     - .. autodoc2-docstring:: pickax.seismogram_iterator.CacheSeismogramIterator
          :summary:
   * - :py:obj:`FDSNSeismogramIterator <pickax.seismogram_iterator.FDSNSeismogramIterator>`
     -
   * - :py:obj:`ThreeAtATime <pickax.seismogram_iterator.ThreeAtATime>`
     - .. autodoc2-docstring:: pickax.seismogram_iterator.ThreeAtATime
          :summary:

API
~~~

.. py:class:: SeismogramIterator()
   :canonical: pickax.seismogram_iterator.SeismogramIterator

   Bases: :py:obj:`abc.ABC`

   .. autodoc2-docstring:: pickax.seismogram_iterator.SeismogramIterator

   .. rubric:: Initialization

   .. autodoc2-docstring:: pickax.seismogram_iterator.SeismogramIterator.__init__

   .. py:method:: next()
      :canonical: pickax.seismogram_iterator.SeismogramIterator.next
      :abstractmethod:

      .. autodoc2-docstring:: pickax.seismogram_iterator.SeismogramIterator.next

   .. py:method:: prev()
      :canonical: pickax.seismogram_iterator.SeismogramIterator.prev
      :abstractmethod:

      .. autodoc2-docstring:: pickax.seismogram_iterator.SeismogramIterator.prev

   .. py:method:: quake_iterator()
      :canonical: pickax.seismogram_iterator.SeismogramIterator.quake_iterator

      .. autodoc2-docstring:: pickax.seismogram_iterator.SeismogramIterator.quake_iterator

   .. py:method:: station_iterator()
      :canonical: pickax.seismogram_iterator.SeismogramIterator.station_iterator

      .. autodoc2-docstring:: pickax.seismogram_iterator.SeismogramIterator.station_iterator

.. py:class:: MDLSeismogramIterator(mdl_dir, mseed_storage='waveforms', stationxml_storage='stations', quakeml='*.qml')
   :canonical: pickax.seismogram_iterator.MDLSeismogramIterator

   Bases: :py:obj:`pickax.seismogram_iterator.SeismogramIterator`

   .. autodoc2-docstring:: pickax.seismogram_iterator.MDLSeismogramIterator

   .. rubric:: Initialization

   .. autodoc2-docstring:: pickax.seismogram_iterator.MDLSeismogramIterator.__init__

   .. py:method:: next()
      :canonical: pickax.seismogram_iterator.MDLSeismogramIterator.next

      .. autodoc2-docstring:: pickax.seismogram_iterator.MDLSeismogramIterator.next

   .. py:method:: prev()
      :canonical: pickax.seismogram_iterator.MDLSeismogramIterator.prev

      .. autodoc2-docstring:: pickax.seismogram_iterator.MDLSeismogramIterator.prev

   .. py:method:: quake_iterator()
      :canonical: pickax.seismogram_iterator.MDLSeismogramIterator.quake_iterator

      .. autodoc2-docstring:: pickax.seismogram_iterator.MDLSeismogramIterator.quake_iterator

   .. py:method:: station_iterator()
      :canonical: pickax.seismogram_iterator.MDLSeismogramIterator.station_iterator

      .. autodoc2-docstring:: pickax.seismogram_iterator.MDLSeismogramIterator.station_iterator

   .. py:method:: __load_seismograms__(net, sta, quake, query_params={})
      :canonical: pickax.seismogram_iterator.MDLSeismogramIterator.__load_seismograms__

      .. autodoc2-docstring:: pickax.seismogram_iterator.MDLSeismogramIterator.__load_seismograms__

.. py:class:: CacheSeismogramIterator(sub_itr, size=10)
   :canonical: pickax.seismogram_iterator.CacheSeismogramIterator

   Bases: :py:obj:`pickax.seismogram_iterator.SeismogramIterator`

   .. autodoc2-docstring:: pickax.seismogram_iterator.CacheSeismogramIterator

   .. rubric:: Initialization

   .. autodoc2-docstring:: pickax.seismogram_iterator.CacheSeismogramIterator.__init__

   .. py:method:: next()
      :canonical: pickax.seismogram_iterator.CacheSeismogramIterator.next

      .. autodoc2-docstring:: pickax.seismogram_iterator.CacheSeismogramIterator.next

   .. py:method:: prev()
      :canonical: pickax.seismogram_iterator.CacheSeismogramIterator.prev

      .. autodoc2-docstring:: pickax.seismogram_iterator.CacheSeismogramIterator.prev

   .. py:method:: quake_iterator()
      :canonical: pickax.seismogram_iterator.CacheSeismogramIterator.quake_iterator

      .. autodoc2-docstring:: pickax.seismogram_iterator.CacheSeismogramIterator.quake_iterator

   .. py:method:: station_iterator()
      :canonical: pickax.seismogram_iterator.CacheSeismogramIterator.station_iterator

      .. autodoc2-docstring:: pickax.seismogram_iterator.CacheSeismogramIterator.station_iterator

.. py:class:: FDSNSeismogramIterator(quake_itr, station_itr, dc_name='EARTHSCOPE', start_phases='origin', start_offset=0, end_phases='origin', end_offset=300, debug=False, timeout=30)
   :canonical: pickax.seismogram_iterator.FDSNSeismogramIterator

   Bases: :py:obj:`pickax.seismogram_iterator.SeismogramIterator`

   .. py:method:: next()
      :canonical: pickax.seismogram_iterator.FDSNSeismogramIterator.next

      .. autodoc2-docstring:: pickax.seismogram_iterator.FDSNSeismogramIterator.next

   .. py:method:: prev()
      :canonical: pickax.seismogram_iterator.FDSNSeismogramIterator.prev

      .. autodoc2-docstring:: pickax.seismogram_iterator.FDSNSeismogramIterator.prev

   .. py:method:: quake_iterator()
      :canonical: pickax.seismogram_iterator.FDSNSeismogramIterator.quake_iterator

      .. autodoc2-docstring:: pickax.seismogram_iterator.FDSNSeismogramIterator.quake_iterator

   .. py:method:: station_iterator()
      :canonical: pickax.seismogram_iterator.FDSNSeismogramIterator.station_iterator

      .. autodoc2-docstring:: pickax.seismogram_iterator.FDSNSeismogramIterator.station_iterator

   .. py:method:: __load_seismograms__(net, sta, quake, query_params={})
      :canonical: pickax.seismogram_iterator.FDSNSeismogramIterator.__load_seismograms__

      .. autodoc2-docstring:: pickax.seismogram_iterator.FDSNSeismogramIterator.__load_seismograms__

.. py:class:: ThreeAtATime(sub_itr)
   :canonical: pickax.seismogram_iterator.ThreeAtATime

   Bases: :py:obj:`pickax.seismogram_iterator.SeismogramIterator`

   .. autodoc2-docstring:: pickax.seismogram_iterator.ThreeAtATime

   .. rubric:: Initialization

   .. autodoc2-docstring:: pickax.seismogram_iterator.ThreeAtATime.__init__

   .. py:method:: split_3c(net, sta, quake, waveforms)
      :canonical: pickax.seismogram_iterator.ThreeAtATime.split_3c

      .. autodoc2-docstring:: pickax.seismogram_iterator.ThreeAtATime.split_3c

   .. py:method:: next()
      :canonical: pickax.seismogram_iterator.ThreeAtATime.next

      .. autodoc2-docstring:: pickax.seismogram_iterator.ThreeAtATime.next

   .. py:method:: prev()
      :canonical: pickax.seismogram_iterator.ThreeAtATime.prev

      .. autodoc2-docstring:: pickax.seismogram_iterator.ThreeAtATime.prev

   .. py:method:: quake_iterator()
      :canonical: pickax.seismogram_iterator.ThreeAtATime.quake_iterator

      .. autodoc2-docstring:: pickax.seismogram_iterator.ThreeAtATime.quake_iterator

   .. py:method:: station_iterator()
      :canonical: pickax.seismogram_iterator.ThreeAtATime.station_iterator

      .. autodoc2-docstring:: pickax.seismogram_iterator.ThreeAtATime.station_iterator