safe.impact_reports.population_exposure_report_mixin module

InaSAFE Disaster risk assessment tool developed by AusAid - Building Exposure Report Mixin Class

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.

class safe.impact_reports.population_exposure_report_mixin.PopulationExposureReportMixin[source]

Bases: safe.impact_reports.report_mixin_base.ReportMixin

Building specific report.

action_checklist()[source]

Breakdown by building type.

Returns:The buildings breakdown report.
Return type:list
affected_population[source]

Get the affected population counts.

Returns:Affected population counts.
Return type:dict
generate_report()[source]

Breakdown by building type.

Returns:The report.
Return type:list
impact_category_ordering[source]

Get the ordering of the impact categories.

Returns:The categories by defined or default ordering.
Return type:list
impact_summary()[source]

The impact summary as per category

Returns:The impact summary.
Return type:list
lookup_category(category)[source]

Lookup a category by its name.

Parameters:category (basestring) – The category to be looked up.
Returns:The category’s count.
Return type:int

Note

The category may be any valid category, but it also includes ‘Population Not Affected’, ‘Unaffected Population’ for unaffected as well as ‘Total Impacted’, ‘People impacted’, ‘Total Population Affected’ for total affected population. This diversity is to accodate existing usages, which have evolved separately. We may want to update these when we have decided on a single convention.

minimum_needs[source]

Get the minimum needs as specified, or default.

Returns:The minimum needs parameters.
Return type:list
minimum_needs_breakdown()[source]

Breakdown by building type.

Returns:The buildings breakdown report.
Return type:list
other_population_counts[source]

The population counts which are not explicitly included in affected.

Returns:Population counts.
Return type:dict
question[source]

Get the impact function question.

Returns:The impact function question.
Return type:basestring
total_affected_population[source]

Get the total affected population.

Returns:Total affected population.
Return type:int.
total_evacuated[source]

Get the total evacuated population.

Returns:The total evacuated population.
Return type:int

Note

The total evacuated is said to either the evacuated amount,

failing that the total affected population and if applicable reduced by a evacuation percentage.

total_needs[source]

Get the total minimum needs based on the total evacuated.

Returns:Total minimum needs.
Return type:dict
total_population[source]

Get the total population.

Returns:The total population.
Return type:int
unaffected_population[source]

Get the unaffected population count.

Returns:The unaffected population count.
Returns:int