:py:mod:`pickax.quake_iterator`
===============================

.. py:module:: pickax.quake_iterator

.. autodoc2-docstring:: pickax.quake_iterator
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`QuakeIterator <pickax.quake_iterator.QuakeIterator>`
     -
   * - :py:obj:`QuakeMLFileIterator <pickax.quake_iterator.QuakeMLFileIterator>`
     -
   * - :py:obj:`QuakeMLDirectoryIterator <pickax.quake_iterator.QuakeMLDirectoryIterator>`
     - .. autodoc2-docstring:: pickax.quake_iterator.QuakeMLDirectoryIterator
          :summary:
   * - :py:obj:`FDSNQuakeIterator <pickax.quake_iterator.FDSNQuakeIterator>`
     -
   * - :py:obj:`CachedPicksQuakeItr <pickax.quake_iterator.CachedPicksQuakeItr>`
     -

API
~~~

.. py:class:: QuakeIterator()
   :canonical: pickax.quake_iterator.QuakeIterator

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

   .. py:method:: next()
      :canonical: pickax.quake_iterator.QuakeIterator.next
      :abstractmethod:

      .. autodoc2-docstring:: pickax.quake_iterator.QuakeIterator.next

   .. py:method:: prev()
      :canonical: pickax.quake_iterator.QuakeIterator.prev
      :abstractmethod:

      .. autodoc2-docstring:: pickax.quake_iterator.QuakeIterator.prev

   .. py:method:: beginning()
      :canonical: pickax.quake_iterator.QuakeIterator.beginning
      :abstractmethod:

      .. autodoc2-docstring:: pickax.quake_iterator.QuakeIterator.beginning

   .. py:method:: all()
      :canonical: pickax.quake_iterator.QuakeIterator.all

      .. autodoc2-docstring:: pickax.quake_iterator.QuakeIterator.all

.. py:class:: QuakeMLFileIterator(file)
   :canonical: pickax.quake_iterator.QuakeMLFileIterator

   Bases: :py:obj:`pickax.quake_iterator.QuakeIterator`

   .. py:method:: next()
      :canonical: pickax.quake_iterator.QuakeMLFileIterator.next

      .. autodoc2-docstring:: pickax.quake_iterator.QuakeMLFileIterator.next

   .. py:method:: prev()
      :canonical: pickax.quake_iterator.QuakeMLFileIterator.prev

      .. autodoc2-docstring:: pickax.quake_iterator.QuakeMLFileIterator.prev

   .. py:method:: beginning()
      :canonical: pickax.quake_iterator.QuakeMLFileIterator.beginning

      .. autodoc2-docstring:: pickax.quake_iterator.QuakeMLFileIterator.beginning

   .. py:method:: all()
      :canonical: pickax.quake_iterator.QuakeMLFileIterator.all

      .. autodoc2-docstring:: pickax.quake_iterator.QuakeMLFileIterator.all

.. py:class:: QuakeMLDirectoryIterator(dir, pattern='**/*.qml')
   :canonical: pickax.quake_iterator.QuakeMLDirectoryIterator

   Bases: :py:obj:`pickax.quake_iterator.QuakeIterator`

   .. autodoc2-docstring:: pickax.quake_iterator.QuakeMLDirectoryIterator

   .. rubric:: Initialization

   .. autodoc2-docstring:: pickax.quake_iterator.QuakeMLDirectoryIterator.__init__

   .. py:method:: next()
      :canonical: pickax.quake_iterator.QuakeMLDirectoryIterator.next

      .. autodoc2-docstring:: pickax.quake_iterator.QuakeMLDirectoryIterator.next

   .. py:method:: prev()
      :canonical: pickax.quake_iterator.QuakeMLDirectoryIterator.prev

      .. autodoc2-docstring:: pickax.quake_iterator.QuakeMLDirectoryIterator.prev

   .. py:method:: beginning()
      :canonical: pickax.quake_iterator.QuakeMLDirectoryIterator.beginning

      .. autodoc2-docstring:: pickax.quake_iterator.QuakeMLDirectoryIterator.beginning

   .. py:method:: all()
      :canonical: pickax.quake_iterator.QuakeMLDirectoryIterator.all

      .. autodoc2-docstring:: pickax.quake_iterator.QuakeMLDirectoryIterator.all

   .. py:method:: quakedir(quake)
      :canonical: pickax.quake_iterator.QuakeMLDirectoryIterator.quakedir

      .. autodoc2-docstring:: pickax.quake_iterator.QuakeMLDirectoryIterator.quakedir

.. py:class:: FDSNQuakeIterator(query_params, days_step=30, dc_name='USGS', debug=False)
   :canonical: pickax.quake_iterator.FDSNQuakeIterator

   Bases: :py:obj:`pickax.quake_iterator.QuakeIterator`

   .. py:property:: client
      :canonical: pickax.quake_iterator.FDSNQuakeIterator.client

      .. autodoc2-docstring:: pickax.quake_iterator.FDSNQuakeIterator.client

   .. py:method:: next_batch()
      :canonical: pickax.quake_iterator.FDSNQuakeIterator.next_batch

      .. autodoc2-docstring:: pickax.quake_iterator.FDSNQuakeIterator.next_batch

   .. py:method:: next_batch_step()
      :canonical: pickax.quake_iterator.FDSNQuakeIterator.next_batch_step

      .. autodoc2-docstring:: pickax.quake_iterator.FDSNQuakeIterator.next_batch_step

   .. py:method:: next()
      :canonical: pickax.quake_iterator.FDSNQuakeIterator.next

      .. autodoc2-docstring:: pickax.quake_iterator.FDSNQuakeIterator.next

   .. py:method:: prev()
      :canonical: pickax.quake_iterator.FDSNQuakeIterator.prev

      .. autodoc2-docstring:: pickax.quake_iterator.FDSNQuakeIterator.prev

   .. py:method:: beginning()
      :canonical: pickax.quake_iterator.FDSNQuakeIterator.beginning

      .. autodoc2-docstring:: pickax.quake_iterator.FDSNQuakeIterator.beginning

   .. py:method:: all()
      :canonical: pickax.quake_iterator.FDSNQuakeIterator.all

      .. autodoc2-docstring:: pickax.quake_iterator.FDSNQuakeIterator.all

.. py:class:: CachedPicksQuakeItr(quake_itr, cachedir='by_eventid')
   :canonical: pickax.quake_iterator.CachedPicksQuakeItr

   Bases: :py:obj:`pickax.quake_iterator.QuakeIterator`

   .. py:method:: next()
      :canonical: pickax.quake_iterator.CachedPicksQuakeItr.next

      .. autodoc2-docstring:: pickax.quake_iterator.CachedPicksQuakeItr.next

   .. py:method:: prev()
      :canonical: pickax.quake_iterator.CachedPicksQuakeItr.prev

      .. autodoc2-docstring:: pickax.quake_iterator.CachedPicksQuakeItr.prev

   .. py:method:: beginning()
      :canonical: pickax.quake_iterator.CachedPicksQuakeItr.beginning

      .. autodoc2-docstring:: pickax.quake_iterator.CachedPicksQuakeItr.beginning

   .. py:method:: reload_picks(quake)
      :canonical: pickax.quake_iterator.CachedPicksQuakeItr.reload_picks

      .. autodoc2-docstring:: pickax.quake_iterator.CachedPicksQuakeItr.reload_picks

   .. py:method:: all()
      :canonical: pickax.quake_iterator.CachedPicksQuakeItr.all

      .. autodoc2-docstring:: pickax.quake_iterator.CachedPicksQuakeItr.all