L1AuxiliaryProcessorParameters version 2

L1AuxiliaryProcessorParameters_v2

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

root type

xml record
idfield namedefinition
0l1AuxiliaryProcessorParameters
xml record
L1 Processor parameters auxiliary file definition (AUX_PP1).

attribute: schemaVersion
xml string

available: optional

attribute: noNamespaceSchemaLocation
xml string

available: optional


idfield namedefinition
0productList
xml record
List of L1 products containing the applicable auxiliary parameters for each. This list contains an entry for each product the IPF is capable of generating, indexed by its unique product identifier.

attribute: count
xml string


idfield namedefinition
0product
xml array[dim_0]
dim_0: determined automatically from xml file
xml record
Product auxiliary parameters. This DSR contains all of the auxiliary parameters required to process a single product. The parameters are stored in structures that are grouped together by the logical processing steps used during image creation. The parameters within this DSR and its children are not polarisation dependent and in general apply to the entire product; however, in some cases a distinction must be made amongst swaths and when this is necessary the records are indexed with a swath identifier.

idfield namedefinition
0productId
xml string
Product type identifier as per S1 IPF ICD to which this set of parameters applies. The productId is used to index and find the correct set of auxiliary parameters for each product the IPF is capable of generating.
1commonProcParams
xml record
Common processing auxiliary parameters. This record holds the parameters that are common among multiple steps in the image processing chain.

idfield namedefinition
0correctIQBiasFlag
ascii uint8
Flag to control the correction of the constant biases from the I and Q channels. IQ bias correction will be performed if and only if this flag is set to "true".

mapping: "false" -> 0

mapping: "true" -> 1
1correctIQGainImbalanceFlag
ascii uint8
Flag to control the correction of the IQ gain imbalance. IQ gain imbalance correction will be performed if and only if this flag is set to "true".

mapping: "false" -> 0

mapping: "true" -> 1
2correctIQOrthogonalityFlag
ascii uint8
Flag to control the correction of the IQ orthogonality. IQ orthorgonality correction will be performed if and only if this flag is set to "true".

mapping: "false" -> 0

mapping: "true" -> 1
3correctBistaticDelayFlag
ascii uint8
Flag to compensate for the bi-static delay. Correction will be performed if and only if this flag is set to "true".

mapping: "false" -> 0

mapping: "true" -> 1
4correctBistaticDelayMethod
xml string
Method used to compensate for the bi-static delay. If set to "Coarse" then only the coarse bistatic delay correction is applied; otherwise, if set to "Fine" then the full correction is applied. Flag introduced starting from IPF V290.
5correctRxVariationFlag
ascii uint8
Flag to control the correction of the gain variation across the receive window. Receive variation correction will be performed if and only this flag is set to "true".

mapping: "false" -> 0

mapping: "true" -> 1
6ellipsoidParams
xml record
Ellipsoid and DEM parameters.

idfield namedefinition
0ellipsoidName
xml string
Name of the reference ellipsoid.
1ellipsoidSemiMajorAxis
ascii double
Semi-major axis of ellipsoid [m].

unit: "m"
2ellipsoidSemiMinorAxis
ascii double
Semi-minor axis of ellipsoid [m].

unit: "m"
3useDemFlag
ascii uint8
This flag is used to control the use of a DEM during processing. Set to true if a DEM is to be used during processing, false otherwise.

mapping: "false" -> 0

mapping: "true" -> 1
7aziProcBlockParamsList
xml record
Azimuth processing block parameters record indexed by swath. There will be one record per swath.

attribute: count
xml string


idfield namedefinition
0aziProcBlockParams
xml array[dim_0]
dim_0: determined automatically from xml file
xml record
Azimuth processing block parameters record indexed by swath. There will be one record per swath.

