safe.defaults module

SAFE (Scenario Assessment For Emergencies) - API

The purpose of the module is to provide a well defined public API for the packages that constitute the SAFE engine. Modules using SAFE should only need to import functions from here.

Contact : ole.moller.nielsen@gmail.com

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.

safe.defaults.age_postprocessor()[source]

Get age postprocessor selectors.

Returns:Selectors to activate age postprocessor.
Return type:list
safe.defaults.aggregation_categorical_postprocessor()[source]

Get aggregation categorical postprocessor selectors.

Returns:List of boolean parameter.
Return type:list
safe.defaults.black_inasafe_logo_path()[source]

Get the path to the Black InaSAFE SVG logo.

New in version 3.2.

safe.defaults.building_type_postprocessor()[source]

Get building-type parameter for postprocessing.

Returns:A list of boolean parameter.
Return type:list
safe.defaults.default_gender_postprocessor()[source]

Get gender postprocessor selector.

Returns:A selector to activate gender postprocessor.
Return type:list
safe.defaults.default_minimum_needs()[source]

Helper to get the default minimum needs.

Note

Key names will be translated.

safe.defaults.default_north_arrow_path()[source]

Get a default north arrow image path.

Returns:Default north arrow path.
Return type:str
safe.defaults.default_provenance()[source]

The provenance for the default values.

Returns:default provenance.
Return type:str
safe.defaults.define_defaults()[source]

Define standard defaults such as age ratios etc.

Returns:A dictionary of standard default definitions.
Return type:dict
safe.defaults.disclaimer()[source]

Get a standard disclaimer.

Returns:Standard disclaimer string for InaSAFE.
Return type:str
safe.defaults.get_defaults(default=None)[source]

Get defaults for aggregation / post processing.

Parameters:default (str) – Optional parameter if you only want a specific default.
Returns:A single value (when default is passed) or a dict of values.
Return type:str, int, float, dict
safe.defaults.limitations()[source]

Get InaSAFE limitations.

Returns:All limitations on current InaSAFE.
Return type:list
safe.defaults.minimum_needs_selector()[source]

Get minimum needs postprocessor selector.

Returns:A selector to activate minimum needs postprocessor.
Return type:list
safe.defaults.road_type_postprocessor()[source]

Get road-type parameter for postprocessing.

Returns:A list of boolean parameter.
Return type:list
safe.defaults.supporters_logo_path()[source]

Get the supporters logo path.

Changed in version Changed: in 3.2 from default_organisation_path to supporters_logo_path.

Returns:Default organisation logo path.
Return type:str
safe.defaults.white_inasafe_logo_path()[source]

Get the path to the White InaSAFE SVG logo.

New in version 3.2.