access.Access.weighted_catchment

Access.weighted_catchment(name='catchment', supply_cost=None, supply_values=None, weight_fn=None, max_cost=None, normalize=False)

Calculate the catchment area (buffer) aggregate access score.

Parameters:

namestr

Column name for access values

supply_coststr

Name of supply cost value column in supply_df

supply_values{str, list}

Name(s) of supply values in supply_df

weight_fnfunction

function to apply to the cost to reach the supply. In this way, you could run, e.g., a gravity function. (Be careful of course of values as distances go to 0!)

max_costfloat

Cutoff of cost values

normalizebool

If True, return normalized access values; otherwise, return raw access values

Returns:

accesspandas Series

Accessibility score for origin locations.

Examples

Create an Access object, as detailed in __init__.py

>>> illinois_primary_care = Access(<...>)

Call the floating catchment area with max_cost only

>>> gravity = weights.gravity(scale = 60, alpha = -1)
>>> illinois_primary_care.weighted_catchment(weight_fn = gravity)