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.

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

Release 0.9.2 #446

Merged
merged 40 commits into from
May 17, 2024
Merged
Show file tree
Hide file tree
Changes from 34 commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
6621661
fix insar tutorial
forrestfwilliams Apr 18, 2024
50bd7ae
use track D71
forrestfwilliams Apr 23, 2024
e6f54c5
Update dependabot.yml to weekly
asjohnston-asf Apr 30, 2024
440b429
Merge pull request #440 from ASFHyP3/asjohnston-asf-patch-1
asjohnston-asf May 2, 2024
9517d46
double-check notebook
forrestfwilliams May 3, 2024
7d4a453
update changelog
forrestfwilliams May 3, 2024
907a1c9
Merge branch 'develop' into insar_tutorial
forrestfwilliams May 3, 2024
553b99b
add asf_search>7.0.0 as a requirement
forrestfwilliams May 3, 2024
88340eb
quotes
forrestfwilliams May 3, 2024
bb6397b
add a request access page
hjkristenson May 3, 2024
a21f347
add access requirement language to using-snippet.md
hjkristenson May 3, 2024
f5321c0
fix copy-pasta
forrestfwilliams May 3, 2024
49ffc81
Merge pull request #441 from ASFHyP3/insar_tutorial
forrestfwilliams May 3, 2024
e2df8d0
add Requesting Access content
hjkristenson May 3, 2024
894190b
update changelog
hjkristenson May 3, 2024
c9914b9
update dictionary
hjkristenson May 3, 2024
43e8482
add clarification that only co-pol interferograms are generated
hjkristenson May 7, 2024
a3df507
update burst back-population status
hjkristenson May 7, 2024
e1aef8e
adjust header type for Sentinel-1 Bursts section
hjkristenson May 8, 2024
083305d
reword burst description section
hjkristenson May 8, 2024
21aa385
Merge remote-tracking branch 'origin/develop' into insar-copol
hjkristenson May 8, 2024
f8e6f31
revise content of requesting access page
asjohnston-asf May 9, 2024
22d213d
Update docs/using/requesting_access.md
forrestfwilliams May 13, 2024
def8a31
Update docs/using/requesting_access.md
forrestfwilliams May 13, 2024
907aafe
Update docs/using/requesting_access.md
forrestfwilliams May 13, 2024
c46579b
Merge pull request #443 from ASFHyP3/feedback
forrestfwilliams May 13, 2024
45beb57
Merge remote-tracking branch 'origin/develop' into request-access
hjkristenson May 13, 2024
6b6f1d9
Merge remote-tracking branch 'origin/request-access' into insar-copol
hjkristenson May 13, 2024
43da8d9
update dictionary
forrestfwilliams May 13, 2024
b10863d
Merge pull request #444 from ASFHyP3/insar-copol
hjkristenson May 13, 2024
d6d7772
comment out requesting access section pending feature release
hjkristenson May 16, 2024
0394482
Merge pull request #442 from ASFHyP3/request-access
hjkristenson May 17, 2024
3b18638
Fix changelog
jtherrmann May 17, 2024
7a00e50
Merge pull request #447 from ASFHyP3/fix-changelog
jtherrmann May 17, 2024
4808005
Merge branch 'main' into develop
jtherrmann May 17, 2024
e670dbe
fix changelog
jtherrmann May 17, 2024
ad25a77
add TODOs for Release Requesting Access Documentation
jtherrmann May 17, 2024
79a9167
comment out all new /using content
jtherrmann May 17, 2024
de4e135
update changelog
jtherrmann May 17, 2024
9e0f70f
Merge pull request #449 from ASFHyP3/requesting-access-todos
jtherrmann May 17, 2024
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
8 changes: 4 additions & 4 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@

