GROUND TRUTHING EDITOR AND DOCUMENT INTERFACE (GEDI) Overview Presentation and Tutorial

Transcription

1 GROUND TRUTHING EDITOR AND DOCUMENT INTERFACE (GEDI) Overview Presentation and Tutorial 1

2 Index Introduction GEDI Interface Basic GEDI Operations Login, Loading Images, Display Basic Concepts - GEDI documents Zone Annotation Configuration, Creation, Editing, Attributes GEDI Menu options File Menu Options Preferences Menu options Special Functionality Network listener Overlay GEDI Help Future Work 2

3 INTRODUCTION This presentation is intended to explain the core functionalities present in the GEDI software, a generic and configurable tool for standoff annotation of document images. Most of the options in GEDI are covered explaining how the software actually works, but there is no substitute for hand-on experience with the software. It is recommended that you download the software and try various options as you go through this presentation The latest version can be downloaded from lamp.cfar.umd.edu, or questions should be forwarded to any LAMP researcher or doermann@umd.edu 3

4 Annotation concepts Annotation in GEDI refers to a process in which specific zones or pixels on an image are labeled with standoff metadata, primarily as a precursor for future training or evaluation of document analysis systems. The metadata is focused on the concept of a zone, with a physical location, and a set of user defined attributes Although there is no specific constraints on the system, it was designed primarily for document image annotation and to be compatible with the UMD DocLib Libraries. One specific application illustrated repeatedly is page segmentation (also called page decomposition or zoning), the process of decomposing a document page into its structural and logical units (called regions or zones), such as headlines, logos, images etc Annotation can be thought of as spatially identifying pieces of a document and the relations between those pieces 4

5 General Philosophy GEDI annotation is standoff data is included in a separate XML file, with the same name as the image. Zones are spatial locations relative to the upper left corner, that can have associated attributes Attributes are name/value pairs Several reserved attributes exist and are treated uniquely in GEDI. For example, the contents field is assumed to be a text and can be rendered over the zone RLEIMAGE represents the run length encoding of the image pixels within the zone 5

6 Files in GEDI There are several types of files that are referred to as a part of GEDI: 1. Document File A document can be an image which is being annotated. GEDI accepts TIFF, JPEG, BMP, and GIF image formats. 2. Ground Truth File An XML file containing GEDI formatted annotations is referred as a Ground Truth file. 3. Configuration file A task specific definition of a Zone types and attributes for a given annotation. A configuration file can be designed and distributed for a given annotation task, or will be created automatically as GEDI is configured through the interface. By default, the configuration file is named GEDIConfig.xml and saved in the same directory where Ground Truth files are located. 4. Properties file The properties file defines the setup and options currently used in the interface. The properties file is named GEDI.properties and stored in the config subfolder of the GEDI installation. 6

7 The GEDI INTERFACE Options panel: The menu panel is at the extreme left of the GEDI screen. It consists of the options such as File, Edit, etc. which in turn have more options which a user can access by clicking on any of these options. 7

8 GEDI INTERFACE Navigation toolbar: Navigation toolbar has options which have the same functionalities as some of the options present in the main options panel. It has options such as Select, Merge, Split, etc. which can be used just by clicking on the corresponding icons present on the toolbar. 8

9 GEDI INTERFACE File Selection: The table has all the files present in the current directory It also shows whether or not the present image is having XML data User has the option of viewing either the Image content or the XML content alone by clicking on the corresponding table columns 9

10 GEDI INTERFACE Zone type selection panel: This panel allows users to select zone type for annotation It actually shows the zone types defined by the user in the Preferences menu These zone types can be added/edited in Zones tab of the Preferences menu Attributes for the corresponding zone types can also be added/edited for a specific zone type with the preferences menu 10

11 GEDI INTERFACE Drawing types: GEDI has three shapes of Zones: Normal, Oriented and Polygon 11

12 GEDI INTERFACE Attributes panel: Attribute table shows attributes of one or more zones selected on the drawing panel Attributes are presented in the Attribute-Value format 12

13 GEDI INTERFACE Drawing panel: The main (center) part of the application is the panel for the loaded image to be ground truthed. Zones can be added and edited as per the requirement. On the toolbar there is an option for Zooming which can be used to adjust the image size PRESENT IMAGE 13

14 GEDI INTERFACE Search Bar: Search bar is used to find a particular image from the currently loaded directory Image can be searched by either typing the image name or image number in the Find Image box or Go to image # respectively. To simplify image search, the commonly used wildcards - the asterisk ( * ) and the question mark (? ) - can be used for the "Find image" option. Using the Goto Zone option, a zone can be searched by Zone ID Ctrl-F shortcut puts cursor to the Goto Zone box or opens the search bar if it is hidden Search bar 14

