Remove all lines containing cvs/svn "$Id$" keyword.
[wxWidgets.git] / src / tiff / man / raw2tiff.1
1 .\"
2 .\" Copyright (c) 1990-1997 Sam Leffler
3 .\" Copyright (c) 1991-1997 Silicon Graphics, Inc.
4 .\"
5 .\" Permission to use, copy, modify, distribute, and sell this software and 
6 .\" its documentation for any purpose is hereby granted without fee, provided
7 .\" that (i) the above copyright notices and this permission notice appear in
8 .\" all copies of the software and related documentation, and (ii) the names of
9 .\" Sam Leffler and Silicon Graphics may not be used in any advertising or
10 .\" publicity relating to the software without the specific, prior written
11 .\" permission of Sam Leffler and Silicon Graphics.
12 .\" 
13 .\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, 
14 .\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY 
15 .\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.  
16 .\" 
17 .\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
18 .\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
19 .\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
20 .\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF 
21 .\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE 
22 .\" OF THIS SOFTWARE.
23 .\"
24 .if n .po 0
25 .TH RAW2TIFF 1 "November 2, 2005" "libtiff"
26 .SH NAME
27 raw2tiff \- create a
28 .SM TIFF
29 file from a raw data
30 .SH SYNOPSIS
31 .B raw2tiff
32 [
33 .I options
34 ]
35 .I input.raw
36 .I output.tif
37 .SH DESCRIPTION
38 .I raw2tiff
39 converts a raw byte sequence into
40 .SM TIFF.
41 By default, the
42 .SM TIFF
43 image is created with data samples packed (\c
44 .IR PlanarConfiguration =1),
45 compressed with the PackBits algorithm (\c
46 .IR Compression =32773),
47 and with each strip no more than 8 kilobytes.
48 These characteristics can overridden, or explicitly specified
49 with the options described below.
50 .SH OPTIONS
51 .TP
52 .BI \-H " number"
53 size of input image file header in bytes (0 by default). This amount of data
54 just will be skipped from the start of file while reading.
55 .TP
56 .BI \-w " number"
57 width of input image in pixels (can be guessed, see
58 .SM
59 .B "GUESSING THE IMAGE GEOMETRY"
60 below).
61 .TP
62 .BI \-l " number"
63 length of input image in lines (can be guessed, see
64 .SM
65 .B "GUESSING THE IMAGE GEOMETRY"
66 below).
67 .TP
68 .BI \-b " number"
69 number of bands in input image (1 by default).
70 .TP
71 .BI \-d " data_type"
72 type of samples in input image, where
73 .I data_type
74 may be:
75 .ta \w'\fBdouble  \fR'u
76 .br
77 .B byte\t
78 8-bit unsigned integer (default),
79 .br
80 .B short\t
81 16-bit unsigned integer,
82 .br
83 .B long\t
84 32-bit unsigned integer,
85 .br
86 .B sbyte\t
87 8-bit signed integer,
88 .br
89 .B sshort\t
90 16-bit signed integer,
91 .br
92 .B slong\t
93 32-bit signed integer,
94 .br
95 .B float\t
96 32-bit IEEE floating point,
97 .br
98 .B double\t
99 64-bit IEEE floating point.
100 .TP
101 .BI \-i " config"
102 type of samples interleaving in input image, where
103 .I config
104 may be:
105 .ta \w'\fBpixel  \fR'u
106 .br
107 .B pixel\t
108 pixel interleaved data (default),
109 .br
110 .B band\t
111 band interleaved data.
112 .TP
113 .BI \-p " photo"
114 photometric interpretation (color space) of the input image, where
115 .I photo
116 may be:
117 .ta \w'\fBminiswhite  \fR'u
118 .br
119 .B miniswhite\t
120 white color represented with 0 value,
121 .br
122 .B minisblack\t
123 black color represented with 0 value (default),
124 .br
125 .B rgb\t
126 image has RGB color model,
127 .br
128 .B cmyk\t
129 image has CMYK (separated) color model,
130 .br
131 .B ycbcr\t
132 image has YCbCr color model,
133 .br
134 .B cielab\t
135 image has CIE L*a*b color model,
136 .br
137 .B icclab\t
138 image has ICC L*a*b color model,
139 .br
140 .B itulab\t
141 image has ITU L*a*b color model.
142 .TP
143 .B \-s
144 swap bytes fetched from the input file.
145 .TP
146 .B \-L
147 input data has LSB2MSB bit order (default).
148 .TP
149 .B \-M
150 input data has MSB2LSB bit order.
151 .TP
152 .B \-c
153 Specify a compression scheme to use when writing image data:
154 .B "\-c none"
155 for no compression,
156 .B "\-c packbits"
157 for the PackBits compression algorithm (the default),
158 .B "\-c jpeg"
159 for the baseline JPEG compression algorithm,
160 .B "\-c zip"
161 for the Deflate compression algorithm,
162 and
163 .B "\-c lzw"
164 for Lempel-Ziv & Welch.
165 .TP
166 .BI \-r " number"
167 Write data with a specified number of rows per strip;
168 by default the number of rows/strip is selected so that each strip
169 is approximately 8 kilobytes.
170 .SH GUESSING THE IMAGE GEOMETRY
171 .I raw2tiff
172 can guess image width and height in case one or both of these parameters are
173 not specified. If you omit one of those parameters, the complementary one will
174 be calculated based on the file size (taking into account header size, number
175 of bands and data type). If you omit both parameters, the statistical approach
176 will be used. Utility will compute correlation coefficient between two lines
177 at the image center using several appropriate line sizes and the highest
178 absolute value of the coefficient will indicate the right line size. That is
179 why you should be cautious with the very large images, because guessing
180 process may take a while (depending on your system performance). Of course, the
181 utility can't guess the header size, number of bands and data type, so it
182 should be specified manually. If you don't know anything about your image,
183 just try with the several combinations of those options.
184 .P
185 There is no magic, it is just a mathematical statistics, so it can be wrong
186 in some cases. But for most ordinary images guessing method will work fine.
187 .SH "SEE ALSO"
188 .BR pal2rgb (1),
189 .BR tiffinfo (1),
190 .BR tiffcp (1),
191 .BR tiffmedian (1),
192 .BR libtiff (3)
193 .PP
194 Libtiff library home page:
195 .BR http://www.remotesensing.org/libtiff/