HOTSPOT

Description

HOTSPOT performs hot spot correction on image data.

Parameters

hotspot(fili, dbic, filo, dboc)

Name	Type	Caption	Length
FILI *	str	Input file name	1 -
DBIC *	List[int]	Input raster channel(s) or layer(s)	1 -
FILO *	str	Output file name	1 -
DBOC *	List[int]	Output raster channel(s) or layer(s)	1 -

* Required parameter

Parameter descriptions

FILI

Specifies the name of the file that contains the input image channel(s) to be corrected.

DBIC

Specifies the channel(s) or layer(s) in the input file to be corrected. Up to 1,024 channels or layers can be handled and a maximum of 48 integer values can be specified. Duplicate output channels are not allowed.

The total number of channels specified by DBIC (Input) must be equal to the total number of channels specified by DBOC (Output).

FILO

Specifies the name of the file to receive the corrected image(s). This can be the same as the file name specified by FILI.

DBOC

Specifies the output channel(s) or layer(s) that receive the corrected output channel(s). Although this parameter can be the same as DBIC (Input), it is not recommended, since you will be changing your raw data.

Duplicate output channels are not allowed. The total number of channels specified by DBIC (Input) must be equal to the total number of channels specified by DBOC (Output).

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

HOTSPOT performs hot spot correction on an image channel. This is useful as a pre-processing step for computing a mosaic with a set of images to improve the homogeneity of each image, removing an over-all hot spot or side-to-side fade from each image.

HOTSPOT can be run on either raw images or orthorectified images. HOTSPOT computes and applies a hot spot correction for an image channel. The correction is computed by fitting a second-order polynomial to all of the non-background valued pixels in the image channel. The value 0 is considered to be background and is ignored.

Example

Compute a hot spot correction for channel 1 of data1.pix and write the result in channel 1 of data2.pix.

from pci.hotspot import hotspot

fili="data1.pix"
dbic=[1]
filo="data2.pix"
dboc=[1]

hotspot(fili, dbic, filo, dboc)

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