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

.. py:module:: mnp.species_models.species_evaluation

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

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

Classes
~~~~~~~

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

   * - :py:obj:`SpeciesEvaluationParameters <mnp.species_models.species_evaluation.SpeciesEvaluationParameters>`
     - .. autodoc2-docstring:: mnp.species_models.species_evaluation.SpeciesEvaluationParameters
          :summary:
   * - :py:obj:`SpeciesEvaluation <mnp.species_models.species_evaluation.SpeciesEvaluation>`
     - .. autodoc2-docstring:: mnp.species_models.species_evaluation.SpeciesEvaluation
          :summary:

Data
~~~~

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

   * - :py:obj:`ID_COLNAME <mnp.species_models.species_evaluation.ID_COLNAME>`
     - .. autodoc2-docstring:: mnp.species_models.species_evaluation.ID_COLNAME
          :summary:
   * - :py:obj:`AREA_M_COLNAME <mnp.species_models.species_evaluation.AREA_M_COLNAME>`
     - .. autodoc2-docstring:: mnp.species_models.species_evaluation.AREA_M_COLNAME
          :summary:
   * - :py:obj:`EFF_AREA_M_COLNAME <mnp.species_models.species_evaluation.EFF_AREA_M_COLNAME>`
     - .. autodoc2-docstring:: mnp.species_models.species_evaluation.EFF_AREA_M_COLNAME
          :summary:
   * - :py:obj:`EFF_AREA_KP_COLNAME <mnp.species_models.species_evaluation.EFF_AREA_KP_COLNAME>`
     - .. autodoc2-docstring:: mnp.species_models.species_evaluation.EFF_AREA_KP_COLNAME
          :summary:
   * - :py:obj:`IS_KP_COLNAME <mnp.species_models.species_evaluation.IS_KP_COLNAME>`
     - .. autodoc2-docstring:: mnp.species_models.species_evaluation.IS_KP_COLNAME
          :summary:
   * - :py:obj:`EFF_AREA_KP_NORM_COLNAME <mnp.species_models.species_evaluation.EFF_AREA_KP_NORM_COLNAME>`
     - .. autodoc2-docstring:: mnp.species_models.species_evaluation.EFF_AREA_KP_NORM_COLNAME
          :summary:

API
~~~

.. py:data:: ID_COLNAME
   :canonical: mnp.species_models.species_evaluation.ID_COLNAME
   :value: 'id'

   .. autodoc2-docstring:: mnp.species_models.species_evaluation.ID_COLNAME

.. py:data:: AREA_M_COLNAME
   :canonical: mnp.species_models.species_evaluation.AREA_M_COLNAME
   :value: 'area_m'

   .. autodoc2-docstring:: mnp.species_models.species_evaluation.AREA_M_COLNAME

.. py:data:: EFF_AREA_M_COLNAME
   :canonical: mnp.species_models.species_evaluation.EFF_AREA_M_COLNAME
   :value: 'effective_area_m'

   .. autodoc2-docstring:: mnp.species_models.species_evaluation.EFF_AREA_M_COLNAME

.. py:data:: EFF_AREA_KP_COLNAME
   :canonical: mnp.species_models.species_evaluation.EFF_AREA_KP_COLNAME
   :value: 'effective_area_kp'

   .. autodoc2-docstring:: mnp.species_models.species_evaluation.EFF_AREA_KP_COLNAME

.. py:data:: IS_KP_COLNAME
   :canonical: mnp.species_models.species_evaluation.IS_KP_COLNAME
   :value: 'is_key_population'

   .. autodoc2-docstring:: mnp.species_models.species_evaluation.IS_KP_COLNAME

.. py:data:: EFF_AREA_KP_NORM_COLNAME
   :canonical: mnp.species_models.species_evaluation.EFF_AREA_KP_NORM_COLNAME
   :value: 'effective_area_kp_norm'

   .. autodoc2-docstring:: mnp.species_models.species_evaluation.EFF_AREA_KP_NORM_COLNAME

