momepy.cds_length#
- momepy.cds_length(graph, radius=5, mode='sum', name='cds_len', degree='degree', length='mm_len', distance=None, verbose=True)[source]#
Calculates length of cul-de-sacs for subgraph around each node if radius is set, or for whole graph, if
radius=None
. A subgraph is generated around each node within set radius. Ifdistance=None
, radius will define topological distance, otherwise it uses values in distance attribute.- Parameters:
- graphnetworkx.Graph
A Graph representing a street network. Ideally generated from GeoDataFrame using
momepy.gdf_to_nx()
.- radiusint
Include all neighbors of distance <= radius from
n
.- modestr (default ‘sum’)
If
'sum'
, calculate total length, if'mean'
calculate mean length.- namestr, optional
The calculated attribute name.
- degreestr
The name of attribute of node degree (
momepy.node_degree()
).- lengthstr, optional
The name of the attribute of segment length (geographical).
- distancestr, optional
Use specified edge data key as distance. For example, setting
distance=’weight’
will use the edgeweight
to measure the distance from the noden
.- verbosebool (default True)
If
True
, shows progress bars in loops and indication of steps.
- Returns:
- netxGraph
A networkx.Graph object if
radius
is set.- float
The length of cul-de-sacs for the graph if
radius=None
.
Examples
>>> network_graph = mm.cds_length(network_graph, radius=9, mode='mean')