dist-s1-enumerator 1.0.8__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- dist_s1_enumerator/__init__.py +57 -0
- dist_s1_enumerator/asf.py +328 -0
- dist_s1_enumerator/constants.py +50 -0
- dist_s1_enumerator/data/jpl_burst_geo.parquet +0 -0
- dist_s1_enumerator/data/mgrs.parquet +0 -0
- dist_s1_enumerator/data/mgrs_burst_lookup_table.parquet +0 -0
- dist_s1_enumerator/dist_enum.py +425 -0
- dist_s1_enumerator/dist_enum_inputs.py +138 -0
- dist_s1_enumerator/exceptions.py +2 -0
- dist_s1_enumerator/mgrs_burst_data.py +170 -0
- dist_s1_enumerator/param_models.py +100 -0
- dist_s1_enumerator/py.typed +0 -0
- dist_s1_enumerator/rtc_s1_io.py +142 -0
- dist_s1_enumerator/tabular_models.py +91 -0
- dist_s1_enumerator-1.0.8.dist-info/METADATA +295 -0
- dist_s1_enumerator-1.0.8.dist-info/RECORD +19 -0
- dist_s1_enumerator-1.0.8.dist-info/WHEEL +5 -0
- dist_s1_enumerator-1.0.8.dist-info/licenses/LICENSE +202 -0
- dist_s1_enumerator-1.0.8.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1,295 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: dist-s1-enumerator
|
|
3
|
+
Version: 1.0.8
|
|
4
|
+
Summary: Enumeration and ops library for the OPERA DIST-S1 project
|
|
5
|
+
Author-email: "Richard West, Charlie Marshak, Talib Oliver-Cabrera, and Jungkyo Jung" <charlie.z.marshak@jpl.nasa.gov>
|
|
6
|
+
License: Apache-2.0
|
|
7
|
+
Project-URL: Homepage, https://github.com/opera-adt/dist-s1-enumerator
|
|
8
|
+
Project-URL: Bug Tracker, https://github.com/opera-adt/dist-s1-enumerator/issues
|
|
9
|
+
Project-URL: Discussions, https://github.com/opera-adt/dist-s1-enumerator/discussions
|
|
10
|
+
Project-URL: Changelog, https://github.com/opera-adt/dist-s1-enumerator/releases
|
|
11
|
+
Classifier: Intended Audience :: Developers
|
|
12
|
+
Classifier: Intended Audience :: Science/Research
|
|
13
|
+
Classifier: Programming Language :: Python :: 3
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
16
|
+
Classifier: Programming Language :: Python
|
|
17
|
+
Classifier: Topic :: Scientific/Engineering
|
|
18
|
+
Requires-Python: >=3.12
|
|
19
|
+
Description-Content-Type: text/markdown
|
|
20
|
+
License-File: LICENSE
|
|
21
|
+
Requires-Dist: numpy
|
|
22
|
+
Dynamic: license-file
|
|
23
|
+
|
|
24
|
+
# dist-s1-enumerator
|
|
25
|
+
|
|
26
|
+
[](https://pypi.python.org/pypi/dist-s1-enumerator/)
|
|
27
|
+
[](https://pypi.python.org/pypi/dist-s1-enumerator/)
|
|
28
|
+
[](https://pypi.python.org/pypi/dist-s1-enumerator/)
|
|
29
|
+
[](https://anaconda.org/conda-forge/dist_s1_enumerator)
|
|
30
|
+
[](https://anaconda.org/conda-forge/dist_s1_enumerator)
|
|
31
|
+
|
|
32
|
+
This is a Python library for enumerating OPERA RTC-S1 inputs necessary for the creation of OPERA DIST-S1 products.
|
|
33
|
+
The library can enumerate inputs for the creation of a single DIST-S1 product or a time-series of DIST-S1 products over a large area spanning multiple passes.
|
|
34
|
+
The DIST-S1 measures disturbance comparing a baseline of RTC-S1 images (pre-images) to a current set of acquisition images (post-images).
|
|
35
|
+
This library also provides functionality for downloading the OPERA RTC-S1 data from ASF DAAC.
|
|
36
|
+
We use "enumeration" to describe the "curation of required DIST-S1 inputs."
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
## Installation/Setup
|
|
40
|
+
|
|
41
|
+
We recommend managing dependencies and virutal environments using [mamba/conda](https://mamba.readthedocs.io/en/latest/user_guide/installation.html).
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
mamba update -f environment.yml # creates a new environment dist-s1-enumerator
|
|
45
|
+
conda activate dist-s1-enumerator
|
|
46
|
+
pip install dist-s1-enumerator
|
|
47
|
+
python -m ipykernel install --user --name dist-s1-enumerator
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
### Downloading data
|
|
51
|
+
|
|
52
|
+
For searching through the metadata of OPERA RTC-S1, you will not need any earthdata credentials.
|
|
53
|
+
For downloading data from the ASF DAAC, you will need to make sure you have a Earthdata credentials (see: https://urs.earthdata.nasa.gov/) and successfully accepted the ASF terms of use (this can be checked by downloading any product at the ASF DAAC using your Earthdata credentials: https://search.asf.alaska.edu/).
|
|
54
|
+
You will need to create or append to `~/.netrc` file with these credentials:
|
|
55
|
+
```
|
|
56
|
+
machine urs.earthdata.nasa.gov
|
|
57
|
+
login <your_username>
|
|
58
|
+
password <your_password>
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
### Development installation
|
|
62
|
+
|
|
63
|
+
Same as above replacing `pip install dist-s1-enumerator` with `pip install -e .`.
|
|
64
|
+
|
|
65
|
+
## Usage
|
|
66
|
+
|
|
67
|
+
### Motivation
|
|
68
|
+
|
|
69
|
+
We want to generate a DIST-S1 product using [dist-s1](https://github.com/opera-adt/dist-s1). We successfully installed the software, but don't know how to call the CLI:
|
|
70
|
+
|
|
71
|
+
```
|
|
72
|
+
dist-s1 run \
|
|
73
|
+
--mgrs_tile_id '19HBD' \
|
|
74
|
+
--post_date '2024-03-28' \
|
|
75
|
+
--track_number 91
|
|
76
|
+
```
|
|
77
|
+
Where do these inputs come from? Can we get them without looking up RTC-S1 products manually? Of course! That's the point of this library.
|
|
78
|
+
|
|
79
|
+
### Triggering the DIST-S1 Workflow
|
|
80
|
+
|
|
81
|
+
Each DIST-S1 product is uniquely identified in space and time by:
|
|
82
|
+
|
|
83
|
+
1. an MGRS Tile ID
|
|
84
|
+
2. a Track Number of Sentinel-1
|
|
85
|
+
3. the post-image acquisition time (within 1 day)
|
|
86
|
+
|
|
87
|
+
These pieces of information are required to generate any given DIST-S1 product.
|
|
88
|
+
Identifying all such products over time (acceptable times of the post-image) and space (MGRS tiles) allows us to enumerate all DIST-S1 products.
|
|
89
|
+
We can enumerate DIST-S1 products with this library as follows:
|
|
90
|
+
```
|
|
91
|
+
from dist_s1_enumerator import enumerate_dist_s1_workflow_inputs
|
|
92
|
+
|
|
93
|
+
workflow_inputs = enumerate_dist_s1_workflow_inputs(mgrs_tile_ids='19HBD',
|
|
94
|
+
track_numbers=None,
|
|
95
|
+
start_acq_dt='2023-11-01',
|
|
96
|
+
stop_acq_dt='2024-04-01')
|
|
97
|
+
```
|
|
98
|
+
Yields:
|
|
99
|
+
<details>
|
|
100
|
+
<summary>Output</summary>
|
|
101
|
+
|
|
102
|
+
```[{'mgrs_tile_id': '19HBD', 'post_acq_date': '2023-11-05', 'track_number': 91},
|
|
103
|
+
{'mgrs_tile_id': '19HBD', 'post_acq_date': '2023-11-10', 'track_number': 156},
|
|
104
|
+
{'mgrs_tile_id': '19HBD', 'post_acq_date': '2023-11-12', 'track_number': 18},
|
|
105
|
+
{'mgrs_tile_id': '19HBD', 'post_acq_date': '2023-11-17', 'track_number': 91},
|
|
106
|
+
{'mgrs_tile_id': '19HBD', 'post_acq_date': '2023-11-22', 'track_number': 156},
|
|
107
|
+
{'mgrs_tile_id': '19HBD', 'post_acq_date': '2023-11-24', 'track_number': 18},
|
|
108
|
+
{'mgrs_tile_id': '19HBD', 'post_acq_date': '2023-12-04', 'track_number': 156},
|
|
109
|
+
{'mgrs_tile_id': '19HBD', 'post_acq_date': '2023-12-06', 'track_number': 18},
|
|
110
|
+
{'mgrs_tile_id': '19HBD', 'post_acq_date': '2023-12-11', 'track_number': 91},
|
|
111
|
+
{'mgrs_tile_id': '19HBD', 'post_acq_date': '2023-12-16', 'track_number': 156},
|
|
112
|
+
{'mgrs_tile_id': '19HBD', 'post_acq_date': '2023-12-18', 'track_number': 18},
|
|
113
|
+
{'mgrs_tile_id': '19HBD', 'post_acq_date': '2023-12-23', 'track_number': 91},
|
|
114
|
+
{'mgrs_tile_id': '19HBD', 'post_acq_date': '2023-12-28', 'track_number': 156},
|
|
115
|
+
{'mgrs_tile_id': '19HBD', 'post_acq_date': '2023-12-30', 'track_number': 18},
|
|
116
|
+
{'mgrs_tile_id': '19HBD', 'post_acq_date': '2024-01-04', 'track_number': 91},
|
|
117
|
+
{'mgrs_tile_id': '19HBD', 'post_acq_date': '2024-01-09', 'track_number': 156},
|
|
118
|
+
{'mgrs_tile_id': '19HBD', 'post_acq_date': '2024-01-11', 'track_number': 18},
|
|
119
|
+
{'mgrs_tile_id': '19HBD', 'post_acq_date': '2024-01-16', 'track_number': 91},
|
|
120
|
+
{'mgrs_tile_id': '19HBD', 'post_acq_date': '2024-01-21', 'track_number': 156},
|
|
121
|
+
{'mgrs_tile_id': '19HBD', 'post_acq_date': '2024-01-23', 'track_number': 18},
|
|
122
|
+
{'mgrs_tile_id': '19HBD', 'post_acq_date': '2024-01-28', 'track_number': 91},
|
|
123
|
+
{'mgrs_tile_id': '19HBD', 'post_acq_date': '2024-02-02', 'track_number': 156},
|
|
124
|
+
{'mgrs_tile_id': '19HBD', 'post_acq_date': '2024-02-04', 'track_number': 18},
|
|
125
|
+
{'mgrs_tile_id': '19HBD', 'post_acq_date': '2024-02-09', 'track_number': 91},
|
|
126
|
+
{'mgrs_tile_id': '19HBD', 'post_acq_date': '2024-02-14', 'track_number': 156},
|
|
127
|
+
{'mgrs_tile_id': '19HBD', 'post_acq_date': '2024-02-16', 'track_number': 18},
|
|
128
|
+
{'mgrs_tile_id': '19HBD', 'post_acq_date': '2024-02-21', 'track_number': 91},
|
|
129
|
+
{'mgrs_tile_id': '19HBD', 'post_acq_date': '2024-02-26', 'track_number': 156},
|
|
130
|
+
{'mgrs_tile_id': '19HBD', 'post_acq_date': '2024-02-28', 'track_number': 18},
|
|
131
|
+
{'mgrs_tile_id': '19HBD', 'post_acq_date': '2024-03-04', 'track_number': 91},
|
|
132
|
+
{'mgrs_tile_id': '19HBD', 'post_acq_date': '2024-03-09', 'track_number': 156},
|
|
133
|
+
{'mgrs_tile_id': '19HBD', 'post_acq_date': '2024-03-11', 'track_number': 18},
|
|
134
|
+
{'mgrs_tile_id': '19HBD', 'post_acq_date': '2024-03-16', 'track_number': 91},
|
|
135
|
+
{'mgrs_tile_id': '19HBD', 'post_acq_date': '2024-03-21', 'track_number': 156},
|
|
136
|
+
{'mgrs_tile_id': '19HBD', 'post_acq_date': '2024-03-23', 'track_number': 18},
|
|
137
|
+
{'mgrs_tile_id': '19HBD', 'post_acq_date': '2024-03-28', 'track_number': 91}]
|
|
138
|
+
```
|
|
139
|
+
</details>
|
|
140
|
+
Each dictionary uniquely determines a DIST-S1 product.
|
|
141
|
+
In fact, the list above is a complete account of all DIST-S1 products over this MGRS tile and during this time period.
|
|
142
|
+
We can use any of the dictionaries in the list to trigger the DIST-S1 workflow e.g. using the last dictionary in the list above:
|
|
143
|
+
|
|
144
|
+
```
|
|
145
|
+
dist-s1 run \
|
|
146
|
+
--mgrs_tile_id '19HBD' \
|
|
147
|
+
--post_date '2024-03-28' \
|
|
148
|
+
--track_number 91
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
See the [dist-s1](https://github.com/opera-adt/dist-s1) repository for more details on the `dist-s1` usage and workflow.
|
|
152
|
+
|
|
153
|
+
### Obtaining RTC-S1 Inputs for a given DIST-S1 product
|
|
154
|
+
|
|
155
|
+
In addition to figuring out the relevant information to trigger the DIST-S1 workflow, we can query NASA's Common Metadata Repository to identify all RTC-S1 products required to create this DIST-S1 product that are used in the workflow.
|
|
156
|
+
This is done above, except we only save information required to trigger the actual DIST-S1 worklow.
|
|
157
|
+
Here is an example to get the full account of the necessary RTC-S1 input products for a given set of DIST-S1 workflow inputs:
|
|
158
|
+
```
|
|
159
|
+
from dist_s1_enumerator import enumerate_one_dist_s1_product
|
|
160
|
+
|
|
161
|
+
df_product_t91 = enumerate_one_dist_s1_product('20TLP', track_number=[91], post_date='2025-09-25')
|
|
162
|
+
df_product_t91.head()
|
|
163
|
+
```
|
|
164
|
+
<details>
|
|
165
|
+
<summary>Output</summary>
|
|
166
|
+
|
|
167
|
+
```opera_id jpl_burst_id \
|
|
168
|
+
0 OPERA_L2_RTC-S1_T091-193570-IW3_20240807T22192... T091-193570-IW3
|
|
169
|
+
1 OPERA_L2_RTC-S1_T091-193570-IW3_20240819T22192... T091-193570-IW3
|
|
170
|
+
2 OPERA_L2_RTC-S1_T091-193570-IW3_20240831T22192... T091-193570-IW3
|
|
171
|
+
3 OPERA_L2_RTC-S1_T091-193570-IW3_20240912T22192... T091-193570-IW3
|
|
172
|
+
4 OPERA_L2_RTC-S1_T091-193570-IW3_20240924T22192... T091-193570-IW3
|
|
173
|
+
|
|
174
|
+
acq_dt acq_date_for_mgrs_pass polarizations \
|
|
175
|
+
0 2024-08-07 22:19:28+00:00 2024-08-07 VV+VH
|
|
176
|
+
1 2024-08-19 22:19:28+00:00 2024-08-19 VV+VH
|
|
177
|
+
2 2024-08-31 22:19:28+00:00 2024-08-31 VV+VH
|
|
178
|
+
3 2024-09-12 22:19:29+00:00 2024-09-12 VV+VH
|
|
179
|
+
4 2024-09-24 22:19:29+00:00 2024-09-24 VV+VH
|
|
180
|
+
|
|
181
|
+
track_number pass_id url_crosspol \
|
|
182
|
+
0 91 645 https://cumulus.asf.earthdatacloud.nasa.gov/OP...
|
|
183
|
+
1 91 647 https://cumulus.asf.earthdatacloud.nasa.gov/OP...
|
|
184
|
+
2 91 649 https://cumulus.asf.earthdatacloud.nasa.gov/OP...
|
|
185
|
+
3 91 651 https://cumulus.asf.earthdatacloud.nasa.gov/OP...
|
|
186
|
+
4 91 653 https://cumulus.asf.earthdatacloud.nasa.gov/OP...
|
|
187
|
+
|
|
188
|
+
url_copol \
|
|
189
|
+
0 https://cumulus.asf.earthdatacloud.nasa.gov/OP...
|
|
190
|
+
1 https://cumulus.asf.earthdatacloud.nasa.gov/OP...
|
|
191
|
+
2 https://cumulus.asf.earthdatacloud.nasa.gov/OP...
|
|
192
|
+
3 https://cumulus.asf.earthdatacloud.nasa.gov/OP...
|
|
193
|
+
4 https://cumulus.asf.earthdatacloud.nasa.gov/OP...
|
|
194
|
+
|
|
195
|
+
geometry mgrs_tile_id \
|
|
196
|
+
0 POLYGON ((-65.58616 43.67944, -65.07523 43.740... 20TLP
|
|
197
|
+
1 POLYGON ((-65.58746 43.68056, -65.07652 43.741... 20TLP
|
|
198
|
+
2 POLYGON ((-65.58803 43.68023, -65.07706 43.741... 20TLP
|
|
199
|
+
3 POLYGON ((-65.58995 43.68007, -65.07902 43.740... 20TLP
|
|
200
|
+
4 POLYGON ((-65.5893 43.67982, -65.07838 43.7406... 20TLP
|
|
201
|
+
|
|
202
|
+
acq_group_id_within_mgrs_tile track_token input_category
|
|
203
|
+
0 2 91 pre
|
|
204
|
+
1 2 91 pre
|
|
205
|
+
2 2 91 pre
|
|
206
|
+
3 2 91 pre
|
|
207
|
+
4 2 91 pre
|
|
208
|
+
```
|
|
209
|
+
</details>
|
|
210
|
+
The output is a pandas dataframe that can be serialized using the pandas API:
|
|
211
|
+
|
|
212
|
+
```
|
|
213
|
+
df_product_t91.to_csv("df_product.csv", index=False)
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
For more details see the [Jupyter notebooks](./notebooks):
|
|
217
|
+
|
|
218
|
+
- [Enumerating inputs for a single DIST-S1 product](./notebooks/A__Staging_Inputs_for_One_MGRS_Tile.ipynb)
|
|
219
|
+
- [Enumerating inputs for a time-series of DIST-S1 products](./notebooks/B__Enumerate_MGRS_tile.ipynb)
|
|
220
|
+
|
|
221
|
+
### Identifiers for DIST-S1 products
|
|
222
|
+
|
|
223
|
+
As noted above, each DIST-S1 product is uniquely identified by:
|
|
224
|
+
|
|
225
|
+
1. MGRS Tile ID
|
|
226
|
+
2. Track Number
|
|
227
|
+
3. Post-image acquisition time (within 1 day)
|
|
228
|
+
|
|
229
|
+
We briefly explain why these fields uniquely identify DIST-S1 products.
|
|
230
|
+
These pieces information uniquely describe the space (MGRS tile and track) and time (post-image acquisition) that a Sentinel-1 makes a pass over a fixed area.
|
|
231
|
+
Each DIST-S1 product is resampled to an MGRS tile, so we need that.
|
|
232
|
+
While the post-image acquisition time is a lot - there are particular instances when Sentinel-1 constellation passes over the same area in a single day and so fixing the track number differentiates between the two different sets of acquired imagery occurring in the same 24 hour period.
|
|
233
|
+
In theory, we could specify the exact time of acquisition, but we have elected to use track numbers to differentiate when there Sentinel-1 constellation collects data over the same area in a single day.
|
|
234
|
+
It is also important to note that we are assuming the selection of pre-images (once a post-image set is selected) is fixed.
|
|
235
|
+
Although varying a baseline of pre-images to measure disturbance will alter the final DIST-S1 product, we assume with a fixed strategy to construct this baseline, the above 3 fields uniquely identify a DIST-S1 product.
|
|
236
|
+
|
|
237
|
+
# About the Data Tables in this Library
|
|
238
|
+
|
|
239
|
+
One of the purposes of this data is to provide easy access via standard lookups to a variety of tables associated with enumerating DIST-S1 products.
|
|
240
|
+
There are three data tables:
|
|
241
|
+
|
|
242
|
+
1. [Burst Geometry Table](src/dist_s1_enumerator/data/jpl_burst_geo.parquet) - the JPL spatially fixed bursts within 2 km of land as identified via the UMD Ocean Mask ([link](https://console.cloud.google.com/storage/browser/earthenginepartners-hansen/OceanMask;tab=objects?prefix=&forceOnObjectsSortingFiltering=false))
|
|
243
|
+
2. [MGRS Table](src/dist_s1_enumerator/data/mgrs.parquet) - the MGRS tiles that are (1) used in DIST-HLS processing (see this [list](tests/data/dist_hls_tiles.txt)) and (2) have overlapping bursts from 1.
|
|
244
|
+
3. [MGRS/Burst Lookup Table](src/dist_s1_enumerator/data/mgrs_burst_lookup_table.parquet) - this is effectively a spatial join of burst geometries and MGRS tiles to allow us to get all relevant bursts from a pass. A pass is defined to be all the data collected over an MGRS tile from Sentinel-1, i.e. all the RTC-S1 products coming from the Sentinel-1.
|
|
245
|
+
|
|
246
|
+
How these tables were created be found in this [notebook](https://github.com/OPERA-Cal-Val/dist-s1-research/blob/dev/marshak/Zc_check_bursts_without_mgrs_tile/1__Lookup%20Tables%20for%20MGRS%20and%20Bursts.ipynb).
|
|
247
|
+
It's worth noting there is some care taken to do the accounting of track numbers within a Sentinel-1 acquisition to properly identify a single data take.
|
|
248
|
+
Sentinel-1 track numbers of products increment near the equator even though they are still within the same pass.
|
|
249
|
+
Thus, we include the column `acq_group_id_within_mgrs_tile` to identify different data takes within a single MGRS tile.
|
|
250
|
+
We also filter out burst/mgrs pairs if the a Sentinel-1 pass that is smaller than 250 km^2 within the intersection. The MGRS tiles are 3660 x 3660 pixels at 30 meter resolution and so have total area of 12,056 km^2. Thus, this minimum overlap means if a data acquisition over an MGRS tile has less than about 2 percent of total possible data, then we do not need to create a DIST-S1 product for it. Because there is at least 10 km of overlap<sup>*</sup> between adjacent tiles (more at higher latitudes), this minimum coverage requirement means such excluded products will likely be better represented in adjacent MGRS tiles.
|
|
251
|
+
|
|
252
|
+
<sup>*</sup>Although there is [documentation](https://hls.gsfc.nasa.gov/products-description/tiling-system/) saying there is 4.9 overlap between tiles, looking at the MGRS tile table above, we see that overlap is closer to 10 km, or 9% of overlap of the area (since the MGRS tiles are about 109 km x 109 km).
|
|
253
|
+
|
|
254
|
+
# Testing
|
|
255
|
+
|
|
256
|
+
For the test suite:
|
|
257
|
+
|
|
258
|
+
1. Install `papermill` via `conda-forge` (currently not supported by 3.13)
|
|
259
|
+
2. Run `pytest tests`
|
|
260
|
+
|
|
261
|
+
There are two category of tests: unit tests and integration tests. The former can be run using `pytest tests -m 'not integration'` and similarly the latter with `pytest tests -m 'integration'`. The intgeration tests are those that can be integrated into the DAAC data access workflows and thus require internet access with earthdata credentials setup correctly (as described above). The unit tests mock the necessary data inputs.
|
|
262
|
+
The integration tests that are the most time consuming are represented by the notebooks and are run only upon a release PR.
|
|
263
|
+
These notebook tests are tagged with `notebooks` and can be excluded from the other tests with `pytest tests -m 'not notebooks'`.
|
|
264
|
+
|
|
265
|
+
# Remarks about the Dateline/Dateline and Geometry
|
|
266
|
+
|
|
267
|
+
The antimeridian (or dateline) is the line at the -180 longitude mark that global CRS tiles are wrapped by standard global reference systems.
|
|
268
|
+
The geometries of the bursts and the MGRS tiles in this package are all in `epsg:4326` (standard lon/lat).
|
|
269
|
+
The geometries are all between -180 and 180 so those geometries that cross the antimeridian/dateline are generally wrapped.
|
|
270
|
+
For MGRS tiles, the statement that a geometry overlaps the antimeridian occurs if and only if the geometry is a Polygon.
|
|
271
|
+
The same is true for burst geometries.
|
|
272
|
+
See `test_antimeridian_crossing` in [`tests/test_mgrs_burst_data.py`](tests/test_mgrs_burst_data.py).
|
|
273
|
+
|
|
274
|
+
# Contributing
|
|
275
|
+
|
|
276
|
+
We welcome contributions to this open-source package. To do so:
|
|
277
|
+
|
|
278
|
+
1. Create an GitHub issue ticket desrcribing what changes you need (e.g. issue-1)
|
|
279
|
+
2. Fork this repo
|
|
280
|
+
3. Make your modifications in your own fork
|
|
281
|
+
4. Make a pull-request (PR) in this repo with the code in your fork and tag the repo owner or a relevant contributor.
|
|
282
|
+
|
|
283
|
+
We use `ruff` and associated linting packages to ensure some basic code quality (see the `environment.yml`). These will be checked for each commit in a PR. Try to write tests wherever possible.
|
|
284
|
+
|
|
285
|
+
# Support
|
|
286
|
+
|
|
287
|
+
1. Create an GitHub issue ticket desrcribing what changes you would like to see or to report a bug.
|
|
288
|
+
2. We will work on solving this issue (hopefully with you).
|
|
289
|
+
|
|
290
|
+
# Acknowledgements
|
|
291
|
+
|
|
292
|
+
See the [LICENSE](LICENSE.txt) file for copyright information.
|
|
293
|
+
|
|
294
|
+
This package was developed as part of the Observational Products for End-Users from Remote Sensing Analysis ([OPERA](https://www.jpl.nasa.gov/go/opera/)) project. This work was originally carried out at the Jet Propulsion Laboratory, California Institute of Technology, under a contract with the National Aeronautics and Space Administration (80NM0018D0004).
|
|
295
|
+
Copyright 2024 by the California Institute of Technology. United States Government Sponsorship acknowledged.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
dist_s1_enumerator/__init__.py,sha256=L89uOLGobmF-ZsBA767RiGpKCDKVx6KOK6wJkjGQ69M,1766
|
|
2
|
+
dist_s1_enumerator/asf.py,sha256=m0LHIBM6OSeoNi2Htin5oeeyGjsWecFgyKeqUXNcbDo,13850
|
|
3
|
+
dist_s1_enumerator/constants.py,sha256=Ve_aLWRqNduh7uEBaHbJNy1VfH2njzV57L4T_gBVNaE,727
|
|
4
|
+
dist_s1_enumerator/dist_enum.py,sha256=g4oHh_0T2IGFdCQGJiG9BaMMv4uvbbp3hk6Kw9aHHv0,21388
|
|
5
|
+
dist_s1_enumerator/dist_enum_inputs.py,sha256=KxGZNQYEsN2KNPcrHnh8Zi5e84dBdbtyeVV-aA8XI5o,6732
|
|
6
|
+
dist_s1_enumerator/exceptions.py,sha256=JhT8fIEmW3O2OvUQADkEJkL8ZrUN5pkKNzCCSt33goQ,82
|
|
7
|
+
dist_s1_enumerator/mgrs_burst_data.py,sha256=vt9ubDUP3l2iNXK82OuvahX_WUq0MpHMkmTKOPvbRuw,7162
|
|
8
|
+
dist_s1_enumerator/param_models.py,sha256=DI2MgSxiPo7HiRKtXX8bxZnQtuoYAmtAcdYYrnhMIho,4614
|
|
9
|
+
dist_s1_enumerator/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
10
|
+
dist_s1_enumerator/rtc_s1_io.py,sha256=TPlgMdyjRYnGWCt7J1nQ1AY90lAPQoMy2BN0oFMw4gg,5267
|
|
11
|
+
dist_s1_enumerator/tabular_models.py,sha256=OjsTg6fN9Mq-LHVKuz9klFD3DsG0WkfPmfDfdZYUJOw,3189
|
|
12
|
+
dist_s1_enumerator/data/jpl_burst_geo.parquet,sha256=EXpQcXhWt2T6RVBmvkh7vQb150ShftIsZWvN97wQP4g,30106843
|
|
13
|
+
dist_s1_enumerator/data/mgrs.parquet,sha256=XB69HyNK502cJJ2Ry5wmnrbe-jepAdoMe7y35QUj_Gs,596933
|
|
14
|
+
dist_s1_enumerator/data/mgrs_burst_lookup_table.parquet,sha256=m_r0E7yTet6Xwd_H-lg2qr6IpBYBksYn5C5nOaXY8pw,3029091
|
|
15
|
+
dist_s1_enumerator-1.0.8.dist-info/licenses/LICENSE,sha256=qsoT0jnoSQSgSzA-sywESwmVxC3XcugfW-3vctvz2aM,11346
|
|
16
|
+
dist_s1_enumerator-1.0.8.dist-info/METADATA,sha256=5M-iULqELlLIaLnen9tRkp_36QEUKhQjtYpMIxFag9E,18490
|
|
17
|
+
dist_s1_enumerator-1.0.8.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
|
|
18
|
+
dist_s1_enumerator-1.0.8.dist-info/top_level.txt,sha256=5-RGu6oxsKKyhybZZSuUImALhcQT8ZOAnVv2MmrESDE,19
|
|
19
|
+
dist_s1_enumerator-1.0.8.dist-info/RECORD,,
|
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright 2024 Charlie Marshak
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
dist_s1_enumerator
|