.. py:class:: SpeciesEvaluationParameters
   :canonical: mnp.species_models.species_evaluation.SpeciesEvaluationParameters

   .. autodoc2-docstring:: mnp.species_models.species_evaluation.SpeciesEvaluationParameters

   .. py:attribute:: key_population_area
      :canonical: mnp.species_models.species_evaluation.SpeciesEvaluationParameters.key_population_area
      :type: float
      :value: 1

      .. autodoc2-docstring:: mnp.species_models.species_evaluation.SpeciesEvaluationParameters.key_population_area

   .. py:attribute:: possibly_viable_threshold
      :canonical: mnp.species_models.species_evaluation.SpeciesEvaluationParameters.possibly_viable_threshold
      :type: float
      :value: 1

      .. autodoc2-docstring:: mnp.species_models.species_evaluation.SpeciesEvaluationParameters.possibly_viable_threshold

   .. py:attribute:: viable_threshold
      :canonical: mnp.species_models.species_evaluation.SpeciesEvaluationParameters.viable_threshold
      :type: float
      :value: 1

      .. autodoc2-docstring:: mnp.species_models.species_evaluation.SpeciesEvaluationParameters.viable_threshold

   .. py:attribute:: small_pop_threshold_area
      :canonical: mnp.species_models.species_evaluation.SpeciesEvaluationParameters.small_pop_threshold_area
      :type: float
      :value: 500

      .. autodoc2-docstring:: mnp.species_models.species_evaluation.SpeciesEvaluationParameters.small_pop_threshold_area

   .. py:attribute:: small_pop_slope
      :canonical: mnp.species_models.species_evaluation.SpeciesEvaluationParameters.small_pop_slope
      :type: float
      :value: 2

      .. autodoc2-docstring:: mnp.species_models.species_evaluation.SpeciesEvaluationParameters.small_pop_slope

   .. py:attribute:: pxl_area
      :canonical: mnp.species_models.species_evaluation.SpeciesEvaluationParameters.pxl_area
      :type: float
      :value: 0

      .. autodoc2-docstring:: mnp.species_models.species_evaluation.SpeciesEvaluationParameters.pxl_area

.. py:class:: SpeciesEvaluation(mnp_parameters: MNPParameters or None, species_code: str, hsi: mnp.species_models.habitat_suitability.HSI, clustering: mnp.species_models.clustering.ClusteringProcedure)
   :canonical: mnp.species_models.species_evaluation.SpeciesEvaluation

   .. autodoc2-docstring:: mnp.species_models.species_evaluation.SpeciesEvaluation

   .. rubric:: Initialization

   .. autodoc2-docstring:: mnp.species_models.species_evaluation.SpeciesEvaluation.__init__

   .. py:method:: population_array(array_type: str, only_keypopulations=False) -> scipy.sparse.sparray | int
      :canonical: mnp.species_models.species_evaluation.SpeciesEvaluation.population_array

      .. autodoc2-docstring:: mnp.species_models.species_evaluation.SpeciesEvaluation.population_array

   .. py:method:: trait_info() -> dict[str, float]
      :canonical: mnp.species_models.species_evaluation.SpeciesEvaluation.trait_info

      .. autodoc2-docstring:: mnp.species_models.species_evaluation.SpeciesEvaluation.trait_info

   .. py:method:: evaluate_metapopulations() -> None
      :canonical: mnp.species_models.species_evaluation.SpeciesEvaluation.evaluate_metapopulations

      .. autodoc2-docstring:: mnp.species_models.species_evaluation.SpeciesEvaluation.evaluate_metapopulations

   .. py:method:: calculate()
      :canonical: mnp.species_models.species_evaluation.SpeciesEvaluation.calculate

      .. autodoc2-docstring:: mnp.species_models.species_evaluation.SpeciesEvaluation.calculate

   .. py:method:: update_viability_class()
      :canonical: mnp.species_models.species_evaluation.SpeciesEvaluation.update_viability_class

      .. autodoc2-docstring:: mnp.species_models.species_evaluation.SpeciesEvaluation.update_viability_class

   .. py:method:: update_results_dictionary()
      :canonical: mnp.species_models.species_evaluation.SpeciesEvaluation.update_results_dictionary

      .. autodoc2-docstring:: mnp.species_models.species_evaluation.SpeciesEvaluation.update_results_dictionary

   .. py:method:: results() -> dict
      :canonical: mnp.species_models.species_evaluation.SpeciesEvaluation.results

      .. autodoc2-docstring:: mnp.species_models.species_evaluation.SpeciesEvaluation.results

   .. py:method:: summary_table_to_file(output_path)
      :canonical: mnp.species_models.species_evaluation.SpeciesEvaluation.summary_table_to_file

      .. autodoc2-docstring:: mnp.species_models.species_evaluation.SpeciesEvaluation.summary_table_to_file