HomesInfographicModel

database_builder.HomesInfographicModel()

Model for Homes and SVI (Social Vulnerability Index) infographic configuration.

Attributes

svi : SviModel

SVI classification configuration.

mapping : TypeMapping

Database field mapping for filtering relevant objects.

impact_categories : ImpactCategoriesModel

Impact categories configuration.

Methods

Name Description
get_template Get a pre-configured template for SVI infographics.

get_template

database_builder.HomesInfographicModel.get_template(
    type: Literal['OSM', 'NSI'] = 'OSM',
    svi_threshold: float | None = None,
)

Get a pre-configured template for SVI infographics.

Parameters

svi_threshold : float | None = None

The SVI threshold value for vulnerability classification. If not provided, SVI will be None.

type : Literal['OSM', 'NSI'] = "OSM"

The database type to create a template for.

Returns

: HomesInfographicModel

Pre-configured Homes infographic model.

Back to top