ZoneCorrespondence.get_correspondence#

ZoneCorrespondence.get_correspondence(filter_zones, filter_on='from')[source]#

Retrieve the correspondence for a subset of zones.

If the filter zones do not exist an empty dataframe is returned

Parameters:

  • filter_zones (ValidZoneIdDtype | Sequence[ValidZoneIdDtype]) – The zones for which to retrieve correspondence.

  • filter_on (Literal["from", "to"], optional) – If set to “from” (default) the filter is applied to the from column in the translation vector. If “to” the filter is applied to the to column.

Returns:

All columns in the zone correspondence for the selected zones.

Return type:

pd.DataFrame