Read Me

The Super Overlay Generator is Copyright (C) 2007-2008 OFFIS e.V.
It is published under the GNU General Public License version 2 (see LICENCE.txt).


Description
-----------
With this tool a single image or a sequence of images can be transformed into a Super Overlay for Google Earth.


Requirements
------------
The Super Overlay Generator needs Java 1.5 or higher to run.


Usage
-----
The Super Overlay Generator can be run on a Linux-System with "generator.sh <Parameter>"

Another way to run the Super Overlay Generator is to call it directly like this:
java -jar generator.jar <Parameter>

In the examples directory are examples for calling the Super Overlay Generator.

There are three operation modi:

1.) generator -help
    Shows a help text.

2.) generator -image <path to image> -name <Super Overlay name> -north <northern latitude edge> -south <southern latitude edge> -east <eastern longitude edge> -west <western longitude edge> [-rotation <arc by wich the image is rotated>] [-out <path where the Super Overlay files are saved>] [-debug] [-url <an url>]
    Generates a Super Overlay from a single image.

3.) generator -sequence <xml file> [-out <path where the Super Overlay files are saved>] [-debug] [-url <an url>]
    Generates a Super Overlay from a sequence of images.

Meaning of the parameter:

-help 
	Shows a help text.

-image
	The image from which a Super Overlay will be generated. (Only used when processing a single image.)

-name
	The name of the Super Overlay. (Only used when processing a single image.)

-north
	The northern latitude edge of the Super Overlay in decimal degrees. (Only used when processing a single image.)

-south
	The southern latitude edge of the Super Overlay in decimal degrees. (Only used when processing a single image.)

-east
	The eastern longitude edge of the Super Overlay in decimal degrees. (Only used when processing a single image.)

-west
	The western longitude edge of the Super Overlay in decimal degrees. (Only used when processing a single image.)

-rotation
	Arc (in degrees) by which the image is rotated. This parameter is optional. 
	default value: "0" (Only used when processing a single image.)

-out
	The path to which the Super Overlay files are saved. Missing directories will be created. This parameter is optional. 
	default value: "out" (Only used when processing a single image.)

-debug
	Lets the generator print more output.
	
-url
	Adds an URL before the path in the top level kml file. 
	The URL could be the URL of an server where the Super Overlay will be saved.
	In this way the top level kml file can be chosen in a Web browser or even saved locally.
	This parameter is optional. default value: "" 
	(Can be used when processing a single image and when processing an image sequence.)

-sequence
	Path to an xml file, with informations to one or more images. (Only used when processing an image sequence.)
	Example for an xml file:
        <SuperOverlay>
            <name>Cyclon over Sri Lanka</name>
            <OverlayList>
                <Overlay>
                    <name>cyclon_A</name>
                    <file>cyclon1.jpg</file>
                    <begin>2003-05-13</begin>
                    <end>2003-05-14</end>
                    <north>23.9061246206023</north>
                    <south>4.05485537986857</south>
                    <west>72.5985562084481</west>
                    <east>89.2144734267342</east>
                    <rotation>0</rotation>
                </Overlay>
                <Overlay>
                    <name>cyclon_B</name>
                    <file>cyclon2.jpg</file>
                    <begin>2003-05-14</begin>
                    <end>2003-05-15</end>
                    <north>19.87682541909688</north>
                    <south>0.07674339162095907</south>
                    <east>93.36094039921403</east>
                    <west>76.75793492168452</west>
                    <rotation>0</rotation>
                </Overlay>
            </OverlayList>
        </SuperOverlay>