idfield namedefinition
0swath
xml string
Swath identifier. This parameter defines the swath to which this record applies.
1aziProcBandwidth
ascii float
Total processing bandwidth [Hz] (excluding any additional bandwidth resulting from the taperBwExtentFraction). This parameter defines the bandwidth (Bw) to use during processing. The processing bandwidth (Bw) must be 0 < Bw <= PRF.
2aziBlockSize
ascii uint32
Azimuth processing block size [lines].
3extraAziProcBlockOverlap
ascii uint32
Extra azimuth block overlap to account for possible variation of Doppler centroid frequency from azimuth block to azimuth block [lines].
4maxFdc
ascii array[dim_0]
Maximum expected Doppler centroid frequency [Hz]. Used to calculate the SM SLC azimuth matched filter throwaway component of azimuth block overlap as applicable to all azimuth blocks in a segment.

dim_0: if(exists(@count), int(str(@count)), 1)

attribute: count
ascii string

available: optional

ascii float
8outputMeanExpected
ascii double
This parameter specifies the expected mean of the samples in the output image and is used for verifying that the calculated mean of the output samples is within the tolerated threshold.
9outputMeanThreshold
ascii double
Threshold for setting the outputDataMeanOutsideNominalRange flag in the output product annotations. This is the value T, such that the measured mean must fall between the outputMeanExpected-T and outputMeanExpected+T.
10outputStdDevExpected
ascii double
This parameter specifies the expected standard deviation of the samples in the output image and is used for verifying that the calculated std. dev. of the output samples is within the tolerated threshold.
11outputStdDevThreshold
ascii double
Threshold for setting the outputDataStdDevOutsideNominalRange flag in the output product annotations. This is the value D, such that the measured standard deviation must fall between the outputStdDevExpected-D and outputStdDevExpected+D.
12topsFilterConvention
xml string
Name of the TOPS filter convention to use during processing. This field controls how the TOPS ramping/de-ramping filters are defined. If set to "Only Echo Lines" then the filter is defined using only the echo lines in a burst; otherwise, if set to "All Lines" then the filter is defined using all the lines in a burst.
13orbitModelMargin
ascii double
Additional time to add to the start and end of the orbit model generated by the IPF [s]. This provides margin for performing interpolation near the boundaries of the sensing start and stop times and extrapolation beyond the boundaries of the sensing start and stop times. For example, if the sensing start time is Tstart, the sensing stop time is Tstop and orbitModelMargin is 2.0, then the orbit model generated by the IPF will range from (Tstart - 2.0) .. (Tstop + 2.0)

available: optional
2preProcParams
xml record
Pre-processing auxiliary parameters. This record contains the auxiliary parameters required during image pre-processing.

idfield namedefinition
0inputMeanExpected
ascii double
This parameter specifies the expected mean of the input I and Q samples and is used in verifying that the calculated mean of the input samples is within the tolerated threshold.
1inputMeanThreshold
ascii double
Threshold for setting the inputDataMeanOutsideNominalRange flag in the output product annotations. This is the value T, such that the measured mean must fall between the inputMeanExpected-T and inputMeanExpected+T. This threshold is used for both the I and Q channels.
2inputStdDevExpected
ascii double
This parameter specifies the expected standard deviation of the input I and Q samples and is used in verifying that the calculated std. dev. of the input samples is within the tolerated threshold.
3inputStdDevThreshold
ascii double
Threshold for setting the inputDataStdDevOutsideNominalRange flag in the output product annotations. This is the value D, such that the measured std. dev. must fall between the inputStdDevExpected-D and inputStdDevExpected+D. This threshold is used for both the I and Q channels.
4terrainHeightAziSpacing
ascii double
Spacing of terrain height estimates along azimuth [s]. The calculation, terrainHeightAziSpacing + terrainHeightAziBlockSize, defines the location (relative to the start of the segment) and size of the azimuth blocks used to generate each terrain height estimate. These two parameters should be set to ensure that there is an overlapping region within each adjacent azimuth block.

unit: "s"
5terrainHeightAziBlockSize
ascii double
Size of the block along azimuth used to calculate an average terrain height [s]. The calculation, terrainHeightAziSpacing + terrainHeightAziBlockSize, defines the location (relative to the start of the segment) and size of the azimuth blocks used to generate each terrain height. . These parameters should be set to ensure that there is an overlapping region within each adjacent azimuth block.

