Skip to main content
Ctrl+K

openplaces

  • Overview
  • Get started
  • Examples
  • Reference
  • Contribute
  • Overview
  • Get started
  • Examples
  • Reference
  • Contribute

Section Navigation

  • openplaces
    • api
    • config
    • diagnostics
    • flow
    • geo
      • ids
      • link
      • overlay
      • polygon
    • io
      • admin
      • aggregate
      • cloud_geoparquet_ingester
      • harmonizer
        • attributes
        • discover
        • filter
        • links
        • spine
      • image_ingester
      • ingester
      • parcel
      • raster_ingester
      • readers
      • scrapers
        • google_satellite
        • google_streetview
        • types
      • table_ingester
      • transform
    • path
    • recipe
    • timing
    • utils
    • viz
      • colors
      • maps
      • tabulation
  • Reference
  • openplaces
  • geo
  • link

link#

link.py

Entity linking: create ID linkages between two spatial entity datasets.

Functions#

create_entity_link(entity1_recipe_id, entity2_recipe_id)

Create ID linkage (n-to-m) between two entities and save

Module Contents#

openplaces.geo.link.create_entity_link(entity1_recipe_id, entity2_recipe_id, save=True, **kwargs)#

Create ID linkage (n-to-m) between two entities and save

Parameters:
  • entity1_recipe_id (str) – Recipe ID of first entity

  • entity2_recipe_id (str) – Recipe ID of second entity

  • save (bool) – If True, save output as a file, in the folder of entity1: {entity1_recipe_id}_{entity2_recipe_id}.parquet

  • kwargs (dict) – Are passed to overlay_polygons or overlay_polygons_with_duckdb. When how='intersection' (default), iou=False (default), and geom=False (default), the DuckDB implementation is used because it is faster for Path inputs in that configuration; otherwise geopandas is used.

previous

ids

next

overlay

On this page
  • Functions
  • Module Contents
    • create_entity_link()

© Copyright 2025, Christoph Nolte.

Created using Sphinx 9.1.0.

Built with the PyData Sphinx Theme 0.18.0.