User Guide
Getting Started
Data Ingestion
Filtering & Completeness
Tessellation
Stop Detection
Visit Attribution
Mobility Metrics
Co-location & Contact Networks
Aggregation & Debiasing
Synthetic Data Generation
Examples
Loading Trajectory Data
Comparing runtimes of different stop detection algorithms on toy datasets
Lachesis Stop Detection
TADBSCAN Stop Detection
HDBSCAN Stop Detection
Grid-Based Stop Detection
Synthetic POI Generation
Downloading places of interest (POI) Data from OSM
Synthetic Trajectory Generation with Nomad
Random City Generation
API Reference
API Reference
NOMAD
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
V
|
W
|
Z
A
add_agent() (nomad.traj_gen.Population method)
add_algorithm() (nomad.stop_detection.validation.AlgorithmRegistry method)
add_building() (nomad.city_gen.City method)
add_buildings_from_gdf() (nomad.city_gen.City method)
add_street() (nomad.city_gen.City method)
Agent (class in nomad.traj_gen)
AlgorithmRegistry (class in nomad.stop_detection.validation)
animate_stop_dashboard() (in module nomad.stop_detection.viz)
annotate_metrics() (nomad.stop_detection.validation.AlgorithmRegistry method)
applyParallel() (in module nomad.stop_detection.utils)
assign_block_types() (in module nomad.city_gen)
assign_door_to_building() (in module nomad.city_gen)
B
blocks_to_mercator() (in module nomad.map_utils)
blocks_to_mercator_gdf() (in module nomad.map_utils)
bootstrap_metric_summary() (in module nomad.stop_detection.validation)
buildings (nomad.city_gen.City attribute)
buildings_df (nomad.city_gen.City property)
buildings_outline (nomad.city_gen.City attribute)
C
check_adjacent() (nomad.city_gen.City method)
City (class in nomad.city_gen)
city (nomad.traj_gen.Agent attribute)
(nomad.traj_gen.Population attribute)
city_boundary (nomad.city_gen.City attribute)
clip_spatial_outliers() (in module nomad.stop_detection.viz)
clip_stays_date() (in module nomad.visit_attribution.visit_attribution)
completeness() (in module nomad.filters)
compute_candidate_homes() (in module nomad.home_attribution)
(in module nomad.visit_attribution.home_attribution)
compute_candidate_workplaces() (in module nomad.visit_attribution.home_attribution)
compute_contact_weights() (in module nomad.contact_estimation)
compute_gravity() (nomad.city_gen.City method)
compute_shortest_paths() (nomad.city_gen.City method)
compute_stop_detection_metrics() (in module nomad.stop_detection.validation)
compute_visitation_errors() (in module nomad.stop_detection.validation)
condense_destinations() (in module nomad.traj_gen)
coordinates (nomad.city_gen.Street attribute)
count_nights() (in module nomad.visit_attribution.visit_attribution)
coverage_matrix() (in module nomad.filters)
D
dawn_time() (in module nomad.visit_attribution.visit_attribution)
dbstop() (in module nomad.stop_detection.density_algs)
dbstop_labels() (in module nomad.stop_detection.density_algs)
dbstop_labels_per_user() (in module nomad.stop_detection.density_algs)
dbstop_per_user() (in module nomad.stop_detection.density_algs)
destination_diary (nomad.traj_gen.Agent attribute)
detect_locations() (in module nomad.visit_attribution.visit_attribution)
detect_stops() (in module nomad.stop_detection.sequential_algs)
detect_stops_labels() (in module nomad.stop_detection.sequential_algs)
detect_stops_labels_per_user() (in module nomad.stop_detection.sequential_algs)
detect_stops_per_user() (in module nomad.stop_detection.sequential_algs)
diary (nomad.traj_gen.Agent attribute)
dimensions (nomad.city_gen.City attribute)
download_osm_buildings() (in module nomad.map_utils)
download_osm_streets() (in module nomad.map_utils)
downsample() (in module nomad.filters)
dt (nomad.traj_gen.Agent attribute)
(nomad.traj_gen.Population attribute)
duration_at_night_fast() (in module nomad.visit_attribution.visit_attribution)
dusk_time() (in module nomad.visit_attribution.visit_attribution)
E
estimate_contacts() (in module nomad.contact_estimation)
explode_stops() (in module nomad.stop_detection.utils)
F
family_timing_summary() (nomad.stop_detection.validation.AlgorithmRegistry method)
fill_block() (nomad.city_gen.RandomCityGenerator method)
fill_timestamp_gaps() (in module nomad.stop_detection.postprocessing)
filter_users() (in module nomad.filters_spark)
find_connected_components() (in module nomad.city_gen)
find_intersecting_blocks() (in module nomad.city_gen)
from_df() (in module nomad.io.base)
from_file() (in module nomad.io.base)
from_geodataframes() (nomad.city_gen.City class method)
from_geopackage() (nomad.city_gen.City class method)
from_mercator() (nomad.city_gen.City method)
G
gen_params_target_f() (nomad.traj_gen.Population static method)
gen_params_target_q() (nomad.traj_gen.Population static method)
generate_agents() (nomad.traj_gen.Population method)
generate_canvas_blocks() (in module nomad.city_gen)
generate_city() (nomad.city_gen.RandomCityGenerator method)
generate_dest_diary() (nomad.traj_gen.Agent method)
generate_ping_times() (in module nomad.traj_gen)
generate_streets() (nomad.city_gen.RandomCityGenerator method)
generate_trajectory() (nomad.traj_gen.Agent method)
geometry (nomad.city_gen.Street attribute)
get_adjacent_street() (nomad.city_gen.RandomCityGenerator method)
get_block() (nomad.city_gen.City method)
get_block_type() (nomad.city_gen.RandomCityGenerator method)
get_building() (nomad.city_gen.City method)
get_building_coordinates() (nomad.city_gen.City method)
get_category_for_subtype() (in module nomad.map_utils)
get_category_summary() (in module nomad.map_utils)
get_city_boundary_osm() (in module nomad.map_utils)
get_distance_fast() (nomad.city_gen.City method)
get_paths_fast() (nomad.city_gen.City method)
get_shortest_path() (nomad.city_gen.City method)
get_street_graph() (nomad.city_gen.City method)
get_subtype_summary() (in module nomad.map_utils)
get_table_head() (in module nomad.io.snowflake)
gravity (nomad.city_gen.City attribute)
grid_based() (in module nomad.stop_detection.sequential_algs)
grid_based_labels() (in module nomad.stop_detection.sequential_algs)
grid_based_labels_per_user() (in module nomad.stop_detection.sequential_algs)
grid_based_per_user() (in module nomad.stop_detection.sequential_algs)
H
h3_cell_to_polygon() (in module nomad.stop_detection.viz)
has_overlapping_stops() (in module nomad.stop_detection.utils)
hdbscan_labels() (in module nomad.stop_detection.density_algs)
hdbscan_labels_per_user() (in module nomad.stop_detection.density_algs)
home (nomad.traj_gen.Agent attribute)
home_centroid (nomad.traj_gen.Agent attribute)
I
id (nomad.city_gen.Street attribute)
identifier (nomad.traj_gen.Agent attribute)
is_within() (in module nomad.filters)
iter_algorithms() (nomad.stop_detection.validation.AlgorithmRegistry method)
L
lachesis() (in module nomad.stop_detection.sequential_algs)
lachesis_labels() (in module nomad.stop_detection.sequential_algs)
lachesis_labels_per_user() (in module nomad.stop_detection.sequential_algs)
lachesis_per_user() (in module nomad.stop_detection.sequential_algs)
last_ping (nomad.traj_gen.Agent attribute)
load() (in module nomad.city_gen)
load_geodata() (in module nomad.map_utils)
localize_from_offset() (in module nomad.io.base)
M
mercator_to_blocks() (in module nomad.map_utils)
mercator_to_blocks_gdf() (in module nomad.map_utils)
merge_stops() (in module nomad.stop_detection.postprocessing)
module
nomad.agg
nomad.agg.privacy
nomad.aggregation
nomad.city_gen
nomad.constants
nomad.contact_estimation
nomad.displacement
nomad.filters
nomad.filters_spark
nomad.generation
nomad.generation.viz
nomad.home_attribution
nomad.io
nomad.io.base
nomad.io.snowflake
nomad.io.spark
nomad.map_utils
nomad.metrics
nomad.metrics.metrics
nomad.metrics.spark
nomad.stop_detection.density_algs
nomad.stop_detection.postprocessing
nomad.stop_detection.preprocessing
nomad.stop_detection.sequential_algs
nomad.stop_detection.utils
nomad.stop_detection.validation
nomad.stop_detection.viz
nomad.traj_gen
nomad.visit_attribution
nomad.visit_attribution.home_attribution
nomad.visit_attribution.visit_attribution
nomad.visit_attribution.viz
N
naive_datetime_from_unix_and_offset() (in module nomad.io.base)
night_stops() (in module nomad.visit_attribution.visit_attribution)
nocturnal_stops() (in module nomad.home_attribution)
(in module nomad.visit_attribution.home_attribution)
nomad.agg
module
nomad.agg.privacy
module
nomad.aggregation
module
nomad.city_gen
module
nomad.constants
module
nomad.contact_estimation
module
nomad.displacement
module
nomad.filters
module
nomad.filters_spark
module
nomad.generation
module
nomad.generation.viz
module
nomad.home_attribution
module
nomad.io
module
nomad.io.base
module
nomad.io.snowflake
module
nomad.io.spark
module
nomad.map_utils
module
nomad.metrics
module
nomad.metrics.metrics
module
nomad.metrics.spark
module
nomad.stop_detection.density_algs
module
nomad.stop_detection.postprocessing
module
nomad.stop_detection.preprocessing
module
nomad.stop_detection.sequential_algs
module
nomad.stop_detection.utils
module
nomad.stop_detection.validation
module
nomad.stop_detection.viz
module
nomad.traj_gen
module
nomad.visit_attribution
module
nomad.visit_attribution.home_attribution
module
nomad.visit_attribution.visit_attribution
module
nomad.visit_attribution.viz
module
normalize_od() (in module nomad.displacement)
normalized_moved() (in module nomad.displacement)
normalized_remained() (in module nomad.displacement)
O
oracle_map() (in module nomad.visit_attribution.visit_attribution)
overlapping_visits() (in module nomad.contact_estimation)
P
pad_short_stops() (in module nomad.stop_detection.utils)
parse_agent_attr() (in module nomad.traj_gen)
place_buildings_in_blocks() (nomad.city_gen.RandomCityGenerator method)
plot_circles() (in module nomad.stop_detection.viz)
plot_city() (nomad.city_gen.City method)
plot_family_timing() (in module nomad.stop_detection.validation)
plot_hexagons() (in module nomad.stop_detection.viz)
plot_metric_boxplots() (in module nomad.stop_detection.validation)
plot_metric_intervals() (in module nomad.stop_detection.validation)
plot_metric_vs_param() (in module nomad.stop_detection.validation)
plot_od_map() (in module nomad.visit_attribution.viz)
plot_pings() (in module nomad.stop_detection.viz)
plot_sparse_clusters() (in module nomad.generation.viz)
plot_stops() (in module nomad.stop_detection.viz)
plot_stops_barcode() (in module nomad.stop_detection.viz)
plot_time_barcode() (in module nomad.stop_detection.viz)
plot_traj() (nomad.traj_gen.Agent method)
poi_map() (in module nomad.visit_attribution.visit_attribution)
point_in_polygon() (in module nomad.visit_attribution.visit_attribution)
Population (class in nomad.traj_gen)
precision_recall_f1_from_minutes() (in module nomad.contact_estimation)
Q
q_filter() (in module nomad.filters)
R
RandomCityGenerator (class in nomad.city_gen)
RasterCity (class in nomad.city_gen)
record_timing() (nomad.stop_detection.validation.AlgorithmRegistry method)
remove_overlaps() (in module nomad.map_utils)
reproject_to_mercator() (nomad.traj_gen.Population method)
reset_trajectory() (nomad.traj_gen.Agent method)
rog() (in module nomad.metrics.metrics)
rog_spark() (in module nomad.metrics.spark)
roster (nomad.traj_gen.Population attribute)
rotate() (in module nomad.map_utils)
rotate_streets_to_align() (in module nomad.map_utils)
S
sample_from_file() (in module nomad.io.base)
sample_from_intervals() (nomad.traj_gen.Population static method)
sample_trajectory() (nomad.traj_gen.Agent method)
sample_users() (in module nomad.io.base)
(in module nomad.io.spark)
save() (in module nomad.city_gen)
(nomad.city_gen.City method)
save_geodata() (in module nomad.map_utils)
save_geopackage() (nomad.city_gen.City method)
save_pop() (nomad.traj_gen.Population method)
select_home() (in module nomad.home_attribution)
(in module nomad.visit_attribution.home_attribution)
select_workplace() (in module nomad.visit_attribution.home_attribution)
self_containment() (in module nomad.metrics.metrics)
seqscan() (in module nomad.stop_detection.density_algs)
seqscan_labels() (in module nomad.stop_detection.density_algs)
seqscan_labels_per_user() (in module nomad.stop_detection.density_algs)
seqscan_per_user() (in module nomad.stop_detection.density_algs)
set_beta_params() (nomad.traj_gen.Agent method)
shortest_paths (nomad.city_gen.City attribute)
slice_datetimes_interval_fast() (in module nomad.visit_attribution.visit_attribution)
social_interaction_potential() (in module nomad.metrics.metrics)
sparse_traj (nomad.traj_gen.Agent attribute)
sparsity_params (nomad.traj_gen.Agent attribute)
speeds (nomad.traj_gen.Agent attribute)
st_hdbscan() (in module nomad.stop_detection.density_algs)
st_hdbscan_per_user() (in module nomad.stop_detection.density_algs)
still_probs (nomad.traj_gen.Agent attribute)
Street (class in nomad.city_gen)
street_graph (nomad.city_gen.City attribute)
streets (nomad.city_gen.City attribute)
streets_df (nomad.city_gen.City property)
summarize_stop() (in module nomad.stop_detection.utils)
summarize_stop_grid() (in module nomad.stop_detection.utils)
summarize_stops() (in module nomad.stop_detection.utils)
T
ta_dbscan() (in module nomad.stop_detection.density_algs)
ta_dbscan_labels() (in module nomad.stop_detection.density_algs)
ta_dbscan_labels_per_user() (in module nomad.stop_detection.density_algs)
ta_dbscan_per_user() (in module nomad.stop_detection.density_algs)
table_column_filtered() (in module nomad.io.snowflake)
table_column_unique() (in module nomad.io.snowflake)
table_columns() (in module nomad.io.base)
(in module nomad.io.snowflake)
(in module nomad.io.spark)
thin_traj_by_times() (in module nomad.traj_gen)
time_call() (nomad.stop_detection.validation.AlgorithmRegistry method)
timing_frame() (nomad.stop_detection.validation.AlgorithmRegistry method)
to_file() (in module nomad.io.base)
(nomad.city_gen.City method)
to_mercator() (nomad.city_gen.City method)
to_projection() (in module nomad.filters)
(in module nomad.filters_spark)
to_rgba() (in module nomad.visit_attribution.viz)
to_tessellation() (in module nomad.filters)
to_timestamp() (in module nomad.filters)
to_yyyymmdd() (in module nomad.filters)
to_zoned_datetime() (in module nomad.filters)
trajectory (nomad.traj_gen.Agent attribute)
V
verify_street_connectivity() (in module nomad.city_gen)
W
window_graph() (in module nomad.stop_detection.density_algs)
within() (in module nomad.filters)
workday_stops() (in module nomad.visit_attribution.home_attribution)
workplace (nomad.traj_gen.Agent attribute)
workplace_centroid (nomad.traj_gen.Agent attribute)
Z
zoned_datetime_from_ts_and_offset() (in module nomad.io.base)