unit: "s"
6chirpReplicaSource
xml string
Chirp replica to use during processing. The extracted replica will be used if this parameter is set to "Extracted" and the IPF determines that the reconstructed replica is valid; otherwise, the nominal chirp will be used if this field is set to "Nominal" or the reconstructed replica is deemed invalid.
7replicaThresholds
xml record
Thresholds used to assess the quality of the replica reconstruction and the PG product.

idfield namedefinition
0maxXCorrPulseIrw
ascii double
Maximum allowable IRW (3-dB width) of the cross-correlation with the nominal replica [samples]. Used for setting the replicaReconstructionFailedFlag in the output product annotations.
1maxXCorrPulsePslr
ascii double
Maximum allowable PSLR of the cross correlation with the nominal replica [dB]. Used for setting the replicaReconstructionFailedFlag in the output product annotations.

unit: "dB"
2maxXCorrPulseIslr
ascii double
Maximum allowable ISLR of the cross correlation with the nominal replica [dB]. Used for setting the replicaReconstructionFailedFlag in the output product annotations.

unit: "dB"
3maxPgAmpStdFraction
ascii float
Maximum deviation from the mean allowed for the PG product amplitude, measured as a fraction of the standard deviation. Relative PG product validation shall fail if this value is exceeded.
4maxPgPhaseStdFraction
ascii float
Maximum deviation from the mean allowed for the PG product phase, measured as a fraction of the standard deviation. Relative PG product validation shall fail if this value is exceeded.
5maxPgAmpError
ascii float
Maximum deviation allowed for a PG product amplitude from the corresponding PG product model value. Absolute PG product validation shall fail if this value is exceeded.
6maxPgPhaseError
ascii float
Maximum deviation allowed for a PG product phase from the corresponding PG product model value [radians]. Absolute PG product validation shall fail if this value is exceeded.

unit: "radians"
7maxNumInvalidPgValFraction
ascii float
Maximum number of invalid PG product values allowed, expressed as a fraction of the total number of PG values. The PG product model will be used instead of the extracted PG product values if this value is exceeded.
8missingLinesThreshold
ascii double
Threshold for setting the missingLinesSignificant flag in the output product annotations. This parameter ranges between 0 and 1 and specifies the percentage of missing lines to total lines [%]. For TOPS products, this threshold is relative to each individual swath, in other words the missingLinesSignificant flag is set to true if the number of missing lines in any of the swaths is above the missingLinesThreshold.

unit: "%"
9linesPerGapThreshold
ascii uint32
This parameter specifies the number of consecutive missing lines in the input data which constitute a gap [lines].
10missingGapsThreshold
ascii uint32
Threshold for setting the significantGapsInInputData flag in the output product annotations. This parameter specifies the number of missing gaps permitted in the input data. For TOPS products, this threshold is relative to each individual swath, in other words the significantGapsInInputData flag is set to true if the number of missing gaps in any of the swaths is above the missingGapsThreshold.
11performInternalCalibrationFlag
ascii uint8
Flag controlling the calculation of the internal calibration from the calibration pulses extracted from the downlink. If this flag is set to true then the internal calibration information will be calculated by the IPF using the calibration pulses extracted from the downlink. If this flag is set to false then the internal calibration information will not be calculated from the calibration pulses extracted from the downlink. In addition, if this flag is set to false, the values provided for chirpReplicaSource and pgSource will be ignored and set to "Nominal" and "Model" espectively.

mapping: "false" -> 0

mapping: "true" -> 1
12pgSource
xml string
PG source to use during processing. The PG derived from the extracted replica will be used if this parameter is set to "Extracted" and the IPF determines that the reconstructed replica is valid; otherwise, the pgModel from the AUX_INS data will be used if this field is set to "Model" or the reconstructed replica is deemed invalid.
13estimateNoiseEquivalentPowerFlag
ascii uint8
Flag introduced starting from IPF V290 to manage the new L0N products format including also noise-equivalent echoes. If set to true, then the noise power is estimated also from the noise equivalent echoes; otherwise, if set to false only pure noise echoes are used.

