File: imview.1

package info (click to toggle)
imview 1.1.8-6
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 3,052 kB
  • ctags: 3,797
  • sloc: cpp: 29,842; sh: 2,620; ansic: 1,835; makefile: 756; exp: 112; python: 88
file content (265 lines) | stat: -rw-r--r-- 10,756 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
.\" This manpage has been automatically generated by docbook2man 
.\" from a DocBook document.  This tool can be found at:
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
.\" Please send any bug reports, improvements, comments, patches, 
.\" etc. to Steve Cheng <steve@ggi-project.org>.
.TH "IMVIEW" "1" "01 July 2002" "" ""
.SH NAME
imview \- displays and interactively analyses images
.SH SYNOPSIS

\fBimview\fR [ \fBoptions\fR ] [ \fBimage\fR\fI ...\fR ]

.PP
Where image is an image file in one of the supported formats, e.g: TIFF, JPEG, GIF, PNG,
BMP, XPM, PNM, etc...
.SH "DESCRIPTION"
.PP
\fBImview\fR is an X11 and Windows GDI GUI application for displaying images on
screen. It has advanced capabilities for interactive image analysis (getting information out of
images) and can be easily controlled through a socket connection for embedding in image analysis
systems.
.PP
Imview supports a large number of popular and scientific image file formats, in part
through the use of the ImageMagick library.
.SH "OPTIONS"
.PP
Here is the complete list of optional arguments for \fBimview\fR.
.TP
\fB-\fR
Reads an image from the standard input stream. Example:
.TP
\fB-a\fR
Reads and appends to an existing pointfile (see option \fI-p\fR).
.TP
\fB-C <lutname>\fR
Specifies <lutname> as the default look-up tables for all the images on the command line.
.TP
\fB-c <lutname>\fR
Applies the look-up table <lutname> to the \fBpreceding\fR image on the command line (see example section).
.TP
\fB-debug\fR
Starts a debugging GUI console where debugging messages can be seen (there are lots of them!). Under
Unix messages are also appended to the file /tmp/imbugs.txt.
.TP
\fB-delete\fR
Any image given to \fBimview\fR on the command line will be deleted after
\fBimview\fR exits. This is useful when \fBimview\fR is started from an
interpreter with a temporary image as argument. For safety only images with paths beginning with
/tmp, /usr/tmp or under the standard environment
variable-controlled TMPDIR directory are effectively deleted.
.TP
\fB-disable_io_keys\fR
This option disables some I/O shortcut that are not menu-dependent, such as c
that closes an image. This is useful in conjuction with options \fI-hide_menubar\fR and \fI-disable_menubar\fR
for limiting the user's interaction with the application.
.TP
\fB-disable_menubar\fR
This option completely disables the menu bar (but does not hide it, see \fI-hide_menubar\fR for that). Both hiding and disabling the menubar at the
same time can be useful for producing a viewer that users cannot control other than through some
other means than the menu (if \fBimview\fR is embedded in another application for
example).
.TP
\fB-disable_quit\fR
This option disables the shortcut ways of quitting the \fBimview\fR application, such
as the Escape key, clicking the windows manager `close window' button, etc. This is useful to
restrict the user's control over \fBimview\fR.
.TP
\fB-fork\fR
Sends \fBimview\fR to the background (works on all platforms including windows). It is
better to use this option rather than the shell semantics (adding & at the end of the command
under Unix) when the server is ran in conjuction with \fI-server\fR,
because imview will synchonize the foreground and background processes so that the foreground
process can know the server port number.
.TP
\fB-gamma <value>\fR
Sets the default gamma for all the images. A gamma between 0 and 1.0 will darken the displayed image while a
gamma greater than 1.0 will brighten them.
.TP
\fB-h\fR
Prints an abbreviated list of options and exits.
.TP
\fB-hide_menubar\fR
Hides the main menubar. The menu items are still accessible via shortcuts. For example try Alt+f
to get the file->open menu. From there you can use the keyboard arrow keys to select a menu item 
for example. This is useful if you have little screen real estate, but confusing for the beginner!
.TP
\fB-no_dblbuf\fR
Do not use double buffering at certain zoom factors. This is a hack you might want to experiment with if you
find that \fBimview\fR does not redraw some parts of images after closing and re-opening images.
.TP
\fB-locked\fR
Equivalent to all the following options used together: \fI-hide_menubar\fR, 
\fI-disable_menubar\fR, \fI-disable_iokeys\fR and
\fI-disable_quit\fR. If run with this option, \fBimview\fR can
only be controlled via a socket in server mode. This is useful for embedding imview in another application.
.TP
\fB-mag <zoom facto>\fR
Magnifies all images by  <zoom factors>. Any positive value is legal. Values between 0 and 1.0 will reduce
the size of the images while values greater than 1.0 will expand them.
.TP
\fB-no_magick\fR
Disables the use of the ImageMagick library. This library is very useful for reading and
writing a large number of file formats but tries to do too much sometimes, such as converting text files to
images.
.TP
\fB-p <pointfile>\fR
Specifies the point file name. A pointfile is a regular text file in which point (pixel) information
can be recorded. The default point file name is pointfile. This option simply
changes that default, no other action is taken.
.TP
\fB-portfile <file>\fR
This option is only useful in combination with \fI-server\fR. \fBImview\fR's
server binds to a port in the range 7600-7700. Because it is often useful to have more than one image server at the
same time and because of the interactive nature of \fBimview\fR, the precise port number is impossible
to predict, so when the server is started it prints the port it decided to bind against on the command line, or 
alternatively in a file, specified by this option. 

\fBNOTE:\fR If you are planning to send imview to the background, for
this command to work as expected, you must also use the \fI-fork\fR option,
otherwise the file might still be empty when the command returns.
.TP
\fB-server\fR
Starts the \fBimview\fR server. In server mode \fBimview\fR performs as a TCP/IP server on which
images can be uploaded and commands can be run. The aim is to make \fBimview\fR completely 
remote-controllable: every command accessible via the menu can also be made available through the server. 

\fBImview\fR uses its own text-based protocol. For simple commands a standard telnet
session is enough to communicate with \fBimview\fR. However for uploading images into
\fBimview\fR a protocol similar to FTP has been implemented. A simple
\fBimview\fR client is shipped in source form with the imview distribution. For a
specification of the \fBimview\fR protocol see the full documentation.

\fBImview\fR's server port number is in the range 7600-7700 which allows up to 50
different imview server to be run on the same machine (each server uses up two ports: one for commands and the
other for binary data exchange, such as uploading images).
.TP
\fB-stopdebug\fR
Used in conjunction with \fI-debug\fR, will stop the program after each debugging message. To
continue the user must type <Enter>.
.TP
\fB-v\fR
Prints the version and build numbers, the date of build, the configuration options and exits.
.TP
\fB-wt <title>\fR
Changes the title of the main window. The default is Imview.
.SH "EXAMPLES"
.PP
In the following examples `%' indicate the shell prompt.
.SS "SIMPLE USAGE"

