L2AuxiliaryProcessorParameters version 7

L2AuxiliaryProcessorParameters_v7

This definition is based on version 3.16 of the Sentinel-1 IPF Auxiliary Product Specification S1-RS-MDA-52-7443

root type

xml record
idfield namedefinition
0l2AuxiliaryProcessorParameters
xml record
attribute: schemaVersion
xml string

available: optional

attribute: noNamespaceSchemaLocation
xml string

available: optional


idfield namedefinition
0productList
xml record
attribute: count
xml string


idfield namedefinition
0product
xml array[dim_0]
dim_0: determined automatically from xml file
xml record
idfield namedefinition
0productId
xml string
1ocnProcParams
xml record
idfield namedefinition
0oswProcParams
xml record
idfield namedefinition
0spectralEstimationParams
xml record
idfield namedefinition
0frequencySeparation
ascii double
Frequency separation of neighbouring looks.

unit: "Hz"
1rangeLookFilterWidth
ascii double
Range look filter width.

unit: "Hz"
2azimuthLookFilterWidth
ascii double
Azimuth look filter width.

unit: "Hz"
3numberOfLooks
ascii uint64
Number of individual looks.
4numRangePixels
ascii uint64
Number of range pixels from input L1 product to be used in the estimation of the OSW. Only used for SM, for WV all range pixels are used.
5numAzimuthPixels
ascii uint64
Number of azimuth pixels from input L1 product to be used in the estimation of the OSW. Only used for SM, for WV all range pixels are used.
6numAzimuthPixelsCartesianSpec
ascii uint64
Number of azimuth pixels in cartesian co- and cross-spectra [pixels]: N_x=256
7numRangePixelsCartesianSpec
ascii uint64
Number of range pixels in cartesian co- and cross-spectra [pixels]: N_y=256
8xHanningPixels
ascii uint64
Order of Hanning window function over the range axis: β_x=1
9yHanningPixels
ascii uint64
Order of Hanning window function over the azimuth axis: β_y=1
10detrendFilterWindow
ascii array[dim_0]
dim_0: int(str(@count))

attribute: count
ascii string

ascii uint64
Width of low-pass filter for detrending of SLC image. The default value are: filerwidth=(500 ,500)
11sizePeriodogrammeXspecTops
ascii array[dim_0]
dim_0: int(str(@count))

attribute: count
ascii string

ascii uint64
Specifies the periodogram size used to estimate the cross-spectra in TOPS mode, applied over the azimuth and range dimensions [Pixel]. Default value: (300,600 )

available: optional
12sizeEstimationAreaXspecTops
ascii array[dim_0]
dim_0: int(str(@count))

attribute: count
ascii string

ascii uint64
Specifies the maximum size, over azimuth and range dimension, of the estimation area form intra/inter-Burst to estimate the cross-spectra in TOPS mode [Pixel]. Default value: (2000, 3000 )

available: optional
1spectralInversionParams
xml record
idfield namedefinition
0shortestWavelength
ascii float
Shortest wavelength of output polar grid.

unit: "m"
1longestWavelength
ascii float
Longest wavelength of output polar grid.

unit: "m"
2waveNumberBins
ascii uint64
Number of wavenumber bins in polar grid.
3directionalBins
ascii uint64
Number of directional bins in polar grid.
4vel_thr
xml array[dim_0]
dim_0: determined automatically from xml file
ascii float
Parameters relative to velocity bunching.

attribute: beam
ascii string

available: optional
5activateAlfaCorrection
xml array[dim_0]
dim_0: determined automatically from xml file
ascii uint8
Parameters relative to the calibration of the MTF to compensate for wind-dependent Hs Range Ratio. The parameter has an attribute named "beam" to allow decoupling the activation depending on the beam for WV (i.e: allowed attribute value WV1, WV2, S1, S2, S3, S4, S5, S6)

mapping: "false" -> 0

mapping: "true" -> 1

attribute: beam
ascii string

available: optional
6activateBetaCorrection
xml array[dim_0]
dim_0: determined automatically from xml file
ascii uint8
Parameters relative to the calibration of the MTF to compensate for wind-dependent Hs Eff Ratio. The parameter has an attribute named "beam" to allow decoupling the activation depending on the beam for WV (i.e: allowed attribute value WV1, WV2, S1, S2, S3, S4, S5, S6)

mapping: "false" -> 0

mapping: "true" -> 1

attribute: beam
ascii string

available: optional
7merge_thr_low
xml array[dim_0]
dim_0: determined automatically from xml file
ascii float
Value of the contrast between two partitions below which they should be merged during the removal of the low frequency noise (non-wave signatures).

