>K ë " Z 5 ImageMagick Image Capturing Utility9`U
Import

 
Ð
>Contents

Ð
>Synopsis




Cimport [ options ... ] file

*Back to Contents
Ó
>Description




GImport reads an image from any visible window on an X server andHoutputs it as an image file. You can capture a single window, the entire_screen, or any rectangular portion of the screen. Use displayJfor redisplay, printing, editing, formatting, archiving, image processing, etc. of the captured image.
E

The target window can be specified by id, name, or may be selectedFby clicking the mouse in the desired window. If you press a button andIthen drag, a rectangle will form which expands and contracts as the mouseGmoves. To save the portion of the screen defined by the rectangle, justFrelease the button. The keyboard bell is rung once at the beginning of4the screen capture and twice when it completes.

*Back to Contents
Ö
>Examples 




ITo select an X window with the mouse and save it in the MIFF image format'to a file titled window.miff, use:





import window.miff





GTo select an X window and save it in the Encapsulated Postscript format)to include in another document, use:





import figure.eps





HTo capture the entire X server screen in the JPEG image format in a filetitled root.jpeg, use:





+import -window root root.jpeg


*Back to Contents
Ï
>Options




FOptions are processed in command line order. Any option you specify onOthe command line remains in effect until it is explicitly changed by specifying)the option again with a different effect.

KImport options can appear on the command line or in your X resourcesMfile. See X(1). Options on the command line supersede values specifiedin your X resources file.

 



Ï
>-adjoin

0join images into a single multi-image file.




HBy default, all images of an image sequence are stored in the same file.HHowever, some formats (e.g. JPEG) do not support more than one image andLare saved to separate files. Use +adjoin to force this behavior.





º
>-cache.threshold
<
megabytes of memory available to the pixel cache.


B

Image pixels are stored in memory until 80 megabytes of memoryDhave been consumed. Subsequent pixel operations are cached on disk.KOperations to memory are significantly faster but if your computer does notMhave a sufficient amount of free memory you may want to adjust this threshold value.





Ï
>-border

/include image borders in the output image.




KThe color of the border is obtained from the X server and is definedSas bordercolor (class borderColor). See X(1) for details.





±
>-colors*value

-preferred number of colors in the image.




GThe actual number of colors in the image may be less than your request,Hbut never more. Note, this is a color reduction option. Images with lessHunique colors than specified with this option will have any duplicate orHunused colors removed. Refer to quantize formore details.
J

Note, options -dither, -colorspace, and -treedepth%affect the color reduction algorithm.





µ
>-colorspace*value

=the type of colorspace: GRAY, OHTA, RGB,Transparent,3XYZ, YCbCr, YIQ, YPbPr, YUV, or CMYK.




JColor reduction, by default, takes place in the RGB color space. EmpiricalNevidence suggests that distances in color spaces such as YUV or YIQ correspondLto perceptual color differences more closely than do distances in RGB space.HThese color spaces may give better results when color reducing an image.DRefer to quantize for more details.
K

The Transparent color space behaves uniquely in that it preserves,the matte channel of the image if it exists.G

The -colors or -monochrome option is required for thisoption to take effect.





²
>-comment)name

&annotate an image with a comment.




GBy default, each image is commented with its file name. Use this optionIto assign a specific comment to the image. Optionally you can include theJimage filename, type, width, height, or other image attribute by embeddingspecial format characters:
    %b   file size    %d   directory    %e   filename extention    %f   filename    %h   height    %i   input filename    %l   label    %m   magick    %n   number of scenes    %o   output filename    %p   page number    %q   quantum depth    %s   scene number    %t   top of filename"    %u   unique temporary filename    %w   width    %x   x resolution    %y   y resolution    \\n   newline    \\r   carriage return
For example,

&

-comment "%m:%f %wx%h"




Gproduces an image comment of MIFF:bird.miff 512x480 for an imageFtitled bird.miff and whose width is 512 and height is 480.




