This is an old revision of the document!
EGO Script Language
Introduction
EGO Script is a simple language used to create and edit Dinamica EGO models. The file describing the model using the EGO Script format uses the extension “.ego”.
They behave just like any XML models, so it is possible to edit, load them on the graphical interface and save them again. However, beware that the Dinamica EGO graphical interface can change the model layout and input/output format based on the currently defined options. More tips on saving EGO scripts on the GUI at the end of this language tutorial.
Overview
A simple EGO script model can be seen below:
- ego1.ego
Script {{ // Loads a GeoTiff map. x := LoadMap "c:/map.tif"; // Saves an ERMapper map. SaveMap x "c:/map-copy.ers"; }};
The Script {{ }}
is used to delimit the script text. It allows several script elements to be passed on the same file. To retain backward compatibility with previous versions, this declaration can be omitted, but this practice is not encouraged.
The second line indicates the use of a Load Map to load the Geotiff file “map.tif”. The resulting map is bound to the variable x
. Note that the functor name is written without breaks. Variables are always defined and bound using the operator :=
.
The third line uses a Save Map to save the map bound by variable x
in a ERMapper file named “c:/map-copy.ers”.
The variables and parameters after the functor name are bound to the functor input ports. Those variables before the operator :=
are bound to the functor output ports.
The sequence //
marks the beginning of a comment. The comment continues until the end of line.
Here is a slightly more complex example:
- ego2.ego
Script {{ landscape := LoadCategoricalMap "c:/landscape.tif"; cells hects m2s := CalcAreas landscape; SaveLookupTable hects "c:/area_in_hectares.csv"; }};
Note that functor Calc Areas produces three lookup tables, representing the calculated area in cells, hectares and square meters.
It is possible to omit variables representing outputs or ignore them using the variable _
(underline). So the previous example can be re-written as shown below:
- ego3.ego
Script {{ landscape := LoadCategoricalMap "c:/landscape.tif"; _ hects := CalcAreas landscape; SaveLookupTable hects "c:/area_in_hectares.csv"; }};
You can also write
_ hects := CalcAreas landscape;
as
_ hects _ := CalcAreas landscape;
Note the trailing _
after hects
.
It is also possible to use the input and output names to bind variables and parameters. The previous example can be rewritten as
- ego4.ego
Script {{ { landscape=map } := LoadCategoricalMap { filename="c:/landscape.tif" }; { hects=cellAreaInHectares } := CalcAreas { categoricalMap=landscape }; SaveLookupTable { table=hects, filename="c:/area_in_hectares.csv" }; }};
So the first line is binding the filename “c:/landscape.tif” to the input named filename
.
…
It is possible to freely mix both styles. So you can write the previous input as
- ego4.ego
Script {{ landscape := LoadCategoricalMap { filename="c:/landscape.tif" }; { hects=cellAreaInHectares } := CalcAreas landscape; SaveLookupTable { table=hects, filename="c:/area_in_hectares.csv" }; }};
It is also possible to inline a definition of functor pretty much like nesting function calls in other programming languages:
- ego5.ego
Script {{ { hects=cellAreaInHectares } := CalcAreas (LoadCategoricalMap { filename="c:/landscape.tif" }); SaveLookupTable { table=hects, filename="c:/area_in_hectares.csv" }; }};
Note that the Load Categorical Map is now nested in the definition of Calc Areas.
Reference
Comments
You can define a single line comment preceding the text with a '//'.
// This is a single line comment.
Multi-line comments can be defined surrounding the text with '/*' and '*/'.
/* This is a multi-line
comment */
It is worth noting that there is a very important difference between both comment styles: multi-line comment style are not preserved if the model is opened using the graphical interface. Usually this is not a problem since multi-line comment can be defined using the '//' style. Ex:
// This is a multi-line // comment
Brief and Extended Comments
The sequence ===
is used to separate the brief and extended comments of a functor.
// Generate the initial 'seed' // // === // Living cells are represented by 1 and dead cells by 0
Functor Input/Outputs
It is possible to define value to input ports using two different syntaxes:
Positional Syntax
Using this syntax you can pass values and variables based on the position of the input port. Optional input ports always came last and can be omited. However, it is not possible to omit an input and give the next one. This limitation is a huge drawback when working with function with several optional input ports.
Nominal Syntax
Inline Syntax
Container Functor
Internal input port
Internal Output Port
Properties
Properties can be represented using two different syntaxes. The property definition is always relative to the next functor defined in the model.
The first syntax represents properties using comments.
/** name = value */
The other syntax uses the special symbol @.
@name = value
Property names must start with a letter or '_' followed by letters, '_' and '.'. Property values can include any character (including blanks). Property values including line breaks must be surrounded by '“'.
Examples of properties can be seen below:
/**
dff.date = Wed Oct 21 18:19:21 2009
dff.version = 1.4.0.20090812
metadata.author = Dinamica Team
metadata.description = Calculate the largest patch index of different categories.
metadata.notes = "The model input is a map where the non-null values identify the patches.
The output is a table containing the largest patch index per category."
metadata.organization = CSR / UFMG
metadata.showproperties = yes
metadata.title = Calc Largest Patch Index
metadata.version = 1.0
*/
@alias = Largest Patch Area @collapsed = yes
Note the declaration of a “metadata.notes” above using line breaks.
The syntax @property = value
forces the expansion of the property name if it represents a special property.
Some properties are used internally by Dinamica to store special information about functors and the model script. The list of special properties can be found below:
Functor Properties
Alias | Full Name | Description | Possible Values |
---|---|---|---|
alias | dff.functor.alias | The alias used to represent the functor in the model | Any string |
inline | dff.functor.inline | Used to indicate that functor definition must not be inlined | yes/no or true/false |
comment | dff.functor.comment | The functor comment | Any string |
collapsed | dff.container.collapsed | Used to indicate that the contained must appear closed in the graphical interface | yes/no or true/false |
Script Properties
Full Name | Description | Possible Values |
---|---|---|
dff.date | The date when the model was written for the last time | Any string |
dff.version | The version of Dinamica EGO used to update the model the last time | Any string |
metadata.title | The model title | Any string |
metadata.version | The model version | Any string |
metadata.author | The list of model authors | Any string |
metadata.organization | The list of organization of each model author | Any string |
metadata.description | The model description | Any string |
metadata.keywords | The list of model keywords | Any string |
metadata.notes | The model notes | Any string |
metadata.showproperties | Flag indicating if the property window should be displayed upon opening the model | yes/no or true/false |
Comments are a special property that uses a different syntax. Internally, they are expanded to their equivalent property format.
The syntax
// The input map. // // Non-null values identify the patches.
and
@comment = "The input map. Non-null values identify the patches."
are equivalent.
If used before the “Script” keyword, the // syntax is converted into a “metadata.title” and assigned to the model.
Expression Calculation Syntax
Dinamica version: 1.9.0
Expressions can be represented using an additional special syntax. The example below illustrates:
if #random <= ($mean - $min) / ($max - $min) then $min + sqrt(#random * ($max - $min) * ($mean - $min)) else $mean - sqrt((1 - #random) * ($max - $min) * ($max - $min))
The symbols prefixing the variable names are called sigils. The # represents maps, $ represents values and % represents tables. 1)
The use of sigils has some advantages including making easy to determine the data type represented by the variables. They also prevent clashes between special names like “rand”, “line” and “column” and the user defined ones. 2)
Examples
The example below represents a fragment of a real model using the original syntax:
patches := LoadCategoricalMap "../originals/landscape.ers" .no .no 0 0 .none; // ... currentCategoryId := Step step; // ... @collapsed = yes singleCategoryPatches := CalculateMap [ if i1 = v1 then 1 else null ] .uint8 0 .no {{ NumberMap patches 1; NumberValue currentCategoryId 1; }};
The model modified to use the special expression calculation syntax can be seen below:
patches := LoadCategoricalMap "../originals/landscape.ers" .no .no 0 0 .none; // ... currentCategoryId := Step step; // ... // Isolate the patches of a single category. @collapsed = yes singleCategoryPatches := #[ if #patches = $currenteCategoryId then 1 else null ];