attribute: beam
ascii string

available: optional
8merge_thr_fac
xml array[dim_0]
dim_0: determined automatically from xml file
ascii float
Factor applied to the contrast between two partitions below which they should be merged during the swell spectrum partitioning.

attribute: beam
ascii string

available: optional
9merge_close
xml array[dim_0]
dim_0: determined automatically from xml file
ascii uint8
Decide or not to merge partitions during the swell spectrum partitioning for which the spectral distance between the integral parameters is above the variable merge_close_thr (row below).

mapping: "false" -> 0

mapping: "true" -> 1

attribute: beam
ascii string

available: optional
10merge_close_thr
xml array[dim_0]
dim_0: determined automatically from xml file
ascii float
Factor applied to the contrast between two partitions below which they should be merged during the swell spectrum partitioning.

attribute: beam
ascii string

available: optional
11discard_thr
xml array[dim_0]
dim_0: determined automatically from xml file
ascii float
During the partitioning process, value for which swell spectrum values are not considered to present any relevant peak for the detection of the local peak.

attribute: beam
ascii string

available: optional
12numberOfPartitions
ascii uint64
Maximal number of partitions to be retrieved from the wave spectrum. The default value is: npart=5
13effectiveRangeResolution
ascii float
Effective range resolution used to tune the RAR MTF. The default value: L_res=20
14alphaThreshold
xml array[dim_0]
dim_0: determined automatically from xml file
ascii float
The lowest wavenumber used in the low frequency filtering process. α_h=2π/800

attribute: beam
ascii string

available: optional
15resamplingGrowthRate
xml array[dim_0]
dim_0: determined automatically from xml file
ascii float
Resampling growth rate for cartesian spectrum compression from linear to sinh grid. The default value is: resGrowthRate=32

attribute: beam
ascii string

available: optional
16resamplingHalfWidth
xml array[dim_0]
dim_0: determined automatically from xml file
ascii float
The half width of the lowpass filter for cartesian cross spectra resampling. The default value is 1

attribute: beam
ascii string

available: optional
17ambiguityFactor
xml array[dim_0]
dim_0: determined automatically from xml file
ascii float
This factor is used to adjust the MTF, with a default value of 1100

attribute: beam
ascii string

available: optional
18snrThreshold
xml array[dim_0]
dim_0: determined automatically from xml file
ascii float
Signal-to-noise ratio threshold for ambiguity removal. The default value is: γ_amb=0.02

attribute: beam
ascii string

available: optional
19lowFrequencyMtfThreshold
xml array[dim_0]
dim_0: determined automatically from xml file
ascii float
Parameter used to tune the MTF for low wavenumbers. The default value is: α_mtf=0.25

attribute: beam
ascii string

available: optional
20clutterFactorRegion
xml array[dim_0]
dim_0: determined automatically from xml file
ascii array[dim_0]
dim_0: int(str(@count))

attribute: beam
ascii string

available: optional

attribute: count
ascii string

ascii float
Factors specifying the spectral clutter estimation region (range/azimuth sizes, azimuth position). The default values are: cultreg=[0.15, 0.04, 0.9]
21lambdaScaling
xml array[dim_0]
dim_0: determined automatically from xml file
ascii float
Scaling lambda to give the ROI in azimuth. The default value is: njy=6.911504

attribute: beam
ascii string

available: optional
2activateTotalHs
xml array[dim_0]
dim_0: determined automatically from xml file
ascii uint8
Allow activating the computation of the total significant wave height, value=True to activate the calculation, otherwise False

mapping: "false" -> 0

mapping: "true" -> 1

attribute: beam
ascii string

available: optional
3activateGroupDir
ascii uint8
Allow activating the computation of the peak direction from Group analysis, value=True to activate the calculation, otherwise False

mapping: "false" -> 0

mapping: "true" -> 1
4activateNoiseCorrection
ascii uint8
Allow to trigger the denoising on OSW

mapping: "false" -> 0

mapping: "true" -> 1
5seaCoverageThreshold
ascii float
Threshold on percentage of Sea Coverage. Imagettes having a percentage of Sea Coverage below this threshold will not be processed with a full OSW inversion. Variables not generated will contain fill values. Default is 0%.

available: optional
6useOnlyInference
xml array[dim_0]
dim_0: determined automatically from xml file
ascii uint8
If true, the model inference is performed using the models provided in AUX_ML2 auxiliary product, and if a failure is occurring, the LOP process stops with error. If false, the model inference is performed using the models provided in AUX_ML2 auxiliary product, however, if a failure is occurring, the LOP continues the processing either replacing the result of inference by legacy inversion process (if existing), or by using fill values. The model it applies to can be selected by the "for" attribute, with allowed values "TotalHS" and "Quality Flag"