15 General parsing of image.xyz.xml: GEDI INTERFACE One of the features build into GEDI is the ability to group XML files with an intermediate extension with a given image. Suppose we have several XML files (FILENAME.XXX.XML, FILENAME.YYY.XML, etc.) associated with the image file (FILENAME.TIF) that represent, e.g., different steps of the ground truthing. The system will perform the grouping by the FILENAME basename extracted from the FILENAME.TIF so that the image and all XML files having the same basename will be combined together. In this way, intermediate results can be grouped and one does not have to replicate the image. Groupings are shown in the file list Groups can be collapsed/expanded with the (-) / (+) symbols 15

16 BASIC GEDI OPERATIONS I. Log In: To Log In GEDI, user has to double click on GEDI.jar or Run-GEDI.bat files. The bat file is typically used because it has special parameters to allocate additional memory These files are present in the GEDI folder which should be downloaded in order to start working on GEDI A pop up window appears giving options to select a username. To launch GEDI use Run GEDI button The User information is for tracking, and it is preserved in the output XML file Double click on any of these files to log in GEDI 16

17 II. Loading File/Directory: Use the icon on the toolbar or File->Load File/Directory menu item It will take user to the pop up window that has two browsing options: 1. Image File directory Using this option user can specify location of image(s) to be annotated 2. Data Directory User can specify the location of data directory to be uploaded, which can be different than Image directory. 3. If images and data files are in the same directory, select Use Image Location checkbox BASIC GEDI OPERATIONS 17

18 BASIC GEDI OPERATIONS Load GEDI configuration: A GEDI configuration file saves all the properties of an annotated document Load GEDI configuration option will allow users to select a configuration file already existing on their computer The configuration file (if it exists) located in the Data directory is loaded by default Shortcut: Alt-G Configuration file available to be loaded 18

19 BASIC GEDI OPERATIONS Image Loading Open the file/directory selection menu. This can be done either by clicking on the icon on the toolbar or by selecting the File->Load File/Directory menu item. Shortcut is Alt+O. If you want to load an individual file, you should select that specific file. To load an image directory, you should select the directory. If the directory you selected contains no images that can be opened with GEDI, you will see "No Selection" message in the file table on the left panel. 19

20 BASIC GEDI OPERATIONS Display GEDI allows you to either view just the image, view/edit the image with the XML data for it, or view/edit the data on a white background. To open the image together with the XML data, click on the image name. To open the image by itself, click on the "Image" column for the image. 20

21 BASIC GEDI OPERATIONS Viewing XML data: To view only XML data on the white background, click on the Xml column for the image. 21

22 BASIC GEDI OPERATIONS If no XML data is available If instead of a check mark, a red cross appears in the Xml column, this means that the image does not have any XML data associated with it 22

23 BASIC GEDI OPERATIONS Multi page TIFF GEDI supports multipage TIFF image loading If the image and/or data you are viewing is for a multipage TIFF, you can navigate the pages of the TIFF either by selecting the page number from the dropdown menu above the file table, or by using the 'Page Up' and 'Page Down' keys on the keyboard. 23

24 BASIC GEDI OPERATIONS Information Panel An information panel provides detailed information about the image currently opened, loaded Image and Data directories, user logged in, and other. 24

25 BASIC GEDI OPERATIONS Toolbars GEDI has two toolbars: 1. Navigation toolbar 2. Ground truth toolbar If any of these toolbars are checked then that particular toolbar will be available; otherwise it will be hidden With navigation toolbar checked in windows option, toolbar is available Without navigation toolbar checked in windows option, toolbar is not available 25

26 BASIC GEDI OPERATIONS Image Display: VIEW menu item gives users the options to either enlarge or reduce image size. Options available for zooming varies from 12.5%, 25%, 50%, 75%, 100%, 125%, 150%, 200%, 300%, 400%. There are two special options: 1. Fit to page width: this option will adjust the size of the image according to the width of the panel. 2. Fit to window: This option will adjust the size of the image in accordance with the size of the window. This is a shortcut panel for adjusting the image size 26

27 Text Display If a GEDI zone has a reserved CONTENTS attribute, the text contained in this attribute (attribute value) is displayed over the Zone. If Show text on all zones icon ( ) is ON, the content will be shown always for all zones having a text content. Otherwise the content will be displayed over the zone ONLY if the zone is selected Content display works with all UNICODE encoded text including R-L languages. See zone configuration for more information about the contents attribute BASIC GEDI OPERATIONS - Display 27

