ZoneCorrespondence#

class caf.toolkit.translation.ZoneCorrespondence(vector, from_col_name=<factory>, to_col_name=<factory>, factors_col_name=<factory>)[source]#

Container for a pandas based translation.

Attributes

`factors_col_name`	Get _factors_col_name.
`factors_column`	Factors zone column from the translation vector.
`from_col_name`	Get _from_col_name.
`from_column`	From zone column from the translation vector.
`to_col_name`	Get _to_col_name.
`to_column`	To zone column from the translation vector.
`translation_vector`	Translation vector table.
`vector`	Translation vector.

Methods

`__init__`(args, *kwargs)
`copy`()	Deep copy of the ZoneCorrespondence object.
`get_correspondence`(filter_zones[, filter_on])	Retrieve the correspondence for a subset of zones.

Attributes Documentation

Parameters:

vector (DataFrame)
from_col_name (str | int)
to_col_name (str | int)
factors_col_name (str | int)

factors_col_name#: Get _factors_col_name.

factors_column#: Factors zone column from the translation vector.

from_col_name#: Get _from_col_name.

from_column#: From zone column from the translation vector.

to_col_name#: Get _to_col_name.

to_column#: To zone column from the translation vector.

translation_vector#: Translation vector table.

vector: DataFrame[source]#: Translation vector.