mt_metadata.transfer_functions.io.tools
=======================================

.. py:module:: mt_metadata.transfer_functions.io.tools

.. autoapi-nested-parse::

   Created on Sat Dec  4 17:44:51 2021

   @author: jpeacock



Classes
-------

.. autoapisummary::

   mt_metadata.transfer_functions.io.tools.index_locator


Functions
---------

.. autoapisummary::

   mt_metadata.transfer_functions.io.tools.get_nm_elev


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

.. py:class:: index_locator(component_list)

   Bases: :py:obj:`object`


   .. py:attribute:: ex
      :value: None



   .. py:attribute:: ey
      :value: None



   .. py:attribute:: hx
      :value: None



   .. py:attribute:: hy
      :value: None



   .. py:attribute:: hz
      :value: None



   .. py:attribute:: rhx
      :value: None



   .. py:attribute:: rhy
      :value: None



   .. py:attribute:: rhz
      :value: None



   .. py:property:: n_channels


   .. py:property:: has_tipper


   .. py:property:: has_electric


   .. py:property:: input_channels


   .. py:property:: output_channels


   .. py:property:: n_inputs


   .. py:property:: n_outputs


.. py:function:: get_nm_elev(latitude, longitude)

   Get national map elevation for a given lat and lon.

   Queries the national map website for the elevation value.

   :param lat: latitude in decimal degrees
   :type lat: float

   :param lon: longitude in decimal degrees
   :type lon: float

   :return: elevation (meters)
   :rtype: float

   :Example: ::

       >>> import mtpy.usgs.usgs_archive as archive
       >>> archive.get_nm_elev(35.467, -115.3355)
       >>> 809.12

   .. note:: Needs an internet connection to work.