28 BASIC GEDI OPERATIONS Image Dragging: Enabling this option allows dragging the image without using the scrollbars. The default mouse cursor is changed to the hand cursor in this case. Enables Hand Bar 28

29 RLE (Run Length Encoding): When enabled, an RLE representation of a newly drawn region will be added as a reserved attribute for zone. RLE is for creation only. If a zone with RLE data is moved, the RLE will be regenerated See XML file for RLE representation BASIC GEDI OPERATIONS Text zone is drawn having RLE option enabled 29 Corresponding XML file showing pixels in the text Zone

30 BASIC GEDI OPERATIONS The RLE button on the command line will generate an RLE representation for an existing zone First picture shows the zones without using Generate RLEIMAGE option and the next one is after using this option. 30

31 BASIC GEDI OPERATIONS Connected Component (CC): This option automatically creates a separate zone for each connected component within the drawn region on the image. The region can be any of three available shapes: Normal, Oriented, or Polygon. This is only the operation for the zone creating, and it isn t activated on the zone editing. See example on the next slide 31

32 Example of using CC option Connected Component option Zone created using connected component option 32

33 GEDI DOCUMENTS Close Document Close Document option removes the selected image from the file list After close document option is used 33

34 GEDI DOCUMENTS Refresh document list Clicking on the File->Refresh Document List will update the file list bringing back the image which was previously removed using Close Document" option Save XML To save made changes to the current data file (XML) click on the File->Save XML menu item or on the icon on the toolbar Shortcut: Alt-S 34

35 GEDI DOCUMENTS Save XML as Use this option if you want to save the XML file for a corresponding image at a specific location Save profile as This option will save the current settings for the interface most of which can be changed with the Preferences menu item. Actually it prompts to save the GEDI.properties file at a specific location. Exit This option will close the software. On exit, GEDI saves the current Image and Data directories location. The next time user opens the application, these directories are loaded automatically. Shortcut: Alt-X 35

36 GEDI ZONES GEDI Zones are defined by an ID, zone type, and coordinates Zones may have optional user defined attributes Zones may have optional reserved attributes, that enable GEDI to process such zones in a specific way Example of GEDI Zone saved in the XML: <DL_ZONE gedi_type="picture" id="29" col="1260" row="2584" width="704" height="188" groupof="24;25" RLEIMAGE=""> </DL_ZONE> Zone types and their attributes are configured through the Edit->Preferences->Zones Tab 36

37 GEDI ZONES Creating a new Zone type: To create a new Zone type user needs to go the Zones tab of the Preferences menu Click on ADD TYPE button to create a new Zone type Similarly, to remove an already created Zone type, select that particular type in the table and hit the REMOVE TYPE button. Please note that all zones of this type will be deleted from all XML files in the currently loaded data directory. The system warns user before deleting zones. Click on ADD TYPE to create a new Zone type 37

38 GEDI ZONES After adding a new Zone type, double click on the cell in the NAME column to enter a name to the New Zone type To select a color to a Zone type, just single click on the cell in the COLOR column To assign a key to a Zone type, single click on the cell in the KEY column Zone visibility can be changed by a single click in the VISIBLE column Double click to change the name 38

39 GEDI ZONES kkds d Single click on the COLOR option to view the available options for allotting a color to a zone type 39

40 GEDI ZONES Single click on the cell in the KEY column to allot a shortcut key to a Zone type 40

41 GEDI ZONES Single click to change the Visibility allotted to a particular zone 41

42 GEDI ZONES Zone attributes allow to add specific information to a particular zone(s). Any string can be the value of an attribute, though the possible values for a particular attribute can be limited to a set of strings. Zone attributes are specific to a zone type. Zone attributes can be configured in the Zones tab of the Preferences menu. Zone type attributes Possible values Default value 42

43 GEDI ZONES Creating Groups: Groups are special zone types. A group-zone contains regular GEDI zones of the predefined types. Any existing type can be converted into group type and vice versa For creating Groups, user will have to open Zones tab of the Preferences menu To make one of the available types as a Group, select this type and click on the last column GROUP_OF A list of available types excluding the selected one will be displayed along with check boxes Select required type(s) User can create a group having one or more available types Once a group is formed, all the elements (zones) added to the group can be considered as a whole LOGO has been created as a group of TEXT and IMAGE 43

44 GEDI ZONES Adding and Removing Reserved attributes: Select any of the available Zone types and click on the ADD RESERVED button. Select a reserved attribute package. Currently GEDI has only one package: Textline Reserved attributes (contents, segmentation, and offsets) will be associated with that particular Zone type so that all zones of this type will have these attributes Similarly use the REMOVE RESERVED option to remove the reserved attributes Use these options to add or remove reserved attributes 44

