]> granicus.if.org Git - imagemagick/blob - utilities/compare.1
Support LibRaw delegate library
[imagemagick] / utilities / compare.1
1 .TH compare 1 "Date: 2009/01/10 01:00:00" "ImageMagick"
2 .SH NAME
3 compare \- mathematically and visually annotate the difference between an image and its reconstruction.
4 .SH SYNOPSIS
5 .TP
6 \fBcompare\fP \fIinput-file\fP \fIinput-file\fP [\fIoptions\fP] \fIoutput-file\fP
7 .SH OVERVIEW
8 The \fBcompare\fP program is a member of the ImageMagick(1) suite of tools.  Use it to mathematically and visually annotate the difference between an image and its reconstruction.
9
10 For more information about the compare command, point your browser to file:///usr/local/share/doc/ImageMagick-7/www/compare.html or http://www.imagemagick.org/script/compare.php.
11 .SH DESCRIPTION
12 Image Settings:
13   \-alpha option        on, activate, off, deactivate, set, opaque, copy
14                         transparent, extract, background, or shape
15   \-authenticate value  decrypt image with this password
16   \-background color    background color
17   \-colorspace type     alternate image colorspace
18   \-compose operator    set image composite operator
19   \-compress type       type of pixel compression when writing the image
20   \-decipher filename   convert cipher pixels to plain pixels
21   \-define format:option
22                        define one or more image format options
23   \-density geometry    horizontal and vertical density of the image
24   \-depth value         image depth
25   \-dissimilarity-threshold value
26                         maximum distortion for (sub)image match
27   \-encipher filename   convert plain pixels to cipher pixels
28   \-extract geometry    extract area from image
29   \-format "string"     output formatted image characteristics
30   \-fuzz distance       colors within this distance are considered equal
31   \-identify            identify the format and characteristics of the image
32   \-interlace type      type of image interlacing scheme
33   \-highlight-color color
34                        emphasize pixel differences with this color
35   \-limit type value    pixel cache resource limit
36   \-lowlight-color color
37                        de-emphasize pixel differences with this color
38   \-metric type         measure differences between images with this metric
39   \-monitor             monitor progress
40   \-negate              replace each pixel with its complementary color
41   \-profile filename    add, delete, or apply an image profile
42   \-quality value       JPEG/MIFF/PNG compression level
43   \-quiet               suppress all warning messages
44   \-quantize colorspace reduce colors in this colorspace
45   \-read-mask filename  associate a read mask with the image
46   \-regard-warnings     pay attention to warning messages
47   \-repage geometry     size and location of an image canvas
48   \-respect-parentheses settings remain in effect until parenthesis boundary
49   \-sampling-factor geometry
50                        horizontal and vertical sampling factor
51   \-seed value          seed a new sequence of pseudo-random numbers
52   \-set attribute value set an image attribute
53   \-similarity-threshold value
54                         minimum distortion for (sub)image match
55   \-size geometry       width and height of image
56   \-subimage-search     search for subimage
57   \-synchronize         synchronize image to storage device
58   \-taint               declare the image as modified
59   \-transparent-color color
60                        transparent color
61   \-type type           image type
62   \-write-mask filename associate a write mask with the image
63   \-verbose             print detailed information about the image
64   \-virtual-pixel method
65                        virtual pixel access method
66
67 Image Operators:
68   \-brightness-contrast geometry
69                         improve brightness / contrast of the image
70   \-distort method args
71                         distort images according to given method and args
72   \-level value         adjust the level of image contrast
73   \-resize geometry     resize the image
74   \-rotate degrees      apply Paeth rotation to the image
75   \-sigmoidal-contrast geometry
76                        lightness rescaling using sigmoidal contrast enhancement
77   \-trim                trim image edges
78
79 Image Channel Operators:
80   \-separate            separate an image channel into a grayscale image
81
82 Image Sequence Operators:
83   \-crop geometry       cut out a rectangular region of the image
84   \-write filename      write images to this file
85
86 Image Stack Operators:
87   \-delete indexes      delete the image from the image sequence
88
89 Miscellaneous Options:
90   \-channel mask        set the image channel mask
91   \-debug events        display copious debugging information
92   \-help                print program options
93   \-log format          format of debugging information
94   \-list type           print a list of supported option arguments
95   \-version             print version information
96
97 By default, the image format of `file' is determined by its magic number.  To specify a particular image format, precede the filename with an image format name and a colon (i.e. ps:image) or specify the image type as the filename suffix (i.e. image.ps).  Specify 'file' as '-' for standard input or output.
98
99 The compare program returns 2 on error otherwise 0 if the images are similar or
100 1 if they are dissimilar.
101 .SH SEE ALSO
102 ImageMagick(1)
103
104 .SH COPYRIGHT
105
106 \fBCopyright (C) 1999-2017 ImageMagick Studio LLC. Additional copyrights and licenses apply to this software, see file:///usr/local/share/doc/ImageMagick-7/www/license.html or http://www.imagemagick.org/script/license.php\fP