ConfiguringGEDI

←↑↓→

Configuring GEDI

GEDI can be configured to help you ground truth images more conveniently. This is primarily done through the Preferences menu, which can be opened by selecting the Edit>Preferences option from the top menu bar, or by pressing Alt + Enter. The menu has three main sections: options, zones, and page. The options tab allows you to adjust settings that are specific to your username, and apply to any image that you open with GEDI. The zones tab allows you to configure zone types, the attributes for each zone type, and the hotkeys for the attributes. The page tab allows you to configure page attributes and hotkeys for them.

Hotkeys for zone types, zone attributes, and page attributes, and the auto zone adjustment feature are the some options that could make it easier for you to ground truth images, and are found in the Preferences menu.

Changing the color of a zone type can help make it easier to see and distinguish from other zone types. The color of a zone type can be changed either in the Zones tab of the Preferences menu, or in the left panel of GEDI's main screen.

Toggling the visibility of certain zone types can help you if you are only working with some of the zone types. Zone visibility can be toggled by clicking on the green check or the red cross in the "Visible" column in the left menu.

General Preferences

General preferences affect every image edited with GEDI. These preferences are specific to each user, and can be found under the "Options" tab of the preferences menu. Changes can be applied without leaving the preferences menu by pressing the "Apply" button. Pressing "OK" will apply changes and close the preferences menu, and "Cancel" will close the preferences menu without applying new the new preferences.

Auto save file changes

When this option is selected, GEDI will automatically save the results of your actions to the xml file for the image you are editing, without asking for confirmation. While this allows you to edit numerous files more quickly, if you make any unintended changes they will be saved without you noticing. If you are browsing images without intending to make many edits, we suggest turning this option off.

Auto create config file

When this option is selected, GEDI will automatically create a configuration file for any new directories that you open. The configuration file is used to store the zone and page preferences, which are specific to each directory.

Show content window on DLTextLine draw

When this option is selected, GEDI will automatically open a text input window every time you draw a new DL_TEXTLINEGT zone. This allows you to type in the contents of the zone faster.

Show only the selected text line

When this option is selected, contents of non-selected zones will not be displayed.

Show zone type within zone

When this option is selected, the name of each zone type will be printed in the center of each zone of that type. The font size for the zone type names can be increased with Ctrl + '+' and decreased with Ctrl + '-'.

Enable Parent/Child related toolbar buttons

If this option is not selected, the parent/child toolbar buttons are disabled.

Document Capture to default file

If this option is not selected, the screenshot resulting from document capture will be saved automatically to filename_dump.bmp, where filename is the name of the current image file, without a prompt.

Text Box Opacity (%):

This slide bar allows you to adjust the opacity of selected zones.

Use Electronic Text Window

When this option is selected, a text window with the contents of the directoryname.txt or the filename.txt file (see option described below) will be displayed in the lower left corner of GEDI's main window. If you do not see the text window, try resizing the menus on in the left panel. Lines of text from this text window can be copied directly to the selected DL_TEXTLINEGT zone by pressing Ctrl + Space.

Use Directory name for input .txt file

This option is directly related to the previous option (described above). When this option is selected, the contents of the electronic text window will be loaded from the directoryname.txt file. When it is not selected, the contents of the window will be loaded from the filename.txt file.

Network Options

Accept navigation commands from network: When this option is selected, GEDI listens on a local TCP port for incoming HTTP-formatted requests. This allows you to use a web browser to go through generated HTML error logs and immediately load the corresponding image/zone in GEDI rather than having to look for the file manually. You can leave this option off if you are not using html links to load zones in GEDI.

Listener Port: Changes the port on which GEDI listens for navigational commands. Unless you are instructed to do so by technical support personnel, do not change this port from the default port 8000, as it will probably make navigational commands from a web browser not work.

Root Path: All network operations can use filenames relative to this path. If you need to adjust this path, you will be told how to do so by technical support personnel.

Auto Zone Adjustment Options

GEDI can use a script to automatically adjust Normal zones to fit around connected components (text and graphical elements) on the page.

No Auto Zone Adjustment

When this option is selected, zones remain exactly as drawn.

Auto Zone Adjustment (shrink only)

When this option is selected, GEDI will use a script to automatically shrink Normal zones to fit around connected components. If this option is enabled, you should make sure that every part of the text is included in the zones you are drawing.

Auto Zone Adjustment (shrink and expand)
When this option is selected, GEDI will automatically adjust Normal zones to fit around connected components. Use this option only on clean pages with a solid-color background, or the zone will expand to include the entire page.

Filter Size

This is the smallest amount of pixels that will be recognized by the auto adjustment script as an connected components. If zone that you are drawing are "catching" on background noise and not properly fitting what you want to select, try increasing the filter size. If zones that you are drawing are shrinking too much and not including parts that you wish to include, try decreasing the filter size. By default, the filter size is 5.

Zone Preferences

