Source code for safe.impact_functions.earthquake.earthquake_building.metadata_definitions

# coding=utf-8
"""InaSAFE Disaster risk tool by Australian Aid - Metadata for Earthquake
Impact Function on Building.

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 aggregation_categorical_postprocessor
from safe.impact_functions.earthquake.earthquake_building\
    .parameter_definitions import (
        low_threshold, medium_threshold, high_threshold)
from safe.impact_functions.impact_function_metadata import \
    ImpactFunctionMetadata
from safe.utilities.i18n import tr
from safe.definitions import (
    layer_mode_continuous,
    layer_mode_classified,
    layer_geometry_polygon,
    layer_geometry_point,
    layer_geometry_raster,
    hazard_earthquake,
    exposure_structure,
    unit_mmi,
    hazard_category_single_event,
    hazard_category_multiple_event,
    structure_class_field
)


__author__ = 'lucernae'
__project_name__ = 'inasafe'
__filename__ = 'metadata_definitions'
__date__ = '24/03/15'
__copyright__ = '[email protected]'


[docs]class EarthquakeBuildingMetadata(ImpactFunctionMetadata): """Metadata for Earthquake Building Impact Function. .. 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': 'EarthquakeBuildingFunction', 'name': tr('Earthquake on buildings'), 'impact': tr('Be affected'), 'title': tr('Be affected'), 'function_type': 'old-style', 'author': 'N/A', 'date_implemented': 'N/A', 'overview': tr( 'This impact function will calculate the impact of an ' 'earthquake on buildings, reporting how many are expected ' 'to be damaged.'), 'detailed_description': '', 'hazard_input': '', 'exposure_input': '', 'output': '', 'actions': '', 'limitations': [], 'citations': [], 'layer_requirements': { 'hazard': { 'layer_mode': layer_mode_continuous, 'layer_geometries': [layer_geometry_raster], 'hazard_categories': [ hazard_category_single_event, hazard_category_multiple_event ], 'hazard_types': [hazard_earthquake], 'continuous_hazard_units': [unit_mmi], 'vector_hazard_classifications': [], 'raster_hazard_classifications': [], 'additional_keywords': [] }, 'exposure': { 'layer_mode': layer_mode_classified, 'layer_geometries': [ layer_geometry_point, layer_geometry_polygon ], 'exposure_types': [exposure_structure], 'exposure_units': [], 'exposure_class_fields': [structure_class_field], 'additional_keywords': [] } }, 'parameters': OrderedDict( [('low_threshold', low_threshold()), ('medium_threshold', medium_threshold()), ('high_threshold', high_threshold()), ('postprocessors', OrderedDict([ ('AggregationCategorical', aggregation_categorical_postprocessor())]))] ) } return dict_meta