mapping: "false" -> 0

mapping: "true" -> 1

available: optional
3dcProcParams
xml record
Doppler centroid processing auxiliary parameters. This record contains the auxiliary parameters required during Doppler centroid processing.

idfield namedefinition
0dcMethod
xml string
Doppler centroid estimation method. Although the DCE from both orbit & attitude and data are always performed and the results provided in the output product annotations, this parameter is used to specify exactly which Doppler centroid estimation method to use during the image focusing.
1dcInputData
xml string
Type of input data used for Doppler centroid estimation. Options are "Raw" and "Range Compressed".
2dcPredefinedCoefficients
ascii array[dim_0]
Pre-defined Doppler centroid coefficients. These Doppler centroid coefficients shall be used during processing if and only if the dcMethod element is set to "Pre-defined". This parameter is an array of floating point numbers separated by spaces.

dim_0: int(str(@count))

attribute: count
ascii string

ascii float
3dcRmsErrorThreshold
ascii float
Doppler centroid estimation root mean squared (RMS) error threshold. If theRMS error of the Doppler centroid estimate from data is above this threshold they shall not be used during processing; instead, the Doppler centroid calculated from orbit and attitude shall be used, unless overridden by the dcMethod = Pre-defined.

available: optional
4slcProcParams
xml record
SLC processing auxiliary parameters. This record contains the auxiliary parameters required during SLC image processing.

idfield namedefinition
0applyElevationAntennaPatternFlag
ascii uint8
Elevation antenna pattern correction flag. True if the EAP is to be applied, false otherwise.

mapping: "false" -> 0

mapping: "true" -> 1
1applyRangeSpreadingLossFlag
ascii uint8
Apply range spreading loss correction flag. True if the RSL is to be applied, false otherwise.

mapping: "false" -> 0

mapping: "true" -> 1
2estimateThermalNoiseFlag
ascii uint8
Thermal noise estimation flag. True if thermal noise estimation is to be performed, false otherwise.

mapping: "false" -> 0

mapping: "true" -> 1
3rfiMitigationPerformed
xml string
Whether or not to perform the RFI mitigation step: if "Always" the RFI mitigation step is always performed; if "Never" the RFI mitigation step is not performed; if "BasedOnNoiseMeas" the preliminary RFI detection from noise measurements decides whether to perform RFI mitigation.
4rfiMitigationDomain
xml string
In case the RFI mitigation step is performed, this flag indicates in what domain it has to be applied: "Time", "Frequency", "TimeAndFrequency".
5rrfSpectrum
xml string
The type of range matched filter to use during processing. "Unextended": range reference function is unextended in frequency domain; "Extended Flat": range reference function is extended and flat in frequency domain; and, "Extended Tapered": range reference function is extended and tapered in frequency domain.
6swathParamsList
xml record
List of swath-dependent SLC processing parameters. There is one record per swath for each mode.

attribute: count
xml string


idfield namedefinition
0swathParams
xml array[dim_0]
dim_0: determined automatically from xml file
xml record
idfield namedefinition
0swath
xml string
Swath identifier. This parameter defines the swath to which this record applies.
1gain
ascii array[dim_0]
Product specific gain. This parameter defines the gain that is applied to each output sample during azimuth processing.

dim_0: if(exists(@count), int(str(@count)), 1)

attribute: count
ascii string

available: optional

ascii double
2instantaneousBandwidth
ascii float
Azimuth instantaneous bandwidth [Hz]. This field is applicable only to IW and EW modes.

unit: "Hz"
3nominalBeamWidth
ascii double
Nominal width of the beam [radians].

unit: "radians"

available: optional
5postProcParams
xml record
Post processing auxiliary parameters. This record contains the auxiliary parameters required during image post processing. This includes: SLC post-processing, GRD processing and Quick-look image processing.