mapping: "false" -> 0

mapping: "true" -> 1

attribute: for
ascii string

available: optional
7useAncillaryWind
ascii uint8
Use the wind direction from ECMWF. The default value is set to True.

mapping: "false" -> 0

mapping: "true" -> 1
8hsWindSeaMethod
xml string
"legacy_empirical": Uses an empirical algorithm that has been implemented since the start of the mission (for IPF versions earlier than 4.0). "deep_learning": Uses a deep learning model to estimate the Hs wind sea (available for IPF versions 4.0 and later). "None": No Hs wind sea computation is performed for the product.
9useBathy
ascii uint8
Use bathymetry data. The default value is set to True.

mapping: "false" -> 0

mapping: "true" -> 1
10useLandMask
ascii uint8
Use land mask data. The default value is set to True..

mapping: "false" -> 0

mapping: "true" -> 1
11activateXspecEstimationTops
ascii uint8
Estimate the Cross-spectra estimation from TOPS mode. The default value is set to False.

mapping: "false" -> 0

mapping: "true" -> 1

available: optional
1owiProcParams
xml record
idfield namedefinition
0rangeCellSize
ascii double
Size of the SAR derived wind field in the range direction. Wind cells should typically be square therefore nominally rangeCellSize = azimuthCellSize.

unit: "m"
1azimuthCellSize
ascii double
Size of the SAR derived wind field in the azimuth direction. Wind cells should typically be square therefore nominally azimuthCellSize = rangeCellSize.

unit: "m"
2distanceToShore
ascii double
Distance to shore where the processing is not performed.

unit: "km"
3windSpeedStdDev
ascii double
Standard deviation error of the wind speed provided by ancillary wind information.

unit: "m/s"
4windDirStdDev
ascii double
Standard deviation error of the wind direction provided by ancillary wind information.

unit: "degrees"
5gmfIndex
xml array[dim_0]
dim_0: determined automatically from xml file
ascii uint8
Index or name of the Geophysical Model Function (GMF) to be used for the wind inversion, used for either for VV or HH polarisation data. Options supported are integers in the range [ 0, 21]: 0=gmf_cmod2_i3_nn, 1= gmf_cmod_ifr2_nn, 2=gmf_cmod_ifr2_bc_nn,3=gmf_cmod4_nn, 4=gmf_cmod2_i3, 5=gmf_cmod_ifr2, 6=gmf_cmod_ifr2_bc, 7=gmf_cmod4, 8=gmf_cmod5, 9=gmf_cmodcross2pol, 10=gmf_cmodrs2cross4pol, 11=gmf_cmodrs2cross4pol_vachon, 12=gmf_cmod5n, 13=gmf_cmod5h, 14=gmf_cmod5na, 15=gmf_cmod6, 16=gmf_sarmodVV, 17=gmf_sarmodHH, 18=gmf_cmodcross_h14e, 19=gmf_cmodcross_h14s, 20=gmf_cmodcross_ms1a, 21=gmf_cmodrs2cross2pol. The concerned polarisation is discriminated by the attribute named "polarisation" with supported value 'VV' or 'HH'

attribute: polarisation
ascii string

available: optional
6gmf
xml array[dim_0]
dim_0: determined automatically from xml file
xml string
Name of the Geophysical Model Function (GMF) to be used for the wind inversion, used for either for VV or HH polarisation data. One GMF per polarisation (VV and HH) described as an attribute. Allowed values are cmod2_i3_nn, cmod_ifr2_nn, cmod_ifr2_bc_nn, cmod4_nn, cmod2_i3, cmod_ifr2, mod_ifr2_bc, mod4, mod5, modcross2pol, cmodrs2cross4pol, cmodrs2cross4pol_vachon, cmod5n, cmod5h, cmod5na, cmod6, sarmodVV, sarmodHH, cmodcross_h14e, cmodcross_h14s, cmodcross_ms1a, cmodrs2cross2pol

attribute: polarisation
xml string

available: optional
7polarisationRatio
xml string
Name of the polarization ratio to be used for the wind inversion. It is considered only for HH polarisation. Allowed values are mouch1_ and zhang_2.
8inversionQualityThreshold
ascii double
Value above which minimization in the inversion is considered low quality. Valid value range is between 0 and 1e29.
9calibrationQualityThreshold
ascii double
Value above which the calibration of the product is considered to be incorrect. Valid value range is between 0 and 10 dB.

