1 .\" $Id: tiffcrop.1,v 1.7 2010-12-12 01:45:35 faxguy Exp $
2 .\" tiffcrop -- a port of tiffcp.c extended to include extended processing of images
6 .\" Copyright (c) 1988-1997 Sam Leffler
7 .\" Copyright (c) 1991-1997 Silicon Graphics, Inc.
9 .\" Permission to use, copy, modify, distribute, and sell this software and
10 .\" its documentation for any purpose is hereby granted without fee, provided
11 .\" that (i) the above copyright notices and this permission notice appear in
12 .\" all copies of the software and related documentation, and (ii) the names of
13 .\" Sam Leffler and Silicon Graphics may not be used in any advertising or
14 .\" publicity relating to the software without the specific, prior written
15 .\" permission of Sam Leffler and Silicon Graphics.
17 .\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND,
18 .\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
19 .\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
21 .\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
22 .\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
23 .\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
24 .\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
25 .\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
28 .\" Additional code Copyright (c) 2006-2009 Richard Nolde
29 .\" Lasted Updated 9/2009
31 .TH "TIFFCROP" "1" "December, 2008" "libtiff" ""
33 tiffcrop \- select, copy, crop, convert, extract, and/or process one or more
41 .I "src1.tif ... srcN.tif dst.tif"
44 processes one or more files created according
45 to the Tag Image File Format, Revision 6.0, specification
50 is most often used to extract portions of an image for processing
51 with bar code recognizer or OCR software when that software cannot
52 restrict the region of interest to a specific portion of the image
53 or to improve efficiency when the regions of interest must be rotated.
54 It can also be used to subdivide all or part of a processed image into
55 smaller sections and export individual images or sections of images
56 as separate files or separate images within one or more files derived
57 from the original input image or images.
59 The available functions can be grouped broadly into three classes:
61 Those that select individual images or sections of images from the input files.
62 The options \-N for sequences or lists of individual images in the input files,
63 \-Z for zones, \-z for regions, \-X and \-Y for fixed sized selections,
64 \-m for margins, \-U for units, and \-E for edge reference provide a variety of
65 ways to specify portions of the input image.
67 Those that allow the individual images or selections to be exported to one or
68 more output files in different groupings and control the organization of the
69 data in the output images. The options \-P for page size grouping, \-S for
70 subdivision into columns and rows and \-e for export mode options that produce
71 one or more files from each input image. The options \-r, \-s, \-t, \-w control
72 strip and tile format and sizes while \-B \-L \-c \-f modify the endian addressing
73 scheme, the compression options, and the bit fill sequence of images as they
76 Those that perform some action on each image that is selected from the input file.
77 The options include \-R for rotate, \-I for inversion of the photometric
78 interpretation and/or data values, and \-F to flip (mirror) the image horizontally
82 Functions are applied to the input image(s) in the following order:
83 cropping, fixed area extraction, zone and region extraction,
84 inversion, mirroring, rotation.
86 Functions are applied to the output image(s) in the following order:
87 export mode options for grouping zones, regions, or images into
90 row and column divisions with output margins,
92 page size divisions with page orientation options.
94 Finally, strip, tile, byte order, output resolution, and compression options are
95 applied to all output images.
97 The output file(s) may be organized and compressed using a different
98 algorithm from the input files.
101 will copy all the understood tags in a
103 directory of an input file to the associated directory in the output file.
104 Options can be used to force the resultant image to be written as strips
105 or tiles of data, respectively.
108 can be used to reorganize the storage characteristics of data
109 in a file, and to reorganize, extract, rotate, and otherwise
110 process the image data as specified at the same time whereas
111 tiffcp does not alter the image data within the file.
113 Using the options for selecting individual input images and the
114 options for exporting images and/or segments defined as zones or
115 regions of each input image,
117 can perform the functions of tiffcp and tiffsplit in a single pass
118 while applying multiple operations to individual selections or images.
123 Display the syntax summary for tiffcrop.
126 Report the current version and last modification date for tiffcrop.
128 .B \-N odd|even|#,#\-#,#|last
129 Specify one or more series or range(s) of images within each file to process.
134 may be used to specify all odd or even numbered images counting from one.
135 Note that internally, TIFF images are numbered from zero rather than one
136 but since this convention is not obvious to most users, tiffcrop used 1
137 to specifiy the first image in a multipage file. The word
139 may be used in place of a number in the sequence to indicate the
140 final image in the file without knowing how many images there are.
141 Ranges of images may be specified with a dash and multiple sets
142 can be indicated by joining them in a comma\-separated list. eg. use
144 to process the 1st, 5th through 7th, and final image in the file.
146 .B \-E top|bottom|left|right
147 Specify the top, bottom, left, or right edge as the reference from
148 which to calcuate the width and length of crop regions or sequence
149 of postions for zones. When used with the \-e option for exporting
150 zones or regions, the reference edge determines how composite images
151 are arranged. Using \-E left or right causes successive zones or
152 regions to be merged horizontally whereas using \-E top or bottom
153 causes successive zones or regions to be arranged vertically. This
154 option has no effect on export layout when multiple zones or regions
155 are not being exported to composite images. Edges may be abbreviated
158 .B \-e combined|divided|image|multiple|separate
159 Specify the export mode for images and selections from input images.
160 The final filename on the command line is considered to be the
161 destination file or filename stem for automatically generated
162 sequences of files. Modes may be abbreviated to the first letter.
164 combined All images and selections are written to a single file with
165 multiple selections from one image combined into a single image (default)
167 divided All images and selections are written to a single file
168 with each selection from one image written to a new image
170 image Each input image is written to a new file (numeric filename sequence)
171 with multiple selections from the image combined into one image
173 multiple Each input image is written to a new file (numeric filename sequence)
174 with each selection from the image written to a new image
176 separate Individual selections from each image are written to separate files
179 Specify the type of units to apply to dimensions for margins and
180 crop regions for input and output images. Inches or centimeters
181 are converted to pixels using the resolution unit specified in the
182 TIFF file (which defaults to inches if not specified in the IFD).
185 Specify margins to be removed from the input image. The order must
186 be top, left, bottom, right with only commas separating the elements
187 of the list. Margins are scaled according to the current units and
188 removed before any other extractions are computed..
191 Set the horizontal (X\-axis) dimension of a region to extract relative to
192 the specified origin reference. If the origin is the top or bottom
193 edge, the X axis value will be assumed to start at the left edge.
196 Set the vertical (Y\-axis) dimension of a region to extract relative to
197 the specified origin reference. If the origin is the left or right
198 edge, the Y axis value will be assumed to start at the top.
201 Specify zones of the image designated as position X of Y equal sized portions
202 measured from the reference edge, eg 1:3 would be first third of the
203 image starting from the reference edge minus any margins specified
204 for the confining edges. Multiple zones can be specified as a comma
205 separated list but they must reference the same edge. To extract the
206 top quarter and the bottom third of an image you would use
209 .B \-z x1,y1,x2,y2: ... :xN,yN,xN+1,yN+1
210 Specify a series of coordinates to define regions for processing and exporting.
211 The coordinates represent the top left and lower right corners of each region
212 in the current units, eg inch, cm, or pixels. Pixels are counted from one to
213 width or height and inches or cm are calculated from image resolution data.
215 Each colon delimited series of four values represents the horizontal and vertical
216 offsets from the top and left edges of the image, regardless of the edge specified
217 with the \-E option. The first and third values represent the horizontal offsets of
218 the corner points from the left edge while the second and fourth values represent
219 the vertical offsets from the top edge.
222 Flip, ie mirror, the image or extracted region horizontally or vertically.
225 Rotate the image or extracted region 90, 180, or 270 degrees clockwise.
227 .B \\-I [black|white|data|both]
228 Invert color space, eg dark to light for bilevel and grayscale images.
229 This can be used to modify negative images to positive or to correct
230 images that have the PHOTOMETRIC_INTERPRETATIN tag set incorrectly.
231 If the value is black or white, the PHOTOMETRIC_INTERPRETATION tag is set to
232 MinIsBlack or MinIsWhite, without altering the image data. If the argument
233 is data or both, the data values of the image are modified. Specifying both
234 inverts the data and the PHOTOMETRIC_INTERPRETATION tag, whereas using data
235 inverts the data but not the PHOTOMETRIC_INTERPRETATION tag.
236 No support for modifying the color space of color images in this release.
239 Set the horizontal resolution of output images to #
240 expressed in the current units.
243 Set the vertical resolution of the output images to #
244 expressed in the current units.
247 Set the horizontal margin of an output page size to #
248 expressed in the current units when sectioning image into columns x rows
249 subimages using the \-S cols:rows option.
252 Set the vertical margin of an output page size to #
253 expressed in the current units when sectioning image into columns x rows
254 submiages using the \-S cols:rows option.
256 .B \-O portrait|landscape|auto
257 Set the output orientation of the pages or sections.
258 Auto will use the arrangement that requires the fewest pages.
259 This option is only meaningful in conjunction with the -P
260 option to format an image to fit on a specific paper size.
263 Format the output images to fit on page size paper. Use
264 \-P list to show the supported page sizes and dimensions.
265 You can define a custom page size by entering the width and length of the
266 page in the current units with the following format #.#x#.#.
269 Divide each image into cols across and rows down equal sections.
272 Force output to be written with Big\-Endian byte order.
273 This option only has an effect when the output file is created or
274 overwritten and not when it is appended to.
277 Suppress the use of ``strip chopping'' when reading images
278 that have a single strip/tile of uncompressed data.
281 Specify the compression to use for data written to the output file:
285 for PackBits compression,
287 for Lempel\-Ziv & Welch compression,
289 for baseline JPEG compression.
291 for Deflate compression,
293 for CCITT Group 3 (T.4) compression,
296 for CCITT Group 4 (T.6) compression.
299 will compress data according to the value of the
301 tag found in the source file.
305 Group 3 and Group 4 compression algorithms can only
306 be used with bilevel data.
308 Group 3 compression can be specified together with several
309 T.4\-specific options:
311 for 1\-dimensional encoding,
313 for 2\-dimensional encoding,
316 to force each encoded scanline to be zero\-filled so that the
317 terminating EOL code lies on a byte boundary.
318 Group 3\-specific options are specified by appending a ``:''\-separated
319 list to the ``g3'' option; e.g.
321 to get 2D\-encoded data with byte\-aligned EOL codes.
324 compression can be specified together with a
327 A predictor value of 2 causes
328 each scanline of the output image to undergo horizontal
329 differencing before it is encoded; a value
330 of 1 forces each scanline to be encoded without differencing.
331 LZW\-specific options are specified by appending a ``:''\-separated
332 list to the ``lzw'' option; e.g.
336 compression with horizontal differencing.
339 Specify the bit fill order to use in writing output data.
342 will create a new file with the same fill order as the original.
345 will force data to be written with the FillOrder tag set to
349 will force data to be written with the FillOrder tag set to
353 Ignore non\-fatal read errors and continue processing of the input file.
356 Specify the length of a tile (in pixels).
358 attempts to set the tile dimensions so
359 that no more than 8 kilobytes of data appear in a tile.
362 Force output to be written with Little\-Endian byte order.
363 This option only has an effect when the output file is created or
364 overwritten and not when it is appended to.
367 Suppress the use of memory\-mapped files when reading images.
370 Specify the planar configuration to use in writing image data
371 that has more than one sample per pixel.
374 will create a new file with the same planar configuration as
378 will force data to be written with multi\-sample data packed
381 will force samples to be written in separate planes.
384 Specify the number of rows (scanlines) in each strip of data
385 written to the output file.
386 By default (or when value
390 attempts to set the rows/strip that no more than 8 kilobytes of
391 data appear in a strip. If you specify the special value
393 it will results in infinite number of the rows per strip. The entire image
394 will be the one strip in that case.
397 Force the output file to be written with data organized in strips
401 Force the output file to be written with data organized in tiles
402 (rather than strips).
405 Specify the width of a tile (in pixels).
407 attempts to set the tile dimensions so
408 that no more than 8 kilobytes of data appear in a tile.
410 attempts to set the tile dimensions so
411 that no more than 8 kilobytes of data appear in a tile.
413 Debug and dump facility
414 .B \-D opt1:value1,opt2:value2,opt3:value3:opt4:value4
415 Display program progress and/or dump raw data to non\-TIFF files.
416 Options include the following and must be joined as a comma
417 separated list. The use of this option is generally limited to
418 program debugging and development of future options. An equal sign
419 may be substituted for the colon in option:value pairs.
421 debug:N Display limited program progress indicators where larger N
422 increase the level of detail.
424 format:txt|raw Format any logged data as ASCII text or raw binary
425 values. ASCII text dumps include strings of ones and zeroes representing
426 the binary values in the image data plus identifying headers.
428 level:N Specify the level of detail presented in the dump files.
429 This can vary from dumps of the entire input or output image data to dumps
430 of data processed by specific functions. Current range of levels is 1 to 3.
432 input:full\-path\-to\-directory/input\-dumpname
434 output:full\-path\-to\-directory/output\-dumpname
436 When dump files are being written, each image will be written to a separate
437 file with the name built by adding a numeric sequence value to the dumpname
438 and an extension of .txt for ASCII dumps or .bin for binary dumps.
440 The four debug/dump options are independent, though it makes little sense to
441 specify a dump file without specifying a detail level.
443 Note: Tiffcrop may be compiled with -DDEVELMODE to enable additional very
444 low level debug reporting.
446 The following concatenates two files and writes the result using
451 tiffcrop \-c lzw a.tif b.tif result.tif
455 To convert a G3 1d\-encoded
457 to a single strip of G4\-encoded data the following might be used:
460 tiffcrop \-c g4 \-r 10000 g3.tif g4.tif
463 (1000 is just a number that is larger than the number of rows in
466 To extract a selected set of images from a multi\-image TIFF file
467 use the \-N option described above. Thus, to copy the 1st and 3rd
468 images of image file "album.tif" to "result.tif":
471 tiffcrop \-N 1,3 album.tif result.tif
475 Invert a bilevel image scan of a microfilmed document and crop off margins of
476 0.25 inches on the left and right, 0.5 inch on the top, and 0.75 inch on the
477 bottom. From the remaining portion of the image, select the second and third
478 quarters, ie, one half of the area left from the center to each margin.
480 tiffcrop \-U in \-m 0.5,0.25,0.75,0.25 \-E left \-Z 2:4,3:4 \-I both MicrofilmNegative.tif MicrofilmPostiveCenter.tif
484 Extract only the final image of a large Architectural E sized
485 multipage TIFF file and rotate it 90 degrees clockwise while
486 reformatting the output to fit on tabloid sized sheets with one
487 quarter of an inch on each side:
489 tiffcrop \-N last \-R 90 \-O auto \-P tabloid \-U in \-J 0.25 \-K 0.25 \-H 300 \-V 300 Big\-PlatMap.tif BigPlatMap\-Tabloid.tif
492 The output images will have a specified resolution of 300 dpi in both
493 directions. The orientation of each page will be determined by whichever
494 choice requires the fewest pages. To specify a specific orientation, use
495 the portrait or landscape option. The paper size option does not resample
496 the image. It breaks each original image into a series of smaller images
497 that will fit on the target paper size at the specified resolution.
501 Extract two regions 2048 pixels wide by 2048 pixels high from each page of
502 a multi\-page input file and write each region to a separate output file.
504 tiffcrop \-U px \-z 1,1,2048,2048:1,2049,2048,4097 \-e separate CheckScans.tiff Check
507 The output file names will use the stem Check with a numeric suffix which is
508 incremented for each region of each image, eg Check\-001.tiff, Check\-002.tiff ...
509 Check\-NNN.tiff. To produce a unique file for each page of the input image
510 with one new image for each region of the input image on that page, change
511 the export option to \-e multiple.
515 In general, bilevel, grayscale, palette and RGB(A) data with bit depths
516 from 1 to 32 bits should work in both interleaved and separate plane
517 formats. Unlike tiffcp, tiffcrop can read and write tiled images with
518 bits per sample that are not a multiple of 8 in both interleaved and
519 separate planar format. Floating point data types are supported at
520 bit depts of 16, 24, 32 and 64 bits per sample.
522 Not all images can be converted from one compression scheme to another.
523 Data with some photometric interpretations and/or bit depths are tied to
524 specific compression schemes and vice-versa, e.g. Group 3/4 compression
525 is only usable for bilevel data. JPEG compression is only usable on 8
526 bit per sample data (or 12 bit if
528 was compiled with 12 bit JPEG support). Support for OJPEG compressed
529 images is problematic at best. Since OJPEG compression is no longer
530 supported for writing images with LibTIFF, these images will be updated
531 to the newer JPEG compression when they are copied or processed. This
532 may cause the image to appear color shifted or distorted after conversion.
533 In some cases, it is possible to remove the original compression from
534 image data using the option -cnone.
536 Tiffcrop does not currently provide options to up or downsample data to
537 different bit depths or convert data from one photometric interpretation
538 to another, e.g. 16 bits per sample to 8 bits per sample or RGB to grayscale.
540 Tiffcrop is very loosely derived from code in
542 with extensive modifications and additions to support the selection of input
543 images and regions and the exporting of them to one or more output files in
544 various groupings. The image manipulation routines are entirely new and
545 additional ones may be added in the future. It will handle tiled images with
546 bit depths that are not a multiple of eight that tiffcp may refuse to read.
549 was designed to handle large files containing many moderate sized images
550 with memory usage that is independent of the number of images in the file.
551 In order to support compression modes that are not based on individual
552 scanlines, e.g. JPEG, it now reads images by strip or tile rather than by
553 indvidual scanlines. In addition to the memory required by the input and
554 output buffers associated with
556 one or more buffers at least as large as the largest image to be read are
557 required. The design favors large volume document processing uses over
558 scientific or graphical manipulation of large datasets as might be found
559 in research or remote sensing scenarios.
569 Libtiff library home page:
570 .BR http://www.remotesensing.org/libtiff/
projects / wxWidgets.git / blob