Programs¶

exquires-new¶

Syntax:

exquires-new [-h] [-v] [-p PROJECT] [-I IMAGE [IMAGE ...]]

Description:

Generate a new project file to use with exquires-run.

The project file is used to specify the following components of the suite:

Images ( sRGB TIFF | 16 bits/sample (48/pixel) | 840x840 pixels )

Downsamplers

Resampling Ratios

Upsamplers

Difference Metrics

For the specified project name and list of images, a default project file will be created with the name PROJECT.ini, where PROJECT is a name specified using the -p:option:–proj option. If a name is not specified, the default name is project1.

Use the -I:option:–image option to provide a list of images to include in the project file. If no images are specified, a default image (wave.tif) is included in the project file.

Manually edit this file to customize your project.

Optional Arguments:

SHORT FLAG	LONG FLAG	ARGUMENTS	DESCRIPTION
-h	--help		show this help message and exit
-v	--version		show program’s version number and exit
-p	--proj	PROJECT	name of the project (default: project1)
-I	--image	IMAGE [IMAGE ...]	the test images to use (default: `wave.tif`)

For additional usage instructions, see Obtaining suitable test images, Creating a new project file, and Customizing the project file.

For technical information, see new.

exquires-run¶

Syntax:

exquires-run [-h] [-v] [-s] [-p PROJECT]

Description:

Compute error data for the entries in the specified project file.

The project file is read to determine which images, downsamplers, ratios, upsamplers, and metrics to use. If a database file already exists for this project, it will be backed up and a new one will be created.

Each image will be downsampled by each of the ratios using each of the downsamplers. The downsampled images will then be upsampled back to their original size (840x840) using each of the upsamplers. The upsampled images will be compared to the original images using each of the metrics and the results will be stored in the database file.

If you make changes to the project file and wish to only compute data for these changes rather than recomputing everything, use exquires-update.

To view aggregated error data, use exquires-report.

Optional Arguments:

SHORT FLAG	LONG FLAG	ARGUMENTS	DESCRIPTION
-h	--help		show this help message and exit
-v	--version		show program’s version number and exit
-s	--silent		do not display progress information
-p	--proj	PROJECT	name of the project (default: project1)

For additional usage instructions, see Computing the image comparison data.

For technical information, see run.

exquires-update¶

Syntax:

exquires-update [-h] [-v] [-s] [-p PROJECT]

Description:

Compute new error data for changes to the user-specified project file.

The project file is inspected to determine which changes have been made. Items that have been removed will result in entries being removed from the database. Items that have been changed or added will result in new data being computed and added to the database file. If no changes have been made to the project file, the database will not be updated.

If you wish to recompute all data based on your project file rather than simply updating it with the changes, use exquires-run.

To view aggregated error data, use exquires-report.

Optional Arguments:

SHORT FLAG	LONG FLAG	ARGUMENTS	DESCRIPTION
-h	--help		show this help message and exit
-v	--version		show program’s version number and exit
-s	--silent		do not display progress information
-p	--proj	PROJECT	name of the project (default: project1)

For additional usage instructions, see Updating the image comparison data.

For technical information, see update.

exquires-report¶

Syntax:

exquires-report [-h] [-v] [-l] [-r | -m] [-p PROJECT] [-f FILE]
                [-d DIGITS] [-s METRIC] [-U METHOD [METHOD ...]]
                [-I IMAGE [IMAGE ...]] [-D METHOD [METHOD ...]]
                [-R RATIO [RATIO ...]] [-M METRIC [METRIC ...]]

Description:

Print a formatted table of aggregate image difference data.

Each database table in the current project contains data for a single image, downsampler, and ratio. Each row represents an upsampler and each column represents a difference metric. By default, the data across all rows and columns of all tables is aggregated. Use the appropriate option flags to aggregate across a subset of the database.

Optional Arguments:

SHORT FLAG	LONG FLAG	ARGUMENTS	DESCRIPTION
-h	--help		show this help message and exit
-v	--version		show program’s version number and exit
-l	--latex		print a LaTeX formatted table
-r	--rank		print Spearman (fractional) ranks
-m	--merge		print merged Spearman ranks
-p	--proj	PROJECT	name of the project (default: project1)
-f	--file	FILE	output to file (default: sys.stdout)
-d	--digits	DIGITS	total number of digits (default: 4)
-s	--sort	METRIC	sort using this metric (default: first)
-U	--up	METHOD [METHOD ...]	upsamplers to consider (default: all)
-I	--image	IMAGE [IMAGE ...]	images to consider (default: all)
-D	--down	METHOD [METHOD ...]	downsamplers to consider (default: all)
-R	--ratio	RATIO [RATIO ...]	ratios to consider (default: all)
-M	--metric	METRIC [METRIC ...]	metrics to consider (default: all)

Features:

-R/--ratio supports hyphenated ranges (ex. ‘2-4 6’ gives ‘2 3 4 6’)

-U/--up, -I/--image, -D/--down and -M/--metric support wildcards

