ORTHOSAR2

Generate orthorectified image for SAR data


EnvironmentsPYTHON :: EASI
Quick linksDescription :: Parameters :: Parameter descriptions :: Return Value :: Details :: Example

Back to top

Description


Uses different geometric models to orthorectify images.
Back to top

Parameters


orthosar2(fili, dbic, outbgd, filedem, filo)

Name Type Caption Length Value range
FILI * str Input file name 1 -    
DBIC List[int] Input raster channel(s) 0 -    
OUTBGD List[float] Output background 0 - 1 Default: 0
FILEDEM str File or directory containing the digital elevation model 0 -    
FILO str Output file or directory 0 -    

* Required parameter
Back to top

Parameter descriptions

FILI

Input scene in a SAR geometry to be orthorectified

DBIC

Specifies the channel(s) in the input file to be processed.

If this parameter is not specified, all channels in the source file will be processed.

OUTBGD

Specifies the background (NoData) value to use for ortho pixels that are not populated. All channels are set to the same background value. The provided background value will be truncated to the range allowed by the source image data type.

FILEDEM

Optionally specifies the name of a file or directory containing DEM tiles.

If FILEDEM is the name of a single file, the parameters DBEC, BACKELEV, ELEVREF, ELEVUNIT and ELFACTOR are used, if provided.

If FILEDEM is an empty string, the offset component of ELFACTOR and the ELEVREF parameter are used to define the height surface for orthorectification. Note that if ELEVREF is Mean Sea Level (MSL), this constant elevation is treated as a Mean Sea Level height and may be converted to an ellipsoidal height before use.

If FILEDEM is the name of an existing directory, this directory is searched for a file named index.txt, as well as a set of DEM raster tiles. The index.txt file contains information describing the raster tiles. The format of index.txt and specific requirements for the individual DEM tiles are described in the Details section.

FILO

Specifies the name of the output file or directory to receive the processed files, depending on the value of MFILE.

If MFILE is the name of a single file, this parameter specifies the name of the new orthorectified file to create. If FILO is an empty string, the output file will have the same name as the input file, prefixed with an "o".

If MFILE represents multiple files, this parameter specifies the name of the output directory where the new files will be created. Each output file will have the same name as its corresponding input file, prefixed with an "o". If FILO is an empty string, the output files will be generated in the current working directory.

Back to top

Return Value

Returns: Program execution status

Type:  PCI_INT

The return value is 0. This function returns only if it executes successfully; otherwise, it throws an exception.

Back to top

Details

Back to top

Example

from pci.orthosar2 import orthosar2

fili = "rawAirphoto.pix"
dbic = [3,2,1]
outbgd = [0]
filedem = "dem.pix"
filo = "oAirphoto_trim512_ch321.pix"

orthosar2( fili, dbic, outbgd, filedem, filo )
        

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