Skip to content

Commit

Permalink
update phase_filter_parameter docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
jtherrmann committed Oct 23, 2023
1 parent e282478 commit 086fe4d
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions src/hyp3_sdk/hyp3.py
Original file line number Diff line number Diff line change
Expand Up @@ -354,9 +354,10 @@ def submit_insar_job(self,
apply_water_mask: Sets pixels over coastal waters and large inland waterbodies
as invalid for phase unwrapping
include_displacement_maps: Include displacement maps (line-of-sight and vertical) in the product package
phase_filter_parameter: Adaptive phase filter exponent (alpha).
Larger values result in more aggressive filtering. If zero, adaptive phase filter will be skipped.
We recommend against values less than 0.2, or values with more than two decimal places of precision.
phase_filter_parameter: Adaptive phase filter parameter.
Useful values fall in the range 0.2 to 1.
Larger values result in stronger filtering.
If zero, adaptive phase filter will be skipped.
Returns:
A Batch object containing the InSAR job
Expand Down Expand Up @@ -397,9 +398,10 @@ def prepare_insar_job(cls,
apply_water_mask: Sets pixels over coastal waters and large inland waterbodies
as invalid for phase unwrapping
include_displacement_maps: Include displacement maps (line-of-sight and vertical) in the product package
phase_filter_parameter: Adaptive phase filter exponent (alpha).
Larger values result in more aggressive filtering. If zero, adaptive phase filter will be skipped.
We recommend against values less than 0.2, or values with more than two decimal places of precision.
phase_filter_parameter: Adaptive phase filter parameter.
Useful values fall in the range 0.2 to 1.
Larger values result in stronger filtering.
If zero, adaptive phase filter will be skipped.
Returns:
A dictionary containing the prepared InSAR job
Expand Down

0 comments on commit 086fe4d

Please sign in to comment.