Tree [5ec81d] v0.5.4 /
 History



File Date Author Commit
 help 2010-03-07 Behnam Tabatabai Behnam Tabatabai [5740c6] README complete
 m4 2010-03-02 Behnam Tabatabai Behnam Tabatabai [20251f] copyright, hard-code win32 install dirs
 po 2010-03-07 Behnam Tabatabai Behnam Tabatabai [5ec81d] version 0.5.4
 src 2010-03-07 Behnam Tabatabai Behnam Tabatabai [5ec81d] version 0.5.4
 AUTHORS 2009-08-22 Behnam Tabatabai Behnam Tabatabai [a305ec] Initial commit
 BUGS 2009-08-22 Behnam Tabatabai Behnam Tabatabai [a305ec] Initial commit
 COPYING 2009-08-22 Behnam Tabatabai Behnam Tabatabai [a305ec] Initial commit
 ChangeLog 2009-08-22 Behnam Tabatabai Behnam Tabatabai [a305ec] Initial commit
 INSTALL 2009-08-22 Behnam Tabatabai Behnam Tabatabai [a305ec] Initial commit
 Makefile.am 2010-03-07 Behnam Tabatabai Behnam Tabatabai [95d6cb] last minute changes to win32
 NEWS 2009-08-22 Behnam Tabatabai Behnam Tabatabai [a305ec] Initial commit
 README 2010-03-07 Behnam Tabatabai Behnam Tabatabai [95d6cb] last minute changes to win32
 autogen.sh 2009-09-16 Behnam Tabatabai Behnam Tabatabai [265e71] User-install now working.
 configure.ac 2010-03-06 Behnam Tabatabai Behnam Tabatabai [0df436] german translation
 win32-configure.sh 2010-03-07 Behnam Tabatabai Behnam Tabatabai [95d6cb] last minute changes to win32
 win32-make-dist.sh 2010-03-07 Behnam Tabatabai Behnam Tabatabai [95d6cb] last minute changes to win32

Read Me

Gimp Plug-in for "Image Registration"
http://gimp-image-reg.sourceforge.net/

Version 0.5.4
2010-03-07

Contents
--------
(1) What is "Image Registration"?
(2) Using the plug-in
(3) Building and Installing
(3.1) Building and Installing for Linux
(3.1.1) User Installation
(3.1.2) System-Wide Installation
(3.2) Building and Installing for Win32
(3.2.1) Binary Distribution for Win32
(3.2.2) Building for Win32


(1) What is "Image Registration"?
---------------------------------
"Image registration", also known as "image alignment", is the process
of transforming an image (called "template") to achieve a best match
with another image (called "reference"). The need for such a tool is
given in situations where for achieving some visual effect, you must
combine two or more images, which are more or less similar, but
geometrically do not have a perfect match.

A typical situation is the combination of 2 or 3 photos in HDR
methods. Unless you use a stable tripod, the source images will always
be slightly out of alignment, so the very first step will be to
re-align the images. The alignment step is normally built into
dedicated HDR software, but for doing simple HDR using for example
Gimp's layer masks, you'll need to do it yourself, and this is where
you can use this plug-in.

