SAGA-GIS Tool Library Documentation (v6.1.0)

Tool Universal Image Quality Index

The Universal Image Quality Index compares two grids (greyscale images) using the three parameters luminance, contrast and structure. This is done for each pixel using a moving window as specified by the kernel radius.


References


Parameters

 NameTypeIdentifierDescriptionConstraints
InputFirst GridGrid (input)A--
Second GridGrid (input)B--
OutputUniversal Image Quality IndexGrid (output)QThe product of correlation, luminance and contrast similarity.-
Correlation (*)Grid (optional output)RThe correlation coefficient.-
Luminance (*)Grid (optional output)LThe similarity of mean luminance.-
Contrast (*)Grid (optional output)CThe similarity of contrast.-
OptionsGrid systemGrid systemPARAMETERS_GRID_SYSTEM--
k1Floating pointK1-Minimum: 0.000000
Maximum: 1.000000
Default: 0.010000
k2Floating pointK2-Minimum: 0.000000
Maximum: 1.000000
Default: 0.030000
LIntegerLThe dynamic range for the image pixel, i.e. the number of different grey values.Minimum: 1
Default: 255
Kernel TypeChoiceKERNEL_TYPEThe shape of the filter kernel.Available Choices:
[0] Square
[1] Circle
Default: 1
Kernel RadiusIntegerKERNEL_RADIUSThe kernel radius in cells.Minimum: 1
Default: 2
(*) optional

Command-line

Usage: saga_cmd imagery_tools 13 [-A <str>] [-B <str>] [-Q <str>] [-R <str>] [-L <str>] [-C <str>] [-K1 <double>] [-K2 <double>] [-L <num>] [-KERNEL_TYPE <str>] [-KERNEL_RADIUS <num>]
  -A:<str>            	First Grid
	Grid (input)
  -B:<str>            	Second Grid
	Grid (input)
  -Q:<str>            	Universal Image Quality Index
	Grid (output)
  -R:<str>            	Correlation
	Grid (optional output)
  -L:<str>            	Luminance
	Grid (optional output)
  -C:<str>            	Contrast
	Grid (optional output)
  -K1:<double>        	k1
	Floating point
	Minimum: 0.000000
	Maximum: 1.000000
	Default: 0.010000
  -K2:<double>        	k2
	Floating point
	Minimum: 0.000000
	Maximum: 1.000000
	Default: 0.030000
  -L:<num>            	L
	Integer
	Minimum: 1
	Default: 255
  -KERNEL_TYPE:<str>  	Kernel Type
	Choice
	Available Choices:
	[0] Square
	[1] Circle
	Default: 1
  -KERNEL_RADIUS:<num>	Kernel Radius
	Integer
	Minimum: 1
	Default: 2