wolfhece.multicriteria.salmon

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

wolfhece.multicriteria.salmon.VELOCITY = 'velocity'

wolfhece.multicriteria.salmon.DEPTH = 'depth'

wolfhece.multicriteria.salmon.TKE = 'tke'

wolfhece.multicriteria.salmon.SVG_X = 'svg_x'

wolfhece.multicriteria.salmon.SVG_Y = 'svg_y'

wolfhece.multicriteria.salmon.SVG_NORM = 'svg_norm'

class wolfhece.multicriteria.salmon.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.

_velocity = None

_depth = None

_tke = None

_svg_x = None

_svg_y = None

_svg_norm = None

_threshold_velocity = None

_threshold_depth = None

_threshold_tke = None

_threshold_svg = None

property velocity: wolfhece.wolf_array.WolfArray

property depth: wolfhece.wolf_array.WolfArray

property tke: wolfhece.wolf_array.WolfArray

property svg_x: wolfhece.wolf_array.WolfArray

property svg_y: wolfhece.wolf_array.WolfArray

property svg_norm: wolfhece.wolf_array.WolfArray

property threshold_velocity: float

property threshold_depth: float

property threshold_tke: float

property threshold_svg: float

inputs

_analysis = None

property analysis: wolfhece.multicriteria.analysis.MulticriteriAnalysis

property input_velocity: wolfhece.multicriteria.analysis.Input

property input_depth: wolfhece.multicriteria.analysis.Input

property input_tke: wolfhece.multicriteria.analysis.Input

property input_svg_x: wolfhece.multicriteria.analysis.Input

property input_svg_y: wolfhece.multicriteria.analysis.Input

property input_svg_norm: wolfhece.multicriteria.analysis.Input

property result: wolfhece.wolf_array.WolfArray

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

compute_spatial_velocity_gradient() → None

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

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.

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.

Parameters:

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.

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.

Parameters:

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.

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.

Parameters:

variable – The variable to return. Must be one of “velocity”, “depth”, “tke”, “svg_x”, “svg_y”, “svg_norm”.

Returns:

The variable as a WolfArray.