Data Ingest SAR module


Quick linksDescription :: Parameters :: Parameter descriptions :: Details :: References

Back to top

Description


The Data Ingest SAR module imports the specified synthetic aperture radar (SAR) data set into the PCIDSK image format and automatically extracts the required metadata. By default, the entire image is imported. Image channels are stored automatically according to the input data type. Single-look (that is, unfiltered) data is stored as a scattering matrix, while multi-look (filtered) data is stored as a covariance matrix.
Back to top

Parameters


Name Caption
Scene Source Input scene folder
Output Folder Output folder
Build Pyramids Builds pyramids
Overwrite Results Overwrite existing results
Send Email Email notification settings
Calibrate Calibrate data
Calibration Type Calibration type
Apply Filter Apply filter to ingested data
Filter Type Filter type
Filter Size Filter size (pixels)
Back to top

Parameter descriptions

Scene Source

The path and name of the folder containing RAW SAR scenes to ingest as acquired from the satellite vendor.

The folder cannot contain a mixture of sensor types; rather, keep multiple sensor types separate, as the module is capable of traversing nested folders.

Note: When the scene source is RADARSAT-2 data in compressed (.zip) format, the module expands the compressed file and recognizes the imagery before ingesting the data. When the scene source is compressed KOMPSAT-5 or Cosmo SkyMed data, it must be uncompressed manually prior to ingestion.

This parameter is mandatory.

Output Folder

The path and name of the folder to which to write the ingested data in PCIDSK format.

The Data Ingest SAR module creates PCIDSK files for each raw image specified for Scene Source. An RPC radar OrthoEngine project file of each scene with a valid math model is also created.

After the scenes are ingested, an OrthoEngine project file is created according to the math model of the first ingested scene. If a subsequent ingested scene does not contain enough information to meet the requirement of the selected math model, it will not be included in the OrthoEngine project file. This may occur if the input folder contains scenes of varying processing levels; for example, SLC, GEC, and GTC.

The selected math model is either Toutin’s Model, Radar Specific Model, or Rational Function. If more than one math model can can be calculated for a given scene, Rational Function is used.

Build Pyramids

This check box controls whether to build image pyramids (raster overviews) for the ingested scenes.

Building pyramids improves performance in some subsequent processing steps. They can use the pyramids instead of reading all the pixels. However, building pyramids can cause the ingest job to take longer to complete. If immediately after ingestion you intend only to create orthorectified images, you need not build pyramids.

When to turn on pyramids:

For more information on pyramids, see the Pyramid module.

Overwrite Results

Select this check box to overwrite the existing output files, if any exist. If this check box is left clear, and an output file exists in the relevant folder, the status of the job displays a message informing you of the existence and name of the output file. The message is also written to the event log of the job.

Send Email

If necessary, you can set up CATALYST Enterprise to send an email notification on job start and job completion.

With this check box selected, an email message is sent to each address specified in the Email Addresses box after the job starts and on completion.

You can specify one or more addresses, and each must be separated by a comma or a semi-colon. The email address of the user currently logged in displays by default.

Calibrate

Selected by default, this option applies radiometric calibration to supported RADARSAT-2 (SLC, SGX, SGF) and Cosmo SkyMed (SCS_B, DGM_B) images. The calibration is applied based on the coefficients provided in the metadata of the scene.

With this check box selected, the module calibrates the data using the method selected in the Calibration Type list.

Note: For more information on the sensors CATALYST Enterprise supports, including data products and calibration, see Supported SAR sensors.

Calibration Type

The type of radiometric calibration to apply. This defines the physical quantity that the imported pixels will represent.

Available options are:

This parameter is mandatory when the Calibrate check box is selected.

Apply Filter

Select this check box to apply a spatial filter to the ingested data.

When selected, the module applies the filter selected in the Filter Type list.

Filter Type

The type of filter to apply to the ingested data.

Available options are:

This parameter is mandatory when the Apply Filter check box is selected.

Filter Size

The filter size in horizontal (columns) and vertical (lines) directions, in pixels. The value must be an odd integer between 1 and 33.

When Adaptive Lee is selected for the Filter Type parameter, the window must be specified as a square for the Filter Size parameter, such as 9 x 9 pixels (9,9). When available, the Boxcar filter type can be specified as a rectangle, such as 5 x 9 pixels (5,9).

If no value is specified for this parameter, the module uses a default filter of 7 x 7 pixels (7,7).

Back to top

Details

General job details

Preprocessing requirements

Radarsat-2 images can be ingested as compressed (zipped) files. All other sensor data must be decompressed prior to ingestion. The file names of the Radarsat-2 compressed files should not have been modified.

The product naming convention for electronic FTP delivery is as follows:

RS2_OrderKey_ProductKey_DeliveryKey_BeamMode_Date_Time_Polarizations_ProcessingLevel.zip

For example:

RS2_OK774_PK6404_DK334_MF23_20080328_075402_HV_SGF.zip

where:
  • RS2 = Radarsat-2
  • OK774 = Order Key
  • PK6404 = Product Key
  • DK334 = Delivery Key
  • MF23 = Beam Mode
  • 20080328 = Acquisition Date
  • 075402 = Start Time
  • HV = Polarization
  • SGF = Processing Level
Note: For a complete description of the Radarsat-2 product naming convention, refer to the document cited in the References section.

Module details

With the Data Ingest SAR module, you can automatically import raw satellite-sensor data into the PCIDSK format. This is a mandatory step in the CATALYST Enterprise workflows, and allows other actions to take place, including:
  • Ingesting the nominal math model provided with the raw SAR data
  • Setting default metadata in the ingested PCIDSK file

With complex imagery, the module converts the input data set into PCIDSK complex-imagery format, required for processing by other SAR modules.

The Data Ingest SAR module reads the scene-source folder to identify each raw scene to import to PCIDSK format. For each valid raw scene, the module creates and submits a child job.

Job results

For each valid raw scene in the scene-source folder, the module produces a PCIDSK file, with a file name created automatically, in the specified output folder. Output file names are created according to the following pattern:

<sceneid>_<suffix>.pix

"<sceneid>" corresponds to the name of each individual image ingested. "<suffix>" corresponds to the processing applied. Ingested images are written to a rawpix output folder, created automatically.

When a value is specified for the Filter Type parameter, the filtered images are written to a subfolder of the output folder, also created automatically.

Example

A SAR image U3-HH-2010-05-14-SLC is ingested with no calibration, but filtered with a 5 x 5 boxcar filter and the output folder is \results. The following files and folders are created:
  • \results\rawpix\U3-HH-2010-05-14-SLC_RAW_SAR.pix
  • \results\filtered5x5\U3-HH-2010-05-14-SLC_RAW_SAR.pix
When available, the Data Ingest SAR module extracts the following from the data provider and adds them to the output PCIDSK (pix) file:
  • Ground control points (GCP)
  • Orbit segment
  • Satellite model segment (binaries)
  • Incidence angle array
Restriction: When running this module on a Linux operating system, do not use circular symbolic links, because this will cause the job to loop continuously. For example, when you ingest the contents of folder /abc, make sure the following does not exist:
  • /abc -> /def
  • /def -> /xyz
  • /xyz -> /abc
Back to top

References

MacDonald, Dettwiler and Associates Ltd., RADARSAT-2 Product Format Definition, RN-RP-51-2713, Issue 1/5. November 24, 2003.

© PCI Geomatics Enterprises, Inc.®, 2026. All rights reserved.