Annotations

From OKOS Wiki
Jump to navigation Jump to search

Annotations are measurements, indicators, and other tools used to display information about the image for use in reporting or presentations. Annotations, once established, will be saved with the collection. Annotations can be added and deleted at any time, and can be set to span multiple features.

Annotations are keyed to the feature on which they are created, and thus will not be visible on other features unless otherwise configured.

Types of Annotations

Area

An area annotation is a simple box that shows a starting position, width/height, and the area covered by the annotation (in physical units). An Area annotation can also be displayed in "Circular Area" (e.g. Oval) mode, where the region describes the bounds of an oval instead. The Area bounded by the annotation will adjust accordingly.

Area Annotation
Area Annotation in "Circular Area" mode

The starting position will match the setting of Absolute Units option on the Image Toolbar.

If an Area annotation is used on a RTG Map, the information displayed will also include the Percentage of delamination (e.g. Phase Inversion) found on in the selected area.


Arrow

Arrow Annotation pointing at a section of Delamination.

An arrow annotation can be used to point at a feature of interest. Both sides of the arrow can be moved as needed.

Frame

Frame annotation

A Frame annotation is a box within a box, that measures the area between the boxes (the "Frame"). Like an Area annotation, this will will display a start point, Width/Height and an Area, in physical units.

Also like an Area annotation, the Frame can be displayed as Circular regions instead of a box.

The frame will exclude the "Center" region from most calculations (such as Cluster Analysis).


Grid

Grid Annotation with three rows and four columns

Note: this should not be confused with the Reference Grid option.

A Grid annotation allows the user to create an n by m array of regions on a part. When using Cluster Analysis or Threshold calculations, each region will be analyzed separately. This is useful for analyzing a scan of a regular array of parts.

A user can add rows and columns to the grid, and also adjust the row and column dimensions individually if needed.


Marker

Marker annotations


Polygon

Polygon annotation

A polygon is a free-form object with multiple vertices. To create a polygon, click on the polygon tool and then click on the image until all vertices are created. When you click near the original point, the polygon will be complete.

The polygon will show the location of the first point and the area contained within the region.

Once created, individual points can be moved by clicking with the left mouse button on the Grip point and dragging the mouse. The Polygon can be rotated by left-clicking on one of the Rotational Grip points (identified by a circle drawn within the Grip point), and moving the mouse up/down or left/right.


Ruler

Ruler annotation

A ruler shows a distance between points in physical units. The ruler can be oriented in any direction. The text box containing the result can be moved independently from the ruler, but will maintain a constant distance from it.

When resizing the ruler, if the "Shift" key is held down at the same time, the ruler will "lock" at 0, 15, 30, 45, 60, 75, and 90 degree angles.


Text

Text annotation

To create a Text annotation, click on the Text button of the Image Toolbar, then double-click on the image where you wish the text to be. The user can type in any text required.

To edit a Text annotation, simply double-click on the annotation again.


Creating Annotations

The major Annotation tools

Annotations are created by selecting an image window and clicking on the appropriate tool on the Image Toolbar. For most annotations, click and hold on the image with the left mouse button, then drag the mouse to size the annotation. There are exceptions:

  • For the Text tool, double-click with the left mouse button to generate the text.
  • For the Marker tool, click once with the left mouse button and then release.
  • For the Polygon tool, click with the left mouse button until the area of interest is completely surrounded, then click near the original point to complete the shape.

Some annotations can be accessed directly on the Image window, if enabled via the "Show Annotation Tools on Image" button.


Moving and Resizing Annotations

Area annotation with Grip Points highlighted in red

Each annotation has Grip points, representing by small squares along the borders of the object. By clicking with the left mouse button and dragging these points, the user can move or resize the annotation. All grip points become visible when the user moves the mouse cursor over any grip point region. Not all annotations have the same number of Grip points.

Some Grip points are distinguished by an "X" (such as in area or rectangle annotations): this indicates a region that is to be used for moving the annotation without changing its size.

For annotations that include text (or are text in the case of the Text annotation), the text boxes can be moved individually by dragging them with the left mouse button. They stay associated with the parent annotation, and will be moved if the parent is moved.

Markers and Text boxes are their own Grip points.

The Polygon tool contains four extra Grip points that can be used to rotate the annotation 360o. These can be identified by the circle contained within the Grip Point.

Resizing via the Dimensions Tool

Shape annotations such as Area, Frame, and Grid can be resized using the Dimensions dialog box. This allows a user to specify specific lengths in physical units. The annotation will be resized to the closest approximation of the desired dimensions (given the resolution of the parent image).

Location of the Dimensions tool on the annotation popup menu
Annotation dimensions dialog.


Changing Annotation Properties

Named Area annotation with the colors and line width changed.

The Annotations Menu

By Right-clicking on an annotation Grip Point, a menu of options for the annotation will be displayed.

Copy/Paste

The user can copy an annotation by using the Copy/Paste menu items.

Delete

The user can delete an annotation through the menu. This is the same as selecting the annotation and pressing the "Delete" key.

Color

The user can change the color of the annotation using this option. the Fore color changes the annotation itself. If the annotation includes text, the Back Color of the text box can also be changed.

Font

If the annotation includes text, the font of the text can be changed to any available Windows font using a standard Font dialog.

Line Width

The thickness (in pixels) of the lines used to draw the annotation can be changed between 1 and 5.

Name

An annotation can be given a user-customizable name. For annotations that include text, the name will be added as part of the text display.

Show On All

If "Show on All" is checked, the selected annotation will appear on all features of the selected channel as the user pages among them. If not, the annotation is only visible on the feature in which it was created.

An annotation can be set to appear on all features by using the "Global Annotations Show Across Channels" Configuration option.

Hide Details

If checked, any text that is displayed with the annotation will be hidden (with the exception of Text annotations). Unchecking this item will restore the details.

This option applies to all annotations and will persist between ODIS sessions.

Set as Default

If this menu item is selected, the current settings for the type of annotation will be stored as Default settings. Thus, the next time the user creates the same type of annotation, its default thickness, colors, and font will be set based on the new Default.

The default settings apply only to the selected annotation type, and will persist between ODIS sessions.

Loading and Saving Annotations

Annotations are automatically saved when the collection is saved. The user will be prompted to save the collection upon closing if annotations are changed, added, or deleted.

Note: if the "Ignore Annotations When Saving" Configuration option is enabled, changes to annotations will be ignored.

To store a set of annotations for re-use in a later collection, use the "Save Annotations to File" button on the Image Toolbar. This will save a file with the extension ".ann.xml"

To load the saved annotations into another collection, use the "Load Annotations from File" button on the Image Toolbar.

If the collection to which you are loading annotations is not scanned at the same resolution or does not have the same features, your saved annotations may not be visible. Annotations are keyed to the feature in which they were created. Be sure to transfer annotations only between collections that have similar scan configurations.

The set of annotations saved with a collection as "ScanAnnotations.xml" can be directly loaded through the "Load Annotations to File."

See Also: ODIS Raw File Format

Annotations and Exports

When exporting image data, annotations are only visible if saving in "Form" mode. Annotations will not be saved on Raw Data exports.

Deleting Annotations

to delete an annotation, select it with the left mouse button, then do either of the following:

  • Hit the "Delete" key on the keyboard to remove the annotation
  • right-click on one of the grip points and select the "Delete" menu item.

Once an annotation is removed and the collection data resaved, it cannot be restored and must be re-created.

Using Annotations

Measurement

Cluster Analysis

See Cluster Analysis

Reporting