API reference
The reference is the authoritative contract for Fastmob's public APIs. It documents accepted dataframe backends, detected columns, return schemas, optional dependencies, and behavior that matters at production scale.
Start from your input
| You have | Start here |
|---|---|
| Raw GPS or check-in points | Data structures, then preprocessing |
| A cleaned trajectory | Trajectory and individual measures |
| Visits, stays, or trips | Collective measures |
| A road/rail graph or GPS trace | Network |
| A model output to compare | Evaluation |
Modules
- Data structures — typed trajectory, hierarchy, and flow wrappers.
- Preprocessing — filtering, segmentation, stays, H3, and OD preparation.
- Trajectory — interpolation, smoothing, shape clustering, and comparison.
- Network — Overture graphs, Arrow routing, snapping, and map matching.
- Integration — joins with points of interest and events.
- Measures — individual, collective, and evaluation metrics.
- Models — mobility generation models.
- Input/output, privacy, data, and visualization.
Column and backend conventions
Most APIs auto-detect datetime, lat, lng, and uid from common
names. Pass explicit *_col arguments when your schema differs. See
Columns and backends
for the supported workflow.