The settings in the Zones tab of the Preferences menu will affect all zones of a given type, as well as all zones of that type created in the future. Changes can be applied without leaving the preferences menu by pressing the "Apply" button. Pressing "OK" will apply changes and close the preferences menu, and "Cancel" will close the preferences menu without applying new the new preferences.

Adding Zone Types

To add a new zone type, press the "ADD TYPE" button. This will add a new zone type named New_Type_# without any attributes or hotkeys.

Adding the DL_TEXTLINEGT Zone Type

To add the DL_TEXTLINEGT Zone Type, press the "Create DL_TEXTLINEGT" button in the upper right hand corner.

Renaming a Zone Type

To rename a zone type, click on the name of the zone type in the "Available Types" table. Once the grid cell containing the name is outlined, you can type a new name for the zone type. Once you have entered the new name, press Enter. If you have entered an invalid name, a message will pop up.

Changing a Hotkey of a Zone Type

To add or change a hotkey of a zone type, click the grid cell under the "KEY" column in the "Available Types" table in the row corresponding to the zone type that you want to hotkey. A list of available hotkeys will appear, and you can select the hotkey you want by clicking it. To remove a hotkey, change it to "None".

Changing the Color

To change the color of a zone type, click the grid cell under the "COLOR" column in the "Available Types" table in the row corresponding to the zone type whose color you want to change. A color selection menu will appear, from which you can pick the new color of the zone type.

Deleting a Zone Type

To delete a zone type, select the zone type in the "Available Types" grid by clicking on its name. Once the row in the table for the zone type is highlighted, press the "REMOVE TYPE" button.

Adding an Attribute

To add an attribute to a zone type, first select the zone type in the "Available Types" grid by clicking on its name. Once the row in the table for the zone type is highlighted, press the "ADD ATTRIBUTE" button. This will add a new attribute named New_Attribute_# without any values, defaults, or hotkeys.

Renaming an Attribute

To rename an attribute of a zone type, first select the zone type in the "Available Types" grid by clicking on its name. Once the row in the table for the zone type is highlighted, click on the name of the attribute in the "Type Specific Attributes" under the "Type Attribute" column. Once the grid cell containing the attribute name is outlined, you can type a new name for the attribute. Once you have entered a new name, press Enter. If you have entered an invalid name, a message will pop up.

Setting Possible Values for an Attribute

To set the possible values for an attribute, click the corresponding cell in the "Type Specific Attributes" table. Once the cell is outlined, you can type in the possible values. Separate each value with a semicolon. Once you have entered all the possible values, press Enter.

Setting a Default Value for an Attribute

To set the default value for an attribute, click the corresponding cell in the "Type Specific Attributes" table. A list the possible values will appear, and you can select the default value by clicking on it. If there is not a list of possible values, a default value can still be set by typing it in and pressing Enter. To have no default value, select the blank value.

Deleting an Attribute

To delete an Attribute, select the attribute from the "Type Specific Attributes" table, then press the "REMOVE ATTRIBUTE" button.

Setting Hotkeys for an Attribute

To add a hotkey for an attribute, first select the zone type from the "Available Types" table. Then, in the "Type Specific Attribute Hot Keys" table, find the row corresponding to the hotkey you want to use. For that hotkey, first select an attribute then a value by clicking on the cells in the table and selecting from the list that appears. To remove actions associated with a hotkey, change either the attribute or the value to "None".

Page Preferences

The settings in the Page tab of the Preferences menu will affect all pages edited with GEDI. Changes can be applied without leaving the preferences menu by pressing the "Apply" button. Pressing "OK" will apply changes and close the preferences menu, and "Cancel" will close the preferences menu without applying new the new preferences.

Adding a Page Attribute

To add a page attribute, press the "ADD ATTRIBUTE" button. This will create a new page attribute named New_Atribute_# with no possible values and no default value.

Renaming a Page Attribute

To rename a page attribute, click the name of the attribute in the "Page Attributes" table. Once the name is outlined, you can type in a new name, and press Enter when you are done. If you enter an invalid name, a message will pop up.

Setting Possible Values

To set the possible values for an attribute, click the corresponding cell in the "Page Attributes" table. Once the cell is outlined, you can type in the possible values. Separate each value with a semicolon. Once you have entered all the possible values, press Enter.

Setting a Default Value

To set the default value for an attribute, click the corresponding cell in the "Page Attributes" table. A list the possible values will appear, and you can select the default value by clicking on it. If there is not a list of possible values, a default value can still be set by typing it in and pressing Enter. To have no default value, select the blank value.

Setting Hotkeys for an Attribute

To add a hotkey for an attribute, find the row corresponding to the hokey you want to use in the "Page Attribute Hot Keys" table. For that hotkey, first select an attribute then a value by clicking on the cells in the table and selecting from the list that appears. To remove actions associated with a hotkey, change either the attribute or the value to "None".

Deleting an Attribute

To delete a page attribute, select the attribute from the "Page Attributes" table, then press the "REMOVE ATTRIBUTE" button.