Skip to content

Commit be7ff30

Browse files
committed
docstring updated; variable name changed
1 parent 367a9c2 commit be7ff30

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

src/s1reader/s1_burst_slc.py

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -701,7 +701,7 @@ def az_carrier_components(self, offset, position):
701701

702702
def az_fm_rate_mismatch_mitigation(self, path_dem: str,
703703
path_scratch: str = None,
704-
rg_step=None,
704+
range_step=None,
705705
az_step=None,
706706
threshold_rdr2geo=1e-8,
707707
numiter_rdr2geo=25,
@@ -718,6 +718,11 @@ def az_fm_rate_mismatch_mitigation(self, path_dem: str,
718718
Path to the DEM to calculate the actual azimuth FM rate
719719
path_scratch: str
720720
Path to the scratch directory to store intermediate data
721+
If None, the scratch files will be saved on temporary directory generated by system
722+
range_step: float
723+
Range step of the correction grid in meters
724+
az_step: float
725+
Azimuth step of the correciton grid in seconds
721726
threshold_rdr2geo: int
722727
Threshold of the iteration for rdr2geo
723728
numiter_rdr2geo: int
@@ -749,20 +754,20 @@ def az_fm_rate_mismatch_mitigation(self, path_dem: str,
749754
correction_radargrid = custom_radargrid
750755

751756
# Override the radargrid definition if `rg_step` and `az_step` is defined
752-
if rg_step and az_step:
757+
if range_step and az_step:
753758
if custom_radargrid is not None:
754-
warnings.warn('rg_step and az_step assigned. '
759+
warnings.warn('range_step and az_step assigned. '
755760
'Overriding the custom radargrid definition.')
756761

757762
width_radargrid, length_radargrid = \
758-
[vec.size for vec in self._steps_to_vecs(rg_step, az_step)]
763+
[vec.size for vec in self._steps_to_vecs(range_step, az_step)]
759764
sensing_start_radargrid = self.as_isce3_radargrid().sensing_start
760765
correction_radargrid = isce3.product.RadarGridParameters(
761766
sensing_start_radargrid,
762767
self.wavelength,
763768
1/az_step,
764769
self.starting_range,
765-
rg_step,
770+
range_step,
766771
isce3.core.LookSide.Right,
767772
length_radargrid,
768773
width_radargrid,

0 commit comments

Comments
 (0)