Osmium

https://docs.osmcode.org/osmium/latest/
Admin
Osmium is a command-line tool and library for processing and manipulating OpenStreetMap data with...
Tokens:22,621
Snippets:266
Trust Score:8.9
Update:10 months ago
Show doc for...
Tokens:
Raw
### Renumber with Specific Start IDs

Source: https://docs.osmcode.org/osmium/latest/osmium-renumber

This example shows how to renumber OSM IDs with specific starting points for nodes, ways, and relations. The '-s' option allows defining custom starting sequences for each ID type.

```bash
osmium renumber -o renumbered.osm.pbf -s 1,100,-200 athens.osm.pbf
```

--------------------------------

### Polygon Configuration Example (JSON)

Source: https://docs.osmcode.org/osmium/latest/osmium-extract

This snippet shows how to configure a polygon file in the Osmium configuration file using JSON. It specifies the 'file_name' and 'file_type' for a GeoJSON file. File names are relative to the config file directory unless they start with a slash.

```json
{
    "polygon": {
        "file_name": "berlin.geojson",
        "file_type": "geojson"
    }
}
```

--------------------------------

### Add Node Locations Example (PBF)

Source: https://docs.osmcode.org/osmium/latest/osmium-add-locations-to-ways

This example demonstrates how to add node locations to an extract file in PBF format, ensuring all nodes are retained. It specifies the output file and the input extract.

```bash
osmium add-locations-to-ways -n -o germany-low.osm.pbf germany.osm.pbf
```

--------------------------------

### Add Node Locations Example (Planet File, Dense MMAP Array)

Source: https://docs.osmcode.org/osmium/latest/osmium-add-locations-to-ways

This example shows how to add node locations to a planet file, utilizing the 'dense_mmap_array' index type and excluding untagged nodes. It specifies the output file and the input planet file.

```bash
osmium add-locations-to-ways -i dense_mmap_array -o planet-low.osm.pbf planet.osm.pbf
```

--------------------------------

### Renumber PBF to Compressed XML

Source: https://docs.osmcode.org/osmium/latest/osmium-renumber

Example of renumbering a PBF file and saving the output as a compressed XML file. This demonstrates setting the output file name and format.

```bash
osmium renumber -o ch.osm.bz2 germany.osm.pbf
```

--------------------------------

### Filter Nodes by Amenity Tag

Source: https://docs.osmcode.org/osmium/latest/osmium-tags-filter

This example shows how to filter OSM data to select all nodes that have the 'amenity' tag. It's a basic example of matching a tag key without specifying a value.

```Shell
osmium tags-filter -o amenties.osm.pbf berlin.osm.pbf n/amenity
```

--------------------------------

### Convert PBF to Compressed XML

Source: https://docs.osmcode.org/osmium/latest/osmium-cat

Converts an input PBF file to a compressed XML format and saves it to the specified output file. This example demonstrates basic file conversion using osmium-cat.

```bash
osmium cat -o out.osm.bz2 in.osm.pbf
```

--------------------------------

### Filter Expression Examples for OSM Data

Source: https://docs.osmcode.org/osmium/latest/osmium-export

Illustrates various filter expressions used to match OSM tags. These expressions can match keys, specific key-value pairs, or use wildcards for flexible filtering.

```text
amenity

highway=primary

highway!=primary

type=multipolygon,boundary

name,name:de=Kastanienallee,Kastanienstrasse

addr:*

name=*Paris
```

--------------------------------

### Count specific building keys in Madrid

Source: https://docs.osmcode.org/osmium/latest/osmium-tags-count

Counts all occurrences of the 'building' key within the specified OSM file (madrid.osm.pbf). This example shows how to filter counts by a specific key.

```bash
osmium tags-count madrid.osm.pbf building
```

--------------------------------

### Filter for open changesets and output to a file

Source: https://docs.osmcode.org/osmium/latest/osmium-changeset-filter

This example shows how to filter an OSM changeset file to include only open changesets. The filtered output is then written to a new file named 'open-changesets.opl.bz2' in the OPL format.

```bash
osmium changeset-filter --open -o open-changesets.opl.bz2 changesets.osm.bz2
```

--------------------------------

### Sort OSM file and write to PBF format

Source: https://docs.osmcode.org/osmium/latest/osmium-sort

This example demonstrates sorting an input OSM file (e.g., bzip2 compressed) and writing the sorted output to a Protocol Buffer Binary (PBF) file. It utilizes the '-o' option to specify the output file and implies the input file is provided as an argument.

```bash
osmium sort -o sorted.osm.pbf in.osm.bz2
```

