# coding=utf-8
"""InaSAFE Disaster risk tool by Australian Aid - Volcano Point on Building
Metadata Definitions.
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.common.utilities import OrderedDict
from safe.defaults import building_type_postprocessor
from safe.impact_functions.impact_function_metadata import \
ImpactFunctionMetadata
from safe.impact_functions.volcanic.volcano_point_building\
.parameter_definitions import distance
from safe.utilities.i18n import tr
from safe.definitions import (
layer_geometry_point,
layer_geometry_polygon,
hazard_volcano,
hazard_category_multiple_event,
exposure_structure,
layer_mode_classified,
volcano_name_field,
structure_class_field,
hazard_category_single_event
)
[docs]class VolcanoPointBuildingFunctionMetadata(ImpactFunctionMetadata):
"""Metadata for VolcanoPointBuildingFunctionMetadata.
.. versionadded:: 2.1
We only need to re-implement as_dict(), all other behaviours
are inherited from the abstract base class.
"""
@staticmethod
[docs] def as_dict():
"""Return metadata as a dictionary.
This is a static method. You can use it to get the metadata in
dictionary format for an impact function.
:returns: A dictionary representing all the metadata for the
concrete impact function.
:rtype: dict
"""
dict_meta = {
'id': 'VolcanoPointBuildingFunction',
'name': tr('Point volcano on buildings'),
'impact': tr('Be affected'),
'title': tr('Be affected'),
'function_type': 'old-style',
'author': 'AIFDR',
'date_implemented': 'N/A',
'overview': tr(
'To assess the impacts of volcano points on buildings.'),
'detailed_description': '',
'hazard_input': tr(
'The hazard layer must be a point layer. '
'This point will be buffered with the radii specified in '
'the parameters as the hazard zone. If you want to see '
'the name of the volcano in the result, you need to '
'specify the volcano name attribute in the Impact Function '
'option.'),
'exposure_input': tr(
'Vector polygon layer extracted from OSM where each '
'polygon represents the footprint of a building.'),
'output': tr(
'Vector layer contains Map of building exposed to '
'volcanic hazard zones for each radius.'),
'actions': tr(
'Provide details about how many building would likely be '
'affected by each hazard zones.'),
'limitations': [],
'citations': [],
'layer_requirements': {
'hazard': {
'layer_mode': layer_mode_classified,
'layer_geometries': [layer_geometry_point],
'hazard_categories': [
hazard_category_multiple_event,
hazard_category_single_event
],
'hazard_types': [hazard_volcano],
'continuous_hazard_units': [],
'vector_hazard_classifications': [],
'raster_hazard_classifications': [],
'additional_keywords': [volcano_name_field]
},
'exposure': {
'layer_mode': layer_mode_classified,
'layer_geometries': [
layer_geometry_polygon,
layer_geometry_point],
'exposure_types': [exposure_structure],
'exposure_units': [],
'exposure_class_fields': [structure_class_field],
'additional_keywords': []
}
},
'parameters': OrderedDict([
# The list of radii in km for volcano point hazard
('distances', distance()),
('postprocessors', OrderedDict([
('BuildingType', building_type_postprocessor())]))
])
}
return dict_meta