@@ -582,9 +582,10 @@ def crop_burst_dataset(
582
582
use_center : bool = False ,
583
583
burst_id : T .Optional [int ] = None ,
584
584
) -> DataArrayOrDataset :
585
- """
586
- Returns the measurement dataset cropped to the selected burst.
585
+ """Return the measurement dataset cropped to the selected burst.
586
+
587
587
Only one keyword between 'burst_index' and 'azimuth_anx_time' and 'burst_id' must be defined.
588
+
588
589
:param xr.Dataset pol_dataset: measurement dataset
589
590
:param int burst_index: burst index can take values from 1 to the number of bursts
590
591
:param float azimuth_anx_time: azimuth anx time of first line of the bursts
@@ -659,9 +660,11 @@ def mosaic_slc_iw(
659
660
def calibrate_amplitude (
660
661
digital_number : xr .DataArray , calibration_lut : xr .DataArray
661
662
) -> xr .DataArray :
662
- """Returns the calibrated amplitude. The calibration is done using the calibration LUT in the product metadata.
663
+ """Return the calibrated amplitude. The calibration is done using the calibration LUT in the product metadata.
664
+
663
665
:param digital_number: digital numbers to be calibrated
664
666
:param calibration_lut: calibration LUT (sigmaNought, betaNought or gamma).
667
+
665
668
The LUT can be opened using the measurement sub-group `calibration`
666
669
"""
667
670
calibration = calibration_lut .interp (
@@ -685,8 +688,8 @@ def calibrate_intensity(
685
688
as_db : bool = False ,
686
689
min_db : T .Optional [float ] = - 40.0 ,
687
690
) -> xr .DataArray :
688
- """
689
- Returns the calibrated intensity. The calibration is done using the calibration LUT in the product metadata.
691
+ """Return the calibrated intensity. The calibration is done using the calibration LUT in the product metadata.
692
+
690
693
:param digital_number: digital numbers to be calibrated
691
694
:param calibration_lut: calibration LUT (sigmaNought, betaNought or gamma).
692
695
The LUT can be opened using the measurement sub-group `calibration`.
@@ -717,14 +720,12 @@ def slant_range_time_to_ground_range(
717
720
slant_range_time : xr .DataArray ,
718
721
coordinate_conversion : xr .Dataset ,
719
722
) -> xr .DataArray :
720
- """
721
- Convert the slant range time coordinates to ground range coordinates using the coordinate conversion `sr0`
722
- and `srgrCoefficients` product metadata
723
+ """Convert slant range time to ground range using the coordinate conversion metadata.
724
+
723
725
:param azimuth_time: azimuth time coordinates
724
726
:param slant_range_time: slant range time
725
727
:param coordinate_conversion: coordinate conversion dataset.
726
728
The coordinate conversion dataset can be opened using the measurement sub-groub `coordinate_conversion`
727
- :return:
728
729
"""
729
730
slant_range = SPEED_OF_LIGHT / 2.0 * slant_range_time
730
731
cc = coordinate_conversion .interp (azimuth_time = azimuth_time )
0 commit comments