GMInputs#

class caf.van.lgv_model.GMInputs(trip_length_distribution_path, cost_function, cost_function_params, calibrate, cat_zone_correspondence_path=None, furness_jacobian=True)[source]#

Defines the input paths and parameters for the gravity model.

Attributes

`cat_zone_correspondence_path`	Correspondence between the categories in the TLD and the model zones.
`furness_jacobian`	Whether to Furness the Jacobian matrix in the gravity model.

Methods

Attributes Documentation

Parameters:

trip_length_distribution_path (Annotated[Path, PathType(path_type=file)])
cost_function (Literal['log_normal', 'tanner'])
cost_function_params (tuple[float, float] | dict[int | str, tuple[float, float]])
calibrate (bool)
cat_zone_correspondence_path (Annotated[Path, PathType(path_type=file)] | None)
furness_jacobian (bool)

cat_zone_correspondence_path: Annotated[Path, PathType(path_type=file)] | None = None#: Correspondence between the categories in the TLD and the model zones.

furness_jacobian: bool = True#: Whether to Furness the Jacobian matrix in the gravity model. Find your nearest demand modelling expert for more information.