shareloc.geomodels.geomodel_template
====================================

.. py:module:: shareloc.geomodels.geomodel_template

.. autoapi-nested-parse::

   This module contains the GeoModel abstract class



Classes
-------

.. autoapisummary::

   shareloc.geomodels.geomodel_template.GeoModelTemplate


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

.. py:class:: GeoModelTemplate

   Class for general specification of a geometric model
   declined in rpc.py and grid.py and rpc_optim.py


   .. py:attribute:: type
      :type:  str


   .. py:attribute:: epsg
      :type:  int
      :value: None



   .. py:method:: direct_loc_h(row, col, alt, fill_nan=False)
      :abstractmethod:


      direct localization at constant altitude

      :param row:  line sensor position
      :type row: float or 1D numpy.ndarray dtype=float64
      :param col:  column sensor position
      :type col: float or 1D numpy.ndarray dtype=float64
      :param alt:  altitude
      :param fill_nan: fill numpy.nan values with lon and lat offset if true (same as OTB/OSSIM), nan is returned
          otherwise
      :type fill_nan: boolean
      :return: ground position (lon,lat,h)
      :rtype: numpy.ndarray 2D dimension with (N,3) shape, where N is number of input coordinates



   .. py:method:: direct_loc_dtm(row, col, dtm)
      :abstractmethod:


      direct localization on dtm

      :param row:  line sensor position
      :type row: float
      :param col:  column sensor position
      :type col: float
      :param dtm: dtm intersection model
      :type dtm: shareloc.geofunctions.dtm_intersection
      :return: ground position (lon,lat,h) in dtm coordinates system
      :rtype: numpy.ndarray 2D dimension with (N,3) shape, where N is number of input coordinates



   .. py:method:: inverse_loc(lon, lat, alt)
      :abstractmethod:


      Inverse localization

      :param lon: longitude position
      :type lon: float or 1D numpy.ndarray dtype=float64
      :param lat: latitude position
      :type lat: float or 1D numpy.ndarray dtype=float64
      :param alt: altitude
      :type alt: float
      :return: sensor position (row, col, alt)
      :rtype: tuple(1D np.array row position, 1D np.array col position, 1D np.array alt)



   .. py:method:: load(geomodel_path)
      :classmethod:

      :abstractmethod:


      load function with class specific args

      :param geomodel_path: filename of geomodel



   .. py:method:: check_lonlat(lonlath)

      returns filtered latlonh. abs(longitude) should be <= 180, abs(latitude) should be <=90,
      and no NaN in coordinates.

      :param latlonh: np.array of latlonh
      :return: filtered array