ZoneCorrespondencePath

class caf.toolkit.translation.ZoneCorrespondencePath(path, from_col_name, to_col_name, factors_col_name=None)

Defines the path and columns to use for a translation.

Attributes

factors_col_name	Column name for the translation factors.
path	Path to the translation file.
from_col_name	Column name for the from zoning IDs.
to_col_name	Column name for the to zoning IDs.

Methods

__init__(*args, **kwargs)
read(*[, factors_mandatory, ...])	Read the translation file.

Attributes Documentation

Parameters:

• path (Annotated[Path, PathType(path_type=file)])

• from_col_name (str)

• to_col_name (str)

• factors_col_name (str | None)

factors_col_name: str | None = None

Column name for the translation factors.

path: Annotated[Path, PathType(path_type=file)]

Path to the translation file.

from_col_name: str

Column name for the from zoning IDs.

to_col_name: str

Column name for the to zoning IDs.