unit: "dB"
10nrcsQualityThreshold
ascii double
Value above which the NRCS estimated at the SAR wind cell resolution is considered as low quality. Valid value range is between -30 and 10 dB.

unit: "dB"
11brightTargetPfa
xml array[dim_0]
dim_0: determined automatically from xml file
ascii double
Probability of false alarm for the removal of bright target.

attribute: polarisation
ascii string

available: optional
12activateNoiseCorrection
ascii uint8
Allow activating the noise correction, value=True to activate the noise correction, otherwise False.

mapping: "false" -> 0

mapping: "true" -> 1
13activateBrightTarget
xml array[dim_0]
dim_0: determined automatically from xml file
ascii uint8
Allow the activation of bright target computation in a given channel 'polarisation', if the bright target computation is not activated for the given channel, it is not taking into account for combined bright target mask.

mapping: "false" -> 0

mapping: "true" -> 1

attribute: polarisation
ascii string

available: optional
14brightTargetEstimatedFrom
xml array[dim_0]
dim_0: determined automatically from xml file
xml string
Parameter allowing to describe for a given channel, the origin of the Bright target mask that has been applied. Possible value examples: "None" No bright target mask applied, "VV" mask from bright target detected on VV only, "VV+VH" mask from bright targets detected on VV channel OR VH channel, "VVxVH" mask from bright targets detected on both VV channel AND VH channel.

attribute: polarisation
xml string

available: optional
15rfiAnnotationThreshold
xml array[dim_0]
dim_0: determined automatically from xml file
xml record
Parameters threshold applied on RFI report annotation value to report the corresponding burst with RFI. Thresholds are expressed with the attribute beam, supported value ‘IW1’, ‘IW2’, ‘IW3’, ‘EW1’, ‘EW2’, ‘EW3’, ‘EW4’, ‘EW5’

attribute: beam
xml string

available: optional


idfield namedefinition
0timeDomainPercentageAffectedLines
ascii double
Threshold on time Domain Percentage Affected Lines
1timeDomainAvgPercentageAffectedSamples
ascii double
Threshold on time Domain Avg Percentage Affected Samples
2timeDomainMaxPercentageAffectedSamples
ascii double
Threshold on time Domain Max Percentage Affected Samples
3freqDomainPercentageAffectedLines
ascii double
Threshold on freqDomainPercentageAffectedLines
4freqDomainMaxPercentageAffectedBw
ascii double
Threshold on freqDomainMaxPercentageAffectedBw
2rvlProcParams
xml record
idfield namedefinition
0rangeBlockSize
ascii double
Size of the Doppler estimation block in the range direction.

unit: "m"
1azimuthBlockSize
ascii double
Size of the Doppler estimation block in the azimuth direction.

unit: "m"
2rangeCellSize
ascii double
Size of grid cell interval in range direction.

unit: "m"
3azimuthCellSize
ascii double
Size of grid cell interval in azimuth direction

unit: "m"
4rangeResolutionReductionFactor
ascii double
Factor of resolution reduction in the range dimension
5azimuthResolutionReductionFactor
ascii double
Factor of resolution reduction in the azimuth dimension
6nSideBands
ascii double
Parameter used to compute the antenna coefficients
7azimuthTileSize
ascii double
Size of the tile along the azimuth dimension for reading buffered data
8yHanningPixels
ascii double
Hanning window size along the azimuth dimension
9xHanningPixels
ascii double
Hanning window size along the range dimension
10rfiAnnotationThreshold
xml array[dim_0]
dim_0: determined automatically from xml file
xml record
Parameters threshold applied on RFI report annotation value to report the corresponding burst with RFI. Thresholds are expressed with the attribute beam, supported value ‘IW1’, ‘IW2’, ‘IW3’, ‘EW1’, ‘EW2’, ‘EW3’, ‘EW4’, ‘EW5’

attribute: beam
xml string

available: optional


idfield namedefinition
0timeDomainPercentageAffectedLines
ascii double
Threshold on time Domain Percentage Affected Lines
1timeDomainAvgPercentageAffectedSamples
ascii double
Threshold on time Domain Avg Percentage Affected Samples
2timeDomainMaxPercentageAffectedSamples
ascii double
Threshold on time Domain Max Percentage Affected Samples
3freqDomainPercentageAffectedLines
ascii double
Threshold on freqDomainPercentageAffectedLines
4freqDomainMaxPercentageAffectedBw
ascii double
Threshold on freqDomainMaxPercentageAffectedBw

detection rule

This product definition is applicable if a product matches the following rule:

exists(/l2AuxiliaryProcessorParameters@schemaVersion) and
at(/l2AuxiliaryProcessorParameters@schemaVersion,
str(.) == "3.16")