45 GEDI ZONES Reserved attributes added to the Text zone type 45

46 GEDI ZONES Using Hotkeys to Set a Value for an Attribute (Zone): The system allows to set up the hotkey combinations to enter attribute value quickly for the select zone(s). To configure hotkeys, use the Zones tab of the Preferences menu. Hotkeys are always Ctrl + number. To set an attribute value for a particular zone, first select the zone, then press the hotkey combination Hotkeys table 46

47 PAGE ATTRIBUTE CONFIGURATION Page Attributes: Page attributes are attributes associated with the entire image or a particular page of the multipage TIFF Page attributes can be configured in the Page tab of the Preferences menu. Page attributes can be added and deleted in the same way as the zone attributes 47

48 PAGE ATTRIBUTES Using Hotkeys to Set a Value for a Page Attribute: Hotkey combinations can be set in the Page tab of the Preferences menu, and are always Alt + number. To quickly set a page attribute value, deselect zones if they are selected, then press the hotkey combination 48

49 ZONE CREATION Drawing and Annotating Zones The most important way to ground truth using GEDI is by drawing and annotating zones. A zone can be one of three shapes: normal (rectangle), oriented rectangle, or a polygon. A zone has a type, and if there are any attributes associated with the type, each zone of this type will have them but each zone can have its own values for those attributes. Different zone types may have different colors. Attributes associated with the highlighted Text zone. These attributes can be defined in the Preferences menu in the Zones tab. 49

50 ZONE CREATION Zones that have the Normal shape are rectangular with the orientation equals to 0 (zero) degrees. Drawing a Normal Zone To draw a normal zone, first press the "Normal" button in the left panel. Once the button is outlined in red, select a zone type from the list above To draw multiple normal zones of that type in a row, you can toggle on the draw mode by double clicking on the zone type If there is a hotkey associated with the zone type, you also can press the hotkey to toggle the draw mode. 50

51 ZONE CREATION Once the shape and zone type are selected, you can start drawing the zone pressing the left mouse button and dragging the mouse to any direction. While dragging, the zone width and height are changing. When you release the left mouse button, the zone is created If GEDI is in the toggled drawing mode, you can then draw more zones of the same shape and type. To turn off toggled drawing mode, you can click on the zone type name once, or press the hotkey for that zone type if there is one. To reset shape and zone type selection hit ESC. 51

52 ZONE CREATION Resizing a normal Zone: To resize a normal zone, first select the zone by clicking inside the zone or by dragging a box around it. A normal zone can be resized by either moving a side or a corner. Moving a side will change only the height or only the width of the zone. Moving the corner will change both at the same time. Move mouse over a side or a corner until the cursor changes. Then grab a side or a corner pressing the left mouse button. Drag the mouse to new location and release the left mouse button. The zone will be resized. Both height and width of a zone can be changed by moving the corner 52

53 ZONE CREATION Zones that have the Oriented shape are rectangular with the arbitrary orientation. The orientation is presented in degrees. Drawing an Oriented Zone To draw an oriented zone, first press the "Oriented" button in the left panel. Once the button is outlined in red, select a zone type for the new zone from the list above. To draw multiple oriented zones of that type in a row, you can toggle on the draw mode by double clicking on the zone type. If there is a hotkey associated with the zone type, you also can press the hotkey to toggle the draw mode. 53

54 ZONE CREATION Drawing an Oriented Zone: Oriented zones are created by drawing the top side first, then setting the width and height. Once the shape and zone type are selected, you can start drawing the top side by pressing the left mouse button at the start and then dragging the mouse to any direction. Release the left mouse button to fix zone width. Then, set zone height by moving the mouse above or below the created side. To finish zone creating, do single mouse click. 54

55 ZONE CREATION Rotating an Oriented Zone: To rotate an oriented zone, first select the zone by clicking inside the zone or by dragging a box around it. Move mouse over the handle until the cursor changes, and grab it by pressing the left mouse button. Drag the mouse until the zone is oriented the way you want it, and release the left mouse button. The size of the zone will not change. Move this handle to rotate an oriented zone 55

56 ZONE CREATION Resizing an Oriented Zone: To resize an oriented zone, first select the zone by clicking inside the zone or by dragging a box around it. An oriented zone can be resized by either moving a side or a corner. Moving a side will change only the height or only the width of the zone and moving the corner will change both at the same time. Move mouse over a side or a corner until the cursor changes. Then grab a side or a corner pressing the left mouse button. Drag the mouse to new location and release the left mouse button. The zone will be resized. Both height and width can be changed by moving this corner 56

