data

Low-level internals. These are the Rust-backed structures and functions that power cityseer. They carry no stability guarantee and are subject to breaking changes from time to time. Users are encouraged to use the higher-level wrappers instead, which are more stable: the CityNetwork class, or the metrics and tools modules. The basic information below is provided for those who do wish to work with the lower-level internals.

Data structures and utilities for spatial data analysis.

AccessibilityResult

Accessibility computation result.

AccessibilityResult

AccessibilityResult
( )

DataEntry

Data entry for spatial analysis.

DataEntry

DataEntry
( )

DataMap

DataMap

DataMap
( )

accessibility

accessibility
(
self
/
network_structure
landuses_map
accessibility_keys
distances=None
minutes=None
angular=None
speed_m_s=None
decay_fn=None
pbar_disabled=None
)

accessibility_decays

accessibility_decays
(
self
/
network_structure
landuses_map
accessibility_keys
decay_fns
distances=None
minutes=None
angular=None
speed_m_s=None
pbar_disabled=None
)

aggregate_to_src_idx

aggregate_to_src_idx
(
self
/
netw_src_idx
network_structure
max_walk_seconds
speed_m_s
angular=None
)

assign_data_to_network

assign_data_to_network
(
self
/
network_structure
max_assignment_dist
n_nearest_candidates
)

Assigns data entries to network nodes based on proximity and accessibility checks. This method iterates through all data entries and uses NetworkStructure::find_assignments_for_entry to determine valid node assignments for each entry. The results are collected and stored in the node_data_map.

count

count
(
self
/
)

entry_keys

entry_keys
(
self
/
)

get_entry

get_entry
(
self
/
data_key
)

insert

insert
(
self
/
data_key_py
geom_wkt
dedupe_key_py=None
)

is_empty

is_empty
(
self
/
)

mixed_uses

mixed_uses
(
self
/
network_structure
landuses_map
distances=None
minutes=None
compute_hill=None
compute_shannon=None
compute_gini=None
angular=None
speed_m_s=None
decay_fn=None
pbar_disabled=None
)

mixed_uses_decays

mixed_uses_decays
(
self
/
network_structure
landuses_map
decay_fns
distances=None
minutes=None
compute_hill=None
compute_shannon=None
compute_gini=None
angular=None
speed_m_s=None
pbar_disabled=None
)

progress

progress
(
self
/
)

progress_init

progress_init
(
self
/
)

stats

stats
(
self
/
network_structure
numerical_maps
distances=None
minutes=None
angular=None
speed_m_s=None
decay_fn=None
measures=None
pbar_disabled=None
)

stats_decays

stats_decays
(
self
/
network_structure
numerical_maps
decay_fns
distances=None
minutes=None
angular=None
speed_m_s=None
measures=None
pbar_disabled=None
)

MixedUsesResult

Mixed uses computation result.

MixedUsesResult

MixedUsesResult
( )

StatsResult

Statistics computation result.

StatsResult

StatsResult
( )