od_to_pa#

caf.mat.direction.od_to_pa.od_to_pa(input_, output, balancing_method, phi, *, occ_factors=None, tp_factors=None, calculate_tour_proportions=True)[source]#

Convert OD matrices to PA and generate tour proportions.

Parameters:

  • input – Input OD matrices at least split by segmentation and direction (from / to home and non-home-based.)

  • output (Matrices) – Class to handle output PA matrices.

  • balancing_method (Literal['op', '24']) – Method of balancing from / to home matrices. - op: conserves all but the final time period (OP) - 24: conserves the 24hr total

  • phi (PhiFactors) – Phi factors, required for op balancing and generating tour proportions.

  • occ_factors (DVector | None) – Optional occupancy factors to apply to matrices.

  • tp_factors (dict[int, int | float] | None) – Optional time period factors to apply to matrices.

  • calculate_tour_proportions (bool) – If True (default) then produce tour proportions.

  • input_ (Matrices)

Return type:

None

See also

balance_fh_th_by_op, balance_fh_th_conserve_24hr