:py:mod:`pickax.station_iterator`
=================================

.. py:module:: pickax.station_iterator

.. autodoc2-docstring:: pickax.station_iterator
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`StationIterator <pickax.station_iterator.StationIterator>`
     -
   * - :py:obj:`StationXMLIterator <pickax.station_iterator.StationXMLIterator>`
     -
   * - :py:obj:`StationXMLFileIterator <pickax.station_iterator.StationXMLFileIterator>`
     -
   * - :py:obj:`FDSNStationIterator <pickax.station_iterator.FDSNStationIterator>`
     -
   * - :py:obj:`StationXMLDirectoryIterator <pickax.station_iterator.StationXMLDirectoryIterator>`
     -

Functions
~~~~~~~~~

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

   * - :py:obj:`channel_from_sac <pickax.station_iterator.channel_from_sac>`
     - .. autodoc2-docstring:: pickax.station_iterator.channel_from_sac
          :summary:

API
~~~

.. py:class:: StationIterator()
   :canonical: pickax.station_iterator.StationIterator

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

   .. py:method:: next()
      :canonical: pickax.station_iterator.StationIterator.next
      :abstractmethod:

      .. autodoc2-docstring:: pickax.station_iterator.StationIterator.next

   .. py:method:: prev()
      :canonical: pickax.station_iterator.StationIterator.prev
      :abstractmethod:

      .. autodoc2-docstring:: pickax.station_iterator.StationIterator.prev

   .. py:method:: beginning()
      :canonical: pickax.station_iterator.StationIterator.beginning

      .. autodoc2-docstring:: pickax.station_iterator.StationIterator.beginning

   .. py:method:: ending()
      :canonical: pickax.station_iterator.StationIterator.ending

      .. autodoc2-docstring:: pickax.station_iterator.StationIterator.ending

   .. py:method:: all_stations()
      :canonical: pickax.station_iterator.StationIterator.all_stations

      .. autodoc2-docstring:: pickax.station_iterator.StationIterator.all_stations

.. py:class:: StationXMLIterator(inv, debug=False)
   :canonical: pickax.station_iterator.StationXMLIterator

   Bases: :py:obj:`pickax.station_iterator.StationIterator`

   .. py:method:: current()
      :canonical: pickax.station_iterator.StationXMLIterator.current

      .. autodoc2-docstring:: pickax.station_iterator.StationXMLIterator.current

   .. py:method:: next()
      :canonical: pickax.station_iterator.StationXMLIterator.next

      .. autodoc2-docstring:: pickax.station_iterator.StationXMLIterator.next

   .. py:method:: prev()
      :canonical: pickax.station_iterator.StationXMLIterator.prev

      .. autodoc2-docstring:: pickax.station_iterator.StationXMLIterator.prev

   .. py:method:: beginning()
      :canonical: pickax.station_iterator.StationXMLIterator.beginning

      .. autodoc2-docstring:: pickax.station_iterator.StationXMLIterator.beginning

   .. py:method:: ending()
      :canonical: pickax.station_iterator.StationXMLIterator.ending

      .. autodoc2-docstring:: pickax.station_iterator.StationXMLIterator.ending

   .. py:method:: __len__()
      :canonical: pickax.station_iterator.StationXMLIterator.__len__

      .. autodoc2-docstring:: pickax.station_iterator.StationXMLIterator.__len__

   .. py:method:: all_stations()
      :canonical: pickax.station_iterator.StationXMLIterator.all_stations

      .. autodoc2-docstring:: pickax.station_iterator.StationXMLIterator.all_stations

.. py:class:: StationXMLFileIterator(filename)
   :canonical: pickax.station_iterator.StationXMLFileIterator

   Bases: :py:obj:`pickax.station_iterator.StationXMLIterator`

.. py:class:: FDSNStationIterator(query_params, dc_name='IRIS', debug=False)
   :canonical: pickax.station_iterator.FDSNStationIterator

   Bases: :py:obj:`pickax.station_iterator.StationXMLIterator`

   .. py:method:: __load__()
      :canonical: pickax.station_iterator.FDSNStationIterator.__load__

      .. autodoc2-docstring:: pickax.station_iterator.FDSNStationIterator.__load__

.. py:class:: StationXMLDirectoryIterator(dir, pattern='**/*.xml')
   :canonical: pickax.station_iterator.StationXMLDirectoryIterator

   Bases: :py:obj:`pickax.station_iterator.StationXMLIterator`

   .. py:method:: next()
      :canonical: pickax.station_iterator.StationXMLDirectoryIterator.next

      .. autodoc2-docstring:: pickax.station_iterator.StationXMLDirectoryIterator.next

   .. py:method:: prev()
      :canonical: pickax.station_iterator.StationXMLDirectoryIterator.prev

      .. autodoc2-docstring:: pickax.station_iterator.StationXMLDirectoryIterator.prev

   .. py:method:: beginning()
      :canonical: pickax.station_iterator.StationXMLDirectoryIterator.beginning

      .. autodoc2-docstring:: pickax.station_iterator.StationXMLDirectoryIterator.beginning

   .. py:method:: ending()
      :canonical: pickax.station_iterator.StationXMLDirectoryIterator.ending

      .. autodoc2-docstring:: pickax.station_iterator.StationXMLDirectoryIterator.ending

.. py:function:: channel_from_sac(tr)
   :canonical: pickax.station_iterator.channel_from_sac

   .. autodoc2-docstring:: pickax.station_iterator.channel_from_sac