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