57 ZONE CREATION Zones that have the Polygon shape are, well, polygons - the geometric figures bounded by arbitrary number of straight edges and vertices. The GEDI polygons don't have to be convex. Drawing a Polygon To draw a polygon, first press the "Polygon" button in the left panel. Once the button is outlined in red, select a zone type for the new zone from the list above. 57

58 ZONE CREATION Drawing a Polygon: Polygon zones are drawn by placing the vertices in order. Once the shape and zone type are selected, you can draw a polygon by clicking at each location you want a vertex. For the last vertex, double click to finish the shape. If GEDI is in toggled drawing mode, you can then draw more zones of the same shape and type. To turn off toggled drawing mode, you can click the zone type name once, or press the hotkey for that zone type if there is one. Draw a polygon by clicking at each location you want a vertex Double click when you are done with fixing all the vertices 58

59 ZONE CREATION Moving a vertex: To move a polygon vertex, first select the polygon by clicking inside the zone once or by dragging a box around it. Move mouse over a vertex until the mouse cursor changes and grab the vertex pressing the left mouse button. Drag the mouse to the new location and release the left mouse button. Select the polygon by clicking inside the zone once Moved vertex 59

60 Adding a Vertex To add a vertex to a polygon, first select the polygon by clicking inside the zone or by dragging a box around it. Hold the CTRL key, and move the mouse close to the side where you want the new vertex to be added. Once the side is highlighted, click the left mouse button once. A new vertex will be added between the two vertices of the highlighted side breaking the side into two edges. ZONE CREATION Highlighted side New vertex added 60

61 ZONE CREATION Deleting a Vertex To delete a polygon vertex, first select the polygon. Then, select the vertex that you want to delete by clicking on it. Once the vertex is selected, press the Delete key on the keyboard. Warning: if you select a polygon but don't select a vertex and press Delete, then the entire zone will be deleted. Select vertex which you want to delete & press the Delete key. After deleting vertex 61

62 Creating a Group: GROUP CREATION As described above, a group is a collection of other zones of particular types, defined on the configuration panel A group can be created as regular zone of normal shape: select Normal button on the left panel and select group type from the list above. The list of available group types are listed below the Groups label in that table. Draw the group-zone by the dragging a box around zones to be added to the group. One more way how to create a group is to highlight all zones you want to combine into the group and do right click on the main drawing panel. Select Group item from the popup menu. The group will be created, and all selected zone will be added to it. When a group is drawn, it encapsulates the zones and display a dashed box around the perimeter. To destroy the group, select the group-zone by clicking inside it. Then click the right mouse button to call the popup menu. Select Ungroup option then. The group can be moved as a unit, and moving any of the inside zones will resize the group. To add/delete a single zone to/from the existing group, select the group-zone (all inside zones will be highlighted), press SHIFT key, and click the left mouse button on the desired zone. It is easy to set the same attribute value for all group elements: select group-zone, open Elements tab on the attribute table (the left bottom table) and assign a value for the attribute. All zones of the group get this value. 62

63 GROUP CREATION LOGO group having the zones of IMAGE and TEXT types Group name Attributes of elements Elements present in the group (zones ID) 63

64 ZONE EDITING User can edit or make changes to a ground truthed document using options available in Edit menu Undo/Redo allows to undo/redo the last made change (Shortcuts: Ctrl-Z, Ctrl-Y) Copy and Paste options create new instance of the selected zone 64

65 ZONE SELECTION Select all Zones: Using File->Select all zones menu item or Ctrl-A shortcut, user can select all zones Logo zone Signature zone Text zone 65

66 ZONE SELECTION The example of the information table on multiple zone selection - Cells are gray if selected zones have different attribute value 66

67 ZONE EDITING Moving Multiple Zones: To move multiple zones at once, first select all of the zones that you want to move as: drag a box around them or hold SHIFT key on the keyboard and click on the zones sequentially. In this case you can select the scattered zones. Once the zones are selected, hold the SHIFT key and pressing the left mouse button drag the mouse to new location Release the mouse button 67

68 ZONE EDITING Changing a zone type: To change the type for a particular zone, first select the zone The zone type can be changed in the attributes table at the bottom of the left panel. The attribute that determines the zone type is named gedi_type. To change the zone type, click in the cell containing the current value of the gedi_type attribute. A list of possible zone types will appear, and you can choose a new type by clicking on it. To change the zone type, click in the cell containing the current value of the gedi_type attribute. 68

