:py:mod:`mnp.species_models.habitat_suitability`
================================================

.. py:module:: mnp.species_models.habitat_suitability

.. autodoc2-docstring:: mnp.species_models.habitat_suitability
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`HSIProcedure <mnp.species_models.habitat_suitability.HSIProcedure>`
     - .. autodoc2-docstring:: mnp.species_models.habitat_suitability.HSIProcedure
          :summary:
   * - :py:obj:`Nature <mnp.species_models.habitat_suitability.Nature>`
     -
   * - :py:obj:`PreCalculated <mnp.species_models.habitat_suitability.PreCalculated>`
     - .. autodoc2-docstring:: mnp.species_models.habitat_suitability.PreCalculated
          :summary:
   * - :py:obj:`HSI <mnp.species_models.habitat_suitability.HSI>`
     - .. autodoc2-docstring:: mnp.species_models.habitat_suitability.HSI
          :summary:

API
~~~

.. py:class:: HSIProcedure(hsi_threshold: float, suitabilities: dict)
   :canonical: mnp.species_models.habitat_suitability.HSIProcedure

   Bases: :py:obj:`abc.ABC`

   .. autodoc2-docstring:: mnp.species_models.habitat_suitability.HSIProcedure

   .. rubric:: Initialization

   .. autodoc2-docstring:: mnp.species_models.habitat_suitability.HSIProcedure.__init__

   .. py:method:: run(land_types: dict, abiotic_factor_array: sparse.csr_array or None)
      :canonical: mnp.species_models.habitat_suitability.HSIProcedure.run
      :abstractmethod:

      .. autodoc2-docstring:: mnp.species_models.habitat_suitability.HSIProcedure.run

.. py:class:: Nature(hsi_threshold: float, suitabilities: dict)
   :canonical: mnp.species_models.habitat_suitability.Nature

   Bases: :py:obj:`mnp.species_models.habitat_suitability.HSIProcedure`

   .. py:method:: run(land_types: dict, environmental_factor_array: sparse.csr_array or None)
      :canonical: mnp.species_models.habitat_suitability.Nature.run

      .. autodoc2-docstring:: mnp.species_models.habitat_suitability.Nature.run

.. py:class:: PreCalculated(hsi_threshold: float, suitabilities: dict)
   :canonical: mnp.species_models.habitat_suitability.PreCalculated

   Bases: :py:obj:`mnp.species_models.habitat_suitability.HSIProcedure`

   .. autodoc2-docstring:: mnp.species_models.habitat_suitability.PreCalculated

   .. rubric:: Initialization

   .. autodoc2-docstring:: mnp.species_models.habitat_suitability.PreCalculated.__init__

   .. py:method:: run(land_types: dict, environmental_factor_array: sparse.csr_array or None)
      :canonical: mnp.species_models.habitat_suitability.PreCalculated.run

.. py:class:: HSI(parameters: mnp.config.MNPParameters, species_code: str)
   :canonical: mnp.species_models.habitat_suitability.HSI

   Bases: :py:obj:`mnp.species_models.species_geo_map.SpeciesGeoMap`

   .. autodoc2-docstring:: mnp.species_models.habitat_suitability.HSI

   .. rubric:: Initialization

   .. autodoc2-docstring:: mnp.species_models.habitat_suitability.HSI.__init__

   .. py:method:: calculate(land_types: dict, environmentals: dict or None = None) -> sparse.sparray or int
      :canonical: mnp.species_models.habitat_suitability.HSI.calculate

      .. autodoc2-docstring:: mnp.species_models.habitat_suitability.HSI.calculate

   .. py:method:: save_environmental_factor_raster()
      :canonical: mnp.species_models.habitat_suitability.HSI.save_environmental_factor_raster

      .. autodoc2-docstring:: mnp.species_models.habitat_suitability.HSI.save_environmental_factor_raster