idfield namedefinition
0rangeParamsList
xml record
Range processing parameters. This list contains the swath-dependent auxiliary parameters required for range processing. The list contains a separate record for each swath, indexed using the applicable swath identifier. For SM SLC products and SM, IW and EW GRD products there is one entry in the list. For IW and EW SLC products, there is one entry per swath (3 and 5 respectively). For all WV products there are two entries in the list.

attribute: count
xml string


idfield namedefinition
0rangeParams
xml array[dim_0]
dim_0: determined automatically from xml file
xml record
This record contains the set of auxiliary parameters required during range processing. For each product type, there is one record for each applicable swath within the product. There will be one record per swath for each mode. For example, for S1 IW there will be 3 records, and for ASAR IM there will be 7 records.

idfield namedefinition
0swath
xml string
Swath identifier. This parameter defines the swath to which this record applies.
1weightingWindow
xml string
Name of the weighting window to use during processing.
2windowCoefficient
ascii double
Value of the weighting window coefficient to use during processing.
3processingBandwidth
ascii double
Total processing bandwidth [Hz]. This parameter defines the bandwidth (Bw) to use during processing. For range, the processing bandwidth (Bw) must be 0 < Bw <= pulse Bw, for azimuth the processing bandwidth (Bw) must be 0 < Bw <= PRF.

unit: "Hz"
4lookBandwidth
ascii double
Look bandwidth [Hz]. This parameter defines the bandwidth to use for each look during processing.

unit: "Hz"
5numberOfLooks
ascii uint32
Number of looks. This parameter defines the number of looks to use during multi-look processing.
6pixelSpacing
ascii double
Spacing between pixels in the output image [m].

unit: "m"
7multiLookThrowaway
ascii int32
Number of ground range samples to be discarded at both edges.
1azimuthParamsList
xml record
Azimuth processing parameters. This list contains the swath-dependent auxiliary parameters required for azimuth processing. The list contains a separate record for each swath, indexed using the applicable swath identifier. For SM SLC products and SM, IW and EW GRD products there is one entry in the list. For IW and EW SLC products, there is one entry per swath (3 and 5 respectively). For all WV products there are two entries in the list.

attribute: count
xml string


idfield namedefinition
0azimuthParams
xml array[dim_0]
dim_0: determined automatically from xml file
xml record
This record contains the set of auxiliary parameters required during azimuth processing. For each product type, there is one record for each applicable swath within the product. There will be one record per swath for each mode. For example, for S1 IW there will be 3 records, and for ASAR IM there will be 7 records.

idfield namedefinition
0swath
xml string
Swath identifier. This parameter defines the swath to which this record applies.
1weightingWindow
xml string
Name of the weighting window to use during processing.
2windowCoefficient
ascii double
Value of the weighting window coefficient to use during processing.
3processingBandwidth
ascii double
Total processing bandwidth [Hz]. This parameter defines the bandwidth (Bw) to use during processing. For range, the processing bandwidth (Bw) must be 0 < Bw <= pulse Bw, for azimuth the processing bandwidth (Bw) must be 0 < Bw <= PRF.

unit: "Hz"
4lookBandwidth
ascii double
Look bandwidth [Hz]. This parameter defines the bandwidth to use for each look during processing.

unit: "Hz"
5numberOfLooks
ascii uint32
Number of looks. This parameter defines the number of looks to use during multi-look processing.
6pixelSpacing
ascii double
Spacing between pixels in the output image [m].

unit: "m"
7multiLookThrowaway
ascii int32
Number of ground range samples to be discarded at both edges.
2annotationVectorStepSize
ascii uint32
The decimation factor used on annotation vectors when written to the output product. Inside the IPF, each annotation vector could have a point for every range sample. To reduce product size, only points every annotationVectorStepSize are written to the output annotation vectors.
3generateCalibrationLutsFlag
ascii uint8
Flag to control the generation of the absolute calibration LUTs. True if the calibration LUTs are to be created, false otherwise.

mapping: "false" -> 0

mapping: "true" -> 1
4applyAzimuthAntennaPatternFlag
ascii uint8
Azimuth Antenna Pattern Flag. True if the AAP is to be applied, false otherwise.

mapping: "false" -> 0