69 ZONE EDITING Deleting Zones: To delete a zone, select it and hit the Delete key Multiple selected zones can be deleted at once Select a zone by clicking on it and hit the Delete key 69

70 READING ORDER Create/Edit Reading Order: Reading Order is the ability to connect two words with the directed line establishing the order To toggle on the Reading Order Creating Mode, select File->Create/Edit Reading Order option, or click on the icon, or use Ctrl-O shortcut. To start reading order creating, click on the first zone in the reading order and then drag mouse to the next zone. Click once inside of that zone. The red directed line will be created connecting two zones. Continue to add zones to the reading order in the required sequence. To finish the reading order, double click on the last zone. To edit existing reading order, toggle on the Reading Order Creating Mode, then click on any zone participating in that order, and then connect this zone to new one To turn off the Reading Order Creating Mode, click on the icon on the toolbar or hit ESC. GEDI doesn t allow to have cyclic reading order It is possible to have more than one reading orders on the same document To show/hide the existing reading order, click on the icon on the toolbar. 70

71 THE EXAMPLE OF READING ORDER Reading Order Selected zone is highlighted 71

72 ZONE ATTRIBUTES Setting value of an attribute: To set a value for the attribute of a particular zone, first highlight the zone. The lowest table in the left panel will display the attribute names and values for the selected zone. Select the value you wish to change by clicking on the cell displaying it. You can then type in a new value for the attribute, or select the value from a drop down menu if a list of possible values is defined for that attribute. Not all attributes listed in the table can be changed directly in the table. 72

73 ZONE ATTRIBUTES lowest table in the left panel will display the attribute names and values for the selected zone. Select the zone by clicking inside it or by dragging a box around it. 73

74 ZONE ATTRIBUTES Select a attribute by clicking on the cell & select the value from a drop down menu 74

75 Setting the Value of a Page Attribute: PAGE ATTRIBUTES To set a value for the page attribute, deselect all zones or jump to a particular page if this is a multipage TIFF. The Page tab on the left bottom table will be selected. Change value for the attribute by typing in new value into the cell or from the drop down menu if a list of possible values is defined for that attribute. Not all attributes listed in the table can be changed directly in the table. Page attributes. Page tab is selected 75

76 GEDI MENU OPTIONS File menu options: File menu is at the extreme left of the top menu bar The top menu bar includes options that can be configured to assist you in ground truthing 76

77 Merge GEDI configuration: The option merges two configuration files (named GEDIConfig. Xml by default). It prompts to select another configuration file to be merged with the current one. The resulting configuration file is saved in the current Data directory and is loaded automatically right after the merge is done. Merging workspaces is non reversible Shortcut : Alt-M GEDI MENU OPTIONS File menu 77

78 GEDI MENU OPTIONS Create XML: The main function of the Create XML option is to create a blank XML file for the current image if it doesn t exist Normally, an XML file is automatically created and saved once a document is annotated Red cross indicates that the current document is not having XML content 78

79 GEDI MENU OPTIONS Create XML: After clicking on Create XML option, an empty XML file is created for the current document If user tries to create the XML content for an image that already has it then GEDI will pop up a message stating that "XML file for selected image is already existing" Green mark indicates that an empty XML file is created 79

80 GEDI MENU OPTIONS View/Edit/Refresh XML: To use these options, click the right mouse button on the image name in the left file table. Select one of these items: View, Edit, or Refresh XML item The raw XML will be opened in the default user s application for the viewing or editing If user edited the currently opened XML outside of GEDI, s/he can reload it using the Refresh XML option. Click on this option to view XML 80

81 GEDI MENU OPTIONS Document Capture: This option will create the screenshot of the loaded document including all drawn zones and save it in the Data directory with the *_dump.bmp name If user wants to save the screenshot in a specific location and/or with a specific name, s/he needs to turn off the option Document capture to default file in the Preferences menu 81

82 CAPTURED DOCUMENT 82

83 GEDI MENU OPTIONS Preferences menu options: 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. 83

84 OPTIONS IN PREFERENCES Preferences: The panel 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. Zones and Page tabs are reviewed above 84

85 OPTIONS IN PREFERENCES Auto save file changes When this option is selected, GEDI will automatically save the results of your actions to the document you are annotating, 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 to avoid accidental changes. 85

86 OPTIONS IN PREFERENCES Auto create Configuration file: When this option is selected, GEDI will automatically create a configuration file (GEDIConfig.xml) for any new directories that user opens. The configuration file is used to store the zone type and page settings, which can be specific to each directory. The configuration file is always saved in the Data directory. 86

