.\" Text automatically generated by txt2man
.TH idiff 1 "24 March 2024" "" "OpenImageIO"
.SH NAME
\fBidiff -- compare two images
\fB
.SH SYNOPSIS
.nf
.fam C

Usage: \fIidiff\fP [\fIoptions\fP] \fIimage1\fP \fIimage2\fP

.fam T
.fi
.fam T
.fi
.SH DESCRIPTION
This program is part of the OpenImageIO (http://www.openimageio.org) tool suite.
Detailed documentation is available in pdf format with the OpenImageIO
distribution.
.SH OPTIONS
.TP
.B
\fB--help\fP
Print help message
.TP
.B
\fB--version\fP
Print version and exit
.TP
.B
\fB-v\fP
Verbose status messages
.TP
.B
\fB-q\fP
Quiet (minimal messages)
.TP
.B
\fB-a\fP
Compare all subimages/miplevels
.RE
.PP
Thresholding and comparison \fIoptions\fP
.RS
.TP
.B
\fB-fail\fP VAL
Failure absolute difference threshold (default: 1e-06)
.TP
.B
\fB-failrelative\fP VAL
Failure relative threshold (default: 0)
.TP
.B
\fB-failpercent\fP PERCENT
Allow this percentage of failures (default: 0)
.TP
.B
\fB-hardfail\fP VAL
Fail if any one pixel exceeds this error (default: inf)
.TP
.B
\fB-allowfailures\fP N
OK for this number of pixels to fail by any amount (default: 0)
.TP
.B
\fB-warn\fP VAL
Warning absolute difference threshold (default: 1e-06)
.TP
.B
\fB-warnrelative\fP VAL
Warning relative threshold (default: 0)
.TP
.B
\fB-warnpercent\fP PERCENT
Allow this percentage of warnings (default: 0)
.TP
.B
\fB-hardwarn\fP VAL
Warn if any one pixel exceeds this error (default: inf)
.TP
.B
\fB-p\fP
Perform perceptual (rather than numeric) comparison
.RE
.PP
Difference image \fIoptions\fP
.RS
.TP
.B
\fB-o\fP FILENAME
Output difference image
.TP
.B
\fB-od\fP
Output image only if nonzero difference
.TP
.B
\fB-abs\fP
Output image of absolute value, not signed difference
.TP
.B
\fB-scale\fP FACTOR
Scale the output image by this factor (default: 1)