mapping: "true" -> 1
5applyTopsDescallopingFlag
ascii uint8
Perform de-scalloping for TOPS by applying the Azimuth Antenna Element Pattern. True if TOPS de-scalloping is to be performed by applying the AAEP, false otherwise. This flag is applicable only to IW and EW modes and is ignored for all others.

mapping: "false" -> 0

mapping: "true" -> 1
6detectFlag
ascii uint8
True to detect power and square root extract measurement data, false otherwise.

mapping: "false" -> 0

mapping: "true" -> 1
7mergeFlag
ascii uint8
True to merge the swaths of output data and annotations, false otherwise. Only valid for IW and EW, not applicable to other modes.

mapping: "false" -> 0

mapping: "true" -> 1
8createInternalSLCFlag
ascii uint8
True if the output of post-processing is an internal SLC product, in which case post-processing will pass the input SLC product through without applying further processing.

mapping: "false" -> 0

mapping: "true" -> 1
9grdProcParams
xml record
GRD processing auxiliary parameters. This record contains the auxiliary parameters required during GRD image processing.

idfield namedefinition
0applySrgrConversionFlag
ascii uint8
Slant Range to Ground Range (SRGR) conversion flag. True if SRGR conversion is to be performed, false otherwise.

mapping: "false" -> 0

mapping: "true" -> 1
1removeThermalNoiseFlag
ascii uint8
Thermal noise removal flag. True if thermal noise removal is to be performed, false otherwise.

mapping: "false" -> 0

mapping: "true" -> 1
10createQlImageFlag
ascii uint8
Create Quick-look image flag. This flag controls the creation of a Quick-look image. It is set to true if a Quick-look image should be created; or, false otherwise.

mapping: "false" -> 0

mapping: "true" -> 1
11qlProcParams
xml record
Quick-look processing auxiliary parameters. This record contains the auxiliary parameters required during Quick-look image processing. This structure need only be present if the createQlImageFlag is true.

idfield namedefinition
0rangeDecimationFactor
ascii uint32
Range decimation factor for the image.
1rangeAveragingFactor
ascii uint32
Range averaging factor for the image.
2azimuthDecimationFactor
ascii uint32
Azimuth decimation factor for the image.
3azimuthAveragingFactor
ascii uint32
Azimuth averaging factor for the image.

available: optional
1applicationLutList
xml record
List of application LUTs. This element is a list of all available application LUTs. The application identifier used to index the list comes from the Job Order.

attribute: count
xml string


idfield namedefinition
0applicationLut
xml array[dim_0]
dim_0: determined automatically from xml file
xml record
Application LUT record. This element contains the information required to identify the application scaling LUT specified in the Job Order. The ICD currently defines four application scaling LUTs, one for each mode. However, more can be added, so long as the applicationLutId matches the Application_LUT processing parameter in the Job Order.

idfield namedefinition
0applicationLutId
xml string
Name of this application scaling LUT.
1scalingLutList
xml record
List of application scaling LUTs for this applicationLutId. There is one entry for each output pixel type.

attribute: count
xml string


idfield namedefinition
0scalingLut
xml array[dim_0]
dim_0: determined automatically from xml file
xml record
Application scaling LUT record. This record provides the scaling LUT for products in the format specified by the outputPixels field.

idfield namedefinition
0outputPixels
xml string
Pixel format. Application scaling LUTs are specific to output pixel data type. This field specifies the output pixel type to which this LUT applies.
1incidenceAngleStart
ascii double
Incidence angle of the first value of the LUT [degrees].

unit: "degrees"
2angleIncrement
ascii double
Step size of the incidence angle between each value [degrees].

unit: "degrees"
3values
ascii array[dim_0]
Application LUT values. This element is a vector containing attribute "count" floating point values separated by spaces [linear].

dim_0: int(str(@count))

attribute: count
ascii string

ascii float

detection rule

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

exists(/l1AuxiliaryProcessorParameters@schemaVersion) and
at(/l1AuxiliaryProcessorParameters@schemaVersion,
str(.) == "3.7")