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

.. py:module:: pickax.pick_util

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

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

Functions
~~~~~~~~~

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

   * - :py:obj:`create_pick_on_stream <pickax.pick_util.create_pick_on_stream>`
     - .. autodoc2-docstring:: pickax.pick_util.create_pick_on_stream
          :summary:
   * - :py:obj:`pick_to_multiline <pickax.pick_util.pick_to_multiline>`
     - .. autodoc2-docstring:: pickax.pick_util.pick_to_multiline
          :summary:
   * - :py:obj:`pick_to_string <pickax.pick_util.pick_to_string>`
     - .. autodoc2-docstring:: pickax.pick_util.pick_to_string
          :summary:
   * - :py:obj:`arrival_for_pick <pickax.pick_util.arrival_for_pick>`
     - .. autodoc2-docstring:: pickax.pick_util.arrival_for_pick
          :summary:
   * - :py:obj:`amplitude_for_pick <pickax.pick_util.amplitude_for_pick>`
     - .. autodoc2-docstring:: pickax.pick_util.amplitude_for_pick
          :summary:
   * - :py:obj:`remove_pick <pickax.pick_util.remove_pick>`
     - .. autodoc2-docstring:: pickax.pick_util.remove_pick
          :summary:
   * - :py:obj:`pick_from_trace <pickax.pick_util.pick_from_trace>`
     - .. autodoc2-docstring:: pickax.pick_util.pick_from_trace
          :summary:
   * - :py:obj:`same_author <pickax.pick_util.same_author>`
     - .. autodoc2-docstring:: pickax.pick_util.same_author
          :summary:
   * - :py:obj:`merge_picks_to_quake <pickax.pick_util.merge_picks_to_quake>`
     - .. autodoc2-docstring:: pickax.pick_util.merge_picks_to_quake
          :summary:
   * - :py:obj:`merge_picks_to_catalog <pickax.pick_util.merge_picks_to_catalog>`
     - .. autodoc2-docstring:: pickax.pick_util.merge_picks_to_catalog
          :summary:
   * - :py:obj:`UNKNOWN_PUBLIC_ID <pickax.pick_util.UNKNOWN_PUBLIC_ID>`
     - .. autodoc2-docstring:: pickax.pick_util.UNKNOWN_PUBLIC_ID
          :summary:
   * - :py:obj:`extractEventId <pickax.pick_util.extractEventId>`
     - .. autodoc2-docstring:: pickax.pick_util.extractEventId
          :summary:
   * - :py:obj:`reloadQuakeMLWithPicks <pickax.pick_util.reloadQuakeMLWithPicks>`
     - .. autodoc2-docstring:: pickax.pick_util.reloadQuakeMLWithPicks
          :summary:
   * - :py:obj:`reloadQuakeMLWithPicksComcat <pickax.pick_util.reloadQuakeMLWithPicksComcat>`
     - .. autodoc2-docstring:: pickax.pick_util.reloadQuakeMLWithPicksComcat
          :summary:
   * - :py:obj:`inventory_for_catalog_picks <pickax.pick_util.inventory_for_catalog_picks>`
     - .. autodoc2-docstring:: pickax.pick_util.inventory_for_catalog_picks
          :summary:
   * - :py:obj:`station_for_pick <pickax.pick_util.station_for_pick>`
     - .. autodoc2-docstring:: pickax.pick_util.station_for_pick
          :summary:
   * - :py:obj:`picks_by_author <pickax.pick_util.picks_by_author>`
     - .. autodoc2-docstring:: pickax.pick_util.picks_by_author
          :summary:
   * - :py:obj:`best_pick_at_station <pickax.pick_util.best_pick_at_station>`
     - .. autodoc2-docstring:: pickax.pick_util.best_pick_at_station
          :summary:
   * - :py:obj:`best_instrument_pick <pickax.pick_util.best_instrument_pick>`
     - .. autodoc2-docstring:: pickax.pick_util.best_instrument_pick
          :summary:

Data
~~~~

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

   * - :py:obj:`zap_space <pickax.pick_util.zap_space>`
     - .. autodoc2-docstring:: pickax.pick_util.zap_space
          :summary:
   * - :py:obj:`DEF_INST_LIST <pickax.pick_util.DEF_INST_LIST>`
     - .. autodoc2-docstring:: pickax.pick_util.DEF_INST_LIST
          :summary:

API
~~~

.. py:data:: zap_space
   :canonical: pickax.pick_util.zap_space
   :value: 'compile(...)'

   .. autodoc2-docstring:: pickax.pick_util.zap_space