87 OPTIONS IN PREFERENCES 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. 87

88 OPTIONS IN PREFERENCES Auto overwrite.overlay file: Checking this option will enable automatic overwriting of the.overlay file every time an operation is performed 88

89 OPTIONS IN PREFERENCES Enable profile loading on login: Enabling this option will allow to load configuration (GEDIConfig.xml) and properties (GEDI.properties) files on the login stage If this option is off, the login window will not have the option to load them See the next slide with examples 89

90 Example of Login window Profile loading is enabled Profile loading is disabled 90

91 OPTIONS IN PREFERENCES Display comments in separate window: GEDI has the ability to create comments during the annotation process It is possible to add a comment either to a particular zone or to a whole page Comments are stored in the Data directory in the XML format with *.cmt extension If the Display comments in separate window is selected, the comments will be shown in a separate window. Otherwise, they will appear at the bottom of the image See mode details about Commenting feature below 91

92 OPTIONS IN PREFERENCES Display content window on DLTextLine creation: DLTextLine is a special zone type. It has an attribute named "content" that is used to store the text data associated with the zone If Display content window on DLTextLine creation is selected, the text window pops up RIGHT AFTER zone drawing so that user is able to enter text content 92

93 OPTIONS IN PREFERENCES Show text on all zones: Using this option user can enable/disable showing the text content for all zones When this option is selected, the text content of non-selected zones will be always displayed over the boxes. Otherwise, the text content will be shown over the zone ONLY if the zone is selected This option can be also turned on/off using the icon on the toolbar See the next slide with examples 93

94 Examples With show text on all zones enabled With show text on all zones disabled 94

95 OPTIONS IN PREFERENCES Display 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. Note: the font size for the rendered text can be increased with Ctrl + '+' and decreased with Ctrl + '-'. 95

96 Examples Display zone type within zone disabled Display zone type within zone enabled K q ; 96

97 OPTIONS IN PREFERENCES Pseudo coloring by attribute: Using this functionality, user can distinguish different zones by pseudo color GEDI pseudo colors the zones by the attribute selected in this option All zones having this attribute get new color which is calculated based on the attribute VALUE Zones that have the same attribute value will have the same color All colors for zones with pseudocolor are equally dark If this option is off, zones have the color set up for their type 97

98 Example of pseudo colored zones 98

99 OPTIONS IN PREFERENCES Text Box Opacity (%): This slide bar allows users to adjust the Opacity of selected zones 99

100 Example. Text Box opacity is 20% 100

101 Example. Text Box opacity is 100% 101

102 OPTIONS IN PREFERENCES Use Directory name for input.txt file: This option is directly related to the above listed option Show text window If the Show text window is selected the Electronic Text Window will be available below the main panel where the image is loaded. Otherwise, the window will be hidden (see the next slide) When the Use directory name for input.txt file option is on, the electronic text will be read from the directoryname.txt and loaded into the Electronic Text Window When it is not selected, the electronic text will be read from the imagename.txt file where imagename is the name of current document 102

103 Example. Show text window option is available Electronic Text Window Selected zone is highlighted 103

104 GEDI SPECIAL FUNCTIONALITY Network Listener: Network Listener option is basically used whenever user wants a fast access to files which have already been annotated Network listener works with HTML file open in a browser so that user can click on a HTTP link directly from the browser. GEDI accepts and parses the request from the browser listening on a particular port (8000 by default) and performs appropriate operation based on the received commands HTTP links are paths to images, XML, or other files to be load with GEDI and must have well-defined format Network listener has different options/commands like open a particular image, immediately bring up a zone with the specific ID, load comment file, etc. See the next slides to get more information 104

105 Network Listener The HTTP link format used for Network listener: The Network listener supports the standard format of passing parameters and values: param1=value1&param2=value2&... operation is the specific command the Network listener accepts. The detailed list of all available commands is presented below The order in which the parameters are listed does not matter 105

106 Network Listener Commands currently used for the Network listener: openimage - opens the specified image with options for specifying xml, zone, and page number required parameters: imgpath optional parameters: xmlpath zoneid pagenum - only for multipage TIFF openxml - opens the specified xml file without changing the current image required parameters: xmlpath openconfig - opens the specified configuration file (GEDIConfig.xml) required parameters: configpath 106

107 Network Listener commands cont. openimagedir- opens the specified image directory with options for specifying xml directory required parameters: imgdirpath optional parameters: xmldirpath writelog - writes the given comment to the log for the current session required parameters: comment writemsg - writes the given comment to the log file location specified in GEDI required parameters: comment optional parameters: zoneid requestcommment - causes GEDI to pop up a comment entry window for the given image, xml, and zone optional parameters: imgpath xmlpath zoneid 107