FIf the first character of string is @, the image commentJis read from a file titled by the remaining characters in the string.





³
>-compress)type

Dthe type of image compression: None, BZip, Fax,Group4,DJPEG, LZW, RunlengthEncoded or Zip.




MSpecify +compress to store the binary image in an uncompressed format.EThe default is the compression type of the specified image file.





¯
>-cropl<width>x<height>{+-}<x offset>{+-}<y offset>{%}

Mpreferred size and location of the cropped image. See X(1) for details&about the geometry specification.




MTo specify a percentage width or height instead, append %. For exampleHto crop the image by ten percent on all sides of the image, use -crop 10%.




KUse cropping to apply image processing options to, or display, a particulararea of an image.




FOmit the x and y offset to generate one or more subimages of a uniform size.




HUse cropping to crop a particular area of an image. Use -crop 0x0Kto trim edges that are the background color. Add an x and y offset to leave3a portion of the trimmed edges with the image.





°
>-delayR<1/100ths of a second\>x<seconds>

*display the next image after pausing.
C

This option is useful for regulating the display of the sequenceHof images. 1/100ths of a second must expire before the display ofHthe next image. The default is 6/100th of a second between each frame ofIthe image sequence. The second value is optional. It specifies the numberDof seconds to pause before repeating your animation sequence.





²
>-densityA<width>x<height>

?vertical and horizontal resolution in pixels of the image.




HThis option specifies an image density when decoding a PostScriptNor Portable Document page. The default is 72 pixels per inch in the horizontalNand vertical direction. This option is used in concert with -page.





²
>-densityA<width>x<height>

?vertical and horizontal resolution in pixels of the image.




HThis option specifies an image density when decoding a PostScriptNor Portable Document page. The default is 72 pixels per inch in the horizontaland vertical direction.





Ð
>-descend

1obtain image by descending window hierarchy.





²
>-display:host:display[.screen]

Gspecifies the X server to contact. This option is used with convert forAobtaining image or font from this X server. see X(1).





²
>-dispose+method

GIF disposal method.




Here are the valid methods:
<
  0     No disposal specified.c  1     Do not dispose between frames.      S  2     Overwrite frame with background color from header.E  3     Overwrite with previous frame.





Ï
>-dither

8apply Floyd/Steinberg error diffusion to the image.




LThe basic strategy of dithering is to trade intensity resolution for spatialFresolution by averaging the intensities of several neighboring pixels.FImages which suffer from severe contouring when reducing colors can beimproved with this option.




KThe -colors or -monochrome option is required for this optionto take effect.




NUse +dither to render Postscript without text or graphic aliasing.





Î
>-frame

"include window manager frame.





³
>-geometryz<width>x<height>{+-}<x offset>{+-}<yoffset>{%}{!}{<}{>}

&the with and height of the image.




GBy default, the width and height are maximum values. That is, the imageMis expanded or contracted to fit the width and height value while maintainingJthe aspect ratio of the image. Append an exclamation point to the geometryHto force the image size to exactly the size you specify. For example, ifKyou specify 640x480! the image width is set to 640 pixels and heightIto 480. If only one factor is specified, both the width and height assumethe value.




ITo specify a percentage width or height instead, append %. The image sizeKis multiplied by the width and height percentages to obtain the final imageFdimensions. To increase the size of an image, use a value greater thanH100 (e.g. 125%). To decrease an image's size, use a percentage less than 100.
G

Use > to change the dimensions of the image only ifJits size exceeds the geometry specification. < resizes the imageFonly if its dimensions is less than the geometry specification.MFor example, if you specify 640x480> and the image size is 512x512,Fthe image size does not change. However, if the image is 1024x1024, itis resized to 640x480.





´
>-interlace)type

Gthe type of interlacing scheme: None, Line, Plane,5or Partition. The default is None.




