1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
[vset VERSION 0.2.3]
[manpage_begin tiff n [vset VERSION]]
[keywords image]
[keywords tif]
[keywords tiff]
[copyright {2005-2006, Aaron Faupell <afaupell@users.sourceforge.net>}]
[moddesc {TIFF image manipulation}]
[titledesc {TIFF reading, writing, and querying and manipulation of meta data}]
[category {File formats}]
[require Tcl "8.5 9"]
[require tiff [opt [vset VERSION]]]
[description]
[para]
This package provides commands to query, modify, read, and write TIFF images.
TIFF stands for [term {Tagged Image File Format}] and is a standard
for lossless storage of photographical images and associated metadata.
It is specified at [uri http://partners.adobe.com/public/developer/tiff/index.html].
[para]
Multiple images may be stored in a single TIFF file. The [opt image] options to the functions
in this package are for accessing images other than the first. Data in a TIFF image is
stored as a series of tags having a numerical value, which are represented in either a 4 digit
hexadecimal format or a string name. For a reference on defined tags and their meanings see
[uri http://www.awaresystems.be/imaging/tiff/tifftags.html]
[section COMMANDS]
[list_begin definitions]
[call [cmd ::tiff::isTIFF] [arg file]]
Returns a boolean value indicating if [arg file] is a
TIFF image.
[call [cmd ::tiff::byteOrder] [arg file]]
Returns either [const big] or [const little].
Throws an error if [arg file] is not a TIFF image.
[call [cmd ::tiff::numImages] [arg file]]
Returns the number of images in [arg file].
Throws an error if [arg file] is not a TIFF image.
[call [cmd ::tiff::dimensions] [arg file] [opt image]]
Returns the dimensions of image number [opt image] in [arg file] as a list of the
horizontal and vertical pixel count.
Throws an error if [arg file] is not a TIFF image.
[call [cmd ::tiff::imageInfo] [arg file] [opt image]]
Returns a dictionary with keys [const ImageWidth], [const ImageLength],
[const BitsPerSample], [const Compression], [const PhotometricInterpretation],
[const ImageDescription], [const Orientation], [const XResolution],
[const YResolution], [const ResolutionUnit], [const DateTime], [const Artist],
and [const HostComputer]. The values are the associated properties of
the TIFF [opt image] in [arg file]. Values may be empty if the associated tag is not
present in the file.
[example {
puts [::tiff::imageInfo photo.tif]
ImageWidth 686 ImageLength 1024 BitsPerSample {8 8 8} Compression 1
PhotometricInterpretation 2 ImageDescription {} Orientation 1
XResolution 170.667 YResolution 170.667 ResolutionUnit 2 DateTime {2005:12:28 19:44:45}
Artist {} HostComputer {}
}]
There is nothing special about these tags, this is simply a convience procedure which calls
[cmd getEntry] with common entries.
Throws an error if [arg file] is not a TIFF image.
[call [cmd ::tiff::entries] [arg file] [opt image]]
Returns a list of all entries in the given [arg file] and [opt image]
in hexadecimal format.
Throws an error if [arg file] is not a TIFF image.
[call [cmd ::tiff::getEntry] [arg file] [arg entry] [opt image]]
Returns the value of [arg entry] from image [opt image] in the TIFF [arg file].
[arg entry] may be a list of multiple entries. If an entry does not exist, an
empty string is returned
[example {
set data [::tiff::getEntry photo.tif {0131 0132}]
puts "file was written at [lindex $data 0] with software [lindex $data 1]"
}]
Throws an error if [arg file] is not a TIFF image.
[call [cmd ::tiff::addEntry] [arg file] [arg entry] [opt image]]
Adds the specified entries to the image named by [opt image] (default 0), or optionally [const all].
[arg entry] must be a list where each element is a list of tag, type, and value. If a tag already
exists, it is overwritten.
[example {
::tiff::addEntry photo.tif {{010e 2 "an example photo"} {013b 2 "Aaron F"}}
}]
The data types are defined as follows
[list_begin definitions]
[def [const 1]] BYTE (8 bit unsigned integer)
[def [const 2]] ASCII
[def [const 3]] SHORT (16 bit unsigned integer)
[def [const 4]] LONG (32 bit unsigned integer)
[def [const 5]] RATIONAL
[def [const 6]] SBYTE (8 bit signed byte)
[def [const 7]] UNDEFINED (uninterpreted binary data)
[def [const 8]] SSHORT (signed 16 bit integer)
[def [const 9]] SLONG (signed 32 bit integer)
[def [const 10]] SRATIONAL
[def [const 11]] FLOAT (32 bit floating point number)
[def [const 12]] DOUBLE (64 bit floating point number)
[list_end]
Throws an error if [arg file] is not a TIFF image.
[call [cmd ::tiff::deleteEntry] [arg file] [arg entry] [opt image]]
Deletes the specified entries from the image named by [opt image] (default 0), or optionally [const all].
Throws an error if [arg file] is not a TIFF image.
[call [cmd ::tiff::getImage] [arg file] [opt image]]
Returns the name of a Tk image containing the image at index [opt image] from [arg file]
Throws an error if [arg file] is not a TIFF image, or if image is an unsupported format.
Supported formats are uncompressed 24 bit RGB and uncompressed 8 bit palette.
[call [cmd ::tiff::writeImage] [arg image] [arg file] [opt entry]]
Writes the contents of the Tk image [arg image] to a tiff file [arg file]. Files are
written in the 24 bit uncompressed format, with big endian byte order. Additional entries
to be added to the image may be specified, in the same format as [cmd tiff::addEntry]
[call [cmd ::tiff::nametotag] [arg names]]
Returns a list with [arg names] translated from string to 4 digit format. 4 digit names
in the input are passed through unchanged. Strings without a defined tag name will throw
an error.
[call [cmd ::tiff::tagtoname] [arg tags]]
Returns a list with [arg tags] translated from 4 digit to string format. If a tag does
not have a defined name it is passed through unchanged.
[call [cmd ::tiff::debug] [arg file]]
Prints everything we know about the given file in a nice format.
[list_end]
[section VARIABLES]
The mapping of 4 digit tag names to string names uses the array ::tiff::tiff_tags. The reverse
mapping uses the array ::tiff::tiff_sgat.
[section LIMITATIONS]
[list_begin enumerated]
[enum] Cannot write exif ifd
[enum] Reading limited to uncompressed 8 bit rgb and 8 bit palletized images
[enum] Writing limited to uncompressed 8 bit rgb
[list_end]
[vset CATEGORY tiff]
[include ../common-text/feedback.inc]
[manpage_end]
|
