Skip to content

Commit c09a52c

Browse files
m-mohrm-mohr
committed
Update to Vecorel and fiboa 0.3, v0.2.0
1 parent e159034 commit c09a52c

File tree

9 files changed

+72
-125
lines changed

9 files changed

+72
-125
lines changed

‎.github/workflows/test.yaml‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,12 @@ jobs:
88
steps:
99
- uses: actions/setup-python@v5
1010
with:
11-
python-version: '>=3.9'
11+
python-version: '>=3.10'
1212
- uses: actions/checkout@v4
1313
- name: Install pipenv
1414
run: |
1515
pip install pipenv
1616
pipenv install
1717
- run: pipenv run test-docs
1818
- run: pipenv run test-schema
19-
- run: pipenv run test-geojson
20-
- run: pipenv run test-geoparquet
19+
- run: pipenv run test-examples

‎CHANGELOG.md‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,15 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
2727

2828
- ...
2929

30+
## [v0.2.0] - 2025-08-26
31+
32+
- Update to Vecorel and fiboa 0.3
33+
3034
## [v0.1.0] - 2024-03-01
3135

3236
- First release
37+
- Attributes for micd, qa and ca_ratio
3338

34-
### Added
35-
- Readme with description
36-
- Attributes for micd, qa and ca_ratio
37-
38-
[Unreleased]: <https://github.com/fiboa/planet-extension/compare/v0.1.0...main>
39+
[Unreleased]: <https://github.com/fiboa/planet-extension/compare/v0.2.0...main>
40+
[v0.2.0]: <https://github.com/fiboa/planet-extension/compare/v0.1.0...v0.2.0>
3941
[v0.1.0]: <https://github.com/fiboa/planet-extension/tree/v0.1.0>

‎CONTRIBUTING.md‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
# Contributing
22