KThis option is used to specify the type of interlacing scheme for raw imageLformats such as RGB or YUV. None means do not interlacef(RGBRGBRGBRGBRGBRGB...), Line uses scanline interlacing (RRR...GGG...BBB...RRR...GGG...BBB...),Fand Plane uses plane interlacing (RRRRRR...GGGGGG...BBBBBB...).GPartition is like plane except the different planes are saved to;individual files (e.g. image.R, image.G, and image.B).




FUse Line, or Plane to create an interlaced GIF or#progressive JPEG image.





°
>-label)name

assign a label to an image.




GUse this option to assign a specific label to the image. Optionally youMcan include the image filename, type, width, height, or other image attributeLby embedding special format character. See -comment for details.




For example,




-label "%m:%f %wx%h"




Lproduces an image label of MIFF:bird.miff 512x480 for an image titled?bird.miff and whose width is 512 and height is 480.




GIf the first character of string is @, the image label isGread from a file titled by the remaining characters in the string.




IWhen converting to PostScript, use this option to specify a header<string to print above the image. Specify the label font with-font.





Ó
>-monochrome

,transform the image to black and white.





Ï
>-negate

Freplace every pixel with its complementary color (white becomes black, yellow becomes blue, etc.).




PThe red, green, and blue intensities of an image are negated. Use +negate6to only negate the grayscale pixels of the image.