(2) Using the plug-in
--------------------
After you have built and installed the plug-in (see below), it will
appear as "Image Registration..." in the "Tools" menu. For using the
tool, load your images into Gimp (preferably as layers, see "Open as
Layers..."), select the layer you would like to transform, and launch
the tool. Refer to "Help" in tool's dialog for more information about
the parameters.

(3) Building and Installing
---------------------------
As of version 0.5.4, the "Image Registration" plug-in has been built
and (roughly) tested only for Linux (Ubuntu 9.04) and Win32. Thanks to
auto-tools, the chances are the software can be easily built also for
Mac OS X, BSD, or other UNIXes, but I have not tried that yet.

(3.1) Building and Installing for Linux
---------------------------------------
For building the plug-in for Linux, you will need the development
package 'libgimp2.0-dev', which you easily get and install by your
package manager (apt, Synaptic Package Manager, etc.).

The plug-in can be built either for a single user, or for a
system-wide installation.

(3.1.1) User Installation
-------------------------
Unless many users on your system will use this plug-in, I recommend a
"user" installation, in which the plug-in goes into your personal
~/.gimp-2.6 directory, and the gimp installation directories remain
untouched.

The steps for a user installation of the plug-in are the following:

(0) [Download 'gimp-image-reg-0.5.4.tar.bz2' into some directory,
     change to that directory,
     and issue the following commands.]

(1) tar xvjf gimp-image-reg-0.5.4.tar.bz2
(2) mkdir build
(3) cd build
(4) ../gimp-image-reg-0.5.4/configure --enable-user-install
(5) make
(6) make install

If everything goes right, the image registration plug-in and the
accompanying files will be installed
in your personal ~/.gimp-2.6 directory, namely:

   ~/.gimp-2.6/plug-ins/gimp-image-reg     (executable)
   ~/.gimp-2.6/share/gimp-image-reg/*      (help files)
   ~/.gimp-2.6/share/locale/*              (localization files)

For uninstalling the plug-in, simply run 'make uninstall'.

(3.1.2) System-Wide Installation
--------------------------------
A system-wide installation is much like the user installation, except:

(a) the configuration step, in which you explicitly provide a
    prefix, and omit the option --enable-user-install [default: no],
    and

(b) administrative rights (sudo) for installing the software.

Passing the right prefix to the configure script is for making sure
that Gimp will find the plug-in after installation. This prefix can be
obtained from 'gimptool-2.0' (part of 'libgimp2.0-dev') by the
following command:

 $ gimptool-2.0 --prefix

The steps for a system-wide installation of the plug-in are the following:

(1) tar xvjf gimp-image-reg-0.5.4.tar.bz2
(2) mkdir build
(3) cd build
(4) ../gimp-image-reg-0.5.4/configure --prefix=`gimptool-2.0 --prefix`
(5) make
(6) sudo make install

Upon successful completion, the plug-in and the accompanying files will
go into:

   ${prefix}/lib/gimp/2.0/plug-ins/gimp-image-reg (executable)
   ${prefix}/share/gimp-image-reg/*               (help files)
   ${prefix}/share/locale/*                       (localization files)

For uninstalling the plug-in, simply run 'sudo make uninstall'.

(3.2) Building and Installing for Win32
---------------------------------------

(3.2.1) Binary Distribution for Win32
-------------------------------------
The easiest way of installing the plug-in in Win32 platforms is to use
the binary distribution 'gimp-image-reg-0.5.4-win32.zip'.  It is a
pre-built version of the plug-in which you simply unpack into your
*personal* gimp directory, which is presumably named:

  c:\Documents and Settings\<user>\.gimp-2.6         (English Windows) 
  c:\Dokumente und Einstellungen\<user>\.gimp-2.6    (German Windows)

or similar in other languages.

Currently there is no Win32 installer (and more specifically, no
uninstaller) for the plug-in. Therefore, for uninstalling the plug-in
you'll need to manually delete the files coming with the zip
package. The locations of the files are as follows:

   ...\.gimp-2.6\plug-ins\gimp-image-reg.exe (executable)
   ...\.gimp-2.6\share\gimp-image-reg\*      (help files)
   ...\.gimp-2.6\share\locale\*              (localization files)

For a more detailed list of installed files refer to the end of the
next section.

(3.2.2) Building for Win32
--------------------------
Currently the binaries for Win32 are built by cross-compiling under
Linux (using the same scripts as for building the Linux binaries).

For cross-compiling the sources, will need to get and install 

(a) 'Minimalist GNU win32 cross-compiler' (look for 'mingw32' in your
    package manager), and

(b) the Win32 development packages for Gimp and Gtk+.

The latter packages can be downloaded from:

http://sourceforge.net/projects/gimp-win/files/ (look for
gimp-dev-2.6.4.zip or newer)

ftp://ftp.gnome.org/pub/gnome/binaries/win32/ (look for
gtk+-bundle_2.18.7-20100213_win32.zip or newer)

Assuming that you unpack/install the development libraries into say
'/opt/mingw32', the build steps are much like the 'normal'
installation for Linux, namely:

(1) tar xvjf gimp-image-reg-0.5.4.tar.bz2
(2) mkdir build
(3) cd build
(4) ../gimp-image-reg-0.5.4/configure \
           --prefix=`pwd`/win32       \
           --with-prefix=/opt/mingw32 \
           --host=i586-mingw32msvc    \
           --target=i586-mingw32msvc  \
           --build=i386-linux
(5) make
(6) make install

This will create a directory 'win32' in your current directory and
'install' the package there. The contents of this directory will be:

win32/
|-- plug-ins
|   `-- gimp-image-reg.exe
`-- share
    |-- gimp-image-reg
    |   `-- help
    |       |-- css
    |       |   `-- image-reg.css
    |       |-- de
    |       |   |-- gimp-help.xml
    |       |   `-- index-de.html
    |       |-- en
    |       |   |-- gimp-help.xml
    |       |   `-- index-en.html
    |       `-- images
    |           |-- dialog-1-de.png
    |           |-- dialog-1-en.png
    |           `-- wilber.png
    `-- locale
        `-- de
            `-- LC_MESSAGES
                `-- gimp-image-reg.mo

For the actual installation of the plug-in, copy the contents of
win32\...  into your *personal* gimp-2.6 directory, preserving the
directory structure.