11
11
This document explains the fields of the Synthetic-Aperture Radar (SAR) Extension to the
12
12
[ SpatioTemporal Asset Catalog] ( https://github.com/radiantearth/stac-spec ) (STAC) specification.
13
13
14
- SAR data is considered to be data that represents a snapshot of the earth for a single date and time taken by a synthetic-aperture radar system
14
+ SAR data is considered to be data that represents a snapshot of the earth for a single date and time taken by a synthetic-aperture radar system
15
15
such as Sentinel-1, RADARSAT or EnviSAT.
16
16
17
- If the data has been collected by a satellite, it is strongly recommended to use the
18
- [ ` sat ` extension] ( https://github.com/stac-extensions/sat ) .
19
- If the data has been collected on an airborne platform it is strongly recommended to use the
17
+ If the data has been collected by a satellite, it is strongly recommended to use the
18
+ [ ` sat ` extension] ( https://github.com/stac-extensions/sat ) .
19
+ If the data has been collected on an airborne platform it is strongly recommended to use the
20
20
[ Instrument Fields] ( https://github.com/radiantearth/stac-spec/blob/master/item-spec/common-metadata.md#instrument ) .
21
21
22
22
To describe frame start and end times, use the
@@ -50,7 +50,7 @@ To describe frame start and end times, use the
50
50
| sar: relative_burst | number | Identification number that uniquely identifies a burst cycle within each repeat cycle. |
51
51
| sar: beam_ids | \[ string] | Composition of the swath of the SAR acquision referencing the beam identifiers. |
52
52
53
- ** Note:** In this specification * range* values are meant to be measured perpendicular to the flight path and * azimuth* values
53
+ ** Note:** In this specification * range* values are meant to be measured perpendicular to the flight path and * azimuth* values
54
54
are meant to be measured parallel to the flight path.
55
55
56
56
### Additional Field Information
@@ -62,13 +62,13 @@ Specifies a single polarization or a polarization combination. For single polari
62
62
For dual polarized radars and alternating polarization, add the corresponding polarizations to the array.
63
63
For instance, for ` HH+HV ` , add both ` HH ` and ` HV ` .
64
64
65
- ** Important:** In the ` properties ` of a STAC Item ` sar:polarizations ` must be a set with unique elements.
65
+ ** Important:** In the ` properties ` of a STAC Item ` sar:polarizations ` must be a set with unique elements.
66
66
In assets ` sar:polarizations ` can contain duplicate elements and, if possible, the polarizations must appear in the same order as in the file.
67
67
68
68
#### sar: beam_ids
69
69
70
70
The ` sar:beam_ids ` field is used to reference the beam identifiers of the SAR acquisition. According to the mission and the sensor mode,
71
- the beam identifiers can be used to identify the composition of the swath of the SAR acquisition.
71
+ the beam identifiers can be used to identify the composition of the swath of the SAR acquisition.
72
72
The beam identifiers are usually provided in the metadata of the SAR data.
73
73
74
74
### Common Frequency Band Names
@@ -104,12 +104,13 @@ A list of suggestions for [`product:type`](https://github.com/stac-extensions/pr
104
104
| SLC | complex | Single-look Ground projected Complex image (used by Sentinel-1) |
105
105
106
106
This can vary by data provider, who all may use slightly different names.
107
- Sentinel-1 for instance uses ` GRD ` , which is the same as the more general ` MGD ` and ` SLC ` instead of ` SGC ` .
107
+ Sentinel-1 for instance uses ` GRD ` , which is the same as the more general ` MGD ` and ` SLC ` instead of ` SGC ` .
108
108
109
- ** Note:**
110
- - v1.0 of the extension did require ` sar:product_type ` .
111
- - v1.1 deprecates ` sar:product_type ` and it's not required any longer, but ` product:type ` is ** strongly recommended** .
112
- - v2.0 will require ` product:type ` as part of this extension and remove ` sar:product_type ` .
109
+ > [ !NOTE]
110
+ >
111
+ > - v1.0 of the extension did require ` sar:product_type ` .
112
+ > - v1.1 deprecates ` sar:product_type ` and it's not required any longer, but ` product:type ` is ** strongly recommended** .
113
+ > - v2.0 will require ` product:type ` as part of this extension and remove ` sar:product_type ` .
113
114
114
115
### Date and Time
115
116
@@ -147,23 +148,26 @@ for running tests are copied here for convenience.
147
148
148
149
### Running tests
149
150
150
- The same checks that run as checks on PR's are part of the repository and can be run locally to verify that changes are valid.
151
+ The same checks that run as checks on PR's are part of the repository and can be run locally to verify that changes are valid.
151
152
To run tests locally, you'll need ` npm ` , which is a standard part of any [ node.js installation] ( https://nodejs.org/en/download/ ) .
152
153
153
- First you'll need to install everything with npm once. Just navigate to the root of this repository and on
154
+ First you'll need to install everything with npm once. Just navigate to the root of this repository and on
154
155
your command line run:
156
+
155
157
``` bash
156
158
npm install
157
159
```
158
160
159
161
Then to check markdown formatting and test the examples against the JSON schema, you can run:
162
+
160
163
``` bash
161
164
npm test
162
165
```
163
166
164
167
This will spit out the same texts that you see online, and you can then go and fix your markdown or examples.
165
168
166
169
If the tests reveal formatting problems with the examples, you can fix them with:
170
+
167
171
``` bash
168
172
npm run format-examples
169
173
```
0 commit comments