¯
>-page{<width>x<height>{+-}<x offset>{+-}<y offset>{%}{!}{<}{>}

*size and location of an image canvas.




0Use this option to specify the dimensions of thePostScript pageGin dots per inch or a TEXT page in pixels. The choices for a Postscriptpage are:


t

       11x17         792  1224 |       Ledger       1224   792    i       Legal         612  1008i       Letter        612   792P       LetterSmall   612   792d       ArchE        2592  3456d       ArchD        1728  2592d       ArchC        1296  1728i       ArchB         864  1296n       ArchA         648   864s       A0           2380  3368s       A1           1684  2380s       A2           1190  1684x       A3            842  1190}       A4            595   842d       A4Small       595   842}       A5            421   595}       A6            297   421}       A7            210   297}       A8            148   210}       A9            105   148}       A10            74   105s       B0           2836  4008s       B1           2004  2836s       B2           1418  2004s       B3           1002  1418x       B4            709  1002}       B5            501   709s       C0           2600  3677s       C1           1837  2600s       C2           1298  1837x       C3            918  1298}       C4            649   918}       C5            459   649}       C6            323   459y       Flsa          612   936 s       Flse          612   936[       HalfLetter    396   612




HFor convenience you can specify the page size by media (e.g. A4, Ledger,0etc.). Otherwise, -page behaves much like-geometry (e.g.&-page letter+43+43>).




ITo position a GIF image, use -page{+-}<x offset>{+-}<y*offset> (e.g. -page +100+200).




OFor a Postscript page, the image is sized as in -geometry and positionedFrelative to the lower left hand corner of the page by {+-}<x8offset>{+-}<y offset>. UseM-page 612x792>, for example, to center the image within the page.GIf the image size exceeds the Postscript page, it is reduced to fit the page.




=The default page dimensions for a TEXT image is 612x792.




9This option is used in concert with -density.





´
>-pointsize*value

&pointsize of the Postscript font.





²
>-quality*value

%JPEG/MIFF/PNG compression level.




JFor the JPEG image format, quality is 0 (worst) to 100 (best). The defaultquality is 75.




NQuality for the MIFF and PNG image format sets the amount of image compressionI(quality / 10) and filter-type (quality % 10). Compression quality valuesNrange from 0 (worst) to 100 (best). If filter-type is 4 or less, the specified+filter-type is used for all scanlines:

    0: none    1: sub    2: up    3: average!    4: Paeth

GIf filter-type is 5, adaptive filtering is used when quality is greaterGthan 50 and the image does not have a color map, otherwise no filtering is used.




ZIf filter-type is 6 or more, adaptive filtering with minimum-sum-of-absolute-values is used.




JThe default is quality is 75. Which means nearly the best compression withadaptive filtering.




For further information, see theBPNG specification.





±
>-rotate8degrees{<}{>}

-apply Paeth image rotation to the image.




KUse > to rotate the image only if its width exceeds the height.I< rotates the image only if its width is less than theJheight. For example, if you specify -90> and the image size isI480x640, the image is not rotated by the specified angle. However, if the4image is 640x480, it is rotated by -90 degrees.




KEmpty triangles left over from rotating the image are filled with the color$defined as bordercolor (class$borderColor). See X(1)for details.





°
>-scene*value

number of screen snapshots.




GUse this option to grab more than one image from the X server screen to"create an animation sequence.





Ï
>-screen

HThis option indicates that the GetImage request used to obtain the imageHshould be done on the root window, rather than directly on the specifiedHwindow. In this way, you can obtain pieces of other windows that overlapJthe specified window, and more importantly, you can capture menus or otherNpopups that are independent windows but appear over the specified window.





Ï
>-screen

1operate silently, i.e. don't ring any bells.





·
>-transparency*color

2make this color transparent within the image.





´
>-treedepth*value

HNormally, this integer value is zero or one. A zero or one tells displayGto choose an optimal tree depth for the color reduction algorithm.




GAn optimal depth generally allows the best representation of the sourceJimage with the fastest computational speed and the least amount of memory.FHowever, the default depth is inappropriate for some images. To assureGthe best representation, try values between 2 and 8 for this parameter.Refer to;quantize for more details.

KThe -colors or -monochrome option is required for this optionto take effect.





Ð
>-verbose

0print detailed information about the image.




HThis information is printed: image scene number; image name; image size;Lthe image class (DirectClass or PseudoClass); the total numberLof unique colors; and the number of seconds to read and transform the image.PRefer to miff for a description of the image class.





±
>-window'id

(select window with this id or name.




GWith this option you can specify the target window by id or name ratherFthan using the mouse. Specify root to select X's root window asthe target window.



G

file specifies the image filename. If file is omitted,Fit defaults to magick.miff. The default image format is MIFF.HTo specify a particular image format, precede the filename with an imageFformat name and a colon (i.e. ) or specify the image:type as the filename suffix (i.e. image.jpg). SeeImageGFormats Supported by ImageMagick for a list of valid image formats.G

Specify file as - for standard output. If file has theJextension .Z or .gz, the file size is com pressed using withcompressFor gzip respectively. Precede t he image file name | to pipe toHa system command. If file already exists, you will be prompted as)to whether it should be overwritten.

*Back to Contents
Ó
>Environment
 
Ï
>DISPLAY

9To get the default host, display number, and screen.


*Back to Contents

Ï
>Authors




cJohn Cristy, magick@wizards.dupont.com=E.I. du Pont de Nemours and Company Incorporated.
1


Back to Contents

Ñ
>Copyright

1Copyright (C) 2000 ImageMagick Studio




HPermission is hereby granted, free of charge, to any person obtainingKa copy of this software and associated documentation files ("ImageMagick"),Hto deal in ImageMagick without restriction, including without limitationHthe rights to use, copy, modify, merge, publish, distribute, sublicense,Pand/or sell copies of ImageMagick, and to permit persons to whom the ImageMagickDis furnished to do so, subject to the following conditions:




JThe above copyright notice and this permission notice shall be included>in all copies or substantial portions of ImageMagick.




JThe software is provided "as is", without warranty of any kind, expressKor implied, including but not limited to the warranties of merchantability,Ffitness for a particular purpose and noninfringement.In no event shall6ImageMagick Studio be liable for any claim, damages orMother liability, whether in an action of contract, tort or otherwise, arisingKfrom, out of or in connection with ImageMagick or the use or other dealingsin ImageMagick.




GExcept as contained in this notice, the name of the E. I. du Pont deLNemours and Company shall not be used in advertising or otherwise to promoteRthe sale, use or other dealings in ImageMagick without prior written authorization%from the ImageMagick Studio.

*Back to Contents


Home Page Image8manipulation software that works like magic.