Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarifications for vector_to_*_points #352

Merged
merged 2 commits into from
Mar 23, 2022
Merged

Clarifications for vector_to_*_points #352

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
33396ca
Fixes #344 and #347
m-mohr Mar 21, 2022
b6989d3
Apply suggestions from code review
m-mohr Mar 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 4 additions & 7 deletions proposals/vector_to_random_points.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"id": "vector_to_random_points",
"summary": "Sample random points from geometries",
"description": "Generate a vector data cube of points by sampling random points from input geometries. At least one point is sampled per input geometry.\n\nThrows a `CountsMissing` exception if `geometry_count` and `total_count` are both unrestricted (i.e. set to `null`).",
"description": "Generate a vector data cube of points by sampling random points from input geometries. At least one point is sampled per input geometry. Vector properties are preserved.\n\nIf `geometry_count` and `total_count` are both unrestricted (i.e. set to `null`, which is the default), one sample per geometry is used.",
"categories": [
"cubes",
"vector"
Expand All @@ -24,9 +24,9 @@
},
{
"name": "geometry_count",
"description": "The maximum number of points to compute per geometry. Defaults to a maximum of one point per geometry.\n\nPoints in the input geometries can be selected only once by the sampling.",
"description": "The maximum number of points to compute per geometry.\n\nPoints in the input geometries can be selected only once by the sampling.",
"optional": true,
"default": 1,
"default": null,
"schema": [
{
"type": "integer",
Expand Down Expand Up @@ -56,7 +56,7 @@
},
{
"name": "group",
"description": "Specifies whether the sampled points should be grouped by input geometry (default) or be generated as independent points.\n\n* If the sampled points are grouped, the process generates a `MultiPoint` per geometry given. Vector properties are preserved.\n* Otherwise, each sampled point is generated as a distinct `Point` geometry. Vector properties are *not* preserved.",
"description": "Specifies whether the sampled points should be grouped by input geometry (default) or be generated as independent points.\n\n* If the sampled points are grouped, the process generates a `MultiPoint` per geometry given which keeps the original identifier.\n* Otherwise, each sampled point is generated as a distinct `Point` geometry with a new identifier.",
m-mohr marked this conversation as resolved.
Show resolved Hide resolved
"optional": true,
"default": true,
"schema": {
Expand Down Expand Up @@ -84,9 +84,6 @@
}
},
"exceptions": {
"CountsMissing": {
"message": "No maximum count is set per geometry and in total."
},
"CountMismatch": {
"message": "The total number of points is lower than the number of geometries."
}
Expand Down
4 changes: 2 additions & 2 deletions proposals/vector_to_regular_points.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"id": "vector_to_regular_points",
"summary": "Sample regular points from geometries",
"description": "Generate a vector data cube of points by sampling regularly-spaced points from input geometries.",
"description": "Generate a vector data cube of points by sampling regularly-spaced points from input geometries. Vector properties are preserved.",
"categories": [
"cubes",
"vector"
Expand Down Expand Up @@ -32,7 +32,7 @@
},
{
"name": "group",
"description": "Specifies whether the sampled points should be grouped by input geometry (default) or be generated as independent points.\n\n* If the sampled points are grouped, the process generates a `MultiPoint` per geometry given. Vector properties are preserved.\n* Otherwise, each sampled point is generated as a distinct `Point` geometry. Vector properties are *not* preserved.",
"description": "Specifies whether the sampled points should be grouped by input geometry (default) or be generated as independent points.\n\n* If the sampled points are grouped, the process generates a `MultiPoint` per geometry given which keeps the original identifier.\n* Otherwise, each sampled point is generated as a distinct `Point` geometry with a new identifier.",
m-mohr marked this conversation as resolved.
Show resolved Hide resolved
"optional": true,
"default": true,
"schema": {
Expand Down