~ubuntu-branches/ubuntu/vivid/fyre/vivid

« back to all changes in this revision

Viewing changes to README

  • Committer: Bazaar Package Importer
  • Author(s): Christoph Haas
  • Date: 2005-05-25 21:59:19 UTC
  • Revision ID: james.westby@ubuntu.com-20050525215919-jawtso5ic23qb401
Tags: upstream-1.0.0
ImportĀ upstreamĀ versionĀ 1.0.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
==================
 
2
 Fyre
 
3
==================
 
4
 
 
5
Introduction
 
6
------------
 
7
 
 
8
Fyre is a tool for producing computational artwork based on histograms of
 
9
iterated chaotic functions. At the moment, it implements the Peter de Jong map
 
10
in a fixed-function pipeline with an interactive GTK+ frontend and a command
 
11
line interface for easy and efficient rendering of high-resolution, high
 
12
quality images.
 
13
 
 
14
This program was previously known as 'de Jong Explorer', but has been renamed
 
15
to make way for supporting other chaotic functions.
 
16
 
 
17
All the images you can create with this program are based on the simple Peter
 
18
de Jong map equations:
 
19
 
 
20
   x' = sin(a * y) - cos(b * x)
 
21
   y' = sin(c * x) - cos(d * y)
 
22
 
 
23
For most values of a,b,c and d the point (x,y) moves chaotically. The resulting
 
24
image is a map of the probability that the point lies within the area
 
25
represented by each pixel. As you let Fyre render longer it collects more
 
26
samples and this probability map and the image becomes more accurate.
 
27
 
 
28
The resulting probability map is treated as a High Dynamic Range image.  This
 
29
software includes some image manipulation features that let you apply linear
 
30
interpolation and gamma correction at the full internal precision, producing a
 
31
much higher quality image than if you tried to create the same effects using
 
32
standard image processing tools.  Additionally, Gaussian blurs can be applied
 
33
to the image using a stochastic process that produces much more natural-looking
 
34
images than most programs, again without losing any of the image's original
 
35
precision.
 
36
 
 
37
Contact info and the latest version of Fyre is available from:
 
38
  http://fyre.navi.cx
 
39
 
 
40
 
 
41
Quality Metric
 
42
--------------
 
43
 
 
44
Fyre 1.0.0 introduces a new quality metric for determining stopping conditions
 
45
on command-line and animation rendering. It is much more consistent across
 
46
images than using the maximum density. A quality of 1.0 is generally "pretty
 
47
good", and 2.0 produces a very high quality image. As usual, while this metric
 
48
is pretty reliable, it's impossible to automatically judge aesthetics, so you
 
49
may need to fiddle with it if you're dissatisfied with the results.
 
50
 
 
51
 
 
52
Loading and Saving
 
53
------------------
 
54
 
 
55
Unless given a .exr extension, all images saved using the GTK+ frontend or the
 
56
-o command line option are standard PNG files containing an extra 'tEXt' chunk
 
57
with all the parameters used to create the image. This means the image can be
 
58
loaded back in using the -i command line option or the "Parameters -> Load from
 
59
image" menu item.
 
60
 
 
61
One convenient use of this is to save small low-quality images using the GUI,
 
62
then use the -i, -q, -s, and -o options to render very high quality and/or
 
63
large images noninteractively.
 
64
 
 
65
When using the -o (--output) option, no GUI is presented. Instead, Fyre just
 
66
outputs status lines every so often with the current rendering process.  These
 
67
lines include:
 
68
 
 
69
  - percent completion
 
70
  - current number of iterations
 
71
  - speed in iterations per second
 
72
  - current and target peak density values
 
73
  - elapsed and estimated remaining time
 
74
 
 
75
 
 
76
Animation
 
77
---------
 
78
 
 
79
Fyre includes an animation subsystem. From the main explorer window, use View >
 
80
Animation window to open the animation interface. Animations are represented as
 
81
a list of keyframes, with a transition after each. Keyframes can be manipulated
 
82
with the buttons at the top of the window. Transitions consist of a duration,
 
83
in seconds, and an editable curve. This curve's presets can be used to
 
84
transition linearly or ease in and out of keyframes, but you can also edit the
 
85
curve for more complex effects.
 
86
 
 
87
Each keyframe in the list also shows you the bifurcation diagram between that
 
88
keyframe's parameters and the next. Intense black dots or lines in the
 
89
bifurcation diagrams are fixed points or limit cycles, which usually don't look
 
90
good in animation.
 
91
 
 
92
You can preview the animation by dragging the two horizontal seek bars, or
 
93
using the 'play' button. The keyframe list can be loaded from and saved to a
 
94
custom binary format. Once you have an animation you like, you can get a higher
 
95
quality version using File -> Render. The result will be an uncompressed .AVI
 
96
file. You can use tools like mencoder or transcode to compress this file with
 
97
your favorite codec.
 
98
 
 
99
Animations can also be rendered from the command line using the -n and -o
 
100
options together.
 
101
 
 
102
 
 
103
Clustering
 
104
----------
 
105
 
 
106
As of 0.7, Fyre supports cluster rendering. On each worker node, start up fyre
 
107
with the -r command-line switch. On the head node, select your cluster nodes
 
108
using either the GUI or -c on the command line. If you're dealing with a large
 
109
cluster, the cluster-utils.sh file will probably prove useful.  Clusters on the
 
110
local network can be autodetected using UDP broadcast packets.  See the -C
 
111
command line option, or the autodetection check box in the GUI.  Note that
 
112
cluster mode cannot be used for animations at this time.
 
113
 
 
114
 
 
115
Dependencies
 
116
------------
 
117
 
 
118
Hard Dependencies:
 
119
- GTK+ 2.0
 
120
- libglade
 
121
 
 
122
Soft Dependencies:
 
123
- GTK+ 2.4
 
124
- OpenEXR, necessary for saving .exr files
 
125
- GNet, for clustering and remote control mode
 
126
 
 
127
 
 
128
Compiling
 
129
---------
 
130
 
 
131
Standard autotools procedure. configure, make, make install, you know the
 
132
drill.
 
133
 
 
134
Fyre supports Windows, using the same autotools build system. You'll need
 
135
Cygwin to compile this under Windows, but we find a cross-compiler under Linux
 
136
easier. The tools in the 'build' directory are used to create the final binary
 
137
packages.
 
138
 
 
139
 
 
140
Authors
 
141
--------
 
142
 
 
143
David Trowbridge <trowbrds@cs.colorado.edu>
 
144
Micah Dowty <micah@navi.cx>
 
145