Skip to content

Add English Stack class documentation #230

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.

Sign up for GitHub

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

Draft
Alex-Lewandowski wants to merge 1 commit into
base: test
Choose a base branch
from
Draft

Add English Stack class documentation #230

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions markdown-docs/asf_search/Pair.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@

This class describes a pair of ASFProducts. This is useful for, but not limited to, describing pairs of reference and seconary scenes for SAR interferometry. The class provides metadata describing the pair's temporal and perpendicular baselines. For Sentinel-1, an optional method is available that estimates temporal coherence.

`Pair` is a supportive class for the soon-to-be-released `Stack` and `SBAS` classes, which will simplify and automate the creation of fully connected, multi-annual, seasonal SBAS stacks.
`Pair` is a supportive class for the `Stack` and soon-to-be-released `SBASNetwork` classes, which will simplify and automate the creation of connected, multi-annual, seasonal SBAS stacks.
***

## Attributes
- `ref_date` datetime.date: The acquisition date of the reference scene
- `sec_date` datetime.date: The acquisition date of the secondary scene
- `perpendicular` int: The pair's perpendicular baseline
- `temporal` datetime.timedelta: the pair's temporal baseline
- `ref_date` datetime.date: The acquisition date of the reference scene.
- `sec_date` datetime.date: The acquisition date of the secondary scene.
- `perpendicular` int: The pair's perpendicular baseline.
- `temporal` datetime.timedelta: the pair's temporal baseline.

***

Expand Down
53 changes: 53 additions & 0 deletions markdown-docs/asf_search/Stack.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Stack

## Description

This class creates stacks of `Pair`s of `ASFProduct`s. A `Stack` contains 4+ lists of `Pair`s, which are described in the Attributes section below.

`Stack` is a supportive class for the soon-to-be-released `SBASNetwork` class, which will simplify and automate the creation of connected, multi-annual, seasonal SBAS stacks.
***

## Attributes
- `geo_reference` ASFProduct: A geographic reference scene from which to build a geographically collocated `Stack`.
- `opts` ASFSearchOptions: Search options used when searching products to create scene `Pair`s.
- `full_stack` List[Pair]: A list of every possible `Pair` in a `Stack`. This forms a complete network of `ASFProducts``.
- `remove_list` List[Pair]: A list of `Pair`s to remove from `full_stack` in order to create `subset_stack`
- `subset_stack` List[Pair]: The resulting list after removing the `Pair`s in `remove_list` from `full_stack`. This contains a possibly disconnected network of `ASFProducts`.
- `connected_substacks` List[List[Pair]]: A list of lists of Pairs. This contains each disconnected component of `subset_stack`. A length of 1 indicates that `subset_stack` represents a connected network of `ASFProducts`.

***

## Methods

### <span style="color: #236192; font-size: 20px;">remove_pairs(self, pairs)</span>

Adds Pairs to `self.remove_list` and removes them from `self.subset_stack`.

**args:**
- `pairs` List[Pair]: A list of Pairs to remove from `self.subset_stack`

***

### <span style="color: #236192; font-size: 20px;">add_pairs(self, pairs)</span>

Adds `Pair`s to `self.subset_stack` and, if necessary, to `self.full_stack`.
I.e., remove `Pair`s from `self.remove_list` if present or else add them to `self.full_stack`.

This allows for the addition of custom `Pair`s that were not originally present in `self.full_stack`.

**args:**
- `pairs`: A list of Pairs to add to `self.subset_stack` (and possibly `self.full_stack`)

***

### <span style="color: #236192; font-size: 20px;">get_scene_ids(self, pair_list)</span>

Provides scene names for all `ASFProducts` in a list of `Pairs`. This is useful when ordering pair-based products from ASF HyP3 or HyP3+ On-Demand Processing.

If no stack_dict is passed, `get_scene_ids()` defaults to using the largest connected substack in `connected_substacks`.

**args:**
- `pair_list` List[Pair]: A list of `Pair`s for which to retrieve scene IDs.

**returns:**
- A list tuples containing the reference and secondary scene names for each `Pair` in a `Pair` list.
1 change: 1 addition & 0 deletions markdown-docs/asf_search/Stack.key
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{{ STACK_1 }}
1 change: 1 addition & 0 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@ nav:
- ASFSearchResults: asf_search/ASFSearchResults.md
- ASFSession: asf_search/ASFSession.md
- Pair: asf_search/Pair.md
- Stack: asf_search/Stack.md
- Best Practices: asf_search/BestPractices.md
- Exceptions: asf_search/exceptions.md
- What's New: https://github.com/asfadmin/Discovery-asf_search/blob/master/CHANGELOG.md
Expand Down
Loading