OD2PAParameters#

class caf.mat.direction.od_to_pa.OD2PAParameters(*, zone_system, time_period_factors, balancing_method, postme_folder, postme_segmentation, synthetic_folder, phi_factors, occupancy_factors, postme_filename_template=None, synthetic_filename_template=None, calculate_tour_proportions=True)[source]#

Bases: BaseConfig

Define parameters for OD to PA conversion process.

Attributes

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

zone_system

time_period_factors

balancing_method

postme_folder

postme_segmentation

synthetic_folder

phi_factors

occupancy_factors

postme_filename_template

synthetic_filename_template

calculate_tour_proportions

Methods

Attributes Documentation

Parameters:

  • zone_system (str)

  • time_period_factors (dict[int, int | float])

  • balancing_method (Literal['op', '24'])

  • postme_folder (Annotated[Path, PathType(path_type=dir)])

  • postme_segmentation (SegmentationInput)

  • synthetic_folder (Annotated[Path, PathType(path_type=dir)])

  • phi_factors (PhiFactorsParameters)

  • occupancy_factors (OccupanciesParameters)

  • postme_filename_template (str | None)

  • synthetic_filename_template (str | None)

  • calculate_tour_proportions (bool)

model_config = {}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

zone_system: str[source]#
time_period_factors: dict[int, int | float][source]#
balancing_method: Literal['op', '24'][source]#
postme_folder: Annotated[Path, PathType(path_type=dir)][source]#
postme_segmentation: SegmentationInput[source]#
synthetic_folder: Annotated[Path, PathType(path_type=dir)][source]#
phi_factors: PhiFactorsParameters[source]#
occupancy_factors: OccupanciesParameters[source]#
postme_filename_template: str | None[source]#
synthetic_filename_template: str | None[source]#
calculate_tour_proportions: bool[source]#