shareloc.geomodels.geomodel
===========================

.. py:module:: shareloc.geomodels.geomodel

.. autoapi-nested-parse::

   This module contains the GeoModel class factory.
   This main API GeoModel class generates an object linked
   with geomodel configuration "geomodel_name"
   (from registered GeoModelTemplate class)

   ** Experimental and not used as API for now**
   ** Will be used with an automatic switcher between Grid file format and
   RPC file format obj = GeoModel("file_geom") only without geomodel_type



Classes
-------

.. autoapisummary::

   shareloc.geomodels.geomodel.GeoModel


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

.. py:class:: GeoModel

   GeoModel factory:
   A class designed for registered all available geomodels
   and instantiate them when needed.


   .. py:attribute:: available_geomodels
      :type:  Dict[str, Any]


   .. py:method:: create_geomodel(geomodel_path, geomodel_type = 'RPC')
      :classmethod:


      Factory command to create the geomodel from geomodel_type
      Return a GeoModelTemplate child instance
      associated with the "geomodel_type"

      :param geomodel_path: Path of geomodel file
      :type geomodel_path: string
      :param geomodel_type: Type of the geomodel, default "RPC", used as key for specific geomodel subclass instance
      :type geomodel_type: string



   .. py:method:: print_avalaible_geomodels()
      :classmethod:


      Print all registered applications



   .. py:method:: register(geomodel_type)
      :classmethod:


      Allows to register the GeoModelTemplate subclass in the factory
      with its geomodel geomodel_type through decorator

      :param geomodel_type: the subclass name to be registered
      :type geomodel_type: string