RSMODEL

Description

RSMODEL computes the math model of a satellite image using an ASAR/RADARSAT-specific model, and stores the results in a segment for each input image.

Parameters

rsmodel(mfile, dbgc, orbit, mmseg)

Name	Type	Caption	Length
MFILE*	str	Input file name, directory, or text file	1 -
DBGC	List[int]	Input GCP segment or layer	0 - 1
ORBIT	List[int]	Input orbit segment or layer	0 - 1
MMSEG	List[int]	Math model segment or layer	0 - 1

* Required parameter

Parameter descriptions

MFILE

Specifies the name of a folder, image file, or text file that contains the input raw images. Wildcards (*) can be used.

MFILE can be set using any of the following options:

A specific data file name or directory path and file name (for example, "irvine.pix" or "c:\data\irvine.pix").
A specific file name pattern or all of the files in a folder (for example, "c:\data\*.pix" or "c:\data").
An existing text file that contains references to multiple files with, optionally, different parameter settings on a per file basis (for example, "c:\list.txt").

If the text file option is used, the following general rules apply:

Specify a .txt extension for the file containing multiple files and different parameter values.
List each set of parameters on its own line in the given order (see below).
Specify string parameters within quotation marks.
Do not specify numeric parameters within quotation marks.
A quotation mark preceded by a backslash is used as part of the string. For example, "ab\"c" is used as: ab"c.
Use an exclamation mark (!) before writing a comment in the text file.
Use semi-colons to delimit the parameters.
Leave the position between the semi-colons empty (";;") if you do not want to specify a value. Alternatively, if there are no remaining parameters to be specified on the end of a line, you may leave it blank.
Parameters in a text file may or may not be specified in the function:
- If a parameter is specified in the function and in the text file, the value provided in the text file is used.
- If a parameter is not specified in the text file, the parameter can be set in the function.

If MFILE is a directory name or if multiple file names are entered, then all images in MFILE should be processed using the parameters set for RSMODEL.

If a directory is specified, then the DBGC, MMSEG, and ORBIT parameters are set to a single value for all input images. If a text file is specified, the DBGC, MMSEG, and ORBIT parameters are read from the text file for each image, and those parameters can be empty.

If one file is specified for MFILE, the model computed will be an independent model (one image).

If a text file is specified for MFILE, the listed files in the text file are processed with the listed parameters.

DBGC

Specifies the ground control point (GCP) segment or layer to use to compute the model.

If a directory is specified for MFILE, then this segment number will be applied to all images. If a text file is specified, DBGC is read from the text file, and this parameter can be empty.

ORBIT

Specifies the orbit segment or layer to use to compute the model.

If a directory is specified for MFILE, then this segment number will be applied to all images. If a text file is specified, ORBIT is read from the text file, and this parameter can be empty. If no value is specified, the last orbit segment is used automatically.

MMSEG

Specifies the math model segment or layer that stores the computed model.

If a directory is specified for MFILE, then this segment number will be applied to all images. If a text file is specified, MMSEG is read from the text file, and this parameter can be empty. If no value is specified, a new segment is created.

Return Value

Returns: execution status

Type: PCI_INT

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

Details

RSMODEL computes the math model of a satellite image using the ASAR/RADARSAT-specific model, and therefore only applies to those two sensors. The mathematical models are stored in a math model segment.

It is an independent model, not a bundle adjustment, but allows accurate solution of the model with few or no GCPs.

The input is a raw image with an orbit segment or layer, and can include GCPs. The output is an updated math model segment or layer for each of the input images.

Example

You have a RADARSAT image and want to correct the data using the RADAR-specific model.

from pci.rsmodel import *

mfile = "radarsat.pix"	# input image file
dbgc = [3]	# gcp segment 3
orbit = [2]	# orbit segment 2
mmseg = []	# create a new math model segment

rsmodel (mfile, dbgc, orbit, mmseg)

Environments	PYTHON :: EASI :: MODELER
Quick links	Description :: Parameters :: Parameter descriptions :: Return Value :: Details :: Example :: Related