.. py:function:: create_pick_on_stream(stream, time, phase='pick', creation_info=None, resource_prefix='pickax', filter_name=None)
   :canonical: pickax.pick_util.create_pick_on_stream

   .. autodoc2-docstring:: pickax.pick_util.create_pick_on_stream

.. py:function:: pick_to_multiline(p, qmlevent=None, start=None)
   :canonical: pickax.pick_util.pick_to_multiline

   .. autodoc2-docstring:: pickax.pick_util.pick_to_multiline

.. py:function:: pick_to_string(p, qmlevent=None, start=None)
   :canonical: pickax.pick_util.pick_to_string

   .. autodoc2-docstring:: pickax.pick_util.pick_to_string

.. py:function:: arrival_for_pick(pick, qmlevent)
   :canonical: pickax.pick_util.arrival_for_pick

   .. autodoc2-docstring:: pickax.pick_util.arrival_for_pick

.. py:function:: amplitude_for_pick(pick, qmlevent)
   :canonical: pickax.pick_util.amplitude_for_pick

   .. autodoc2-docstring:: pickax.pick_util.amplitude_for_pick

.. py:function:: remove_pick(pick, qmlevent)
   :canonical: pickax.pick_util.remove_pick

   .. autodoc2-docstring:: pickax.pick_util.remove_pick

.. py:function:: pick_from_trace(pick, trace)
   :canonical: pickax.pick_util.pick_from_trace

   .. autodoc2-docstring:: pickax.pick_util.pick_from_trace

.. py:function:: same_author(creation_info_a, creation_info_b)
   :canonical: pickax.pick_util.same_author

   .. autodoc2-docstring:: pickax.pick_util.same_author

.. py:function:: merge_picks_to_quake(qmlevent, out_qmlevent, author=None)
   :canonical: pickax.pick_util.merge_picks_to_quake

   .. autodoc2-docstring:: pickax.pick_util.merge_picks_to_quake

.. py:function:: merge_picks_to_catalog(qmlevent, catalog, author=None)
   :canonical: pickax.pick_util.merge_picks_to_catalog

   .. autodoc2-docstring:: pickax.pick_util.merge_picks_to_catalog

.. py:function:: UNKNOWN_PUBLIC_ID()
   :canonical: pickax.pick_util.UNKNOWN_PUBLIC_ID

   .. autodoc2-docstring:: pickax.pick_util.UNKNOWN_PUBLIC_ID

.. py:function:: extractEventId(qmlEvent, host='')
   :canonical: pickax.pick_util.extractEventId

   .. autodoc2-docstring:: pickax.pick_util.extractEventId

.. py:function:: reloadQuakeMLWithPicks(qmlevent, client=None, host='USGS', debug=False)
   :canonical: pickax.pick_util.reloadQuakeMLWithPicks

   .. autodoc2-docstring:: pickax.pick_util.reloadQuakeMLWithPicks

.. py:function:: reloadQuakeMLWithPicksComcat(qmlevent)
   :canonical: pickax.pick_util.reloadQuakeMLWithPicksComcat

   .. autodoc2-docstring:: pickax.pick_util.reloadQuakeMLWithPicksComcat

.. py:function:: inventory_for_catalog_picks(catalog, window=600, client=None, host='IRIS', debug=False)
   :canonical: pickax.pick_util.inventory_for_catalog_picks

   .. autodoc2-docstring:: pickax.pick_util.inventory_for_catalog_picks

.. py:function:: station_for_pick(pick, inventory)
   :canonical: pickax.pick_util.station_for_pick

   .. autodoc2-docstring:: pickax.pick_util.station_for_pick

.. py:data:: DEF_INST_LIST
   :canonical: pickax.pick_util.DEF_INST_LIST
   :value: ['H', 'N']

   .. autodoc2-docstring:: pickax.pick_util.DEF_INST_LIST

.. py:function:: picks_by_author(pick_list, author)
   :canonical: pickax.pick_util.picks_by_author

   .. autodoc2-docstring:: pickax.pick_util.picks_by_author

.. py:function:: best_pick_at_station(pick_list, p_s, station_id, quake, author_list=[], inst_list=DEF_INST_LIST, check_unique=False)
   :canonical: pickax.pick_util.best_pick_at_station

   .. autodoc2-docstring:: pickax.pick_util.best_pick_at_station

.. py:function:: best_instrument_pick(pick_list, station_id, inst_list=DEF_INST_LIST, check_unique=False)
   :canonical: pickax.pick_util.best_instrument_pick

   .. autodoc2-docstring:: pickax.pick_util.best_instrument_pick