native:joinbynearest
How QGIS runs Nearest Join: native:joinbynearest.
| Engine | QGIS |
|---|---|
| Tool name | native:joinbynearest |
| Interface | qgis-process |
| Implements | Nearest Join |
| Preset | {"NEIGHBORS":1} |
| Documentation | Not stated |
| Effects | modifies input: no, network: no |
| Notes | Not stated |
| Status | active |
Parameters
| Name | Type | Required | Default | Choices | Note |
|---|---|---|---|---|---|
DISCARD_NONMATCHING | boolean | yes | no | Not stated | Not stated |
FIELDS_TO_COPY | field | no | Not stated | Not stated | multiple values |
INPUT | source | yes | Not stated | Not stated | Not stated |
INPUT_2 | source | yes | Not stated | Not stated | Not stated |
MAX_DISTANCE | distance | no | Not stated | Not stated | Not stated |
NEIGHBORS | number | yes | 1 | Not stated | Not stated |
NON_MATCHING | sink | no | Not stated | Not stated | output |
OUTPUT | sink | no | Not stated | Not stated | output |
PREFIX | string | no | Not stated | Not stated | Not stated |
How it maps to the operation
| Operation parameter | Parameter here | Note |
|---|---|---|
left | INPUT | Not stated |
right | INPUT_2 | Not stated |
output | OUTPUT | Not stated |
max_distance | MAX_DISTANCE | Not stated |
distance_field | Not stated | Adds the fields distance, feature_x, feature_y, nearest_x and nearest_y itself. |
how | DISCARD_NONMATCHING | left = no; inner = yes |
Differences from the operation
- NEIGHBORS can join the k nearest features (one row each).
Harvested by the qgis harvester from engine version
4.2.3. Names can change when an engine is harvested again.