wolfhece.multicriteria.salmon
=============================

.. py:module:: wolfhece.multicriteria.salmon

.. autoapi-nested-parse::

   This module contains the objects needed to perform
   a multi-criteria analysis for the seaward migration
   of Atlantic salmons on spatially distributed hydrodynamic data.

   The module tests are located in the folder:
   tests/multicriteria/test_analysis.py in the HECEPython repository.

   Authors: Utashi Ciraane,
   HECE, University of Liège, Belgium.







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

.. py:data:: VELOCITY
   :value: 'velocity'


.. py:data:: DEPTH
   :value: 'depth'


.. py:data:: TKE
   :value: 'tke'


.. py:data:: SVG_X
   :value: 'svg_x'


.. py:data:: SVG_Y
   :value: 'svg_y'


.. py:data:: SVG_NORM
   :value: 'svg_norm'


.. py:class:: Smolt(velocity: wolfhece.wolf_array.WolfArray, depth: wolfhece.wolf_array.WolfArray, tke: wolfhece.wolf_array.WolfArray, svg_x: wolfhece.wolf_array.WolfArray = None, svg_y: wolfhece.wolf_array.WolfArray = None, svg_norm: wolfhece.wolf_array.WolfArray = None, threshold_velocity: float = None, threshold_depth: float = None, threshold_tke: float = None, threshold_svg: float = None)

   This class performs a multi-criteria analysis
   to assess the suitability of a river site
   to the downstream migration of Atlantic salmon smolt.


   .. py:attribute:: _velocity
      :value: None



   .. py:attribute:: _depth
      :value: None



   .. py:attribute:: _tke
      :value: None



   .. py:attribute:: _svg_x
      :value: None



   .. py:attribute:: _svg_y
      :value: None



   .. py:attribute:: _svg_norm
      :value: None



   .. py:attribute:: _threshold_velocity
      :value: None



   .. py:attribute:: _threshold_depth
      :value: None



   .. py:attribute:: _threshold_tke
      :value: None



   .. py:attribute:: _threshold_svg
      :value: None



   .. py:property:: velocity
      :type: wolfhece.wolf_array.WolfArray



   .. py:property:: depth
      :type: wolfhece.wolf_array.WolfArray



   .. py:property:: tke
      :type: wolfhece.wolf_array.WolfArray



   .. py:property:: svg_x
      :type: wolfhece.wolf_array.WolfArray



   .. py:property:: svg_y
      :type: wolfhece.wolf_array.WolfArray



   .. py:property:: svg_norm
      :type: wolfhece.wolf_array.WolfArray



   .. py:property:: threshold_velocity
      :type: float



   .. py:property:: threshold_depth
      :type: float



   .. py:property:: threshold_tke
      :type: float



   .. py:property:: threshold_svg
      :type: float



   .. py:attribute:: inputs


   .. py:attribute:: _analysis
      :value: None



   .. py:property:: analysis
      :type: wolfhece.multicriteria.analysis.MulticriteriAnalysis



   .. py:property:: input_velocity
      :type: wolfhece.multicriteria.analysis.Input



   .. py:property:: input_depth
      :type: wolfhece.multicriteria.analysis.Input



   .. py:property:: input_tke
      :type: wolfhece.multicriteria.analysis.Input



   .. py:property:: input_svg_x
      :type: wolfhece.multicriteria.analysis.Input



   .. py:property:: input_svg_y
      :type: wolfhece.multicriteria.analysis.Input



   .. py:property:: input_svg_norm
      :type: wolfhece.multicriteria.analysis.Input



   .. py:property:: result
      :type: wolfhece.wolf_array.WolfArray


      Return the result of the multi-criteria analysis as a WolfArray.


   .. py:method:: compute_spatial_velocity_gradient() -> None

      Compute the spatial velocity gradient (SVG) in both x and y directions.



   .. py:method:: analyse_site(method: Literal['percentage', 'average', 'sum'] = 'sum', write_to: str | pathlib.Path = None) -> wolfhece.wolf_array.WolfArray

      Perform the multi-criteria analysis
      to assess the suitability of the river site for smolt migration.



   .. py:method:: get_score(variable: Literal['Velocity', 'Depth', 'TKE', 'SVG_X', 'SVG_Y']) -> numpy.ma.MaskedArray

      Return the score for a given variable as a numpy array.

      :param variable: The variable for which to get the score.
      Must be one of "Velocity", "Depth", "TKE", "SVG_X", "SVG_Y".
      :return: The score as a numpy array.



   .. py:method:: get_score_as_WolfArray(variable: Literal['Velocity', 'Depth', 'TKE', 'SVG_X', 'SVG_Y']) -> wolfhece.wolf_array.WolfArray

      Return the score for a given variable as a WolfArray.
      The array is georeferenced and masked, with a discrete color palette (0: red, 1: cyan)
      to easily visualize the suitability of the site for smolt migration.

      :param variable: The variable for which to get the score.
      Must be one of "Velocity", "Depth", "TKE", "SVG_X", "SVG_Y".
      :return: The score as a WolfArray.



   .. py:method:: get_variable(variable: Literal['velocity', 'depth', 'tke', 'svg_x', 'svg_y', 'svg_norm']) -> wolfhece.wolf_array.WolfArray

      Return the hydrodynamic variable used in the analysis as a WolfArray.

      :param variable: The variable to return. Must be one of "velocity", "depth", "tke", "svg_x", "svg_y", "svg_norm".
      :return: The variable as a WolfArray.