http://www.jwz.org/xscreensaver/xscreensaver-5.07.tar.gz
[xscreensaver] / hacks / anemotaxis.man
1 .TH XScreenSaver 1 "" "X Version 11"
2 .SH NAME
3 anemotaxis - directional search on a plane.
4 .SH SYNOPSIS
5 .B anemotaxis
6 [\-display \fIhost:display.screen\fP]
7 [\-visual \fIvisual\fP]
8 [\-window]
9 [\-root]
10 [\-delay \fInumber\fP]
11 [\-distance \fInumber\fP]
12 [\-sources \fInumber\fP]
13 [\-searchers \fInumber\fP]
14 [\-fps]
15 .SH DESCRIPTION
16 The program demonstrates a search algorithm designed for locating a
17 source of odor in turbulent atmosphere. The odor is convected by wind
18 which has a constant mean direction and fluctuations around it. The
19 searcher is able to sense the odor and determine local instantaneous
20 wind direction. The goal is to find the source in the shortest mean
21 time.  Some animals face this task to find mates, food, home etc. They
22 exhibit very particular, zigzagging search trajectories.
23
24 This is modeled as a search on a discrete two-dimensional lattice. The
25 source releases particles that drift with constant velocity in one
26 direction and walk randomly in the other direction. The searcher knows
27 if it hit a particle, and if so, particle's position one time step
28 earlier (local wind direction). The program paints sources and
29 particles released by them as well as trajectories of searchers who are
30 trying to capture the sources.
31 .SH OPTIONS
32 .TP 8
33 .B \-visual \fIvisual\fP
34 Specify which visual to use.  Legal values are the name of a visual class,
35 or the id number (decimal or hex) of a specific visual.
36 .TP 8
37 .B \-window
38 Draw on a newly-created window.  This is the default.
39 .TP 8
40 .B \-root
41 Draw on the root window.
42 .TP 8
43 .B \-delay \fInumber\fP
44 Per-frame delay, in microseconds.  Default: 20000 (0.02 seconds.).
45 .TP 8
46 .B \-distance \fInumber\fP
47 Max initial distance to the source .  10 - 250.  Default: 40.
48 .TP 8
49 .B \-sources \fInumber\fP
50 Max number of sources.  Default: 25.
51 .TP 8
52 .B \-searchers \fInumber\fP
53 Max number of searchers. Default: 25.
54 .TP 8
55 .B \-fps
56 Display the current frame rate and CPU load.
57 .SH ENVIRONMENT
58 .PP
59 .TP 8
60 .B DISPLAY
61 to get the default host and display number.
62 .TP 8
63 .B XENVIRONMENT
64 to get the name of a resource file that overrides the global resources
65 stored in the RESOURCE_MANAGER property.
66 .SH SEE ALSO
67 .BR X (1),
68 .BR xscreensaver (1)
69 .SH COPYRIGHT
70 Copyright \(co 2004 by Eugene Balkovsky.  Permission to use, copy, modify, 
71 distribute, and sell this software and its documentation for any purpose is 
72 hereby granted without fee, provided that the above copyright notice appear 
73 in all copies and that both that copyright notice and this permission notice
74 appear in supporting documentation.  No representations are made about the 
75 suitability of this software for any purpose.  It is provided "as is" without
76 express or implied warranty.
77 .SH AUTHOR
78 Eugene Balkovsky