git.hungrycats.org Git - xscreensaver/blob - hacks/xlyap.man

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