README.asciidoc

   1 conformal.py
   2 ============
   3 :Author: Michael J. Gruber
   4 :Email:  conformal@drmicha.warpmail.net
   5 :Revision: 0.3
   6
   7 == Introduction
   8 `conformal.py` is a plugin-in for http://gimp.org[The Gimp] which allows
   9 visualisation of conformal maps.
  10
  11 == Requirements
  12 You need `gimp` and the python scripting extension to Gimp. It is
  13 included in newer versions of Gimp, before it was available in packages
  14 named `gimp-python` or similar.
  15
  16 == Installation
  17 You can install `conformal.py` as a local user or system wide:
  18
  19 === Local User
  20 Copy `conformal.py` to the `plug-ins` subdirectory of your Gimp
  21 directory, usually `$HOME/.gimp-2.*/plug-ins/` on Linux, and make sure
  22 that it is executable (`chmod +x conformal.py`).
  23
  24 === System wide
  25 Copy `conformal.py` to the `plug-ins` subdirectory of your system Gimp
  26 directory, usually `/usr/lib/gimp/2.*/plug-ins/` or (similar) on Linux,
  27 and make sure that it is executable (`chmod a+rx conformal.py`).
  28
  29 === Usage
  30 After starting The Gimp, you find the conformal plug-in in the `Create`
  31 submenu of the `File` menu. From the dialogue, you can adjust these parameters:
  32
  33 `width`, `height`::
  34         The dimensions of the new image.
  35 `code`::
  36         The python code which is executed for every single pixel of the
  37         image. The code can use the value of the complex number `z`
  38         (which represents the current pixel) and should assign a value
  39         to `w` which will be considered the (mapping) image of `z`.
  40 `x left`, `x-right`::
  41         The range of x-values (real parts) which is mapped to the horizontal image axis.
  42 `y top`, `y bottom`::
  43         The range of y-values (imaginary parts) which is mapped to the vertical image axis.
  44 `grid spacing`::
  45         The spacing of the generated coordinate grid.
  46 `checker board`::
  47         Use a checker board instead of a grid.
  48 `gradient`::
  49         The gradient representing the argument of the complex number.
  50
  51 The plugin-in then creates a new image with three layers:
  52
  53 `Grid`::
  54         This layer paints the conformally transformed coordinate grid.
  55
  56 `Log. modulus`::
  57         This layer adds a shading corresponding to the absolute value on
  58         a logarithmic scale, i.e. one cycle (from white to black) of the
  59         shading means doubling the modulus: the fractional part of `lb |w|`
  60         is used as an index into the default white-black gradient.
  61
  62 `Argument`::
  63         This layer is coloured using the value of the gradient
  64         at an index corresponding to `arg w`.
  65
  66 The two topmost layers have transparency and layer mode set
  67 appropriately, but feel free to experiment with these, as well as
  68 turning some layers off, depending on your goal: produce instructive
  69 illustrations, or simply beautiful pictures!
  70
  71 == License
  72 `conformal.py` is copy righted by {author} and is available
  73 under the GNU General Public License Version 2.