For additional usage instructions, see Generating a table of aggregate image comparison table.

For technical information, see report.

exquires-correlate¶

Syntax:

exquires-correlate [-h] [-v] [-l] [-p PROJECT] [-f FILE] [-d DIGITS]
                   [-U METHOD [METHOD ...]] [-I IMAGE [IMAGE ...] | -D
                   METHOD [METHOD ...] | -R RATIO [RATIO ...] | -M
                   METRIC [METRIC ...]]

Description:

Produce a Spearman’s rank cross-correlation matrix for the specified group.

By default, the -M/--metric option is selected. You can select one of the following cross-correlation groups:

-I/--image

-D/--down

-R/--ratio

-M/--metric

You can also select which upsamplers to consider when computing the matrix by using the -U/--up option.

Optional Arguments:

SHORT FLAG	LONG FLAG	ARGUMENTS	DESCRIPTION
-h	--help		show this help message and exit
-v	--version		show program’s version number and exit
-l	--latex		print a LaTeX formatted table
-p	--proj	PROJECT	name of the project (default: project1)
-f	--file	FILE	output to file (default: sys.stdout)
-d	--digits	DIGITS	total number of digits (default: 4)
-a	--anchor	ANCHOR	sort using this anchor (default: none)
-U	--up	METHOD [METHOD ...]	upsamplers to consider (default: all)
-I	--image	IMAGE [IMAGE ...]	images to consider (default: all)
-D	--down	METHOD [METHOD ...]	downsamplers to consider (default: all)
-R	--ratio	RATIO [RATIO ...]	ratios to consider (default: all)
-M	--metric	METRIC [METRIC ...]	metrics to consider (default: all)

For additional usage instructions, see Generating a Spearman’s rank cross-correlation matrix.

For technical information, see correlate.

exquires-compare¶

Syntax:

exquires-compare [-h] [-v] [-m MAX_LEVEL] METRIC IMAGE_1 IMAGE_2

Description:

Print the result of calling a difference metric on two image files.

Difference Metrics:

NAME	DESCRIPTION
`srgb_1`	$\ell_1$ norm in sRGB colour space
`srgb_2`	$\ell_2$ norm in sRGB colour space
`srgb_4`	$\ell_4$ norm in sRGB colour space
`srgb_inf`	$\ell_\infty$ norm in sRGB colour space
`cmc_1`	$\ell_1$ norm in CMC(1:1) colour space
`cmc_2`	$\ell_2$ norm in CMC(1:1) colour space
`cmc_4`	$\ell_4$ norm in CMC(1:1) colour space
`cmc_inf`	$\ell_\infty$ norm in CMC(1:1) colour space
`xyz_1`	$\ell_1$ norm in XYZ colour space
`xyz_2`	$\ell_2$ norm in XYZ colour space
`xyz_4`	$\ell_4$ norm in XYZ colour space
`xyz_inf`	$\ell_\infty$ norm in XYZ colour space
`blur_1`	MSSIM-inspired $\ell_1$ norm
`blur_2`	MSSIM-inspired $\ell_2$ norm
`blur_4`	MSSIM-inspired $\ell_4$ norm
`blur_inf`	MSSIM-inspired $\ell_\infty$ norm
`mssim`	Mean Structural Similarity Index (MSSIM)

Positional Arguments:

ARGUMENT	DESCRIPTION
METRIC	the difference metric to use
IMAGE_1	the first image to compare
IMAGE_2	the second image to compare

Optional Arguments:

SHORT FLAG	LONG FLAG	ARGUMENTS	DESCRIPTION
-h	--help		show this help message and exit
-v	--version		show program’s version number and exit
-m	--maxval	MAX_LEVEL	the maximum pixel value (default: 65535)

For additional usage instructions, see Manually comparing images.

For technical information, see compare.

exquires-aggregate¶

Syntax:

exquires-aggregate [-h] [-v] METHOD NUM [NUM ...]

Description:

Aggregate a list of values using the selected method.

Aggregators:

NAME	DESCRIPTION
`l_1`	return the average
`l_2`	average the squares and return the square root
`l_4`	average the quads and return the fourth root
`l_inf`	return the maximum

Positional Arguments:

ARGUMENT	DESCRIPTION
METHOD	the type of aggregation to use
NUM	number to include in aggregation

Optional Arguments:

SHORT FLAG	LONG FLAG	DESCRIPTION
-h	--help	show the help message and exit
-v	--version	show the program’s version number and exit

For additional usage instructions, see Manually comparing images.

For technical information, see compare.

Programs¶

exquires-new¶

exquires-run¶

exquires-update¶

exquires-report¶

exquires-correlate¶

exquires-compare¶

exquires-aggregate¶

Table Of Contents

Previous topic

Next topic

This Page

Navigation

Programs¶

exquires-new¶

exquires-run¶

exquires-update¶

exquires-report¶

exquires-correlate¶

exquires-compare¶

exquires-aggregate¶

Table Of Contents

Previous topic

Next topic

This Page

Quick search

Navigation