--------------------------------

### Count all keys in Spain

Source: https://docs.osmcode.org/osmium/latest/osmium-tags-count

Counts all keys present in the specified OSM file (spain.osm.pbf) and displays the most common keys first. This command demonstrates basic usage for counting keys.

```bash
osmium tags-count spain.osm.pbf
```

--------------------------------

### Filter Nodes/Ways by Highway and Relations by Type

Source: https://docs.osmcode.org/osmium/latest/osmium-tags-filter

This example demonstrates filtering OSM data using multiple expressions. It selects nodes and ways with the 'highway' tag, and relations tagged with 'type=restriction'. All referenced objects are included.

```Shell
osmium tags-filter -o filtered.osm.pbf planet.osm.pbf \
    nw/highway r/type=restriction
```

--------------------------------

### Derive Changes Between OSM Extracts

Source: https://docs.osmcode.org/osmium/latest/osmium-derive-changes

This example demonstrates how to use 'osmium derive-changes' to find the differences between two OpenStreetMap PBF files for a specific period. The output is compressed using bzip2. This command is useful for tracking changes over time or for preparing data for change application.

```bash
osmium derive-changes nepal-20160101.osm.pbf nepal-20160201.osm.pbf -o nepal-jan.osc.bz2
```

--------------------------------

### Count relation types with minimum occurrences

Source: https://docs.osmcode.org/osmium/latest/osmium-tags-count

Counts all 'relation' elements in the specified OSM file (sevilla.osm.pbf) where the 'type' tag matches any value, provided they appear at least 100 times. This example demonstrates filtering by element type, minimum count, and tag values.

```bash
osmium tags-count -t relation -m 100 sevilla.osm.pbf 'type=*'
```

--------------------------------

### Filter changesets by user 'foo'

Source: https://docs.osmcode.org/osmium/latest/osmium-changeset-filter

This example demonstrates how to filter an OSM changeset file to include only changesets made by a specific user ('foo'). It also specifies the output format as 'debug' and the input file as 'changesets.osm.bz2'.

```bash
osmium changeset-filter -u foo -f debug changesets.osm.bz2
```

--------------------------------

### Count all tags with wildcard

Source: https://docs.osmcode.org/osmium/latest/osmium-tags-count

Counts all tags (key-value pairs) in the input OSM file (input.osm.pbf). This command uses a wildcard '*=*' and is noted to potentially require significant memory due to counting all tags.

```bash
osmium tags-count input.osm.pbf '*=*'
```

--------------------------------

### Merge OSM Change Files (Shell)

Source: https://docs.osmcode.org/osmium/latest/osmium-merge-changes

This example demonstrates merging all compressed change files from the 'changes' directory into a single output file named 'all.osc.gz'. The command utilizes shell globbing to select multiple input files.

```shell
osmium merge-changes -o all.osc.gz changes/*.gz
```

--------------------------------

### Bounding Box Specification (Array)

Source: https://docs.osmcode.org/osmium/latest/osmium-extract

Illustrates how to define a bounding box region using a simple array of four coordinates: [min_lon, min_lat, max_lon, max_lat].

```json
{
    "output": "munich.osm.pbf",
    "description": "Bounding box specified in array format",
    "bbox": [11.35, 48.05, 11.73, 48.25]
}
```

--------------------------------

### Bounding Box Specification (Object)

Source: https://docs.osmcode.org/osmium/latest/osmium-extract

Demonstrates defining a bounding box region using an object with named keys: 'left', 'right', 'top', and 'bottom' for precise coordinate definition.

```json
{
    "output": "dresden.osm.pbf",
    "description": "Bounding box specified in object format",
    "bbox": {
        "left": 13.57,
        "right": 13.97,
        "top": 51.18,
        "bottom": 50.97
    }
}
```

--------------------------------

### Show Index Content

Source: https://docs.osmcode.org/osmium/latest/osmium-renumber

This command displays the content of index files in a human-readable text format. It is useful for inspecting the renumbering process. The output is redirected to text files for each index type (node, way, relation).

```bash
osmium renumber -i idxdir --show-index node     >nodes-index.txt
osmium renumber -i idxdir --show-index way      >ways-index.txt
osmium renumber -i idxdir --show-index relation >relations-index.txt
```

--------------------------------

### Renumber and Store Indexes on Disk

Source: https://docs.osmcode.org/osmium/latest/osmium-renumber

Demonstrates renumbering an OSM file while storing the index files on disk using the '-i .' option. This is useful for managing large datasets or for consistent renumbering across multiple operations.