.nf
 % imview
.fi
.PP
Simply starts imview displaying the splash screen. An image can then be loaded using the menus.

.nf
 % imview myimage.tiff
.fi
.PP
Will display image myimage.tiff.

.nf
 % imview /home/talbot/images/astro/*
.fi
.PP
Will display all images in the directory  /home/talbot/images/astro/. Use 
<spacebar> to switch from one image to the next.
.PP
.SS "ADVANCED USAGE"

.nf
 % imview aGreyLevelImage.tif -c heat.lut
.fi
.PP
Will display image aGreyLevelImage.tif. Assuming this image only contains grey-level information
(a black and white photograph for example), the false colours defined in heat.lut will be applied to it. 
.PP
.SS "SERVER USAGE"

.nf
 % imview -server -fork
Port: 7600
.fi
.PP
This will start \fBimview\fR in server mode. The only difference with the
normal mode is that \fBimview\fR can now be "remote-controlled" via a TCP/IP
connection. The port \fBimview\fR is bound to is printed on the command line when
the server starts. To save it to a file use the \fI-portfile\fR option.
.PP
A simple telnet session can be used to remote-control \fBimview\fR, as
follows. See the full documentation for more details:

.nf
 % telnet localhost 7600
user talbot 
Welcome, talbot /tmp/fileBlabla 000 OK
load "/home/talbot/images/astro/neptune.tiff"
000 OK
zoom factor 2
000 OK
end
Connection closed by foreign host.
.fi
.PP
\fBimclient\fR is shipped with the source distribution as an implementation of
a sample client that can upload images into imview, as follows: 

.nf
 % imclient -p 7600 /home/talbot/images/astro/jupiter.tiff
.fi
.SH "BUGS"
.PP
See the TODO file in the source distribution or the web site for an updated list of known bugs. Here
is a list of the most significant ones:
.TP 0.2i
\(bu
resize still a problem sometimes. Imview gets itself into a weird state with incorrect
limits and partial redraws. Specifying a complete redraw should clear everything but
doesn't.
.TP 0.2i
\(bu
Move to the middle of the screen. Sometimes for no apparent reason Imview
moves to the middle of the screen. This seems to be happening if the main window
resises.
.TP 0.2i
\(bu
last line and last column of image often missing when scrollbar
are present.
.SH "FILES"
.PP
.TP
\fB~/.fltk/hugues.talbot_csiro.au/imview.prefs\fR
User preferences
.TP
\fB<Installation directory>/Imview/*.lut\fR
Colour look-up tables
.TP
\fB<Installation directory>/Imview/doc/*.html\fR
On-line documentation
.SH "SEE ALSO"
.PP
imclient (1), ImageMagick (1), djpeg (1)
.PP
libtiff (3T)
.PP
http://imview.sourceforge.net (full manual can be found there).
.SH "AUTHOR"
.PP
The main author is Hugues Talbot <Hugues.Talbot@cmis.CSIRO.AU>
.SH "COPYRIGHT"
.PP
Imview is Copyrighted (C) 1997-2002 by Hugues Talbot and was supported in parts by the Australian
Commonwealth Science and Industry Research Organisation. Please see web site for full details.
.PP
This program is free software; you can redistribute it and/or modify it under the terms of the GNU
General Public License as published by the Free Software Foundation; either version 2 of the
License, or (at your option) any later version.
.PP
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.
.PP
You should have received a copy of the GNU General Public License along with this program; if not,
write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.