0 | |
Description: Add docs/ folder missing in upstream tarball
|
1 | |
Author: Francesco Paolo Lovergine <frankie@debian.org>
|
2 | |
Bug: https://trac.osgeo.org/geotiff/ticket/78
|
3 | |
Forwarded: not-needed
|
4 | |
|
5 | |
--- /dev/null
|
6 | |
+++ b/docs/Doxyfile
|
7 | |
@@ -0,0 +1,1129 @@
|
8 | |
+# Doxyfile 1.4.2
|
9 | |
+
|
10 | |
+# This file describes the settings to be used by the documentation system
|
11 | |
+# doxygen (www.doxygen.org) for a project
|
12 | |
+#
|
13 | |
+# All text after a hash (#) is considered a comment and will be ignored
|
14 | |
+# The format is:
|
15 | |
+# TAG = value [value, ...]
|
16 | |
+# For lists items can also be appended using:
|
17 | |
+# TAG += value [value, ...]
|
18 | |
+# Values that contain spaces should be placed between quotes (" ")
|
19 | |
+
|
20 | |
+#---------------------------------------------------------------------------
|
21 | |
+# Project related configuration options
|
22 | |
+#---------------------------------------------------------------------------
|
23 | |
+
|
24 | |
+# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
|
25 | |
+# by quotes) that should identify the project.
|
26 | |
+
|
27 | |
+PROJECT_NAME = $(PROJECT)-$(VERSION)
|
28 | |
+
|
29 | |
+# The PROJECT_NUMBER tag can be used to enter a project or revision number.
|
30 | |
+# This could be handy for archiving the generated documentation or
|
31 | |
+# if some version control system is used.
|
32 | |
+
|
33 | |
+PROJECT_NUMBER =
|
34 | |
+
|
35 | |
+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
|
36 | |
+# base path where the generated documentation will be put.
|
37 | |
+# If a relative path is entered, it will be relative to the location
|
38 | |
+# where doxygen was started. If left blank the current directory will be used.
|
39 | |
+
|
40 | |
+OUTPUT_DIRECTORY = $(DOCDIR)
|
41 | |
+
|
42 | |
+# The OUTPUT_LANGUAGE tag is used to specify the language in which all
|
43 | |
+# documentation generated by doxygen is written. Doxygen will use this
|
44 | |
+# information to generate all constant output in the proper language.
|
45 | |
+# The default language is English, other supported languages are:
|
46 | |
+# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish,
|
47 | |
+# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese,
|
48 | |
+# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian,
|
49 | |
+# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish,
|
50 | |
+# Swedish, and Ukrainian.
|
51 | |
+
|
52 | |
+OUTPUT_LANGUAGE = English
|
53 | |
+
|
54 | |
+# This tag can be used to specify the encoding used in the generated output.
|
55 | |
+# The encoding is not always determined by the language that is chosen,
|
56 | |
+# but also whether or not the output is meant for Windows or non-Windows users.
|
57 | |
+# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
|
58 | |
+# forces the Windows encoding (this is the default for the Windows binary),
|
59 | |
+# whereas setting the tag to NO uses a Unix-style encoding (the default for
|
60 | |
+# all platforms other than Windows).
|
61 | |
+
|
62 | |
+USE_WINDOWS_ENCODING = NO
|
63 | |
+
|
64 | |
+# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
|
65 | |
+# include brief member descriptions after the members that are listed in
|
66 | |
+# the file and class documentation (similar to JavaDoc).
|
67 | |
+# Set to NO to disable this.
|
68 | |
+
|
69 | |
+BRIEF_MEMBER_DESC = YES
|
70 | |
+
|
71 | |
+# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
|
72 | |
+# the brief description of a member or function before the detailed description.
|
73 | |
+# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
|
74 | |
+# brief descriptions will be completely suppressed.
|
75 | |
+
|
76 | |
+REPEAT_BRIEF = YES
|
77 | |
+
|
78 | |
+# This tag implements a quasi-intelligent brief description abbreviator
|
79 | |
+# that is used to form the text in various listings. Each string
|
80 | |
+# in this list, if found as the leading text of the brief description, will be
|
81 | |
+# stripped from the text and the result after processing the whole list, is
|
82 | |
+# used as the annotated text. Otherwise, the brief description is used as-is.
|
83 | |
+# If left blank, the following values are used ("$name" is automatically
|
84 | |
+# replaced with the name of the entity): "The $name class" "The $name widget"
|
85 | |
+# "The $name file" "is" "provides" "specifies" "contains"
|
86 | |
+# "represents" "a" "an" "the"
|
87 | |
+
|
88 | |
+ABBREVIATE_BRIEF =
|
89 | |
+
|
90 | |
+# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
|
91 | |
+# Doxygen will generate a detailed section even if there is only a brief
|
92 | |
+# description.
|
93 | |
+
|
94 | |
+ALWAYS_DETAILED_SEC = NO
|
95 | |
+
|
96 | |
+# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
|
97 | |
+# inherited members of a class in the documentation of that class as if those
|
98 | |
+# members were ordinary class members. Constructors, destructors and assignment
|
99 | |
+# operators of the base classes will not be shown.
|
100 | |
+
|
101 | |
+INLINE_INHERITED_MEMB = NO
|
102 | |
+
|
103 | |
+# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
|
104 | |
+# path before files name in the file list and in the header files. If set
|
105 | |
+# to NO the shortest path that makes the file name unique will be used.
|
106 | |
+
|
107 | |
+FULL_PATH_NAMES = NO
|
108 | |
+
|
109 | |
+# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
|
110 | |
+# the path mentioned in the documentation of a class, which tells
|
111 | |
+# the reader which header file to include in order to use a class.
|
112 | |
+# If left blank only the name of the header file containing the class
|
113 | |
+# definition is used. Otherwise one should specify the include paths that
|
114 | |
+# are normally passed to the compiler using the -I flag.
|
115 | |
+
|
116 | |
+STRIP_FROM_INC_PATH = $(SRCDIR)
|
117 | |
+
|
118 | |
+# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
|
119 | |
+# (but less readable) file names. This can be useful is your file systems
|
120 | |
+# doesn't support long names like on DOS, Mac, or CD-ROM.
|
121 | |
+
|
122 | |
+SHORT_NAMES = NO
|
123 | |
+
|
124 | |
+# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
|
125 | |
+# will interpret the first line (until the first dot) of a JavaDoc-style
|
126 | |
+# comment as the brief description. If set to NO, the JavaDoc
|
127 | |
+# comments will behave just like the Qt-style comments (thus requiring an
|
128 | |
+# explicit @brief command for a brief description.
|
129 | |
+
|
130 | |
+JAVADOC_AUTOBRIEF = YES
|
131 | |
+
|
132 | |
+# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
|
133 | |
+# treat a multi-line C++ special comment block (i.e. a block of //! or ///
|
134 | |
+# comments) as a brief description. This used to be the default behaviour.
|
135 | |
+# The new default is to treat a multi-line C++ comment block as a detailed
|
136 | |
+# description. Set this tag to YES if you prefer the old behaviour instead.
|
137 | |
+
|
138 | |
+MULTILINE_CPP_IS_BRIEF = NO
|
139 | |
+
|
140 | |
+# If the DETAILS_AT_TOP tag is set to YES then Doxygen
|
141 | |
+# will output the detailed description near the top, like JavaDoc.
|
142 | |
+# If set to NO, the detailed description appears after the member
|
143 | |
+# documentation.
|
144 | |
+
|
145 | |
+DETAILS_AT_TOP = NO
|
146 | |
+
|
147 | |
+# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
|
148 | |
+# member inherits the documentation from any documented member that it
|
149 | |
+# re-implements.
|
150 | |
+
|
151 | |
+INHERIT_DOCS = YES
|
152 | |
+
|
153 | |
+# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
|
154 | |
+# tag is set to YES, then doxygen will reuse the documentation of the first
|
155 | |
+# member in the group (if any) for the other members of the group. By default
|
156 | |
+# all members of a group must be documented explicitly.
|
157 | |
+
|
158 | |
+DISTRIBUTE_GROUP_DOC = NO
|
159 | |
+
|
160 | |
+# The TAB_SIZE tag can be used to set the number of spaces in a tab.
|
161 | |
+# Doxygen uses this value to replace tabs by spaces in code fragments.
|
162 | |
+
|
163 | |
+TAB_SIZE = 8
|
164 | |
+
|
165 | |
+# This tag can be used to specify a number of aliases that acts
|
166 | |
+# as commands in the documentation. An alias has the form "name=value".
|
167 | |
+# For example adding "sideeffect=\par Side Effects:\n" will allow you to
|
168 | |
+# put the command \sideeffect (or @sideeffect) in the documentation, which
|
169 | |
+# will result in a user-defined paragraph with heading "Side Effects:".
|
170 | |
+# You can put \n's in the value part of an alias to insert newlines.
|
171 | |
+
|
172 | |
+ALIASES =
|
173 | |
+
|
174 | |
+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
|
175 | |
+# sources only. Doxygen will then generate output that is more tailored for C.
|
176 | |
+# For instance, some of the names that are used will be different. The list
|
177 | |
+# of all members will be omitted, etc.
|
178 | |
+
|
179 | |
+OPTIMIZE_OUTPUT_FOR_C = YES
|
180 | |
+
|
181 | |
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
|
182 | |
+# only. Doxygen will then generate output that is more tailored for Java.
|
183 | |
+# For instance, namespaces will be presented as packages, qualified scopes
|
184 | |
+# will look different, etc.
|
185 | |
+
|
186 | |
+OPTIMIZE_OUTPUT_JAVA = NO
|
187 | |
+
|
188 | |
+# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
|
189 | |
+# the same type (for instance a group of public functions) to be put as a
|
190 | |
+# subgroup of that type (e.g. under the Public Functions section). Set it to
|
191 | |
+# NO to prevent subgrouping. Alternatively, this can be done per class using
|
192 | |
+# the \nosubgrouping command.
|
193 | |
+
|
194 | |
+SUBGROUPING = YES
|
195 | |
+
|
196 | |
+#---------------------------------------------------------------------------
|
197 | |
+# Build related configuration options
|
198 | |
+#---------------------------------------------------------------------------
|
199 | |
+
|
200 | |
+# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
|
201 | |
+# documentation are documented, even if no documentation was available.
|
202 | |
+# Private class members and static file members will be hidden unless
|
203 | |
+# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
|
204 | |
+
|
205 | |
+EXTRACT_ALL = NO
|
206 | |
+
|
207 | |
+# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
|
208 | |
+# will be included in the documentation.
|
209 | |
+
|
210 | |
+EXTRACT_PRIVATE = NO
|
211 | |
+
|
212 | |
+# If the EXTRACT_STATIC tag is set to YES all static members of a file
|
213 | |
+# will be included in the documentation.
|
214 | |
+
|
215 | |
+EXTRACT_STATIC = NO
|
216 | |
+
|
217 | |
+# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
|
218 | |
+# defined locally in source files will be included in the documentation.
|
219 | |
+# If set to NO only classes defined in header files are included.
|
220 | |
+
|
221 | |
+EXTRACT_LOCAL_CLASSES = YES
|
222 | |
+
|
223 | |
+# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
|
224 | |
+# undocumented members of documented classes, files or namespaces.
|
225 | |
+# If set to NO (the default) these members will be included in the
|
226 | |
+# various overviews, but no documentation section is generated.
|
227 | |
+# This option has no effect if EXTRACT_ALL is enabled.
|
228 | |
+
|
229 | |
+HIDE_UNDOC_MEMBERS = NO
|
230 | |
+
|
231 | |
+# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
|
232 | |
+# undocumented classes that are normally visible in the class hierarchy.
|
233 | |
+# If set to NO (the default) these classes will be included in the various
|
234 | |
+# overviews. This option has no effect if EXTRACT_ALL is enabled.
|
235 | |
+
|
236 | |
+HIDE_UNDOC_CLASSES = NO
|
237 | |
+
|
238 | |
+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
|
239 | |
+# friend (class|struct|union) declarations.
|
240 | |
+# If set to NO (the default) these declarations will be included in the
|
241 | |
+# documentation.
|
242 | |
+
|
243 | |
+HIDE_FRIEND_COMPOUNDS = NO
|
244 | |
+
|
245 | |
+# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
|
246 | |
+# documentation blocks found inside the body of a function.
|
247 | |
+# If set to NO (the default) these blocks will be appended to the
|
248 | |
+# function's detailed documentation block.
|
249 | |
+
|
250 | |
+HIDE_IN_BODY_DOCS = NO
|
251 | |
+
|
252 | |
+# The INTERNAL_DOCS tag determines if documentation
|
253 | |
+# that is typed after a \internal command is included. If the tag is set
|
254 | |
+# to NO (the default) then the documentation will be excluded.
|
255 | |
+# Set it to YES to include the internal documentation.
|
256 | |
+
|
257 | |
+INTERNAL_DOCS = NO
|
258 | |
+
|
259 | |
+# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
|
260 | |
+# file names in lower-case letters. If set to YES upper-case letters are also
|
261 | |
+# allowed. This is useful if you have classes or files whose names only differ
|
262 | |
+# in case and if your file system supports case sensitive file names. Windows
|
263 | |
+# and Mac users are advised to set this option to NO.
|
264 | |
+
|
265 | |
+CASE_SENSE_NAMES = YES
|
266 | |
+
|
267 | |
+# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
|
268 | |
+# will show members with their full class and namespace scopes in the
|
269 | |
+# documentation. If set to YES the scope will be hidden.
|
270 | |
+
|
271 | |
+HIDE_SCOPE_NAMES = NO
|
272 | |
+
|
273 | |
+# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
|
274 | |
+# will put a list of the files that are included by a file in the documentation
|
275 | |
+# of that file.
|
276 | |
+
|
277 | |
+SHOW_INCLUDE_FILES = YES
|
278 | |
+
|
279 | |
+# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
|
280 | |
+# is inserted in the documentation for inline members.
|
281 | |
+
|
282 | |
+INLINE_INFO = YES
|
283 | |
+
|
284 | |
+# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
|
285 | |
+# will sort the (detailed) documentation of file and class members
|
286 | |
+# alphabetically by member name. If set to NO the members will appear in
|
287 | |
+# declaration order.
|
288 | |
+
|
289 | |
+SORT_MEMBER_DOCS = YES
|
290 | |
+
|
291 | |
+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
|
292 | |
+# brief documentation of file, namespace and class members alphabetically
|
293 | |
+# by member name. If set to NO (the default) the members will appear in
|
294 | |
+# declaration order.
|
295 | |
+
|
296 | |
+SORT_BRIEF_DOCS = NO
|
297 | |
+
|
298 | |
+# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
|
299 | |
+# sorted by fully-qualified names, including namespaces. If set to
|
300 | |
+# NO (the default), the class list will be sorted only by class name,
|
301 | |
+# not including the namespace part.
|
302 | |
+# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
|
303 | |
+# Note: This option applies only to the class list, not to the
|
304 | |
+# alphabetical list.
|
305 | |
+
|
306 | |
+SORT_BY_SCOPE_NAME = NO
|
307 | |
+
|
308 | |
+# The GENERATE_TODOLIST tag can be used to enable (YES) or
|
309 | |
+# disable (NO) the todo list. This list is created by putting \todo
|
310 | |
+# commands in the documentation.
|
311 | |
+
|
312 | |
+GENERATE_TODOLIST = YES
|
313 | |
+
|
314 | |
+# The GENERATE_TESTLIST tag can be used to enable (YES) or
|
315 | |
+# disable (NO) the test list. This list is created by putting \test
|
316 | |
+# commands in the documentation.
|
317 | |
+
|
318 | |
+GENERATE_TESTLIST = YES
|
319 | |
+
|
320 | |
+# The GENERATE_BUGLIST tag can be used to enable (YES) or
|
321 | |
+# disable (NO) the bug list. This list is created by putting \bug
|
322 | |
+# commands in the documentation.
|
323 | |
+
|
324 | |
+GENERATE_BUGLIST = YES
|
325 | |
+
|
326 | |
+# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
|
327 | |
+# disable (NO) the deprecated list. This list is created by putting
|
328 | |
+# \deprecated commands in the documentation.
|
329 | |
+
|
330 | |
+GENERATE_DEPRECATEDLIST= YES
|
331 | |
+
|
332 | |
+# The ENABLED_SECTIONS tag can be used to enable conditional
|
333 | |
+# documentation sections, marked by \if sectionname ... \endif.
|
334 | |
+
|
335 | |
+ENABLED_SECTIONS =
|
336 | |
+
|
337 | |
+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
|
338 | |
+# the initial value of a variable or define consists of for it to appear in
|
339 | |
+# the documentation. If the initializer consists of more lines than specified
|
340 | |
+# here it will be hidden. Use a value of 0 to hide initializers completely.
|
341 | |
+# The appearance of the initializer of individual variables and defines in the
|
342 | |
+# documentation can be controlled using \showinitializer or \hideinitializer
|
343 | |
+# command in the documentation regardless of this setting.
|
344 | |
+
|
345 | |
+MAX_INITIALIZER_LINES = 30
|
346 | |
+
|
347 | |
+# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
|
348 | |
+# at the bottom of the documentation of classes and structs. If set to YES the
|
349 | |
+# list will mention the files that were used to generate the documentation.
|
350 | |
+
|
351 | |
+SHOW_USED_FILES = YES
|
352 | |
+
|
353 | |
+#---------------------------------------------------------------------------
|
354 | |
+# configuration options related to warning and progress messages
|
355 | |
+#---------------------------------------------------------------------------
|
356 | |
+
|
357 | |
+# The QUIET tag can be used to turn on/off the messages that are generated
|
358 | |
+# by doxygen. Possible values are YES and NO. If left blank NO is used.
|
359 | |
+
|
360 | |
+QUIET = NO
|
361 | |
+
|
362 | |
+# The WARNINGS tag can be used to turn on/off the warning messages that are
|
363 | |
+# generated by doxygen. Possible values are YES and NO. If left blank
|
364 | |
+# NO is used.
|
365 | |
+
|
366 | |
+WARNINGS = YES
|
367 | |
+
|
368 | |
+# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
|
369 | |
+# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
|
370 | |
+# automatically be disabled.
|
371 | |
+
|
372 | |
+WARN_IF_UNDOCUMENTED = YES
|
373 | |
+
|
374 | |
+# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
|
375 | |
+# potential errors in the documentation, such as not documenting some
|
376 | |
+# parameters in a documented function, or documenting parameters that
|
377 | |
+# don't exist or using markup commands wrongly.
|
378 | |
+
|
379 | |
+WARN_IF_DOC_ERROR = YES
|
380 | |
+
|
381 | |
+# The WARN_FORMAT tag determines the format of the warning messages that
|
382 | |
+# doxygen can produce. The string should contain the $file, $line, and $text
|
383 | |
+# tags, which will be replaced by the file and line number from which the
|
384 | |
+# warning originated and the warning text. Optionally the format may contain
|
385 | |
+# $version, which will be replaced by the version of the file (if it could
|
386 | |
+# be obtained via FILE_VERSION_FILTER)
|
387 | |
+
|
388 | |
+WARN_FORMAT = "$file:$line: $text"
|
389 | |
+
|
390 | |
+# The WARN_LOGFILE tag can be used to specify a file to which warning
|
391 | |
+# and error messages should be written. If left blank the output is written
|
392 | |
+# to stderr.
|
393 | |
+
|
394 | |
+WARN_LOGFILE =
|
395 | |
+
|
396 | |
+#---------------------------------------------------------------------------
|
397 | |
+# configuration options related to the input files
|
398 | |
+#---------------------------------------------------------------------------
|
399 | |
+
|
400 | |
+# The INPUT tag can be used to specify the files and/or directories that contain
|
401 | |
+# documented source files. You may enter file names like "myfile.cpp" or
|
402 | |
+# directories like "/usr/src/myproject". Separate the files or directories
|
403 | |
+# with spaces.
|
404 | |
+
|
405 | |
+INPUT = $(SRCDIR)
|
406 | |
+
|
407 | |
+# If the value of the INPUT tag contains directories, you can use the
|
408 | |
+# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
|
409 | |
+# and *.h) to filter out the source-files in the directories. If left
|
410 | |
+# blank the following patterns are tested:
|
411 | |
+# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
|
412 | |
+# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
|
413 | |
+
|
414 | |
+FILE_PATTERNS = *.h \
|
415 | |
+ *.cpp \
|
416 | |
+ *.c \
|
417 | |
+ *.dox
|
418 | |
+
|
419 | |
+# The RECURSIVE tag can be used to turn specify whether or not subdirectories
|
420 | |
+# should be searched for input files as well. Possible values are YES and NO.
|
421 | |
+# If left blank NO is used.
|
422 | |
+
|
423 | |
+RECURSIVE = YES
|
424 | |
+
|
425 | |
+# The EXCLUDE tag can be used to specify files and/or directories that should
|
426 | |
+# excluded from the INPUT source files. This way you can easily exclude a
|
427 | |
+# subdirectory from a directory tree whose root is specified with the INPUT tag.
|
428 | |
+
|
429 | |
+EXCLUDE = .svn
|
430 | |
+
|
431 | |
+# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
|
432 | |
+# directories that are symbolic links (a Unix filesystem feature) are excluded
|
433 | |
+# from the input.
|
434 | |
+
|
435 | |
+EXCLUDE_SYMLINKS = NO
|
436 | |
+
|
437 | |
+# If the value of the INPUT tag contains directories, you can use the
|
438 | |
+# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
|
439 | |
+# certain files from those directories.
|
440 | |
+
|
441 | |
+EXCLUDE_PATTERNS =
|
442 | |
+
|
443 | |
+# The EXAMPLE_PATH tag can be used to specify one or more files or
|
444 | |
+# directories that contain example code fragments that are included (see
|
445 | |
+# the \include command).
|
446 | |
+
|
447 | |
+EXAMPLE_PATH = $(SRCDIR)
|
448 | |
+
|
449 | |
+# If the value of the EXAMPLE_PATH tag contains directories, you can use the
|
450 | |
+# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
|
451 | |
+# and *.h) to filter out the source-files in the directories. If left
|
452 | |
+# blank all files are included.
|
453 | |
+
|
454 | |
+EXAMPLE_PATTERNS =
|
455 | |
+
|
456 | |
+# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
|
457 | |
+# searched for input files to be used with the \include or \dontinclude
|
458 | |
+# commands irrespective of the value of the RECURSIVE tag.
|
459 | |
+# Possible values are YES and NO. If left blank NO is used.
|
460 | |
+
|
461 | |
+EXAMPLE_RECURSIVE = NO
|
462 | |
+
|
463 | |
+# The IMAGE_PATH tag can be used to specify one or more files or
|
464 | |
+# directories that contain image that are included in the documentation (see
|
465 | |
+# the \image command).
|
466 | |
+
|
467 | |
+IMAGE_PATH =
|
468 | |
+
|
469 | |
+# The INPUT_FILTER tag can be used to specify a program that doxygen should
|
470 | |
+# invoke to filter for each input file. Doxygen will invoke the filter program
|
471 | |
+# by executing (via popen()) the command <filter> <input-file>, where <filter>
|
472 | |
+# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
|
473 | |
+# input file. Doxygen will then use the output that the filter program writes
|
474 | |
+# to standard output. If FILTER_PATTERNS is specified, this tag will be
|
475 | |
+# ignored.
|
476 | |
+
|
477 | |
+INPUT_FILTER =
|
478 | |
+
|
479 | |
+# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
|
480 | |
+# INPUT_FILTER) will be used to filter the input files when producing source
|
481 | |
+# files to browse (i.e. when SOURCE_BROWSER is set to YES).
|
482 | |
+
|
483 | |
+FILTER_SOURCE_FILES = NO
|
484 | |
+
|
485 | |
+#---------------------------------------------------------------------------
|
486 | |
+# configuration options related to source browsing
|
487 | |
+#---------------------------------------------------------------------------
|
488 | |
+
|
489 | |
+# If the SOURCE_BROWSER tag is set to YES then a list of source files will
|
490 | |
+# be generated. Documented entities will be cross-referenced with these sources.
|
491 | |
+# Note: To get rid of all source code in the generated output, make sure also
|
492 | |
+# VERBATIM_HEADERS is set to NO.
|
493 | |
+
|
494 | |
+SOURCE_BROWSER = NO
|
495 | |
+
|
496 | |
+# Setting the INLINE_SOURCES tag to YES will include the body
|
497 | |
+# of functions and classes directly in the documentation.
|
498 | |
+
|
499 | |
+INLINE_SOURCES = YES
|
500 | |
+
|
501 | |
+# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
|
502 | |
+# doxygen to hide any special comment blocks from generated source code
|
503 | |
+# fragments. Normal C and C++ comments will always remain visible.
|
504 | |
+
|
505 | |
+STRIP_CODE_COMMENTS = YES
|
506 | |
+
|
507 | |
+# If the REFERENCED_BY_RELATION tag is set to YES (the default)
|
508 | |
+# then for each documented function all documented
|
509 | |
+# functions referencing it will be listed.
|
510 | |
+
|
511 | |
+REFERENCED_BY_RELATION = YES
|
512 | |
+
|
513 | |
+# If the REFERENCES_RELATION tag is set to YES (the default)
|
514 | |
+# then for each documented function all documented entities
|
515 | |
+# called/used by that function will be listed.
|
516 | |
+
|
517 | |
+REFERENCES_RELATION = YES
|
518 | |
+
|
519 | |
+# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
|
520 | |
+# will generate a verbatim copy of the header file for each class for
|
521 | |
+# which an include is specified. Set to NO to disable this.
|
522 | |
+
|
523 | |
+VERBATIM_HEADERS = YES
|
524 | |
+
|
525 | |
+#---------------------------------------------------------------------------
|
526 | |
+# configuration options related to the alphabetical class index
|
527 | |
+#---------------------------------------------------------------------------
|
528 | |
+
|
529 | |
+# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
|
530 | |
+# of all compounds will be generated. Enable this if the project
|
531 | |
+# contains a lot of classes, structs, unions or interfaces.
|
532 | |
+
|
533 | |
+ALPHABETICAL_INDEX = NO
|
534 | |
+
|
535 | |
+# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
|
536 | |
+# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
|
537 | |
+# in which this list will be split (can be a number in the range [1..20])
|
538 | |
+
|
539 | |
+COLS_IN_ALPHA_INDEX = 5
|
540 | |
+
|
541 | |
+# In case all classes in a project start with a common prefix, all
|
542 | |
+# classes will be put under the same header in the alphabetical index.
|
543 | |
+# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
|
544 | |
+# should be ignored while generating the index headers.
|
545 | |
+
|
546 | |
+IGNORE_PREFIX =
|
547 | |
+
|
548 | |
+#---------------------------------------------------------------------------
|
549 | |
+# configuration options related to the HTML output
|
550 | |
+#---------------------------------------------------------------------------
|
551 | |
+
|
552 | |
+# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
|
553 | |
+# generate HTML output.
|
554 | |
+
|
555 | |
+GENERATE_HTML = $(GENERATE_HTML)
|
556 | |
+
|
557 | |
+# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
|
558 | |
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
559 | |
+# put in front of it. If left blank `html' will be used as the default path.
|
560 | |
+
|
561 | |
+HTML_OUTPUT = html
|
562 | |
+
|
563 | |
+# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
|
564 | |
+# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
|
565 | |
+# doxygen will generate files with .html extension.
|
566 | |
+
|
567 | |
+HTML_FILE_EXTENSION = .html
|
568 | |
+
|
569 | |
+# The HTML_HEADER tag can be used to specify a personal HTML header for
|
570 | |
+# each generated HTML page. If it is left blank doxygen will generate a
|
571 | |
+# standard header.
|
572 | |
+
|
573 | |
+HTML_HEADER =
|
574 | |
+
|
575 | |
+# The HTML_FOOTER tag can be used to specify a personal HTML footer for
|
576 | |
+# each generated HTML page. If it is left blank doxygen will generate a
|
577 | |
+# standard footer.
|
578 | |
+
|
579 | |
+HTML_FOOTER =
|
580 | |
+
|
581 | |
+# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
|
582 | |
+# style sheet that is used by each HTML page. It can be used to
|
583 | |
+# fine-tune the look of the HTML output. If the tag is left blank doxygen
|
584 | |
+# will generate a default style sheet. Note that doxygen will try to copy
|
585 | |
+# the style sheet file to the HTML output directory, so don't put your own
|
586 | |
+# stylesheet in the HTML output directory as well, or it will be erased!
|
587 | |
+
|
588 | |
+HTML_STYLESHEET =
|
589 | |
+
|
590 | |
+# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
|
591 | |
+# files or namespaces will be aligned in HTML using tables. If set to
|
592 | |
+# NO a bullet list will be used.
|
593 | |
+
|
594 | |
+HTML_ALIGN_MEMBERS = YES
|
595 | |
+
|
596 | |
+# If the GENERATE_HTMLHELP tag is set to YES, additional index files
|
597 | |
+# will be generated that can be used as input for tools like the
|
598 | |
+# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
|
599 | |
+# of the generated HTML documentation.
|
600 | |
+
|
601 | |
+GENERATE_HTMLHELP = $(GENERATE_CHM)
|
602 | |
+
|
603 | |
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
|
604 | |
+# be used to specify the file name of the resulting .chm file. You
|
605 | |
+# can add a path in front of the file if the result should not be
|
606 | |
+# written to the html output directory.
|
607 | |
+
|
608 | |
+CHM_FILE = ../$(PROJECT).chm
|
609 | |
+
|
610 | |
+# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
|
611 | |
+# be used to specify the location (absolute path including file name) of
|
612 | |
+# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
|
613 | |
+# the HTML help compiler on the generated index.hhp.
|
614 | |
+
|
615 | |
+HHC_LOCATION = $(HHC_PATH)
|
616 | |
+
|
617 | |
+# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
|
618 | |
+# controls if a separate .chi index file is generated (YES) or that
|
619 | |
+# it should be included in the master .chm file (NO).
|
620 | |
+
|
621 | |
+GENERATE_CHI = $(GENERATE_CHI)
|
622 | |
+
|
623 | |
+# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
|
624 | |
+# controls whether a binary table of contents is generated (YES) or a
|
625 | |
+# normal table of contents (NO) in the .chm file.
|
626 | |
+
|
627 | |
+BINARY_TOC = NO
|
628 | |
+
|
629 | |
+# The TOC_EXPAND flag can be set to YES to add extra items for group members
|
630 | |
+# to the contents of the HTML help documentation and to the tree view.
|
631 | |
+
|
632 | |
+TOC_EXPAND = NO
|
633 | |
+
|
634 | |
+# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
|
635 | |
+# top of each HTML page. The value NO (the default) enables the index and
|
636 | |
+# the value YES disables it.
|
637 | |
+
|
638 | |
+DISABLE_INDEX = NO
|
639 | |
+
|
640 | |
+# This tag can be used to set the number of enum values (range [1..20])
|
641 | |
+# that doxygen will group on one line in the generated HTML documentation.
|
642 | |
+
|
643 | |
+ENUM_VALUES_PER_LINE = 4
|
644 | |
+
|
645 | |
+# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
|
646 | |
+# generated containing a tree-like index structure (just like the one that
|
647 | |
+# is generated for HTML Help). For this to work a browser that supports
|
648 | |
+# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
|
649 | |
+# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
|
650 | |
+# probably better off using the HTML help feature.
|
651 | |
+
|
652 | |
+GENERATE_TREEVIEW = NO
|
653 | |
+
|
654 | |
+# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
|
655 | |
+# used to set the initial width (in pixels) of the frame in which the tree
|
656 | |
+# is shown.
|
657 | |
+
|
658 | |
+TREEVIEW_WIDTH = 250
|
659 | |
+
|
660 | |
+#---------------------------------------------------------------------------
|
661 | |
+# configuration options related to the LaTeX output
|
662 | |
+#---------------------------------------------------------------------------
|
663 | |
+
|
664 | |
+# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
|
665 | |
+# generate Latex output.
|
666 | |
+
|
667 | |
+GENERATE_LATEX = $(GENERATE_LATEX)
|
668 | |
+
|
669 | |
+# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
|
670 | |
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
671 | |
+# put in front of it. If left blank `latex' will be used as the default path.
|
672 | |
+
|
673 | |
+LATEX_OUTPUT =
|
674 | |
+
|
675 | |
+# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
|
676 | |
+# invoked. If left blank `latex' will be used as the default command name.
|
677 | |
+
|
678 | |
+LATEX_CMD_NAME = latex
|
679 | |
+
|
680 | |
+# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
|
681 | |
+# generate index for LaTeX. If left blank `makeindex' will be used as the
|
682 | |
+# default command name.
|
683 | |
+
|
684 | |
+MAKEINDEX_CMD_NAME = makeindex
|
685 | |
+
|
686 | |
+# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
|
687 | |
+# LaTeX documents. This may be useful for small projects and may help to
|
688 | |
+# save some trees in general.
|
689 | |
+
|
690 | |
+COMPACT_LATEX = NO
|
691 | |
+
|
692 | |
+# The PAPER_TYPE tag can be used to set the paper type that is used
|
693 | |
+# by the printer. Possible values are: a4, a4wide, letter, legal and
|
694 | |
+# executive. If left blank a4wide will be used.
|
695 | |
+
|
696 | |
+PAPER_TYPE = $(PAPER_SIZE)
|
697 | |
+
|
698 | |
+# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
|
699 | |
+# packages that should be included in the LaTeX output.
|
700 | |
+
|
701 | |
+EXTRA_PACKAGES =
|
702 | |
+
|
703 | |
+# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
|
704 | |
+# the generated latex document. The header should contain everything until
|
705 | |
+# the first chapter. If it is left blank doxygen will generate a
|
706 | |
+# standard header. Notice: only use this tag if you know what you are doing!
|
707 | |
+
|
708 | |
+LATEX_HEADER =
|
709 | |
+
|
710 | |
+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
|
711 | |
+# is prepared for conversion to pdf (using ps2pdf). The pdf file will
|
712 | |
+# contain links (just like the HTML output) instead of page references
|
713 | |
+# This makes the output suitable for online browsing using a pdf viewer.
|
714 | |
+
|
715 | |
+PDF_HYPERLINKS = NO
|
716 | |
+
|
717 | |
+# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
|
718 | |
+# plain latex in the generated Makefile. Set this option to YES to get a
|
719 | |
+# higher quality PDF documentation.
|
720 | |
+
|
721 | |
+USE_PDFLATEX = YES
|
722 | |
+
|
723 | |
+# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
|
724 | |
+# command to the generated LaTeX files. This will instruct LaTeX to keep
|
725 | |
+# running if errors occur, instead of asking the user for help.
|
726 | |
+# This option is also used when generating formulas in HTML.
|
727 | |
+
|
728 | |
+LATEX_BATCHMODE = YES
|
729 | |
+
|
730 | |
+# If LATEX_HIDE_INDICES is set to YES then doxygen will not
|
731 | |
+# include the index chapters (such as File Index, Compound Index, etc.)
|
732 | |
+# in the output.
|
733 | |
+
|
734 | |
+LATEX_HIDE_INDICES = NO
|
735 | |
+
|
736 | |
+#---------------------------------------------------------------------------
|
737 | |
+# configuration options related to the RTF output
|
738 | |
+#---------------------------------------------------------------------------
|
739 | |
+
|
740 | |
+# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
|
741 | |
+# The RTF output is optimized for Word 97 and may not look very pretty with
|
742 | |
+# other RTF readers or editors.
|
743 | |
+
|
744 | |
+GENERATE_RTF = $(GENERATE_RTF)
|
745 | |
+
|
746 | |
+# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
|
747 | |
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
748 | |
+# put in front of it. If left blank `rtf' will be used as the default path.
|
749 | |
+
|
750 | |
+RTF_OUTPUT = rtf
|
751 | |
+
|
752 | |
+# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
|
753 | |
+# RTF documents. This may be useful for small projects and may help to
|
754 | |
+# save some trees in general.
|
755 | |
+
|
756 | |
+COMPACT_RTF = NO
|
757 | |
+
|
758 | |
+# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
|
759 | |
+# will contain hyperlink fields. The RTF file will
|
760 | |
+# contain links (just like the HTML output) instead of page references.
|
761 | |
+# This makes the output suitable for online browsing using WORD or other
|
762 | |
+# programs which support those fields.
|
763 | |
+# Note: wordpad (write) and others do not support links.
|
764 | |
+
|
765 | |
+RTF_HYPERLINKS = NO
|
766 | |
+
|
767 | |
+# Load stylesheet definitions from file. Syntax is similar to doxygen's
|
768 | |
+# config file, i.e. a series of assignments. You only have to provide
|
769 | |
+# replacements, missing definitions are set to their default value.
|
770 | |
+
|
771 | |
+RTF_STYLESHEET_FILE =
|
772 | |
+
|
773 | |
+# Set optional variables used in the generation of an rtf document.
|
774 | |
+# Syntax is similar to doxygen's config file.
|
775 | |
+
|
776 | |
+RTF_EXTENSIONS_FILE =
|
777 | |
+
|
778 | |
+#---------------------------------------------------------------------------
|
779 | |
+# configuration options related to the man page output
|
780 | |
+#---------------------------------------------------------------------------
|
781 | |
+
|
782 | |
+# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
|
783 | |
+# generate man pages
|
784 | |
+
|
785 | |
+GENERATE_MAN = $(GENERATE_MAN)
|
786 | |
+
|
787 | |
+# The MAN_OUTPUT tag is used to specify where the man pages will be put.
|
788 | |
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
789 | |
+# put in front of it. If left blank `man' will be used as the default path.
|
790 | |
+
|
791 | |
+MAN_OUTPUT = man
|
792 | |
+
|
793 | |
+# The MAN_EXTENSION tag determines the extension that is added to
|
794 | |
+# the generated man pages (default is the subroutine's section .3)
|
795 | |
+
|
796 | |
+MAN_EXTENSION = .1
|
797 | |
+
|
798 | |
+# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
|
799 | |
+# then it will generate one additional man file for each entity
|
800 | |
+# documented in the real man page(s). These additional files
|
801 | |
+# only source the real man page, but without them the man command
|
802 | |
+# would be unable to find the correct page. The default is NO.
|
803 | |
+
|
804 | |
+MAN_LINKS = NO
|
805 | |
+
|
806 | |
+#---------------------------------------------------------------------------
|
807 | |
+# configuration options related to the XML output
|
808 | |
+#---------------------------------------------------------------------------
|
809 | |
+
|
810 | |
+# If the GENERATE_XML tag is set to YES Doxygen will
|
811 | |
+# generate an XML file that captures the structure of
|
812 | |
+# the code including all documentation.
|
813 | |
+
|
814 | |
+GENERATE_XML = $(GENERATE_XML)
|
815 | |
+
|
816 | |
+# The XML_OUTPUT tag is used to specify where the XML pages will be put.
|
817 | |
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
818 | |
+# put in front of it. If left blank `xml' will be used as the default path.
|
819 | |
+
|
820 | |
+XML_OUTPUT = xml
|
821 | |
+
|
822 | |
+# The XML_SCHEMA tag can be used to specify an XML schema,
|
823 | |
+# which can be used by a validating XML parser to check the
|
824 | |
+# syntax of the XML files.
|
825 | |
+
|
826 | |
+XML_SCHEMA =
|
827 | |
+
|
828 | |
+# The XML_DTD tag can be used to specify an XML DTD,
|
829 | |
+# which can be used by a validating XML parser to check the
|
830 | |
+# syntax of the XML files.
|
831 | |
+
|
832 | |
+XML_DTD =
|
833 | |
+
|
834 | |
+# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
|
835 | |
+# dump the program listings (including syntax highlighting
|
836 | |
+# and cross-referencing information) to the XML output. Note that
|
837 | |
+# enabling this will significantly increase the size of the XML output.
|
838 | |
+
|
839 | |
+XML_PROGRAMLISTING = YES
|
840 | |
+
|
841 | |
+#---------------------------------------------------------------------------
|
842 | |
+# configuration options for the AutoGen Definitions output
|
843 | |
+#---------------------------------------------------------------------------
|
844 | |
+
|
845 | |
+# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
|
846 | |
+# generate an AutoGen Definitions (see autogen.sf.net) file
|
847 | |
+# that captures the structure of the code including all
|
848 | |
+# documentation. Note that this feature is still experimental
|
849 | |
+# and incomplete at the moment.
|
850 | |
+
|
851 | |
+GENERATE_AUTOGEN_DEF = NO
|
852 | |
+
|
853 | |
+#---------------------------------------------------------------------------
|
854 | |
+# configuration options related to the Perl module output
|
855 | |
+#---------------------------------------------------------------------------
|
856 | |
+
|
857 | |
+# If the GENERATE_PERLMOD tag is set to YES Doxygen will
|
858 | |
+# generate a Perl module file that captures the structure of
|
859 | |
+# the code including all documentation. Note that this
|
860 | |
+# feature is still experimental and incomplete at the
|
861 | |
+# moment.
|
862 | |
+
|
863 | |
+GENERATE_PERLMOD = NO
|
864 | |
+
|
865 | |
+# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
|
866 | |
+# the necessary Makefile rules, Perl scripts and LaTeX code to be able
|
867 | |
+# to generate PDF and DVI output from the Perl module output.
|
868 | |
+
|
869 | |
+PERLMOD_LATEX = NO
|
870 | |
+
|
871 | |
+# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
|
872 | |
+# nicely formatted so it can be parsed by a human reader. This is useful
|
873 | |
+# if you want to understand what is going on. On the other hand, if this
|
874 | |
+# tag is set to NO the size of the Perl module output will be much smaller
|
875 | |
+# and Perl will parse it just the same.
|
876 | |
+
|
877 | |
+PERLMOD_PRETTY = YES
|
878 | |
+
|
879 | |
+# The names of the make variables in the generated doxyrules.make file
|
880 | |
+# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
|
881 | |
+# This is useful so different doxyrules.make files included by the same
|
882 | |
+# Makefile don't overwrite each other's variables.
|
883 | |
+
|
884 | |
+PERLMOD_MAKEVAR_PREFIX =
|
885 | |
+
|
886 | |
+#---------------------------------------------------------------------------
|
887 | |
+# Configuration options related to the preprocessor
|
888 | |
+#---------------------------------------------------------------------------
|
889 | |
+
|
890 | |
+# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
|
891 | |
+# evaluate all C-preprocessor directives found in the sources and include
|
892 | |
+# files.
|
893 | |
+
|
894 | |
+ENABLE_PREPROCESSING = YES
|
895 | |
+
|
896 | |
+# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
|
897 | |
+# names in the source code. If set to NO (the default) only conditional
|
898 | |
+# compilation will be performed. Macro expansion can be done in a controlled
|
899 | |
+# way by setting EXPAND_ONLY_PREDEF to YES.
|
900 | |
+
|
901 | |
+MACRO_EXPANSION = YES
|
902 | |
+
|
903 | |
+# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
|
904 | |
+# then the macro expansion is limited to the macros specified with the
|
905 | |
+# PREDEFINED and EXPAND_AS_PREDEFINED tags.
|
906 | |
+
|
907 | |
+EXPAND_ONLY_PREDEF = YES
|
908 | |
+
|
909 | |
+# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
|
910 | |
+# in the INCLUDE_PATH (see below) will be search if a #include is found.
|
911 | |
+
|
912 | |
+SEARCH_INCLUDES = YES
|
913 | |
+
|
914 | |
+# The INCLUDE_PATH tag can be used to specify one or more directories that
|
915 | |
+# contain include files that are not input files but should be processed by
|
916 | |
+# the preprocessor.
|
917 | |
+
|
918 | |
+INCLUDE_PATH =
|
919 | |
+
|
920 | |
+# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
|
921 | |
+# patterns (like *.h and *.hpp) to filter out the header-files in the
|
922 | |
+# directories. If left blank, the patterns specified with FILE_PATTERNS will
|
923 | |
+# be used.
|
924 | |
+
|
925 | |
+INCLUDE_FILE_PATTERNS =
|
926 | |
+
|
927 | |
+# The PREDEFINED tag can be used to specify one or more macro names that
|
928 | |
+# are defined before the preprocessor is started (similar to the -D option of
|
929 | |
+# gcc). The argument of the tag is a list of macros of the form: name
|
930 | |
+# or name=definition (no spaces). If the definition and the = are
|
931 | |
+# omitted =1 is assumed. To prevent a macro definition from being
|
932 | |
+# undefined via #undef or recursively expanded use the := operator
|
933 | |
+# instead of the = operator.
|
934 | |
+
|
935 | |
+PREDEFINED =
|
936 | |
+# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
|
937 | |
+# this tag can be used to specify a list of macro names that should be expanded.
|
938 | |
+# The macro definition that is found in the sources will be used.
|
939 | |
+# Use the PREDEFINED tag if you want to use a different macro definition.
|
940 | |
+
|
941 | |
+EXPAND_AS_DEFINED =
|
942 | |
+
|
943 | |
+# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
|
944 | |
+# doxygen's preprocessor will remove all function-like macros that are alone
|
945 | |
+# on a line, have an all uppercase name, and do not end with a semicolon. Such
|
946 | |
+# function macros are typically used for boiler-plate code, and will confuse
|
947 | |
+# the parser if not removed.
|
948 | |
+
|
949 | |
+SKIP_FUNCTION_MACROS = YES
|
950 | |
+
|
951 | |
+#---------------------------------------------------------------------------
|
952 | |
+# Configuration::additions related to external references
|
953 | |
+#---------------------------------------------------------------------------
|
954 | |
+
|
955 | |
+# The TAGFILES option can be used to specify one or more tagfiles.
|
956 | |
+# Optionally an initial location of the external documentation
|
957 | |
+# can be added for each tagfile. The format of a tag file without
|
958 | |
+# this location is as follows:
|
959 | |
+# TAGFILES = file1 file2 ...
|
960 | |
+# Adding location for the tag files is done as follows:
|
961 | |
+# TAGFILES = file1=loc1 "file2 = loc2" ...
|
962 | |
+# where "loc1" and "loc2" can be relative or absolute paths or
|
963 | |
+# URLs. If a location is present for each tag, the installdox tool
|
964 | |
+# does not have to be run to correct the links.
|
965 | |
+# Note that each tag file must have a unique name
|
966 | |
+# (where the name does NOT include the path)
|
967 | |
+# If a tag file is not located in the directory in which doxygen
|
968 | |
+# is run, you must also specify the path to the tagfile here.
|
969 | |
+
|
970 | |
+TAGFILES =
|
971 | |
+
|
972 | |
+# When a file name is specified after GENERATE_TAGFILE, doxygen will create
|
973 | |
+# a tag file that is based on the input files it reads.
|
974 | |
+
|
975 | |
+GENERATE_TAGFILE = $(DOCDIR)/$(PROJECT).tag
|
976 | |
+
|
977 | |
+# If the ALLEXTERNALS tag is set to YES all external classes will be listed
|
978 | |
+# in the class index. If set to NO only the inherited external classes
|
979 | |
+# will be listed.
|
980 | |
+
|
981 | |
+ALLEXTERNALS = NO
|
982 | |
+
|
983 | |
+# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
|
984 | |
+# in the modules index. If set to NO, only the current project's groups will
|
985 | |
+# be listed.
|
986 | |
+
|
987 | |
+EXTERNAL_GROUPS = YES
|
988 | |
+
|
989 | |
+# The PERL_PATH should be the absolute path and name of the perl script
|
990 | |
+# interpreter (i.e. the result of `which perl').
|
991 | |
+
|
992 | |
+PERL_PATH = $(PERL_PATH)
|
993 | |
+
|
994 | |
+#---------------------------------------------------------------------------
|
995 | |
+# Configuration options related to the dot tool
|
996 | |
+#---------------------------------------------------------------------------
|
997 | |
+
|
998 | |
+# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
|
999 | |
+# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
|
1000 | |
+# or super classes. Setting the tag to NO turns the diagrams off. Note that
|
1001 | |
+# this option is superseded by the HAVE_DOT option below. This is only a
|
1002 | |
+# fallback. It is recommended to install and use dot, since it yields more
|
1003 | |
+# powerful graphs.
|
1004 | |
+
|
1005 | |
+CLASS_DIAGRAMS = YES
|
1006 | |
+
|
1007 | |
+# If set to YES, the inheritance and collaboration graphs will hide
|
1008 | |
+# inheritance and usage relations if the target is undocumented
|
1009 | |
+# or is not a class.
|
1010 | |
+
|
1011 | |
+HIDE_UNDOC_RELATIONS = YES
|
1012 | |
+
|
1013 | |
+# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
|
1014 | |
+# available from the path. This tool is part of Graphviz, a graph visualization
|
1015 | |
+# toolkit from AT&T and Lucent Bell Labs. The other options in this section
|
1016 | |
+# have no effect if this option is set to NO (the default)
|
1017 | |
+
|
1018 | |
+HAVE_DOT = $(HAVE_DOT)
|
1019 | |
+
|
1020 | |
+# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
|
1021 | |
+# will generate a graph for each documented class showing the direct and
|
1022 | |
+# indirect inheritance relations. Setting this tag to YES will force the
|
1023 | |
+# the CLASS_DIAGRAMS tag to NO.
|
1024 | |
+
|
1025 | |
+CLASS_GRAPH = YES
|
1026 | |
+
|
1027 | |
+# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
|
1028 | |
+# will generate a graph for each documented class showing the direct and
|
1029 | |
+# indirect implementation dependencies (inheritance, containment, and
|
1030 | |
+# class references variables) of the class with other documented classes.
|
1031 | |
+
|
1032 | |
+COLLABORATION_GRAPH = YES
|
1033 | |
+
|
1034 | |
+# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
|
1035 | |
+# collaboration diagrams in a style similar to the OMG's Unified Modeling
|
1036 | |
+# Language.
|
1037 | |
+
|
1038 | |
+UML_LOOK = NO
|
1039 | |
+
|
1040 | |
+# If set to YES, the inheritance and collaboration graphs will show the
|
1041 | |
+# relations between templates and their instances.
|
1042 | |
+
|
1043 | |
+TEMPLATE_RELATIONS = NO
|
1044 | |
+
|
1045 | |
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
|
1046 | |
+# tags are set to YES then doxygen will generate a graph for each documented
|
1047 | |
+# file showing the direct and indirect include dependencies of the file with
|
1048 | |
+# other documented files.
|
1049 | |
+
|
1050 | |
+INCLUDE_GRAPH = YES
|
1051 | |
+
|
1052 | |
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
|
1053 | |
+# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
|
1054 | |
+# documented header file showing the documented files that directly or
|
1055 | |
+# indirectly include this file.
|
1056 | |
+
|
1057 | |
+INCLUDED_BY_GRAPH = YES
|
1058 | |
+
|
1059 | |
+# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
|
1060 | |
+# generate a call dependency graph for every global function or class method.
|
1061 | |
+# Note that enabling this option will significantly increase the time of a run.
|
1062 | |
+# So in most cases it will be better to enable call graphs for selected
|
1063 | |
+# functions only using the \callgraph command.
|
1064 | |
+
|
1065 | |
+CALL_GRAPH = NO
|
1066 | |
+
|
1067 | |
+# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
|
1068 | |
+# will graphical hierarchy of all classes instead of a textual one.
|
1069 | |
+
|
1070 | |
+GRAPHICAL_HIERARCHY = YES
|
1071 | |
+
|
1072 | |
+# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
|
1073 | |
+# generated by dot. Possible values are png, jpg, or gif
|
1074 | |
+# If left blank png will be used.
|
1075 | |
+
|
1076 | |
+DOT_IMAGE_FORMAT = png
|
1077 | |
+
|
1078 | |
+# The tag DOT_PATH can be used to specify the path where the dot tool can be
|
1079 | |
+# found. If left blank, it is assumed the dot tool can be found in the path.
|
1080 | |
+
|
1081 | |
+DOT_PATH = $(DOT_PATH)
|
1082 | |
+
|
1083 | |
+# The DOTFILE_DIRS tag can be used to specify one or more directories that
|
1084 | |
+# contain dot files that are included in the documentation (see the
|
1085 | |
+# \dotfile command).
|
1086 | |
+
|
1087 | |
+DOTFILE_DIRS =
|
1088 | |
+
|
1089 | |
+# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
|
1090 | |
+# (in pixels) of the graphs generated by dot. If a graph becomes larger than
|
1091 | |
+# this value, doxygen will try to truncate the graph, so that it fits within
|
1092 | |
+# the specified constraint. Beware that most browsers cannot cope with very
|
1093 | |
+# large images.
|
1094 | |
+
|
1095 | |
+MAX_DOT_GRAPH_WIDTH = 1024
|
1096 | |
+
|
1097 | |
+# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
|
1098 | |
+# (in pixels) of the graphs generated by dot. If a graph becomes larger than
|
1099 | |
+# this value, doxygen will try to truncate the graph, so that it fits within
|
1100 | |
+# the specified constraint. Beware that most browsers cannot cope with very
|
1101 | |
+# large images.
|
1102 | |
+
|
1103 | |
+MAX_DOT_GRAPH_HEIGHT = 1024
|
1104 | |
+
|
1105 | |
+# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
|
1106 | |
+# graphs generated by dot. A depth value of 3 means that only nodes reachable
|
1107 | |
+# from the root by following a path via at most 3 edges will be shown. Nodes
|
1108 | |
+# that lay further from the root node will be omitted. Note that setting this
|
1109 | |
+# option to 1 or 2 may greatly reduce the computation time needed for large
|
1110 | |
+# code bases. Also note that a graph may be further truncated if the graph's
|
1111 | |
+# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH
|
1112 | |
+# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default),
|
1113 | |
+# the graph is not depth-constrained.
|
1114 | |
+
|
1115 | |
+MAX_DOT_GRAPH_DEPTH = 0
|
1116 | |
+
|
1117 | |
+# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
|
1118 | |
+# generate a legend page explaining the meaning of the various boxes and
|
1119 | |
+# arrows in the dot generated graphs.
|
1120 | |
+
|
1121 | |
+GENERATE_LEGEND = YES
|
1122 | |
+
|
1123 | |
+# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
|
1124 | |
+# remove the intermediate dot files that are used to generate
|
1125 | |
+# the various graphs.
|
1126 | |
+
|
1127 | |
+DOT_CLEANUP = YES
|
1128 | |
+
|
1129 | |
+#---------------------------------------------------------------------------
|
1130 | |
+# Configuration::additions related to the search engine
|
1131 | |
+#---------------------------------------------------------------------------
|
1132 | |
+
|
1133 | |
+# The SEARCHENGINE tag specifies whether or not a search engine should be
|
1134 | |
+# used. If set to NO the values of all tags below this one will be ignored.
|
1135 | |
+
|
1136 | |
+SEARCHENGINE = NO
|
1137 | |
--- /dev/null
|
1138 | |
+++ b/docs/geotifcp.html
|
1139 | |
@@ -0,0 +1,48 @@
|
1140 | |
+<html>
|
1141 | |
+<head>
|
1142 | |
+<title>geotifcp - Copy TIFF, Installing GeoTIFF Metadata</title>
|
1143 | |
+</head>
|
1144 | |
+
|
1145 | |
+<body BGCOLOR="#FFFFFF">
|
1146 | |
+
|
1147 | |
+<h1>geotifcp - Copy TIFF with updated GeoTIFF Metadata</h1>
|
1148 | |
+
|
1149 | |
+<pre>
|
1150 | |
+Syntax: geotifcp [options] [-e esri_worldfile] [-g metadata] input output
|
1151 | |
+</pre>
|
1152 | |
+
|
1153 | |
+The program geotifcp is identical in function to the LIBTIFF program
|
1154 | |
+"tiffcp", with the additional feature that if the "-g <metadata>"
|
1155 | |
+option is used the GeoTIFF information from the file <metadata>
|
1156 | |
+will be installed into the output file. The "-e worldfile" option will
|
1157 | |
+override the tiepoint and scale information from the metadata file based
|
1158 | |
+on the contents of the ESRI worldfile. <p>
|
1159 | |
+
|
1160 | |
+If the "-g" option is not used the geotiff information from the source
|
1161 | |
+file is preserved in the new output file.<p>
|
1162 | |
+
|
1163 | |
+"geotifcp" inherits all the other file-transformation capabilities
|
1164 | |
+of the tiffcp program; for help on the additional parameters give
|
1165 | |
+the command:<p>
|
1166 | |
+<pre>
|
1167 | |
+ % geotifcp -h
|
1168 | |
+</pre>
|
1169 | |
+
|
1170 | |
+The metadata format is the same as is described in the <a href="listgeo.html">
|
1171 | |
+listgeo</a> program. Normally metadata files for use with geotifcp are
|
1172 | |
+generated from a similar file with listgeo, and then modified by hand
|
1173 | |
+as required. <p>
|
1174 | |
+
|
1175 | |
+<h2>See Also:</h2>
|
1176 | |
+
|
1177 | |
+<ol>
|
1178 | |
+<li>
|
1179 | |
+<a href="listgeo.html">listgeo</a> - Dump GeoTIFF Metadata<p>
|
1180 | |
+
|
1181 | |
+<li>
|
1182 | |
+<a href="http://www.remotesensing.org/geotiff/geotiff.html">
|
1183 | |
+http://www.remotesensing.org/geotiff/geotiff.html</a> - GeoTIFF/libgeotiff Home Page<p>
|
1184 | |
+
|
1185 | |
+</ol>
|
1186 | |
+</body>
|
1187 | |
+</html>
|
1188 | |
--- /dev/null
|
1189 | |
+++ b/docs/index.dox
|
1190 | |
@@ -0,0 +1,67 @@
|
1191 | |
+/*! \page index
|
1192 | |
+
|
1193 | |
+<center><title>
|
1194 | |
+LIBGEOTIFF
|
1195 | |
+</title></center>
|
1196 | |
+
|
1197 | |
+<h2>Functions</h2>
|
1198 | |
+
|
1199 | |
+<ul>
|
1200 | |
+<li> GTIFFree(): Free GeoTIFF access handle.
|
1201 | |
+<li> GTIFGetDefn(): Read and Normalize GeoTIFF Definition.
|
1202 | |
+<li> GTIFKeyGet(): Read GeoTIFF GeoKey.
|
1203 | |
+<li> GTIFKeySet(): Write GeoTIFF GeoKey.
|
1204 | |
+<li> GTIFNew(): Create GeoTIFF access handle.
|
1205 | |
+<li> GTIFWriteKeys(): Flush GeoTIFF Keys.
|
1206 | |
+<li> SetCSVFilenameHook(): Override CSV File Searching.
|
1207 | |
+<li> XTIFFClose(): Close GeoTIFF file.
|
1208 | |
+<li> XTIFFOpen(): Open GeoTIFF file.
|
1209 | |
+</ul>
|
1210 | |
+
|
1211 | |
+<h2>General Notes</h2>
|
1212 | |
+
|
1213 | |
+The libgeotiff library should compile cleanly with most ANSI-C or
|
1214 | |
+ANSI C++ compilers. All headers have appropriate <b>extern "C" {}</b>
|
1215 | |
+protection to ensure that entry points retain C linkage even if compiled
|
1216 | |
+with a C++ compiler. <p>
|
1217 | |
+
|
1218 | |
+<h2>Source Tree</h2>
|
1219 | |
+
|
1220 | |
+The <a href="http://www.remotesensing.org/cgi-bin/cvsweb.cgi/osrs/geotiff">
|
1221 | |
+current CVS tree</a> is available on the web. The source can be
|
1222 | |
+downloaded anonymously using the <tt>cvs checkout osrs/geotiff/libgeotiff</tt>
|
1223 | |
+command after logging in using the instructions on the remotesensing.org
|
1224 | |
+<a href="/docs/howto-cvs.php3">CVS howto page</a>.<p>
|
1225 | |
+
|
1226 | |
+<h2>Include Files</h2>
|
1227 | |
+
|
1228 | |
+<ul>
|
1229 | |
+<li> xtiffio.h: the primary interface header file for all TIFF
|
1230 | |
+routines, using the extended GeoTIFF tags.<p>
|
1231 | |
+
|
1232 | |
+<li> geotiffio.h: the primary interface header file for all GTIF
|
1233 | |
+routines, keys and code values.<p>
|
1234 | |
+
|
1235 | |
+<li> geotiff.h: an interface header file for all GTIF
|
1236 | |
+routines, if code values are not required.<p>
|
1237 | |
+
|
1238 | |
+<li> geokeys.h: defines all valid GEOTIFF GeoKeys.<p>
|
1239 | |
+
|
1240 | |
+<li> geo_normalize.h: Defined all functions and structures related
|
1241 | |
+to normalization of GeoTIFF information based on CSV files.<p>
|
1242 | |
+
|
1243 | |
+</ul>
|
1244 | |
+
|
1245 | |
+<h2>Licensing</h2>
|
1246 | |
+
|
1247 | |
+All the source code in this toolkit are either in the public domain, or under
|
1248 | |
+an X style license. In any event it is all considered to be free to use
|
1249 | |
+for any purpose (including commercial software). No credit is required
|
1250 | |
+though some of the code requires that the specific source code modules
|
1251 | |
+retain their existing copyright statements. The CSV files, and other tables
|
1252 | |
+derived from the EPSG coordinate system database are also free for commercial
|
1253 | |
+and non-commercial use. In particular, no part of this code is
|
1254 | |
+<i>copyleft</i>, nor does it imply any requirement for users to disclose
|
1255 | |
+this or their own source code.<p>
|
1256 | |
+
|
1257 | |
+*/
|
1258 | |
--- /dev/null
|
1259 | |
+++ b/docs/listgeo.html
|
1260 | |
@@ -0,0 +1,170 @@
|
1261 | |
+<html>
|
1262 | |
+<head>
|
1263 | |
+<title>listgeo - Dump GeoTIFF Metadata</title>
|
1264 | |
+</head>
|
1265 | |
+
|
1266 | |
+<body BGCOLOR="#FFFFFF">
|
1267 | |
+
|
1268 | |
+<h1>listgeo - Dump GeoTIFF Metadata</h1>
|
1269 | |
+
|
1270 | |
+<pre><b>
|
1271 | |
+Usage: listgeo [-tfw] [-no_norm] [-proj4] [-t tabledir] inputfile
|
1272 | |
+</b></pre>
|
1273 | |
+
|
1274 | |
+The program listgeo takes a GeoTIFF file as input and dumps to
|
1275 | |
+the standard output a GeoTIFF "metadata" file, which is human
|
1276 | |
+readable, and may also be used as input to other programs which
|
1277 | |
+use the "GTIFImport" routine, such as <a href="geotiff.html">geotifcp</a>.<p>
|
1278 | |
+
|
1279 | |
+The <b>-tfw</b> flag may be passed to force generation of an ESRI style .tfw
|
1280 | |
+file as well as the metadata file. The ESRI world file is always given
|
1281 | |
+the same basename as the input file, with the extension .tfw. If one
|
1282 | |
+exists already it will be overwritten.<p>
|
1283 | |
+
|
1284 | |
+The <b>-no_norm</b> flag will supress reporting of normalized parameters, and
|
1285 | |
+reporting of corner points. <p>
|
1286 | |
+
|
1287 | |
+The <b>-proj4</b> flag forces listgeo to report the PROJ.4 projection
|
1288 | |
+string it uses for reprojecting corners to lat/long.<p>
|
1289 | |
+
|
1290 | |
+The <b>-t tabledir</b> flag overrides the programs concept of how to file the
|
1291 | |
+EPSG CSV files, causing it to look in directory "tabledir". <p>
|
1292 | |
+
|
1293 | |
+<h2>GeoTIFF Metadata Format</h2>
|
1294 | |
+
|
1295 | |
+For the formalist junkies, we will define a GeoTIFF metadata format
|
1296 | |
+in an unambiguous fashion, and follow that by a concrete example.<p>
|
1297 | |
+
|
1298 | |
+The metadata format is defined as follows (all strings not placed
|
1299 | |
+between <braces> are string literals, case-sensitive, and any entry
|
1300 | |
+followed by "*" or "*<number>" indicates multiple entries):<p>
|
1301 | |
+
|
1302 | |
+<pre>
|
1303 | |
+<Geotiff_Metadata> = <Geotiff_Header> + <GeoTIFF_Body> + <GeoTIFF_Trailer>
|
1304 | |
+
|
1305 | |
+ <Geotiff_Header> = <White_Space> + Geotiff_Information: + <Return>
|
1306 | |
+ <GeoTIFF_Trailer> = <White_Space> + End_Of_Geotiff. + <Return>
|
1307 | |
+ <GeoTIFF_Body> = <GeoTIFF_Info> + <GeoTIFF_Tags> + <GeoTIFF_Keys>
|
1308 | |
+ <GeoTIFF_Info> = <GeoTIFF_Version> + <GeoTIFF_Revision>
|
1309 | |
+ <GeoTIFF_Version> = Version: + <Single_Space> + <Version> + <Return>
|
1310 | |
+ <Version> = <Integer>
|
1311 | |
+ <GeoTIFF_Revision> = Revision: +
|
1312 | |
+ <Single_Space> + <Major_Rev> + <Period> + <Minor_Rev> + <Return>
|
1313 | |
+ <Major_Rev> = <Integer>
|
1314 | |
+ <Minor_Rev> = <Integer>
|
1315 | |
+ <GeoTIFF_Tags> = <Tag_Header> + <Tag_Entry>* + <Tag_Trailer>
|
1316 | |
+ <Tag_Header> = <White_Space> + Tagged_Information: + <Return>
|
1317 | |
+ <Tag_Trailer> = <White_Space> + End_Of_Tags. + <Return>
|
1318 | |
+ <Tag_Entry> = <Tag_Entry_Header> + <Tag_Entry_Row>*
|
1319 | |
+ <Tag_Entry_Header> = <White_Space> +
|
1320 | |
+ <Tag_Name> + <Tag_Dimension> + <Colon> + <Return>
|
1321 | |
+ <Tag_Dimension> = "(" + <NRows> + <Comma> + <NCols> + ")"
|
1322 | |
+ <NRows> = <Integer>
|
1323 | |
+ <NCols> = <Integer>
|
1324 | |
+ <Tag_Entry_Row> = <White_Space> + <Double_Float>*<NCols> + <Return>
|
1325 | |
+ <GeoTIFF_Keys> = <Key_Header> + <Key_Entry>* + <Key_Trailer>
|
1326 | |
+ <Key_Header> = <White_Space> + Keyed_Information: + <Return>
|
1327 | |
+ <Key_Trailer> = <White_Space> + End_Of_Keys. + <Return>
|
1328 | |
+ <Key_Entry> = <Key_Entry_Header> + <Key_Entry_Value>
|
1329 | |
+ <Key_Entry_Header> = <White_Space> +
|
1330 | |
+ <Key_Name> + <Key_Dimension> + <Colon> + <Return>
|
1331 | |
+ <Key_Dimension> = "(" + <Key_Format> + <Comma> + <Key_Count> + ")"
|
1332 | |
+ <Key_Entry_Value> = (<Key_Value> | <Numeric_Value> | <Ascii_Value>)
|
1333 | |
+ <Numeric_Value> = (<Integer> | <Double_Float>)
|
1334 | |
+ <Ascii_Value> = <Double_Quote> + <String> + <Double_Quote>
|
1335 | |
+
|
1336 | |
+ <Tag_Name> = All symbolic tag names defined in GeoTIFF spec.
|
1337 | |
+ <Key_Name> = All symbolic key names defined in GeoTIFF spec.
|
1338 | |
+ <Key_Value> = All symbolic value names defined in GeoTIFF spec.
|
1339 | |
+ <Key_Format> = (Short | Ascii | Double)
|
1340 | |
+</pre>
|
1341 | |
+
|
1342 | |
+And for the pedantic:
|
1343 | |
+<pre>
|
1344 | |
+ <White_Space> = (<Single_Space> | <Tab>)*
|
1345 | |
+ <Double_Float> = <Mantissa><Exponent>
|
1346 | |
+ <Mantissa> = <Sign><Integer><Period><Integer>
|
1347 | |
+ <Exponent> = ( |e<Sign><Integer>)
|
1348 | |
+ <Sign> = ( |+|-)
|
1349 | |
+ <Integer> = (0|1|2|3|4|5|6|7|8|9)*
|
1350 | |
+ ...
|
1351 | |
+</pre>
|
1352 | |
+
|
1353 | |
+Following the formal metadata report, there is an optional (use -no_norm
|
1354 | |
+to supress) report on the <i>normalized</i> projection parameters for the
|
1355 | |
+file. This is an attempt to lookup PCS and GCS definitions to get detailed
|
1356 | |
+datum, ellipsoid, and projection definitions for the file. In general it
|
1357 | |
+requires access to the EPSG CSV files to work properly. The GEOTIFF_CSV
|
1358 | |
+environment variable can be used to point to directory containing the EPSG
|
1359 | |
+CSV files (normally distributed with libgeotiff, or this executable). If
|
1360 | |
+GEOTIFF_CSV is not defined listgeo will look for a csv subdirectory, or
|
1361 | |
+the /usr/local/shared/epsg_csv directory. The -t commandline switch can
|
1362 | |
+also be used to indicate where the CSV files are located.<p>
|
1363 | |
+
|
1364 | |
+Following the normalized projection information listgeo will report the
|
1365 | |
+positions of the four corner coordinates, and if possible their lat/long
|
1366 | |
+equivelents. The corner coordinates are reported for tiepoint+scale and
|
1367 | |
+transformation matrix formulations of GeoTIFF files, but not for multiple
|
1368 | |
+tiepoint formulations. The lat/long coordinates are only available if
|
1369 | |
+listgeo is compiled with PROJ.4, if the projection definition can be
|
1370 | |
+normalized, and if it is a projection supported by the listgeo PROJ.4
|
1371 | |
+binding.<p>
|
1372 | |
+
|
1373 | |
+Example (default output of listgeo):<p>
|
1374 | |
+
|
1375 | |
+<pre>
|
1376 | |
+Geotiff_Information:
|
1377 | |
+ Version: 1
|
1378 | |
+ Key_Revision: 1.0
|
1379 | |
+ Tagged_Information:
|
1380 | |
+ ModelTiepointTag (2,3):
|
1381 | |
+ 0 0 0
|
1382 | |
+ 440720 3751320 0
|
1383 | |
+ ModelPixelScaleTag (1,3):
|
1384 | |
+ 60 60 0
|
1385 | |
+ End_Of_Tags.
|
1386 | |
+ Keyed_Information:
|
1387 | |
+ GTModelTypeGeoKey (Short,1): ModelTypeProjected
|
1388 | |
+ GTRasterTypeGeoKey (Short,1): RasterPixelIsArea
|
1389 | |
+ GTCitationGeoKey (Ascii,17): "UTM 11 S E000"
|
1390 | |
+ GeogLinearUnitsGeoKey (Short,1): Linear_Meter
|
1391 | |
+ GeogAngularUnitsGeoKey (Short,1): Angular_Degree
|
1392 | |
+ ProjectedCSTypeGeoKey (Short,1): PCS_NAD27_UTM_zone_11N
|
1393 | |
+ End_Of_Keys.
|
1394 | |
+ End_Of_Geotiff.
|
1395 | |
+
|
1396 | |
+PCS = 26711 (NAD27 / UTM zone 11N)
|
1397 | |
+Projection = 16011 (UTM zone 11N)
|
1398 | |
+Projection Method: CT_TransverseMercator
|
1399 | |
+ ProjNatOriginLatGeoKey: 0.000000 ( 0d 0' 0.00"N)
|
1400 | |
+ ProjNatOriginLongGeoKey: -117.000000 (117d 0' 0.00"W)
|
1401 | |
+ ProjScaleAtNatOriginGeoKey: 0.999600
|
1402 | |
+ ProjFalseEastingGeoKey: 500000.000000
|
1403 | |
+ ProjFalseNorthingGeoKey: 0.000000
|
1404 | |
+GCS: 4267/NAD27
|
1405 | |
+Datum: 6267/North American Datum 1927
|
1406 | |
+Ellipsoid: 7008/Clarke 1866 (6378206.40,6356583.80)
|
1407 | |
+Prime Meridian: 8901/Greenwich (0.000000/ 0d 0' 0.00"E)
|
1408 | |
+Projection Linear Units: 9001/metre (1.000000m)
|
1409 | |
+
|
1410 | |
+Corner Coordinates:
|
1411 | |
+Upper Left ( 440720.000,3751320.000) (117d38'28.21"W, 33d54' 8.47"N)
|
1412 | |
+Lower Left ( 440720.000,3720600.000) (117d38'20.79"W, 33d37'31.04"N)
|
1413 | |
+Upper Right ( 471440.000,3751320.000) (117d18'32.07"W, 33d54'13.08"N)
|
1414 | |
+Lower Right ( 471440.000,3720600.000) (117d18'28.50"W, 33d37'35.61"N)
|
1415 | |
+Center ( 456080.000,3735960.000) (117d28'27.39"W, 33d45'52.46"N)
|
1416 | |
+</pre>
|
1417 | |
+
|
1418 | |
+<h2>See Also:</h2>
|
1419 | |
+
|
1420 | |
+<ol>
|
1421 | |
+<li>
|
1422 | |
+<a href="geotifcp.html">geotiffcp</a> - Copy TIFF installing GeoTIFF
|
1423 | |
+metadata.<p>
|
1424 | |
+<li>
|
1425 | |
+<a href="http://www.remotesensing.org/geotiff/geotiff.html">
|
1426 | |
+http://www.remotesensing.org/geotiff/geotiff.html</a> - GeoTIFF/libgeotiff Home Page<p>
|
1427 | |
+
|
1428 | |
+</ol>
|
1429 | |
+</body>
|
1430 | |
+</html>
|
1431 | |
--- /dev/null
|
1432 | |
+++ b/docs/manual.txt
|
1433 | |
@@ -0,0 +1,456 @@
|
1434 | |
+-------------------------------------------------------------
|
1435 | |
+
|
1436 | |
+ Manual for Libgeotiff Library and Utilities
|
1437 | |
+
|
1438 | |
+-------------------------------------------------------------
|
1439 | |
+
|
1440 | |
+Documentation Author: Niles Ritter
|
1441 | |
+Last Modified: 31 Jul 95
|
1442 | |
+
|
1443 | |
+See: http://www.remotesensing.org/geotiff/api/index.html
|
1444 | |
+ for up to date API documentation
|
1445 | |
+
|
1446 | |
+-------------------------------------------------------------
|
1447 | |
+Contents:
|
1448 | |
+
|
1449 | |
+ 1. The LibGeoTIFF library
|
1450 | |
+
|
1451 | |
+ 1.1 Preliminaries
|
1452 | |
+ 1.2 Calling Sequences
|
1453 | |
+ 1.3 Examples
|
1454 | |
+
|
1455 | |
+ 2. The LibGeoTIFF Utilities
|
1456 | |
+
|
1457 | |
+ 2.1 listgeo - dump a GeoTIFF metadata file
|
1458 | |
+ 2.2 geotifcp - install GeoTIFF from metadata
|
1459 | |
+
|
1460 | |
+-------------------------------------------------------------
|
1461 | |
+1. The LibGeoTIFF library
|
1462 | |
+
|
1463 | |
+-------------------------------------------------------------
|
1464 | |
+1.1 Preliminaries
|
1465 | |
+
|
1466 | |
+-------------------
|
1467 | |
+1.1.1 Compliance:
|
1468 | |
+
|
1469 | |
+ ANSI-C: The GeoTIFF library is fully ANSI compliant and
|
1470 | |
+ should compile under any ANSI compiler. It is not guaranteed
|
1471 | |
+ to compile under K&R compilers.
|
1472 | |
+
|
1473 | |
+ C++: All headers have the appropriate C++ bindings permitting
|
1474 | |
+ the correct linkage to C++ routines.
|
1475 | |
+
|
1476 | |
+-------------------
|
1477 | |
+1.1.2 Interfaces:
|
1478 | |
+
|
1479 | |
+ xtiffio.h: the primary interface header file for all TIFF
|
1480 | |
+ routines, using the extended GeoTIFF tags.
|
1481 | |
+
|
1482 | |
+ geotiffio.h: the primary interface header file for all GTIF
|
1483 | |
+ routines, keys and code values.
|
1484 | |
+
|
1485 | |
+ geotiff.h: an interface header file for all GTIF
|
1486 | |
+ routines, if code values are not required.
|
1487 | |
+
|
1488 | |
+ geokeys.h: defines all valid GEOTIFF GeoKeys.
|
1489 | |
+
|
1490 | |
+-------------------
|
1491 | |
+1.1.3 Defined macros:
|
1492 | |
+
|
1493 | |
+ All of the tag, key and key-value symbolic names in the GeoTIFF spec are
|
1494 | |
+ supported and defined by the inclusion of "geotiffio.h". In addition,
|
1495 | |
+ the following useful values are defined:
|
1496 | |
+
|
1497 | |
+ GvCurrentVersion: The current GeoTIFF Directory version. Should always be 1.
|
1498 | |
+ GvCurrentRevision: The current GeoTIFF Key Revision.
|
1499 | |
+ GvCurrentMinorRev: The current GeoTIFF Key-Value (minor) Revision.
|
1500 | |
+
|
1501 | |
+ KvUndefined: The universal Key value for "undefined" items.
|
1502 | |
+ KvUserDefined: The universal Key value for "user-defined" items.
|
1503 | |
+
|
1504 | |
+
|
1505 | |
+-------------------
|
1506 | |
+1.1.4 Defined Types:
|
1507 | |
+
|
1508 | |
+ TIFF the type of a TIFF file descriptor (if LIBTIFF is used).
|
1509 | |
+ GTIF the type of a GeoTIFF file descriptor.
|
1510 | |
+ GTIFPrintMethod the type of a print method passed to GTIFPrint().
|
1511 | |
+ GTIFReadMethod the type of a read method passed to GTIFImport().
|
1512 | |
+ geokey_t the type of a GeoTIFF key variable.
|
1513 | |
+ tagtype_t the type of a TIFF tag variable, such as TYPE_DOUBLE.
|
1514 | |
+
|
1515 | |
+
|
1516 | |
+-------------------
|
1517 | |
+1.1.5 Key and Code Databases:
|
1518 | |
+
|
1519 | |
+ All geokeys are defined and named in the database file
|
1520 | |
+ "geokeys.inc", which in turn is included in "geokeys.h"
|
1521 | |
+ and several other files. The symbolic enumerated names are identical
|
1522 | |
+ to those used in the Appendix of the GeoTIFF spec.
|
1523 | |
+
|
1524 | |
+ The geokey code values are stored in the other database files
|
1525 | |
+ having the ".inc" suffix, which in turn are all referenced by
|
1526 | |
+ the file "geovalues.h". The ones with names beginning with
|
1527 | |
+ "epsg_" are codes registered in the EPSG/POSC tables, while
|
1528 | |
+ those beginning with "geo_" are specific to GeoTIFF.
|
1529 | |
+
|
1530 | |
+
|
1531 | |
+-------------------------------------------------------------
|
1532 | |
+1.2 Calling Sequences
|
1533 | |
+
|
1534 | |
+-------------------
|
1535 | |
+1.2.1 TIFF-level interface
|
1536 | |
+
|
1537 | |
+
|
1538 | |
+1.2.1.1 GTIFNew -- Set up a new GeoTIFF file Descriptor
|
1539 | |
+ GTIF* GTIFNew(void *tif);
|
1540 | |
+
|
1541 | |
+GTIFNew() takes an existing TIFF file descriptor and creates
|
1542 | |
+a GTIF GeoTIFF file-I/O object for reading and writing
|
1543 | |
+GeoTIFF keys and values. The TIFF file must currently be open,
|
1544 | |
+though it may be either read or write mode.
|
1545 | |
+
|
1546 | |
+
|
1547 | |
+1.2.1.2 GTIFFree
|
1548 | |
+ void GTIFFree(GTIF *gtif);
|
1549 | |
+
|
1550 | |
+Destroys the GeoTIFF file descriptor following reading or writing
|
1551 | |
+the keys.
|
1552 | |
+
|
1553 | |
+
|
1554 | |
+1.2.1.3 GTIFWriteKeys
|
1555 | |
+ int GTIFWriteKeys(GTIF *gtif);
|
1556 | |
+
|
1557 | |
+This routine must be called for a new GeoTIFF file after all of
|
1558 | |
+the desired Keys are defined and set with GTIFSetKey(). This does
|
1559 | |
+not explicitly write anything out to the file, but it does call
|
1560 | |
+the TIFF-level routines to install the TIFF tag values, which
|
1561 | |
+in turn are written to the file when the TIFF file descriptor
|
1562 | |
+is closed. A GeoTIFF file cannot be opened for updating; only
|
1563 | |
+pure read or write is supported.
|
1564 | |
+
|
1565 | |
+
|
1566 | |
+1.2.1.4 GTIFDirectoryInfo
|
1567 | |
+ void GTIFDirectoryInfo(GTIF *gtif, int *versions, int *keycount);
|
1568 | |
+
|
1569 | |
+Returns header information about the GeoTIFF file directory. The <versions>
|
1570 | |
+is an array of 3 integers, giving the GeoTIFF Version, followed by
|
1571 | |
+the major and minor revisions. The <keycount> argument returns the number
|
1572 | |
+of keys currently defined in this file.
|
1573 | |
+
|
1574 | |
+-------------------
|
1575 | |
+1.2.2 GeoKey Access
|
1576 | |
+
|
1577 | |
+
|
1578 | |
+1.2.2.1 GTIFKeyInfo
|
1579 | |
+ int GTIFKeyInfo(GTIF *gtif, geokey_t key, int *size, tagtype_t* type);
|
1580 | |
+
|
1581 | |
+Returns the number of values defined for key <key> if currently defined in the file, and
|
1582 | |
+returns in <size> the size of individual key values, and the <type>. If the
|
1583 | |
+key is not defined, 0 is returned. You may pass in NULL pointers to any parameters
|
1584 | |
+you do not need (such as the type).
|
1585 | |
+
|
1586 | |
+
|
1587 | |
+1.2.2.1 GTIFKeyGet
|
1588 | |
+ int GTIFKeyGet(GTIF *gtif, geokey_t key, void *val, int index, int count);
|
1589 | |
+
|
1590 | |
+Accesses the key value(s). If there are multiple values (such as ASCII), they
|
1591 | |
+may be accessed individually, starting at <index> and returning <count> values.
|
1592 | |
+The total number of values accessed is returned. Note: unline TIFFGetField()
|
1593 | |
+memory is not allocated for multiple-value arrays such as ASCII. To get the
|
1594 | |
+length of an array call GTIFKeyInfo first, which returns the size and count
|
1595 | |
+of the data. If the values are key-codes they should be declared of type
|
1596 | |
+"geocode_t", which is unsigned SHORT.
|
1597 | |
+
|
1598 | |
+
|
1599 | |
+1.2.2.1 GTIFKeySet
|
1600 | |
+ int GTIFKeySet(GTIF *gtif, geokey_t keyID, tagtype_t type, int count,...);
|
1601 | |
+
|
1602 | |
+Defines and sets the specified key values. Note that this does not install the
|
1603 | |
+tag-level information in the file; to do that you must call GTIFWriteKeys().
|
1604 | |
+For single-valued non-ASCII keys (which are most of them), you must pass the
|
1605 | |
+values in by value not reference. You must use the correct type for the
|
1606 | |
+values: doubles for floating point, strings for ASCII, and "geocode_t" for
|
1607 | |
+SHORT codes (the symbolic names may be used in most cases).
|
1608 | |
+
|
1609 | |
+
|
1610 | |
+1.2.3 Metadata Import-Export utilities
|
1611 | |
+
|
1612 | |
+ void GTIFPrint(GTIF *gtif, GTIFPrintMethod print, void *fd);
|
1613 | |
+ int GTIFImport(GTIF *gtif, GTIFReadMethod scan, void *fd);
|
1614 | |
+
|
1615 | |
+ char* GTIFKeyName(geokey_t key);
|
1616 | |
+ char* GTIFValueName(geokey_t key,int value);
|
1617 | |
+ char* GTIFTypeName(tagtype_t type);
|
1618 | |
+ char* GTIFTagName(int tag);
|
1619 | |
+ int GTIFKeyCode(char * key);
|
1620 | |
+ int GTIFValueCode(geokey_t key,char *value);
|
1621 | |
+ int GTIFTypeCode(char *type);
|
1622 | |
+ int GTIFTagCode(char *tag);
|
1623 | |
+
|
1624 | |
+The GTIFPrint() routine dumps a GeoTIFF metadata stream out to
|
1625 | |
+a specified file <fd>, either for human interpretation or for
|
1626 | |
+input to another program. If <fd> is NULL the data is written
|
1627 | |
+to the standard output.
|
1628 | |
+
|
1629 | |
+The GTIFImport() routine performs the inverse; given a metadata file
|
1630 | |
+specified by <fd> (or stdin if <fd> is NULL) install the corresponding
|
1631 | |
+tags and keys into the current GeoTIFF file. Note that the
|
1632 | |
+import routine only calls GTIFKeySet(), and so it is up to the
|
1633 | |
+client program to call GTIFWriteKey() in order to explicitly
|
1634 | |
+write the keys out to the file.
|
1635 | |
+
|
1636 | |
+The GTIFxxxName() routines all take a numeric code, key or tag and
|
1637 | |
+return a pointer to a static string name associated with the value.
|
1638 | |
+In the case of Key-Values, the key must be explicitly defined in
|
1639 | |
+order to establish the scope of the name-search. A string is always
|
1640 | |
+returned; however, if the code is not recognized the string is
|
1641 | |
+of the format "Unknown-%d", where %d is the input code value.
|
1642 | |
+
|
1643 | |
+The GTIFxxxCode() routines perform the reverse operation; given
|
1644 | |
+an ASCII string name it tries to find the corresponding code,
|
1645 | |
+key or tag numerical value, in a case-sensitive manner. If the
|
1646 | |
+string is not recognized the value -1 is return (no valid codes
|
1647 | |
+are negative). For consistency, any strings of the form "Unknown-%d"
|
1648 | |
+where %d is a decimal integer will return the specified integer.
|
1649 | |
+
|
1650 | |
+Note: be careful when assigning variables to GTIFxxxCode; for example,
|
1651 | |
+the geokey_t type is unsigned, and so if -1 is returned, this will
|
1652 | |
+result in a value of 65535. To be safe, always use signed integers
|
1653 | |
+for the assignment, and pass them on to an unsigned type after
|
1654 | |
+checking that the value is positive.
|
1655 | |
+
|
1656 | |
+
|
1657 | |
+-------------------------------------------------------------
|
1658 | |
+1.3 Examples
|
1659 | |
+
|
1660 | |
+
|
1661 | |
+A typical use of LIBGEOTIFF for creating a GeoTIFF file is
|
1662 | |
+
|
1663 | |
+ #include "xtiffio.h" /* for TIFF */
|
1664 | |
+ #include "geotiffio.h" /* for GeoTIFF */
|
1665 | |
+ void main()
|
1666 | |
+ {
|
1667 | |
+ TIFF *tif=(TIFF*)0; /* TIFF-level descriptor */
|
1668 | |
+ GTIF *gtif=(GTIF*)0; /* GeoKey-level descriptor */
|
1669 | |
+
|
1670 | |
+ /* Open TIFF descriptor to write GeoTIFF tags */
|
1671 | |
+ tif=XTIFFOpen(fname,"w");
|
1672 | |
+ if (!tif) goto failure;
|
1673 | |
+
|
1674 | |
+ /* Open GTIF Key parser */
|
1675 | |
+ gtif = GTIFNew(tif);
|
1676 | |
+ if (!gtif) goto failure;
|
1677 | |
+
|
1678 | |
+ /* Set up standar TIFF file */
|
1679 | |
+ TIFFSetField(tif,TIFFTAG_IMAGEWIDTH, WIDTH);
|
1680 | |
+ /* set other TIFF tags and write out image ... */
|
1681 | |
+
|
1682 | |
+ /* Set GeoTIFF information */
|
1683 | |
+ GTIFKeySet(gtif, GTModelTypeGeoKey, TYPE_SHORT, 1, ModelGeographic);
|
1684 | |
+ /* set other GeoTIFF keys ... */
|
1685 | |
+
|
1686 | |
+ /* Store the keys into the TIFF Tags */
|
1687 | |
+ GTIFWriteKeys(gtif);
|
1688 | |
+
|
1689 | |
+ /* get rid of the key parser */
|
1690 | |
+ GTIFFree(gtif);
|
1691 | |
+
|
1692 | |
+ /* save and close the TIFF file descriptor */
|
1693 | |
+ XTIFFClose(tif);
|
1694 | |
+
|
1695 | |
+ exit (0);
|
1696 | |
+ failure:
|
1697 | |
+ exit (-1);
|
1698 | |
+ }
|
1699 | |
+
|
1700 | |
+While a typical use of the code for reading tags is:
|
1701 | |
+
|
1702 | |
+ #include "xtiffio.h" /* for TIFF */
|
1703 | |
+ #include "geotiffio.h" /* for GeoTIFF */
|
1704 | |
+ enum {VERSION=0,MAJOR,MINOR};
|
1705 | |
+ void main()
|
1706 | |
+ {
|
1707 | |
+ TIFF *tif=(TIFF*)0; /* TIFF-level descriptor */
|
1708 | |
+ GTIF *gtif=(GTIF*)0; /* GeoKey-level descriptor */
|
1709 | |
+ int versions[3];
|
1710 | |
+ int cit_length;
|
1711 | |
+ geocode_t model; /* all key-codes are of this type */
|
1712 | |
+ char *citation;
|
1713 | |
+
|
1714 | |
+ /* Open TIFF descriptor to read GeoTIFF tags */
|
1715 | |
+ tif=XTIFFOpen(fname,"r");
|
1716 | |
+ if (!tif) goto failure;
|
1717 | |
+
|
1718 | |
+ /* Open GTIF Key parser; keys will be read at this time. */
|
1719 | |
+ gtif = GTIFNew(tif);
|
1720 | |
+ if (!gtif) goto failure;
|
1721 | |
+
|
1722 | |
+ /* Get the GeoTIFF directory info */
|
1723 | |
+ GTIFDirectoryInfo(gtif,versions,0);
|
1724 | |
+ if (versions[MAJOR] > 1)
|
1725 | |
+ {
|
1726 | |
+ printf("this file is too new for me\n"); goto failure;
|
1727 | |
+ }
|
1728 | |
+ if (!GTIFKeyGet(gtif, GTModelTypeGeoKey, &model, 0, 1))
|
1729 | |
+ {
|
1730 | |
+ printf("Yikes! no Model Type\n") goto failure;
|
1731 | |
+ }
|
1732 | |
+
|
1733 | |
+ /* ASCII keys are variable-length; compute size */
|
1734 | |
+ cit_length = GTIFKeyInfo(gtif,GTCitationGeoKey,&size,&type);
|
1735 | |
+ if (cit_length > 0)
|
1736 | |
+ {
|
1737 | |
+ citation = malloc(size*cit_length);
|
1738 | |
+ if (!citation) goto failure;
|
1739 | |
+ GTIFKeyGet(gtif, GTCitationGeoKey, citation, 0, cit_length);
|
1740 | |
+ printf("Citation:%s\n",citation);
|
1741 | |
+ }
|
1742 | |
+
|
1743 | |
+ /* Get some TIFF info on this image */
|
1744 | |
+ TIFFGetField(tif,TIFFTAG_IMAGEWIDTH, &width);
|
1745 | |
+
|
1746 | |
+ /* get rid of the key parser */
|
1747 | |
+ GTIFFree(gtif);
|
1748 | |
+
|
1749 | |
+ /* close the TIFF file descriptor */
|
1750 | |
+ XTIFFClose(tif);
|
1751 | |
+
|
1752 | |
+ exit (0);
|
1753 | |
+ failure:
|
1754 | |
+ exit (-1);
|
1755 | |
+ }
|
1756 | |
+
|
1757 | |
+
|
1758 | |
+
|
1759 | |
+-------------------------------------------------------------
|
1760 | |
+2. The LibGeoTIFF Utilities
|
1761 | |
+
|
1762 | |
+-------------------------------------------------------------
|
1763 | |
+2.1 listgeo - dump a GeoTIFF metadata file
|
1764 | |
+
|
1765 | |
+Syntax: listgeo [-tfw] [-no_norm] [-t tabledir] inputfile
|
1766 | |
+
|
1767 | |
+The program listgeo takes a GeoTIFF file as input and dumps to
|
1768 | |
+the standard output a GeoTIFF "metadata" file, which is human
|
1769 | |
+readable, and may also be used as input to other programs which
|
1770 | |
+use the "GTIFImport" routine, such as geotifcp, below.
|
1771 | |
+
|
1772 | |
+The -tfw flag may be passed to force generation of an ESRI style .tfw
|
1773 | |
+file as well as the metadata file.
|
1774 | |
+
|
1775 | |
+The -no_norm flag will supress reporting of normalized parameters, and
|
1776 | |
+reporting of corner points.
|
1777 | |
+
|
1778 | |
+The "-t tabledir" flag overrides the programs concept of how to file the
|
1779 | |
+EPSG CSV files, causing it to look in directory "tabledir".
|
1780 | |
+
|
1781 | |
+------------------------
|
1782 | |
+GeoTIFF Metadata Format:
|
1783 | |
+
|
1784 | |
+For the formalist junkies, we will define a GeoTIFF metadata format
|
1785 | |
+in an unambiguous fashion, and follow that by a concrete example.
|
1786 | |
+
|
1787 | |
+The metadata format is defined as follows (all strings not placed
|
1788 | |
+between <braces> are string literals, case-sensitive, and any entry
|
1789 | |
+followed by "*" or "*<number>" indicates multiple entries):
|
1790 | |
+
|
1791 | |
+<Geotiff_Metadata> = <Geotiff_Header> + <GeoTIFF_Body> + <GeoTIFF_Trailer>
|
1792 | |
+
|
1793 | |
+ <Geotiff_Header> = <White_Space> + Geotiff_Information: + <Return>
|
1794 | |
+ <GeoTIFF_Trailer> = <White_Space> + End_Of_Geotiff. + <Return>
|
1795 | |
+ <GeoTIFF_Body> = <GeoTIFF_Info> + <GeoTIFF_Tags> + <GeoTIFF_Keys>
|
1796 | |
+ <GeoTIFF_Info> = <GeoTIFF_Version> + <GeoTIFF_Revision>
|
1797 | |
+ <GeoTIFF_Version> = Version: + <Single_Space> + <Version> + <Return>
|
1798 | |
+ <Version> = <Integer>
|
1799 | |
+ <GeoTIFF_Revision> = Revision: +
|
1800 | |
+ <Single_Space> + <Major_Rev> + <Period> + <Minor_Rev> + <Return>
|
1801 | |
+ <Major_Rev> = <Integer>
|
1802 | |
+ <Minor_Rev> = <Integer>
|
1803 | |
+ <GeoTIFF_Tags> = <Tag_Header> + <Tag_Entry>* + <Tag_Trailer>
|
1804 | |
+ <Tag_Header> = <White_Space> + Tagged_Information: + <Return>
|
1805 | |
+ <Tag_Trailer> = <White_Space> + End_Of_Tags. + <Return>
|
1806 | |
+ <Tag_Entry> = <Tag_Entry_Header> + <Tag_Entry_Row>*
|
1807 | |
+ <Tag_Entry_Header> = <White_Space> +
|
1808 | |
+ <Tag_Name> + <Tag_Dimension> + <Colon> + <Return>
|
1809 | |
+ <Tag_Dimension> = "(" + <NRows> + <Comma> + <NCols> + ")"
|
1810 | |
+ <NRows> = <Integer>
|
1811 | |
+ <NCols> = <Integer>
|
1812 | |
+ <Tag_Entry_Row> = <White_Space> + <Double_Float>*<NCols> + <Return>
|
1813 | |
+ <GeoTIFF_Keys> = <Key_Header> + <Key_Entry>* + <Key_Trailer>
|
1814 | |
+ <Key_Header> = <White_Space> + Keyed_Information: + <Return>
|
1815 | |
+ <Key_Trailer> = <White_Space> + End_Of_Keys. + <Return>
|
1816 | |
+ <Key_Entry> = <Key_Entry_Header> + <Key_Entry_Value>
|
1817 | |
+ <Key_Entry_Header> = <White_Space> +
|
1818 | |
+ <Key_Name> + <Key_Dimension> + <Colon> + <Return>
|
1819 | |
+ <Key_Dimension> = "(" + <Key_Format> + <Comma> + <Key_Count> + ")"
|
1820 | |
+ <Key_Entry_Value> = (<Key_Value> | <Numeric_Value> | <Ascii_Value>)
|
1821 | |
+ <Numeric_Value> = (<Integer> | <Double_Float>)
|
1822 | |
+ <Ascii_Value> = <Double_Quote> + <String> + <Double_Quote>
|
1823 | |
+
|
1824 | |
+ <Tag_Name> = All symbolic tag names defined in GeoTIFF spec.
|
1825 | |
+ <Key_Name> = All symbolic key names defined in GeoTIFF spec.
|
1826 | |
+ <Key_Value> = All symbolic value names defined in GeoTIFF spec.
|
1827 | |
+ <Key_Format> = (Short | Ascii | Double)
|
1828 | |
+
|
1829 | |
+And for the pedantic:
|
1830 | |
+ <White_Space> = (<Single_Space> | <Tab>)*
|
1831 | |
+ <Double_Float> = <Mantissa><Exponent>
|
1832 | |
+ <Mantissa> = <Sign><Integer><Period><Integer>
|
1833 | |
+ <Exponent> = ( |e<Sign><Integer>)
|
1834 | |
+ <Sign> = ( |+|-)
|
1835 | |
+ <Integer> = (0|1|2|3|4|5|6|7|8|9)*
|
1836 | |
+ ...
|
1837 | |
+
|
1838 | |
+
|
1839 | |
+Example (default output of listgeo):
|
1840 | |
+
|
1841 | |
+Geotiff_Information:
|
1842 | |
+ Version: 1
|
1843 | |
+ Key_Revision: 0.2
|
1844 | |
+ Tagged_Information:
|
1845 | |
+ ModelTiepointTag (2,3):
|
1846 | |
+ 0 0 0
|
1847 | |
+ 130 32 0
|
1848 | |
+ ModelPixelScaleTag (1,3):
|
1849 | |
+ 1 1 0
|
1850 | |
+ End_Of_Tags.
|
1851 | |
+ Keyed_Information:
|
1852 | |
+ GTModelTypeGeoKey (Short,1): ModelTypeGeographic
|
1853 | |
+ GTRasterTypeGeoKey (Short,1): RasterPixelIsArea
|
1854 | |
+ GTCitationGeoKey (Ascii,16): "Just An Example"
|
1855 | |
+ GeographicTypeGeoKey (Short,1): User-Defined
|
1856 | |
+ GeogCitationGeoKey (Ascii,24): "Everest Ellipsoid Used."
|
1857 | |
+ GeogGeodeticDatumGeoKey (Short,1): User-Defined
|
1858 | |
+ GeogLinearUnitsGeoKey (Short,1): Linear_Meter
|
1859 | |
+ GeogAngularUnitsGeoKey (Short,1): Angular_Degree
|
1860 | |
+ GeogEllipsoidGeoKey (Short,1): Ellipse_Everest_1830_1967_Definition
|
1861 | |
+ GeogSemiMajorAxisGeoKey (Double,1): 6377298.556
|
1862 | |
+ GeogInvFlatteningGeoKey (Double,1): 300.8017
|
1863 | |
+ End_Of_Keys.
|
1864 | |
+ End_Of_Geotiff.
|
1865 | |
+
|
1866 | |
+
|
1867 | |
+-------------------------------------------------------------
|
1868 | |
+2.2 geotifcp - Copy a TIFF file and install GeoTIFF info from metadata.
|
1869 | |
+
|
1870 | |
+Syntax: geotifcp [options] [-e esri_worldfile] [-g metadata] input output
|
1871 | |
+
|
1872 | |
+The program geotifcp is identical in function to the LIBTIFF program
|
1873 | |
+"tiffcp", with the additional feature that if the "-g <metadata>"
|
1874 | |
+option is used the GeoTIFF information from the file <metadata>
|
1875 | |
+will be installed into the output file. The "-e worldfile" option will
|
1876 | |
+override the tiepoint and scale information from the metadata file based
|
1877 | |
+on the contents of the ESRI worldfile.
|
1878 | |
+
|
1879 | |
+If the "-g" option is not used, the opposite effect occurs: all
|
1880 | |
+GeoTIFF information is filtered out of the input file before being
|
1881 | |
+written to the new output file.
|
1882 | |
+
|
1883 | |
+"geotifcp" inherits all the other file-transformation capabilities
|
1884 | |
+of the tiffcp program; for help on the additional parameters give
|
1885 | |
+the command:
|
1886 | |
+
|
1887 | |
+ % geotifcp -h
|
1888 | |
+
|
1889 | |
+-------------------------------------------------------------
|