version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/"
- package-ecosystem: github-actions
directory: /
schedule:
interval: "daily"
interval: weekly
labels:
- "bumpless"
- bumpless
3 changes: 3 additions & 0 deletions .github/dictionary.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
.github
.kmz
.lycheeignore
.md-button
.png
.png.aux.xml
.png.xml
Expand Down Expand Up @@ -95,6 +96,7 @@ downsampled
DV
DynamoDB
Earthdata
EDL
EGM2008
EGM96
electro-magnetic
Expand Down Expand Up @@ -309,6 +311,7 @@ sigma0
Sinergise
SLC
SLCs
SLCs.
SNAPHU
SNAPHU's
snaphu_mcf
Expand Down
29 changes: 21 additions & 8 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,30 @@
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [PEP 440](https://www.python.org/dev/peps/pep-0440/)
and this project adheres to [PEP 440](https://www.python.org/dev/peps/pep-0440/)
and uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).


## [0.9.1]

### Added
* [Requesting Access page](docs/using/request_access.md) and references to requesting access in the [Using HyP3](docs/using-snippet.md) documentation

### Changed
* Updated language in InSAR product guides to clarify that only co-pol interferograms are available
* Updated status of burst back-population
* Switched to the use of a descending track in the [MintPy tutorial](docs/tutorials/hyp3_insar_stack_for_ts_analysis.ipynb) so that all interferograms have full coverage of the observed event.

### Fixed
* The [MintPy tutorial](docs/tutorials/hyp3_insar_stack_for_ts_analysis.ipynb) so that it correctly specifies `asf_search` parameters.

## [0.9.0]

### Changed
* Updated language to reflect release of the full credit system to production HyP3.

### Removed
* Quota page now redirects to [Credits](using/credits.md) page.
* Quota page now redirects to [Credits](docs/using/credits.md) page.

## [0.8.9]

Expand Down Expand Up @@ -145,7 +158,7 @@ and uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
Fixes [#334](https://github.com/ASFHyP3/hyp3-docs/issues/334).

### Removed
* `propose-tweet` GitHub action workflow. Closes [#288](https://github.com/ASFHyP3/hyp3-docs/issues/288).
* `propose-tweet` GitHub action workflow. Closes [#288](https://github.com/ASFHyP3/hyp3-docs/issues/288).

## [0.5.3]

Expand Down Expand Up @@ -326,7 +339,7 @@ and uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [0.3.49]

### Changed
* Updated API Use Guide to only use the ESA S2 naming convention.
* Updated API Use Guide to only use the ESA S2 naming convention.

## [0.3.48]

Expand Down Expand Up @@ -387,7 +400,7 @@ and uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
### Added
* Added information and reference links to the [InSAR Product Guide](docs/guides/insar_product_guide.md) for the [Minimum Cost Flow](https://www.gamma-rs.ch/uploads/media/2002-5_TR_Phase_Unwrapping.pdf) phase unwrapping algorithm used for On Demand InSAR products
* Added clarification to the [InSAR Product Guide](docs/guides/insar_product_guide.md) that the sign convention used for unwrapped phase is opposite to that used for displacement maps.
* Added landing page for [Using HyP3](docs/using.md) section
* Added landing page for [Using HyP3](docs/using.md) section
* Added references to hyp3-docs repo citation

### Changed
Expand Down Expand Up @@ -496,7 +509,7 @@ and uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [0.3.20](https://github.com/ASFHyP3/hyp3-docs/compare/v0.3.19...v0.3.20)

### Changed
* Updated the [InSAR Product Guide](docs/guides/insar_product_guide.md) to reflect the change in the location of the phase unwrapping reference point (formerly the (0,0) location of the combined image pair, now the location of the pixel with the highest coherence value)
* Updated the [InSAR Product Guide](docs/guides/insar_product_guide.md) to reflect the change in the location of the phase unwrapping reference point (formerly the (0,0) location of the combined image pair, now the location of the pixel with the highest coherence value)
* Updated the [InSAR Product Guide](docs/guides/insar_product_guide.md) to adjust the list of parameters included in the parameter file

## [0.3.19](https://github.com/ASFHyP3/hyp3-docs/compare/v0.3.18...v0.3.19)
Expand Down Expand Up @@ -566,7 +579,7 @@ and uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.3.7](https://github.com/ASFHyP3/hyp3-docs/compare/v0.3.6...v0.3.7)

### Added
### Added
* A [What's New](docs/whats_new.md) page which displays [@ASFHyP3's](https://twitter.com/ASFHyP3) twitter feed

## [0.3.6](https://github.com/ASFHyP3/hyp3-docs/compare/v0.3.5...v0.3.6)
Expand All @@ -584,7 +597,7 @@ and uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [0.3.4](https://github.com/ASFHyP3/hyp3-docs/compare/v0.3.3...v0.3.4)

### Changed
* Updated availability of InSAR options in [InSAR Product Guide](docs/guides/insar_product_guide.md)
* Updated availability of InSAR options in [InSAR Product Guide](docs/guides/insar_product_guide.md)

## [0.3.3](https://github.com/ASFHyP3/hyp3-docs/compare/v0.3.2...v0.3.3)

Expand Down
23 changes: 14 additions & 9 deletions docs/guides/burst_insar_product_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,26 +11,29 @@ This document is a guide for users of Sentinel-1 Burst Interferometric Synthetic

This functionality is available on [Vertex](https://search.asf.alaska.edu/ "https://search.asf.alaska.edu/" ){target=_blank} as well as through the [HyP3 API](../using/api.md ){target=_blank} and [Python SDK](../using/sdk.md ){target=_blank}.

### Sentinel-1 Bursts
## Sentinel-1 Bursts

!!! tip "Sentinel-1 bursts are not available for all SLC granules"
[Single Look Complex](https://sentinels.copernicus.eu/web/sentinel/technical-guides/sentinel-1-sar/products-algorithms/level-1-algorithms/single-look-complex 'https://sentinels.copernicus.eu/web/sentinel/technical-guides/sentinel-1-sar/products-algorithms/level-1-algorithms/single-look-complex' ){target=_blank} (SLC) data is required to generate interferograms from Sentinel-1 data. The European Space Agency (ESA) packages this type of data into Interferometric Wide (IW) SLC products, which are available for download from ASF. These IW SLC products include three sub-swaths, each containing many individual burst SLCs.

**Burst products only are available for Sentinel-1 granules collected after June 9th, 2023.**
Historically, most InSAR processing has been performed using the full IW SLC scene, but ASF has developed a method of [extracting the individual SLC bursts](https://sentinel1-burst-documentation.asf.alaska.edu/ 'https://sentinel1-burst-documentation.asf.alaska.edu/' ){target=_blank} from IW SLC products, which facilitates burst-based processing workflows.

ASF is currently only forward-populating burst products, which means that burst products are only available for Sentinel-1 granules collected after June 9th, 2023. If this affects your ability to utilize burst products to perform your analyses, please [Email ASF User Services](mailto:[email protected] "[email protected]"), and we will try to populate burst products for your region and time period of interest.

Single Look Complex (SLC) data from the Sentinel-1 mission that is suitable for use in interferometry has historically been packaged into Interferometric Wide (IW) SLC products. These IW SLC products include three sub-swaths, each containing many individual burst SLCs. The framing of the IW SLCs is not consistent through time, so when using IW SLCs as the basis for InSAR, scene pairs do not always fully overlap.

In contrast, working at the burst level of the Sentinel-1 SLC data provides a couple key benefits:
Working at the burst level of the Sentinel-1 SLC data provides a couple key benefits:

**1. Bursts are consistently geolocated through time**
The coverage of a burst is the same for every orbit of the satellite, so you can be confident that every burst with the same [Full Burst ID](https://storymaps.arcgis.com/stories/88c8fe67933340779eddef212d76b8b8#ref-n-VYIiUe "Sentinel-1 Burst Overview https://arcg.is/zSafi0" ){target=_blank} in a stack of acquisitions will cover the same geographic location.
The coverage of a burst is the same for every orbit of the satellite, so you can be confident that every burst with the same [Full Burst ID](https://storymaps.arcgis.com/stories/88c8fe67933340779eddef212d76b8b8#ref-n-VYIiUe "Sentinel-1 Burst Overview https://arcg.is/zSafi0" ){target=_blank} in a stack of acquisitions will cover the same geographic location. In contrast, the framing of the IW SLCs is not consistent through time, so when using IW SLCs as the basis for InSAR, scene pairs do not always fully overlap.

**2. Bursts cover a smaller geographic area**
IW SLC products are extremely large, and, in many cases, only a small portion of the image is of interest. You can process only the bursts that cover your specific area of interest, which significantly decreases the time and cost required to generate InSAR products.

Refer to the [Sentinel-1 Bursts tutorial](https://storymaps.arcgis.com/stories/88c8fe67933340779eddef212d76b8b8 "Sentinel-1 Bursts Tutorial https://arcg.is/zSafi0" ){target=_blank} to learn more about how [ASF extracts burst-level products](https://sentinel1-burst-documentation.asf.alaska.edu/ "ASF Sentinel-1 Burst Documentation" ){target=_blank} from Sentinel-1 IW and EW SLCs.

!!! warning "Sentinel-1 bursts are not available for all SLC granules"

ASF is in the process of back-populating Sentinel-1 bursts, so some acquistions may not yet be available. Burst products are available globally for Sentinel-1 granules collected after June 9th, 2023, but back-population of all acquisitions prior to that date is not yet complete.

Acquisitions over North America are fully back-populated, and more burst products from other areas are being added every day. If a lack of burst availability is impacting your ability to analyze data, please [Email ASF User Services](mailto:[email protected] "[email protected]"), and we will do our best to prioritize back-population of burst products for your region and time period of interest.


### Burst InSAR Processing

The Sentinel-1 Burst InSAR products are generated using the Jet Propulsion Laboratory's [ISCE2 software](https://github.com/isce-framework/isce2#readme "https://github.com/isce-framework/isce2" ){target=_blank}. ASF is committed to transparency in product development, and we are pleased to be able to offer an InSAR product that leverages open-source software for processing.
Expand All @@ -43,6 +46,8 @@ Users can request Sentinel-1 Burst InSAR products [On Demand](https://search.asf

Users can also merge multiple Sentinel-1 Burst InSAR products together if their area of interest covers more than one burst. Please read the section on [Merging Sentinel-1 Burst InSAR Products](#merging-sentinel-1-burst-insar-products "Jump to the merge section of this document") for more information.

On Demand InSAR products only include co-polarized interferograms (VV or HH). Cross-polarized interferograms (VH or HV) are not available using this service.

Users are cautioned to read the sections on [limitations](#limitations "Jump to the Limitations section of this document") and [error sources](#error-sources "Jump to the Error Sources section of this document") in InSAR products before attempting to use InSAR data. For a more complete description of the properties of SAR, see our [Introduction to SAR](../guides/introduction_to_sar.md "https://hyp3-docs.asf.alaska.edu/guides/introduction_to_sar" ){target=_blank} guide.

{% endblock %}
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/insar_product_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# Sentinel-1 InSAR Product Guide
This document is a guide for users of Interferometric Synthetic Aperture Radar (InSAR) Sentinel-1 products generated by the Alaska Satellite Facility (ASF). Users can request InSAR products [On Demand](https://search.asf.alaska.edu/#/?topic=onDemand "https://search.asf.alaska.edu/#/?topic=onDemand" ){target=_blank} in ASF's [Vertex](https://search.asf.alaska.edu/ "https://search.asf.alaska.edu" ){target=_blank} data portal, or make use of our HyP3 [Python SDK](https://hyp3-docs.asf.alaska.edu/using/sdk/ "https://hyp3-docs.asf.alaska.edu/using/sdk" ){target=_blank} or [API](https://hyp3-docs.asf.alaska.edu/using/api/ "https://hyp3-docs.asf.alaska.edu/using/api" ){target=_blank}.

This process requires [Sentinel-1 IW SLC products](https://sentinels.copernicus.eu/web/sentinel/technical-guides/sentinel-1-sar/products-algorithms/level-1/single-look-complex/interferometric-wide-swath "https://sentinels.copernicus.eu" ){target=_blank} as input. Input pairs can be selected in [Vertex](https://search.asf.alaska.edu/ "https://search.asf.alaska.edu" ){target=_blank} using either the [Baseline Tool](https://docs.asf.alaska.edu/vertex/baseline/ "https://docs.asf.alaska.edu/vertex/baseline/" ){target=_blank} or the [SBAS Tool](https://docs.asf.alaska.edu/vertex/sbas/ "https://docs.asf.alaska.edu/vertex/sbas" ){target=_blank} search interfaces.
This process requires [Sentinel-1 IW SLC products](https://sentinels.copernicus.eu/web/sentinel/technical-guides/sentinel-1-sar/products-algorithms/level-1/single-look-complex/interferometric-wide-swath "https://sentinels.copernicus.eu" ){target=_blank} as input. Input pairs can be selected in [Vertex](https://search.asf.alaska.edu/ "https://search.asf.alaska.edu" ){target=_blank} using either the [Baseline Tool](https://docs.asf.alaska.edu/vertex/baseline/ "https://docs.asf.alaska.edu/vertex/baseline/" ){target=_blank} or the [SBAS Tool](https://docs.asf.alaska.edu/vertex/sbas/ "https://docs.asf.alaska.edu/vertex/sbas" ){target=_blank} search interfaces. On Demand InSAR products only include co-polarized interferograms (VV or HH). Cross-polarized interferograms (VH or HV) are not available using this service.

For a step-by-step tutorial on ordering On-Demand InSAR Products using Vertex, visit our [InSAR On Demand! StoryMap](https://storymaps.arcgis.com/stories/68a8a3253900411185ae9eb6bb5283d3 "InSAR On Demand! https://arcg.is/eiP8G0" ){target=_blank}. To learn more about the files included in the On Demand InSAR product packages and how to work with them, refer to our [Exploring Sentinel-1 InSAR StoryMap](https://storymaps.arcgis.com/stories/8be186e4125741518118d0102e6835e5 "Exploring Sentinel-1 InSAR https://arcg.is/11DaW90" ){target=_blank}.

Expand Down
6 changes: 4 additions & 2 deletions docs/guides/insar_product_guide_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,11 @@ For slower processes that require a longer time interval to detect movement, lon
### Polarizations
Polarization refers to the direction of travel of an electromagnetic wave. A horizontal wave is transmitted so that it oscillates in a plane parallel to the surface imaged, while a vertical wave oscillates in a plane perpendicular to the surface imaged.

Most modern SAR systems can transmit chirps with either a horizontal or vertical polarization. In addition, some of these sensors can listen for either horizontal or vertical backscatter. This gives rise to 4 different types of returns: HH, HV, VV, and VH, with the first letter indicating the transmission method and the second the receive method. For example, VH is a vertically polarized transmit signal with horizontally polarized echoes recorded.
Most modern SAR systems can transmit chirps with either a horizontal or vertical polarization. In addition, some of these sensors can listen for either horizontal or vertical backscatter. This results in the potential for 4 different types of returns: HH, HV, VV, and VH, with the first letter indicating the transmission method and the second the receive method. For example, VH is a vertically polarized transmit signal with horizontally polarized echoes recorded.

For InSAR applications, processing is generally performed on the co-pol (VV or HH) data and not on the cross-pol (VH or HV) data. Also, each image used in an InSAR pair is required to be the same polarization - two HH images of the same area could form a valid pair, while a single HH with a single VV of the same area would not.
For InSAR applications, processing is generally performed on the co-pol (VV or HH) data and not on the cross-pol (VH or HV) data. Each image used in an InSAR pair must be the same polarization - two HH acquisitions of the same area could form a valid pair, and two VV acquisitions of the same area could form a valid pair, but you cannot pair an HH acquisition with a VV acquisition to generate an interferogram.

On Demand InSAR products only include co-polarized interferograms. Cross-polarized interferograms are not available using this service.

### Baselines
#### Perpendicular Baseline
Expand Down
Loading
Loading