Source code for safe.impact_functions.inundation.flood_raster_osm_building_impact.parameter_definitions

# coding=utf-8
"""InaSAFE Disaster risk tool by Australian Aid - Parameter definition for
Flood Raster Impact on OSM Buildings

Contact : [email protected]

.. note:: This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.

from safe.impact_functions.unit_definitions import parameter_unit_metres

__author__ = 'lucernae'

from safe_extras.parameters.float_parameter import FloatParameter
from safe.utilities.i18n import tr

[docs]def threshold(): """Generator for the default threshold parameter. :return: List of FloatParameter :rtype: list[FloatParameter] """ field = FloatParameter() = tr('Thresholds [m]') field.is_required = True field.precision = 2 field.value = 1.0 # default value unit_metres = parameter_unit_metres() field.unit = unit_metres field.allowed_units = [unit_metres] field.help_text = tr( 'Threshold value to categorize inundated area.') field.description = tr( 'Hazard value above the threshold in meter will be considered ' 'inundated.') return field