v.distance
How GRASS runs Nearest Join: v.distance.
| Engine | GRASS |
|---|---|
| Tool name | v.distance |
| Interface | cli |
| Implements | Nearest Join |
| Documentation | Not stated |
| Effects | modifies input: no, network: no |
| Notes | Not stated |
| Status | active |
Parameters
| Name | Type | Required | Default | Choices | Note |
|---|---|---|---|---|---|
from | string | yes | Not stated | Not stated | vector name |
from_layer | string | no | 1 | Not stated | layer name |
from_type | string | no | point,line,area | point, line, boundary, centroid, area | multiple values |
to | string | yes | Not stated | Not stated | vector name |
to_layer | string | no | 1 | Not stated | layer name |
to_type | string | no | point,line,area | point, line, boundary, centroid, area | multiple values |
output | string | no | Not stated | Not stated | output vector |
dmax | float | no | -1 | Not stated | Not stated |
dmin | float | no | -1 | Not stated | Not stated |
upload | string | yes | Not stated | cat, dist, to_x, to_y, to_along, to_angle, to_attr | multiple values |
column | string | no | Not stated | Not stated | dbcolumn name; multiple values |
to_column | string | no | Not stated | Not stated | dbcolumn name |
table | string | no | Not stated | Not stated | dbtable name |
separator | string | no | pipe | Not stated | separator name |
format | string | yes | plain | plain, json | Not stated |
flag_p | boolean | no | Not stated | Not stated | flag -p |
flag_a | boolean | no | Not stated | Not stated | flag -a |
flag_s | boolean | no | Not stated | Not stated | flag -s |
flag_overwrite | boolean | no | Not stated | Not stated | flag --overwrite |
How it maps to the operation
| Operation parameter | Parameter here | Note |
|---|---|---|
left | from | Not stated |
right | to | Not stated |
max_distance | dmax | Not stated |
distance_field | Not stated | upload = dist with column = the field name. |
Differences from the operation
- Writes into the from map's attribute table (upload, column, to_column) rather than making a joined layer.
Harvested by the grass harvester from engine version
8.5.0. Names can change when an engine is harvested again.