nhb_proportions#

caf.mat.direction.od_to_pa.nhb_proportions(input_, params, output, output_proportions, *, occ_factors=None, tp_factors=None)[source]#

Calculate 24hr NHB and return proportions.

Parameters:

  • input – OD matrices split by time period.

  • params (dict[str, int]) – Parameters to select matrices for a single set of time periods e.g. {“m”: 3, “p”: 1}, the specific segments are dependent on input_ segmentation.

  • output (Matrices) – Class to save output 24hr matrices to, should have the same segmentation as input_ except without time period.

  • output_proportions (Matrices) – Class to handle saving the output return proportions, should have the same segmentation as input_.

  • occ_factors (DVector | None) – Optional occupancy factors DVector, will be applied to matrices before aggregating to 24 hr.

  • tp_factors (dict[int, int | float] | None) – Optional factors to apply to each time period matrix before aggregating to 24hr, keys should be time period integers.

  • input_ (Matrices)

Return type:

None