matrix_time_periods#

caf.van.lgv_model.matrix_time_periods(matrices, factors_path, output_folder)[source]#

Converts all matrices to time periods based on factors in factors_path.

Saves all matrices to sub-folder inside output_folder, the sub-folders have the same names as the time periods given.

Parameters:
  • matrices (LGVMatrices) – The trip matrices to be converted.

  • factors_path (Path) – Path to Excel workbook containing time period factors.

  • output_folder (Path) – Path to the folder where outputs are saved.

Returns:

Dictionary containing all matrices (values) for each time period (keys), contains the same time periods as given in the input table.

Return type:

dict[str, LGVMatrices]

See also

read_time_factors

Function to read time period factors from factors_path.