```bash
osmium renumber -i. -o renumbered.osm data.osm
```

--------------------------------

### Extract current planet file from history (Bash)

Source: https://docs.osmcode.org/osmium/latest/osmium-time-filter

This example demonstrates how to extract the current state of the planet file from a history file using osmium-time-filter. It specifies the output file name.

```bash
osmium time-filter -o planet.osm.pbf history-planet.osh.pbf
```

--------------------------------

### Polygon Specification (Inline)

Source: https://docs.osmcode.org/osmium/latest/osmium-extract

Shows how to define a polygon region inline within the configuration file using a nested array structure similar to GeoJSON, with the last coordinate matching the first to close the ring.

```json
"polygon": [[
    [9.613465, 53.58071],
    [9.647599, 53.59655],
    [9.649288, 53.61059],
    [9.613465, 53.58071]
]]
```

--------------------------------

### Extract planet data from a specific date (Bash)

Source: https://docs.osmcode.org/osmium/latest/osmium-time-filter

This example shows how to extract planet data as it appeared on a specific date (January 1, 2008) from a history file using osmium-time-filter. The timestamp is provided as an argument.

```bash
osmium time-filter -o planet-20080101.osm.pbf history-planet.osh.pbf 2008-01-01T00:00:00Z
```

--------------------------------

### Supported Output Formats

Source: https://docs.osmcode.org/osmium/latest/osmium-export

Lists and describes the available output formats for the exported data, including GeoJSON, GeoJSON Text Sequence, PostgreSQL COPY format, and a simple text format.

```APIDOC
## Output Formats

The following output formats are supported:

*   **`geojson` (alias: `json`)**: GeoJSON (RFC7946). Outputs a single `FeatureCollection` object. This is the default format.
*   **`geojsonseq` (alias: `jsonseq`)**: GeoJSON Text Sequence (RFC8142). Each line contains one GeoJSON object, prefixed with a record separator (RS, 0x1e) and ending with a linefeed. Suitable for streaming.
*   **`pg`**: PostgreSQL COPY text format. Outputs WGS84 geometry as WKB, tags in JSON format, and optionally `id` and attributes. Requires manual table creation and use of the PostgreSQL `COPY` command. Verbose output provides SQL commands for table creation.
*   **`text` (alias: `txt`)**: Simple text format. Geometry in WKT format followed by comma-delimited tags. Primarily for debugging and may change without notice.
```

--------------------------------

### Count building tags on ways with custom sorting

Source: https://docs.osmcode.org/osmium/latest/osmium-tags-count

Counts all tags where the key is 'building' on 'way' elements in the specified OSM file (madrid.osm.pbf). The results are sorted in ascending order by name. This illustrates filtering by element type and custom sorting.

```bash
osmium tags-count -t way --sort=name-asc madrid.osm.pbf 'building=*'
```

--------------------------------

### Sort a Single OSM Change File (Shell)

Source: https://docs.osmcode.org/osmium/latest/osmium-merge-changes

This example shows how to use osmium-merge-changes to sort a single unsorted change file ('unsorted.osc.gz') and save the sorted output to 'sorted.osc.gz'. This leverages the tool's sorting capabilities for individual files.

```shell
osmium merge-changes unsorted.osc.gz -o sorted.osc.gz
```

--------------------------------

### Output Format Options

Source: https://docs.osmcode.org/osmium/latest/osmium-export

Details the configurable options that modify the behavior of specific output formats, such as print record separator and tag types.

```APIDOC
## Output Format Options

These options modify the behavior of specific output formats:

*   **`print_record_separator`**: (Default: `true`). For `geojsonseq` format, setting this to `false` prevents printing the RS (0x1e) character. Ignored for other formats.
*   **`tags_type`**: (Default: `jsonb`). For `pg` format, setting this to `hstore` uses HSTORE format for tags instead of JSON/JSONB. Ignored in other formats.
```

--------------------------------

### Osmium Config File Structure

Source: https://docs.osmcode.org/osmium/latest/osmium-extract

Defines the basic structure of an Osmium configuration file, including the 'extracts' array and optional 'directory' for output files.

```json
{
    "extracts": [...],
    "directory": "/tmp/"
}
```

--------------------------------

### Export OSM to GeoJSON Text Sequence with Config

Source: https://docs.osmcode.org/osmium/latest/osmium-export

This command exports OpenStreetMap data from a PBF file into the GeoJSON Text Sequence format using a specified configuration file. This allows for more customized export settings.

```bash
osmium export data.osm.pbf -o data.geojsonseq -c export-config.json
```
Tokens:
Raw