Skip to content

Commit c3dbd99

Browse files
committed
Revert altimetry changes (#25)
1 parent 2f793b4 commit c3dbd99

File tree

6 files changed

+7
-33
lines changed

6 files changed

+7
-33
lines changed

CHANGELOG.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1212
### Added
1313

1414
- Added `LH`, `LV`, `RH`, `RV`, `CH` and `CV` enumerations to `sar:polarizations` to support compact polarization.
15-
- Best practices for `altm:instrument_mode` and `altm:instrument_type`
1615

1716
### Changed
1817

1918
- Required fields are recommended.
2019
- Clarified the scope of the fields.
2120

22-
### Deprecated
23-
24-
- `sar:instrument_mode` in favor of `altm:instrument_mode`
25-
2621
### Fixed
2722

2823
- Fixed and updated examples

README.md

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,6 @@ If the data has been collected by a satellite, it is recommended to use the
1818
[Satellite extension](https://github.com/stac-extensions/sat).
1919
If the data has been collected on an airborne platform it is recommended to use the
2020
[Instrument Fields](https://github.com/radiantearth/stac-spec/blob/master/item-spec/common-metadata.md#instrument).
21-
In both cases the instrument details should be provided using the
22-
[Altimetry extension](https://github.com/stac-extensions/altimetry)
2321

2422
To describe frame start and end times, use the
2523
[Date and Time Range fields](https://github.com/radiantearth/stac-spec/blob/master/item-spec/common-metadata.md#date-and-time-range).
@@ -52,6 +50,7 @@ The fields in the table below can be used in these parts of STAC documents:
5250
| Field Name | Type | Description |
5351
| --------------------------- | --------- | ----------- |
5452
| sar:polarizations | \[string] | RECOMMENDED. Any combination of polarizations. |
53+
| sar:instrument_mode | string | RECOMMENDED. The name of the sensor acquisition mode that is commonly used. This should be the short name, if available. For example, `WV` for "Wave mode" of Sentinel-1 and Envisat ASAR satellites. |
5554
| sar:frequency_band | string | RECOMMENDED. The common name for the frequency band to make it easier to search for bands across instruments. See section "Common Frequency Band Names" for a list of accepted names. |
5655
| sar:center_frequency | number | RECOMMENDED. The center frequency of the instrument, in gigahertz (GHz). |
5756
| sar:resolution_range | number | The range resolution, which is the maximum ability to distinguish two adjacent targets perpendicular to the flight path, in meters (m). |
@@ -65,16 +64,13 @@ The fields in the table below can be used in these parts of STAC documents:
6564
| sar:relative_burst | number | Identification number that uniquely identifies a burst cycle within each repeat cycle. |
6665
| sar:beam_ids | \[string] | Composition of the swath of the SAR acquision referencing the beam identifiers. |
6766
| sar:product_type | string | ***DEPRECATED** in favor of [`product:type`](https://github.com/stac-extensions/product).* See [Product type](#product-type). |
68-
| sar:instrument_mode | string | ***DEPRECATED** in favor of [`altm:instrument_mode`](https://github.com/stac-extensions/altimetry).* See [Instrument details](#instrument-details). |
6967

7068
> \[!CAUTION]
7169
>
72-
> - v1.0 of the extension did require `sar:product_type` and `sar:instrument_mode`.
70+
> - v1.0 of the extension did require `sar:product_type`.
7371
> - v1.1 deprecates `sar:product_type` and it's not required any longer, but
7472
> [`product:type`](https://github.com/stac-extensions/product) is **strongly recommended**.
75-
> - v1.2 deprecates `sar:instrument_mode` and it's not required any longer, but
76-
> [`altm:instrument_mode` and `altm:instrument_type`](https://github.com/stac-extensions/altimetry) are **strongly recommended**.
77-
> - v2.0 is going to remove `sar:product_type` and `sar:instrument_mode`.
73+
> - v2.0 is going to remove `sar:product_type`.
7874
7975
### Additional Field Information
8076

@@ -134,15 +130,6 @@ A list of suggestions for [`product:type`](https://github.com/stac-extensions/pr
134130
This can vary by data provider, who all may use slightly different names.
135131
Sentinel-1 for instance uses `GRD`, which is the same as the more general `MGD` and `SLC` instead of `SGC`.
136132

137-
### Instrument details
138-
139-
The instrument type and mode can be provided using the [Altimetry Extension](https://github.com/stac-extensions/altimetry):
140-
141-
- `altm:instrument_type`: RECOMMENDED. The instrument type, must be set to `sar`,
142-
- `altm:instrument_mode`: RECOMMENDED. The name of the sensor acquisition mode that is commonly used.
143-
This should be the short name, if available.
144-
For example, `WV` for "Wave mode" of Sentinel-1 and Envisat ASAR satellites.
145-
146133
### Date and Time
147134

148135
In SAR, you usually have frame start and end time. To describe this information it is recommended to use the [Date and Time Range fields](https://github.com/radiantearth/stac-spec/blob/master/item-spec/common-metadata.md#date-and-time-range).

examples/envisat.json

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
"stac_version": "1.0.0",
44
"stac_extensions": [
55
"https://stac-extensions.github.io/sar/v1.2.0/schema.json",
6-
"https://stac-extensions.github.io/altimetry/v0.1.0/schema.json",
76
"https://stac-extensions.github.io/product/v0.1.0/schema.json"
87
],
98
"id": "sar-envisat-example",
@@ -27,8 +26,7 @@
2726
"sar:looks_azimuth": 4,
2827
"sar:frequency_band": "C",
2928
"sar:center_frequency": 5.331,
30-
"altm:instrument_type": "sar",
31-
"altm:instrument_mode": "GM",
29+
"sar:instrument_mode": "GM",
3230
"product:type": "GM1_1P"
3331
},
3432
"geometry": {

examples/sentinel-1-grd-ew.json

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
"stac_version": "1.0.0",
44
"stac_extensions": [
55
"https://stac-extensions.github.io/sar/v1.2.0/schema.json",
6-
"https://stac-extensions.github.io/altimetry/v0.1.0/schema.json",
76
"https://stac-extensions.github.io/product/v0.1.0/schema.json"
87
],
98
"id": "sentinel-1-example",
@@ -31,8 +30,7 @@
3130
"sar:beam_ids": [
3231
"EW"
3332
],
34-
"altm:instrument_type": "sar",
35-
"altm:instrument_mode": "EW",
33+
"sar:instrument_mode": "EW",
3634
"product:type": "GRD"
3735
},
3836
"geometry": {

examples/sentinel-1-grd-s4.json

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
"stac_version": "1.0.0",
44
"stac_extensions": [
55
"https://stac-extensions.github.io/sar/v1.2.0/schema.json",
6-
"https://stac-extensions.github.io/altimetry/v0.1.0/schema.json",
76
"https://stac-extensions.github.io/processing/v1.2.0/schema.json",
87
"https://stac-extensions.github.io/product/v0.1.0/schema.json",
98
"https://stac-extensions.github.io/sat/v1.0.0/schema.json"
@@ -52,8 +51,7 @@
5251
"instruments": [
5352
"SAR"
5453
],
55-
"altm:instrument_type": "sar",
56-
"altm:instrument_mode": "SM",
54+
"sar:instrument_mode": "SM",
5755
"processing:datetime": "2024-05-31T11:25:04.541000Z",
5856
"processing:level": "L1",
5957
"processing:facility": "Production Service-SERCO",

examples/sentinel-1-slc-iw.json

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44
"stac_extensions": [
55
"https://stac-extensions.github.io/sar/v1.2.0/schema.json",
66
"https://stac-extensions.github.io/alternate-assets/v1.1.0/schema.json",
7-
"https://stac-extensions.github.io/altimetry/v0.1.0/schema.json",
87
"https://stac-extensions.github.io/storage/v1.0.0/schema.json"
98
],
109
"id": "S1A_IW_SLC__1SDV_20240618T173936_20240618T174003_054381_069DC0_C1A4.SAFE",
@@ -45,8 +44,7 @@
4544
"datetime": "2024-06-18T17:39:36.336Z",
4645
"end_datetime": "2024-06-18T17:40:03.297Z",
4746
"start_datetime": "2024-06-18T17:39:36.336Z",
48-
"altm:instrument_type": "sar",
49-
"altm:instrument_mode": "IW",
47+
"sar:instrument_mode": "IW",
5048
"processing:datetime": "2024-06-18T18:24:17.837861Z",
5149
"processing:level": "L1",
5250
"processing:facility": "Production Service-SERCO",

0 commit comments

Comments
 (0)