BBBikeReader.read_osm_pbf
- BBBikeReader.read_osm_pbf(subregion_name, data_dir=None, readable=False, expand=False, parse_geometry=False, parse_other_tags=False, parse_properties=False, update=False, download=True, pickle_it=False, ret_pickle_path=False, rm_pbf_file=False, chunk_size_limit=50, verbose=False, **kwargs)[source]
Read a PBF (.osm.pbf) data file of a geographic (sub)region.
- Parameters:
subregion_name (str) – name of a geographic (sub)region (case-insensitive) that is available on Geofabrik free download server
data_dir (str | None) – directory where the .osm.pbf data file is located/saved; if
None
, the default local directoryreadable (bool) – whether to parse each feature in the raw data, defaults to
False
expand (bool) – whether to expand dict-like data into separate columns, defaults to
False
parse_geometry (bool) – whether to represent the
'geometry'
field in a shapely.geometry format, defaults toFalse
parse_properties (bool) – whether to represent the
'properties'
field in a tabular format, defaults toFalse
parse_other_tags (bool) – whether to represent a
'other_tags'
(of'properties'
) in a dict format, defaults toFalse
download (bool) – whether to download/update the PBF data file of the given subregion, if it is not available at the specified path, defaults to
True
update (bool) – whether to check to update pickle backup (if available), defaults to
False
pickle_it (bool) – whether to save the .pbf data as a pickle file, defaults to
False
ret_pickle_path (bool) – (when
pickle_it=True
) whether to return a path to the saved pickle filerm_pbf_file (bool) – whether to delete the downloaded .osm.pbf file, defaults to
False
chunk_size_limit (int | None) – threshold (in MB) that triggers the use of chunk parser, defaults to
50
; if the size of the .osm.pbf file (in MB) is greater thanchunk_size_limit
, it will be parsed in a chunk-wise wayverbose (bool | int) – whether to print relevant information in console as the function runs, defaults to
False
kwargs – [optional] parameters of the method
_Reader.read_osm_pbf()
- Returns:
dictionary of the .osm.pbf data; when
pickle_it=True
, return a tuple of the dictionary and a path to the pickle file- Return type:
dict | tuple | None
Examples:
>>> from pydriosm.reader import BBBikeReader >>> from pyhelpers.dirs import delete_dir >>> bbr = BBBikeReader() >>> subrgn_name = 'Leeds' >>> dat_dir = "tests\osm_data" >>> leeds_pbf_raw = bbr.read_osm_pbf(subrgn_name, data_dir=dat_dir, verbose=True) Downloading "Leeds.osm.pbf" to "tests\osm_data\leeds\" ... Done. Reading "tests\osm_data\leeds\Leeds.osm.pbf" ... Done. >>> type(leeds_pbf_raw) dict >>> list(leeds_pbf_raw.keys()) ['points', 'lines', 'multilinestrings', 'multipolygons', 'other_relations'] >>> pbf_raw_points = leeds_pbf_raw['points'] >>> type(pbf_raw_points) list >>> type(pbf_raw_points[0]) osgeo.ogr.Feature >>> # (Parsing the data in this example might take up to a few minutes.) >>> leeds_pbf_parsed = bbr.read_osm_pbf( ... subrgn_name, data_dir=dat_dir, readable=True, expand=True, ... parse_geometry=True, parse_other_tags=True, parse_properties=True, ... verbose=True) Parsing "tests\osm_data\leeds\Leeds.osm.pbf" ... Done. >>> list(leeds_pbf_parsed.keys()) ['points', 'lines', 'multilinestrings', 'multipolygons', 'other_relations'] >>> # Data of the 'multipolygons' layer >>> leeds_pbf_parsed_multipolygons = leeds_pbf_parsed['multipolygons'] >>> leeds_pbf_parsed_multipolygons.head() id geometry ... tourism other_tags 0 10595 (POLYGON ((-1.5030223 53.6725382, -1.5034495 5... ... None None 1 10600 (POLYGON ((-1.5116994 53.6764287, -1.5099361 5... ... None None 2 10601 (POLYGON ((-1.5142403 53.6710831, -1.5143686 5... ... None None 3 10612 (POLYGON ((-1.5129341 53.6704885, -1.5131883 5... ... None None 4 10776 (POLYGON ((-1.5523801 53.7029081, -1.5524772 5... ... None None [5 rows x 26 columns] >>> # Delete the example data and the test data directory >>> delete_dir(dat_dir, verbose=True) To delete the directory "tests\osm_data\" (Not empty) ? [No]|Yes: yes Deleting "tests\osm_data\" ... Done.
See also
Examples for the method
GeofabrikReader.read_osm_pbf()
.