33
All contributions are subject to the
4-
[fiboa Code of Conduct](https://github.com/fiboa/specification/blob/main/CODE_OF_CONDUCT.md).
5-
For contributions, please follow the
6-
[fiboa contributing guideline](https://github.com/fiboa/specification/blob/main/CONTRIBUTING.md).
4+
[Code of Conduct](https://vecorel.org/code-of-conduct/).
75

86
## Running tests
97

@@ -13,11 +11,12 @@ We use pipenv to execute the tests.
1311
Start with the following command in the folder where this README is located:
1412
`pip install pipenv --user`
1513

14+
Install the dependencies for the test:
15+
`pipenv install`
16+
1617
Finally, you can run the tests as follows:
1718

1819
- To check the markdown run: `pipenv run test-docs`
19-
- To check the fiboa schema run: `pipenv run test-schema`
20-
- To check the examples run:
21-
- `pipenv run test-geojson` for GeoJSON
22-
- `pipenv run test-geoparquet` for GeoParquet
20+
- To check the schema run: `pipenv run test-schema`
21+
- To check the examples run: `pipenv run test-examples`
2322
- To create a GeoParquet from the GeoJSON examples: `pipenv run create-geoparquet`

‎Pipfile‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,11 @@ verify_ssl = true
44
name = "pypi"
55

66
[packages]
7-
fiboa-cli = ">=0.3"
7+
fiboa-cli = ">=0.20.1"
88
pymarkdownlnt = ">=0.9"
99

1010
[scripts]
1111
test-docs = "pymarkdown -d md024,md013 scan ."
1212
test-schema = "fiboa validate-schema schema/schema.yaml"
13-
test-geojson = "fiboa validate examples/geojson -e https://fiboa.github.io/planet-extension/v0.1.0/schema.yaml,schema/schema.yaml --data"
14-
test-geoparquet = "fiboa validate examples/geoparquet -e https://fiboa.github.io/planet-extension/v0.1.0/schema.yaml,schema/schema.yaml --data"
15-
create-geoparquet = "fiboa create-geoparquet examples/geojson -o examples/geoparquet/example.parquet -c examples/geojson/collection.json -e https://fiboa.github.io/planet-extension/v0.1.0/schema.yaml,schema/schema.yaml"
13+
test-examples = "fiboa validate examples/geojson examples/geoparquet -s https://fiboa.org/planet-extension/v0.2.0/schema.yaml,schema/schema.yaml -n -1"
14+
create-geoparquet = "fiboa create-geoparquet examples/geojson -o examples/geoparquet/example.parquet -s https://fiboa.org/planet-extension/v0.2.0/schema.yaml,schema/schema.yaml"

‎README.md‎

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
# Planet Field Boundary Extension Specification
22

33
- **Title:** Planet Field Boundary
4-
- **Identifier:** <https://fiboa.github.io/planet-extension/v0.1.0/schema.yaml>
4+
- **Identifier:** <https://fiboa.org/planet-extension/v0.2.0/schema.yaml>
55
- **Property Name Prefix:** planet
66
- **Extension Maturity Classification:** Proposal
77
- **Owner**: @cholmes
88

99
This document explains the Planet Field Boundary Extension to the
10-
[Field Boundaries for Agriculture (fiboa) Specification](https://github.com/fiboa/specification).
10+
[Field Boundaries for Agriculture (fiboa)](https://fiboa.org) and
11+
[Vecorel](https://vecorel.org) specifications.
1112

1213
Planet produces fully automated field boundaries from satellite imagery for anywhere on earth. The full
1314
[technical specification](https://planet.widen.net/s/5vq8w5wjvf/2403.08_mar-9444-field-boundaries-technical-specification-sheet-3) explains all
@@ -24,16 +25,11 @@ Any Planet field boundary output can be converted with `fiboa convert planet_afb
2425

2526
## Properties
2627

27-
The properties in the table below can be used in these parts of fiboa documents:
28-
29-
- [ ] Collection
30-
- [x] Feature Properties
31-
32-
| Property Name | Type | Description |
33-
| --------------- | ------ | ----------- |
34-
| planet:micd | float | **REQUIRED** Maximum Inscribed Circle Diameter (MICD) is an intuitive proxy for the width of a field, even in case of rotated and narrow-but-curved fields. |
35-
| planet:ca_ratio | float | **REQUIRED** The Circumference-Area ratio (CA ratio) is calculated by dividing the circumference of a given polygon by the square root of its area. This ratio is then adjusted so that a circle corresponds to 0, and scaled so that a square corresponds to 1 |
36-
| planet:qa | uint8 | **REQUIRED** Quality Assessment attribute, either 0 (good, micd > 30m), 1 (quality not guaranteed, micd < 30m) or 2 (polygons intersecting data availability grid) |
28+
| Property Name | Type | Description |
29+
| --------------- | ----- | ----------- |
30+
| planet:micd | float | **REQUIRED** Maximum Inscribed Circle Diameter (MICD) is an intuitive proxy for the width of a field, even in case of rotated and narrow-but-curved fields. |
31+
| planet:ca_ratio | float | **REQUIRED** The Circumference-Area ratio (CA ratio) is calculated by dividing the circumference of a given polygon by the square root of its area. This ratio is then adjusted so that a circle corresponds to 0, and scaled so that a square corresponds to 1 |
32+
| planet:qa | uint8 | **REQUIRED** Quality Assessment attribute, either 0 (good, micd > 30m), 1 (quality not guaranteed, micd < 30m) or 2 (polygons intersecting data availability grid) |
3733

3834
### planet:mcid
3935

@@ -72,9 +68,9 @@ The ‘qa’ attribute presents three values:
7268

7369
| Value | Description |
7470
| ----- | ------------|
75-
| 0 | Polygons for which the validation scores are representative, i.e. with MICD > 30 m. |
76-
| 1 | Polygons for which the validation scores are not representative, i.e. with MICD < 30 m. The quality for these polygons cannot be guaranteed. |
77-
| 2 | Polygons that are intersecting the border of the data availability grid |
71+
| 0 | Polygons for which the validation scores are representative, i.e. with MICD > 30 m. |
72+
| 1 | Polygons for which the validation scores are not representative, i.e. with MICD < 30 m. The quality for these polygons cannot be guaranteed. |
73+
| 2 | Polygons that are intersecting the border of the data availability grid |
7874

7975
The provided example illustrates four types of polygons. Polygons outside of the AOI are removed from the output. The remaining ones (depicted with solid and diagonal
8076
fill) intersect with the AOI and are therefore kept in the output. Polygons that are intersecting the border of the data availability grid are also kept in the output and are

‎examples/geojson/collection.json‎

Lines changed: 0 additions & 6 deletions
This file was deleted.

‎examples/geojson/example.json‎

Lines changed: 42 additions & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -1,87 +1,45 @@
11
{
2-
"fiboa":
2+
"schemas": {
3+
"planet": [
4+
"https://vecorel.org/specification/v0.1.0/schema.yaml",
5+
"https://fiboa.org/specification/v0.3.0/schema.yaml",
6+
"https://fiboa.org/planet-extension/v0.2.0/schema.yaml",
7+
"https://vecorel.org/geometry-metrics-extension/v0.1.0/schema.yaml"
8+
]
9+
},
10+
"type": "FeatureCollection",
11+
"features": [
312
{
4-
"fiboa_version": "0.2.0",
5-
"fiboa_extensions":
6-
[
7-
"https://fiboa.github.io/planet-extension/v0.1.0/schema.yaml"
13+
"type": "Feature",
14+
"geometry": {
15+
"type": "Polygon",
16+
"coordinates": [
17+
[
18+
[-3.337705, 6.375312],
19+
[-3.337723, 6.375191],
20+
[-3.337743, 6.375161],
21+
[-3.337688, 6.375059],
22+
[-3.337636, 6.375006],
23+
[-3.337572, 6.375003],
24+
[-3.337369, 6.37529],
25+
[-3.337374, 6.375358],
26+
[-3.337434, 6.375417],
27+
[-3.337591, 6.375469],
28+
[-3.337705, 6.375312]
29+
]
830
]
9-
},
10-
"type": "FeatureCollection",
11-
"features":
12-
[
13-
{
14-
"type": "Feature",
15-
"geometry":
16-
{
17-
"type": "Polygon",
18-
"coordinates":
19-
[
20-
[
21-
[
22-
-3.337705,
23-
6.375312
24-
],
25-
[
26-
-3.337723,
27-
6.375191
28-
],
29-
[
30-
-3.337743,
31-
6.375161
32-
],
33-
[
34-
-3.337688,
35-
6.375059
36-
],
37-
[
38-
-3.337636,
39-
6.375006
40-
],
41-
[
42-
-3.337572,
43-
6.375003
44-
],
45-
[
46-
-3.337369,
47-
6.37529
48-
],
49-
[
50-
-3.337374,
51-
6.375358
52-
],
53-
[
54-
-3.337434,
55-
6.375417
56-
],
57-
[
58-
-3.337591,
59-
6.375469
60-
],
61-
[
62-
-3.337705,
63-
6.375312
64-
]
65-
]
66-
]
67-
},
68-
"properties":
69-
{
70-
"area": 0.13337578,
71-
"planet:ca_ratio": 0.6967705,
72-
"determination_datetime": "2023-01-01T00:00:00Z",
73-
"determination_method": "auto-imagery",
74-
"planet:micd": 31.412167,
75-
"planet:qa": 0
76-
},
77-
"id": "30",
78-
"bbox":
79-
[
80-
-3.337743,
81-
6.375003,
82-
-3.337369,
83-
6.375469
84-
]
85-
}
86-
]
87-
}
31+
},
32+
"properties": {
33+
"collection": "planet",
34+
"metrics:area": 1333.7578,
35+
"determination:datetime": "2023-01-01T00:00:00Z",
36+
"determination:method": "auto-imagery",
37+
"planet:ca_ratio": 0.6967705,
38+
"planet:micd": 31.412167,
39+
"planet:qa": 0
40+
},
41+
"id": "30",
42+
"bbox": [-3.337743, 6.375003, -3.337369, 6.375469]
43+
}
44+
]
45+
}

‎examples/geoparquet/example.parquet‎

1.33 KB
Binary file not shown.

‎schema/schema.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
$schema: https://fiboa.github.io/schema/v0.1.0/schema.json
1+
$schema: https://vecorel.org/sdl/v0.2.0/schema.json
22
required:
33
- planet:micd
44
- planet:ca_ratio

0 commit comments

Comments
 (0)