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

.. py:module:: pickax.pickax

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

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

Classes
~~~~~~~

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

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

API
~~~

.. py:class:: PickAx(stream=None, qmlevent=None, inventory=None, config=None)
   :canonical: pickax.pickax.PickAx

   .. autodoc2-docstring:: pickax.pickax.PickAx

   .. rubric:: Initialization

   .. autodoc2-docstring:: pickax.pickax.PickAx.__init__

   .. py:method:: _init_data_(stream, qmlevent=None, inventory=None)
      :canonical: pickax.pickax.PickAx._init_data_

      .. autodoc2-docstring:: pickax.pickax.PickAx._init_data_

   .. py:method:: update_data(stream, qmlevent=None, inventory=None)
      :canonical: pickax.pickax.PickAx.update_data

      .. autodoc2-docstring:: pickax.pickax.PickAx.update_data

   .. py:method:: do_finish(command)
      :canonical: pickax.pickax.PickAx.do_finish

      .. autodoc2-docstring:: pickax.pickax.PickAx.do_finish

   .. py:method:: clear()
      :canonical: pickax.pickax.PickAx.clear

      .. autodoc2-docstring:: pickax.pickax.PickAx.clear

   .. py:method:: draw()
      :canonical: pickax.pickax.PickAx.draw

      .. autodoc2-docstring:: pickax.pickax.PickAx.draw

   .. py:method:: calc_global_amp()
      :canonical: pickax.pickax.PickAx.calc_global_amp

      .. autodoc2-docstring:: pickax.pickax.PickAx.calc_global_amp

   .. py:method:: close()
      :canonical: pickax.pickax.PickAx.close

      .. autodoc2-docstring:: pickax.pickax.PickAx.close

   .. py:method:: on_key(event)
      :canonical: pickax.pickax.PickAx.on_key

      .. autodoc2-docstring:: pickax.pickax.PickAx.on_key

   .. py:method:: get_picks(include_station=False, author=None)
      :canonical: pickax.pickax.PickAx.get_picks

      .. autodoc2-docstring:: pickax.pickax.PickAx.get_picks

   .. py:method:: create_pick_flag(pick, seismograph, is_modifiable, arrival=None)
      :canonical: pickax.pickax.PickAx.create_pick_flag

      .. autodoc2-docstring:: pickax.pickax.PickAx.create_pick_flag

   .. py:method:: do_pick(event, phase='pick')
      :canonical: pickax.pickax.PickAx.do_pick

      .. autodoc2-docstring:: pickax.pickax.PickAx.do_pick

   .. py:method:: seismograph_for_axes(ax)
      :canonical: pickax.pickax.PickAx.seismograph_for_axes

      .. autodoc2-docstring:: pickax.pickax.PickAx.seismograph_for_axes

   .. py:method:: list_channels()
      :canonical: pickax.pickax.PickAx.list_channels

      .. autodoc2-docstring:: pickax.pickax.PickAx.list_channels

   .. py:method:: display_picks(include_station=False, author=None)
      :canonical: pickax.pickax.PickAx.display_picks

      .. autodoc2-docstring:: pickax.pickax.PickAx.display_picks

   .. py:method:: calc_start()
      :canonical: pickax.pickax.PickAx.calc_start

      .. autodoc2-docstring:: pickax.pickax.PickAx.calc_start