granicus.if.org Git - imagemagick/blob - utilities/compare.1.in

   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://@DOCUMENTATION_PATH@/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   \-gravity type        horizontal and vertical text placement
  32   \-identify            identify the format and characteristics of the image
  33   \-interlace type      type of image interlacing scheme
  34   \-highlight-color color
  35                        emphasize pixel differences with this color
  36   \-limit type value    pixel cache resource limit
  37   \-lowlight-color color
  38                        de-emphasize pixel differences with this color
  39   \-metric type         measure differences between images with this metric
  40   \-monitor             monitor progress
  41   \-negate              replace each pixel with its complementary color
  42   \-profile filename    add, delete, or apply an image profile
  43   \-quality value       JPEG/MIFF/PNG compression level
  44   \-quiet               suppress all warning messages
  45   \-quantize colorspace reduce colors in this colorspace
  46   \-read-mask filename  associate a read mask with the image
  47   \-regard-warnings     pay attention to warning messages
  48   \-repage geometry     size and location of an image canvas
  49   \-respect-parentheses settings remain in effect until parenthesis boundary
  50   \-sampling-factor geometry
  51                        horizontal and vertical sampling factor
  52   \-seed value          seed a new sequence of pseudo-random numbers
  53   \-set attribute value set an image attribute
  54   \-similarity-threshold value
  55                         minimum distortion for (sub)image match
  56   \-size geometry       width and height of image
  57   \-subimage-search     search for subimage
  58   \-synchronize         synchronize image to storage device
  59   \-taint               declare the image as modified
  60   \-transparent-color color
  61                        transparent color
  62   \-type type           image type
  63   \-write-mask filename associate a write mask with the image
  64   \-verbose             print detailed information about the image
  65   \-virtual-pixel method
  66                        virtual pixel access method
  67
  68 Image Operators:
  69   \-brightness-contrast geometry
  70                         improve brightness / contrast of the image
  71   \-distort method args
  72                         distort images according to given method and args
  73   \-level value         adjust the level of image contrast
  74   \-resize geometry     resize the image
  75   \-rotate degrees      apply Paeth rotation to the image
  76   \-sigmoidal-contrast geometry
  77                        lightness rescaling using sigmoidal contrast enhancement
  78   \-trim                trim image edges
  79
  80 Image Channel Operators:
  81   \-separate            separate an image channel into a grayscale image
  82
  83 Image Sequence Operators:
  84   \-crop geometry       cut out a rectangular region of the image
  85   \-write filename      write images to this file
  86
  87 Image Stack Operators:
  88   \-delete indexes      delete the image from the image sequence
  89
  90 Miscellaneous Options:
  91   \-channel mask        set the image channel mask
  92   \-debug events        display copious debugging information
  93   \-help                print program options
  94   \-log format          format of debugging information
  95   \-list type           print a list of supported option arguments
  96   \-version             print version information
  97
  98 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.
  99
 100 The compare program returns 2 on error otherwise 0 if the images are similar or
 101 1 if they are dissimilar.
 102 .SH SEE ALSO
 103 ImageMagick(1)
 104
 105 .SH COPYRIGHT
 106
 107 \fBCopyright (C) 1999-2018 ImageMagick Studio LLC. Additional copyrights and licenses apply to this software, see file://@DOCUMENTATION_PATH@/www/license.html or http://www.imagemagick.org/script/license.php\fP