ZoneTranslation

class caf.space.zone_translation.ZoneTranslation(params)

Bases: object

Store paramaters and create zone translations.

This is the main class for the caf.space tool. Running it with an instance of ‘inputs.ZoningTranslationInputs’ will return a zone translation dataframe.

Parameters:

params (ZoningTranslationInputs) – Params should usually be read in from a yml file using the load_yaml method of the ZoningTranslationInputs class. Refer to this class for info on parameters.

Returns:

Instance of ZoneTranslation, where a spatial or weighted zone translation, dependent on inputs, is stored as self.zone_translation

Return type:

Instance of self

Methods

__init__(params)
spatial_translation([return_gdf])	Create spatial zone translation.
weighted_centroids()	Create centroids based on weighting data.
weighted_translation()	Create a weighted zone translation.