MultiCostDistribution

class caf.distribute.gravity_model.multi_area.MultiCostDistribution(name, cost_distribution, zones, function_params)

Bases: object

Dataclass for storing needed info for a MultiCostDistribution model.

Parameters:

• name (str) – The name of the distribution (this will usually identify the area applicable e.g. City, Rural)

• cost_distribution (cost_utils.CostDistribution) – A cost distribution in a CostDistribution class from toolkit. This will often be a trip-length distribution but cost can be in any units as long as they match the cost matrix

• zones (np.ndarray) – The zones this distribution applies to. This is NOT zone number, or zone ID but the indices of the relevant zones in your cost matrix/target_rows

• function_params (dict[str,str]) – Initial parameters for your cost function to start guessing at. There is a method included for choosing these which hasn’t yet been implemented.