git.hungrycats.org Git - xscreensaver/blob - local/man/man.1/xlyap.1

   1 .TH XLYAP 6X
   2 .SH NAME
   3 xlyap \- display an array of Lyapunov exponents graphically
   4 .SH SYNOPSIS
   5 .in +8n
   6 .ti -8n
   7 \fIxlyap\fR
   8 [-BLps][-W width][-H height][-o filename][-a
   9 \fIn\fR ]
  10 [-b
  11 \fIn\fR ]
  12 [-w
  13 \fIn\fR ]
  14 [-h
  15 \fIn\fR ]
  16 [-i xstart]
  17 [-M
  18 \fIn\fR ]
  19 [-R
  20 \fIp\fR ]
  21 [-S
  22 \fIn\fR ]
  23 [-D
  24 \fIn\fR ]
  25 [-F string][-f string][-r
  26 \fIn\fR ]
  27 [-O
  28 \fIn\fR ]
  29 [-C
  30 \fIn\fR ]
  31 [-c
  32 \fIn\fR ]
  33 [-m
  34 \fIn\fR ]
  35 [-x xpos]
  36 [-y ypos]
  37 .in -8n
  38 .SH DESCRIPTION
  39 \fIxlyap\fR
  40 generates and graphically displays an array of Lyapunov exponents for a
  41 variety of iterated periodically forced non-linear maps of the unit interval.
  42 .SH OPTIONS
  43 .TP 8
  44 -random
  45 A good choice for use with xscreensaver: picks random parameters from
  46 a built-in list.
  47 .TP 8
  48 -C \fIn\fP
  49 Specifies the minimum color index to be used for negative exponents
  50 .TP
  51 -D \fIn\fP
  52 Specifies the "dwell" or number of iterations over which to average in order
  53 to calculate the Lyapunov exponent. Default is 400.
  54 .TP
  55 -B
  56 Causes the stop, go, spin and quit buttons to be displayed.
  57 .TP
  58 -H \fIn\fP
  59 Specifies the height of the window. Default is 256.
  60 .TP
  61 -L
  62 Indicates use log(x) + log(y) rather than log(xy).
  63 .TP
  64 -M \fIr\fP
  65 Specifies the real value to compare exponent values to for indexing into
  66 a color wheel. The default value is 1.0.
  67 .TP
  68 -O \fIn\fP
  69 Specifies the minimum color index to be used for positive exponents
  70 .TP
  71 -R \fIp\fP
  72 Specifies pseudo-random forcing with probability \fIp\fP of using parameter
  73 value 'a'.
  74 .TP
  75 -S \fIn\fP
  76 Specifies the "settle" or number of iterations prior to the beginning of
  77 the calculation of the Lyapunov exponent. Default is 200.
  78 .TP
  79 -W \fIn\fP
  80 Specifies the width of the window. Default is 256.
  81 .TP
  82 -a \fIr\fP
  83 Specifies the real value to use as the minimum parameter value of the
  84 horizontal axis. Default is 3.0 for the logistic map.
  85 .TP
  86 -b \fIn\fP
  87 Specifies the real value to use as the minimum parameter value of the
  88 vertical axis. Default is 3.0 for the logistic map.
  89 .TP
  90 -c \fIn\fP
  91 Selects one of six different color wheels to use. The default color
  92 wheel is a rainbow palette.
  93 .TP
  94 -F \fI10101010\fP
  95 Specifies the "Function" forcing function to use. The example above would
  96 alternate between iterating the circle and logistic maps. An argument of
  97 "-F 2323" would alternate between left and right logistic maps. The default
  98 is to only use the single specified map (see the description of -m).
  99 .TP
 100 -f \fIabbabaab\fP
 101 Specifies the forcing function to use. The default is to alternate between
 102 the "a" parameter and the "b" parameter.
 103 .TP
 104 -h \fIr\fP
 105 Specifies the real value to be used as the range over which the vertical
 106 parameter values vary. The default is 1.0.
 107 .TP
 108 -i \fIr\fP
 109 Specifies the real value of the initial condition to use. Default is 0.05.
 110 .TP
 111 -m \fIn\fP
 112 Selects between available non-linear maps of the unit interval. A value of
 113 0 specifies the logistic map. A value of 1, the circle map. A value of 2,
 114 the left-logistic. A value of 3, the right-logistic. A value of 4, the
 115 double-logistic. The default is 0, the logistic map.
 116 .TP
 117 -o \fIfilename\fP
 118 Specifies the output filename to be used. If the -o option is given, this
 119 file will automatically be written out at the completion of the drawing.
 120 If it is not specified, a default filename of lyap.out is used and only
 121 written if the 'f' or 'F' keys are pressed during a run. The format of the
 122 output file is PPM for color and PGM for monochrom. The parameters used to
 123 calculate the picture are included as comments at the beginning of the output
 124 file.
 125 .TP
 126 -p
 127 Switches color indices for negative and positive exponents. Generally,
 128 causes negative exponents to be displayed in more detail while darkening
 129 and narrowing the color range for positive exponents. This can be toggled
 130 during runtime by pressing the 'p' key.
 131 .TP
 132 -r \fIn\fP
 133 Specifies the maximum rgb value to be used. Default is 35000.
 134 .TP
 135 -s \fIn\fP
 136 Specifies the length of the color wheel spin.
 137 .TP
 138 -u
 139 Produces a usage message.
 140 .TP
 141 -v
 142 Prints out the various values to be used and exits.
 143 .TP
 144 -w \fIr\fP
 145 Specifies the real value to be used as the range over which the horizontal
 146 parameter values vary. The default is 1.0.
 147 .TP
 148 -x \fIn\fP
 149 Specifies the x screen coordinate of the window (default is 256).
 150 .TP
 151 -y \fIn\fP
 152 Specifies the y screen coordinate of the window (default is 256).
 153 .sp 2
 154 .SH NOTES
 155 .sp
 156 During display, pressing any mouse button allows you to select the area to
 157 be investigated with the mouse. The upper left hand corner of the desired
 158 area is the location of the cursor when the button is pressed. The lower
 159 right hand corner is specified by the cursor when the button is released.
 160 .sp 2
 161 Use of the keys
 162 \fIbBeEfFkKjJmnrRsSwWxXqQ\fP
 163 indicates:
 164 .sp
 165 .ti 10
 166 (<) Halve dwell value.
 167 .ti 10
 168 (>) Double dwell value.
 169 .ti 10
 170 ([) Halve settle value.
 171 .ti 10
 172 (]) Double settle value.
 173 .ti 10
 174 (B or b) Toggle button display on/off
 175 .ti 10
 176 (E or e) Recalculate the indices into the color wheel using a different method
 177 .ti 10
 178 (F or f) Save current screen to ouput file (not yet implemented)
 179 .ti 10
 180 (H or h or ?) Display brief help message
 181 .ti 10
 182 (i) Decrement the interval between stripes for the striped color map.
 183 .ti 10
 184 (I) Increment the interval between stripes for the striped color map.
 185 .ti 10
 186 (K) Decrease value exponents are compared against by 0.05.
 187 .ti 10
 188 (J) Increase value exponents are compared against by 0.05.
 189 .ti 10
 190 (M) Decrease value exponents are compared against by 0.005.
 191 .ti 10
 192 (N) Increase value exponents are compared against by 0.005.
 193 .ti 10
 194 (m) Increment the map index, changing the map to be iterated.
 195 .ti 10
 196 (P or p) Toggle positive/negative exponent display.
 197 .ti 10
 198 (r) Redraw the window using previously calculated exponents.
 199 .ti 10
 200 (R) Redraw the window using the newly set dwell and/or settle values.
 201 .ti 10
 202 (S) Spin the color wheel
 203 .ti 10
 204 (s) Halve the length of the spin and spin the color wheel
 205 .ti 10
 206 (u) Go up to the window just prior to the most recent zoom.
 207 .ti 10
 208 (U) Go all the way up to the original window.
 209 .ti 10
 210 (V or v) Display values of various parameters currently in use
 211 .ti 10
 212 (W or w) Use next color map.
 213 .ti 10
 214 (X or x) Clear window
 215 .ti 10
 216 (Q or q) quit
 217 .sp 2
 218 .SH AUTHOR
 219 .nf
 220         Ronald Joe Record
 221      The Santa Cruz Operation
 222           P.O. Box 1900
 223        Santa Cruz, CA 95061
 224             rr@sco.com
 225 .fi
 226 .sp 2
 227 .SH ACKNOWLEDGEMENTS
 228 .PP
 229 The algorithm was taken from the September 1991 Scientific American article
 230 by A. K. Dewdney who gives credit to Mario Markus of the Max Planck Institute
 231 for its creation. Additional information and ideas were gleaned from the
 232 discussion on alt.fractals involving Stephen Hall, Ed Kubaitis, Dave Platt
 233 and Baback Moghaddam. Assistance with colormaps and spinning color wheels
 234 and X was gleaned from Hiram Clawson. Rubber banding code was adapted from
 235 an existing Mandelbrot program written by Stacey Campbell.
 236
 237 Viciously hacked for xscreensaver by Jamie Zawinski, 20-Nov-97.