108 Commenting Commenting and tracking feature allows users to mark zones with issues or questions Comments can be added to a particular zone or to a whole page and are stored in a separate file Comments in the interface are connected to pages/zones so that selecting a comment in the commenting interface causes the loading and highlighting the corresponding page or zone on the main screen. And vice versa, selecting a zone on the document results in the highlighting all comments added to that zone in the commenting interface. To add a comment, click the right mouse button on the current document and select Add/View Comments menu item. To add a comment to a specific zone, select the zone first and call the same option. The commenting window will be open; start typing text in the text field at the bottom. If the commenting interface is already open, just select a zone of interest on the main screen. The commenting interface dynamically recognizes what zone has been selected and invites you to add the comment to that zone highlighting all existing comments for it. The alternative way to add/view comments is to click the right mouse click on the document name on the left browse table and select Add/View Comments 108

109 Commenting. Continue. Comments can be NEW or ARCHIVED. The meaning of the fact that the comment is "archived" is application-dependent. For example in one scenario the comment may be marked "archived" when it is read by the supervisor. In another one the comments could signify actions requested, and the comment is marked "archived" when the request is taken care of When user adds a comment, the document icon ( ) becomes yellow indicating that the document has new comments. If there are no comments or all comments are archived for a document, its icon is green To delete comments for a document, select Delete Comments menu item on the right mouse click on the left browse table 109

110 Commenting examples. Two ways how to add comments. Right click to add comment 110

111 Commenting interface Comments for selected zone # 25 are highlighted Documents have new comments (yellow checkmarks) Commenting interface 111

112 Commenting interface in details Newest comments for selected zone 25 (in red) ALL comments for OPEN document are in light yellow Selected zone 25 and comments for it (in light blue) Turn this off to show only comments for open document Add new comment for selected zone 25 here 112

113 Commenting interface in details. Sorting absolute. Absolute sorting is the sorting within whole table. Example shows the sorting by Date. 113

114 Commenting interface in details. Advanced sorting. Advanced sorting (the Sorting absolute is off) is the sorting within a document. Example shows the sorting by Date. 114

115 Overlay Option Overlay option: Overlaying two or more annotated documents implies merging the zones of these documents and creating new single XML file with the.overlay. extension in the middle. E.g. myimage.overlay.xml This option can be useful if the same document was annotated differently (using different algorithms, e.g.) and you want to evaluate the differences by overlapping zones To use this option, select images on the left file table (it is possible to select contiguous or non-contiguous cells), then click the right mouse button on the images name and select Overlay Selected menu item To create.overlay file for all files with the same basename, select Overlay All 115

116 Overlay Option Without using overlay option 116

117 Overlay Option New.overlay document combining all zones of two documents is generated Zone overlapping New zone types are created automatically to distinguish what document a particular zone came from 117

118 Image rotation To rotate an image, use the rotation button on the toolbar Image is always rotated by 90 degrees The rotation button shows the current rotation angel GEDI does NOT save the rotated image but only rotates it for the rendering Zones coordinates are saved relative to the original (not rotated) image 118

119 Command line options GEDI can be run with command line parameters example: java jar GEDI.jar -help The list of available parameters -listener - the flag to load the following parameters via GEDI Network Listener -img <path> - load the image -xml <path> - load the specified XML for the image -imgdir <dir path> - load the directory with images -xmldir <dir path> - load the specified data directory for the images -zoneid <a number> - highlight the zone with this given ID -config <path> - load the specified configuration file (GEDIConfig.xml) -help print out this help 119

120 GEDI HELP Help menu has three basic options: 1. GEDI Help 2. Shortcut Keys 3. About DL-GEDIPro 120

121 GEDI HELP GEDI Help: GEDI Help is the advanced feature and provides capabilities for navigating, searching, displaying, and printing information about GEDI functionalities 121

122 SHORTCUT KEYS Shortcut Keys: Clicking on the Help->Shortcut Keys menu item will open up a new pop window which shows the list of all the short cut keys available with GEDI It includes fixed shortcut keys and directory-specific keys loaded from the current configuration file Clicking on Ok will close the window 122

123 ABOUT GEDI About GEDI: The GEDI version you are using and contact and person can be found on this panel 123

124 FUTURE WORK We are planning to add: The point and line data structures line consisting of any numbers of segments line structure could be not closed polygon Rendering XML file without image show all zones on a white background 124

125 For questions, comments, suggestions contact any member of the LAMP Laboratory or 125