Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The Annotations tool provides a small set of tools designed to help you measure your image while you are in the 2D view. You can access a set of manual drawing tools for defining regions and lines on the image. The Annotations tool will measure the dimension of the drawn shape along with its intensity (if available).

Interface

The Annotations tool is one of the six tabs that are found in the Content panel on the bottom of the Aivia window. The Annotations tool interface is shown below.

Image Removed

Annotations GUI

There are two sections, the data table and the line profiler, highlighted in red and blue above respectively. Each section has its own toolbar that controls the functions related to the given section.

Panel

On this page:

Table of Contents
maxLevel3
exclude[4]

Data table

The data table contains the measurement data of all manual annotations on the image. Each column represents a different measurement while each row represents a different annotation region. The data table toolbar contains a number of tools and options for interacting with the data table. The toolbar is shown below:

Image Removed

Description and function for each tool are summarized in the table below:

NameIconDescriptionLine tool

Image Removed

Toggles the straight line tool for measuring distance between two pointsFreehand region tool

Image Removed

Toggles the freehand region tool for measuring the area and dimension of a drawn regionRectangular ROI tool

Image Removed

Toggles the rectangular ROI tool for measuring the area and dimension of a drawn rectangleAngle tool

Image Removed

Toggles the angle measurement tool for measuring the angle between two drawn segmentsCopy selected data

Image Removed

Copies the selected row in the data table to the clipboardAnnotation options

Image Removed

Toggles the Annotations options pop-upDisplay filter

Image Removed

Filters the data table display by annotation type

Line profiler

When you create a manual annotation using the Line tool, the Line Profiler section will become active and plot the intensity value on the image along the line on the first channel on the image. The toolbar for the line profiler is shown below:

Image Removed

The function for each item is summarized in the table below:

NameIconDescriptionExport chart image 

Image Removed

Saves the displayed line profiler chart as a snapshot imageCopy chart image to clipboard

Image Removed

Copies the displayed line profiler chart as a snapshot image to the clipboardExport chart data

Image Removed

Exports the line profiler data to an Excel spreadsheet

Using annotations

To launch the Annotation tool, click on the Annotations Image Removed button below the image panel in Aivia. This will open the Annotations tool interface.

Draw annotations

Click on the icons on the toolbar in the Annotations panel to select the tools. There are four (4) drawing tools that corresponds to four different types of annotations:

Annotation typeIconMethod of interactionExample (Click to expand)Line

Image Removed

Left-click on the image once to define the start of the line; move your cursor and click on the image again to define the end point

Image Removed

Freehand region

Image Removed

Hold down the left mouse button while moving your cursor to trace the desired region; to finish the region, release the mouse button

Image Removed

Rectangular ROI

Image Removed

Left-click on the image once to define the starting coordinate of the ROI; move your cursor and click on the image again to define the opposing coordinates

Image Removed

Angle

Image Removed

Left-click on the image once to define the start of the first segment; move your cursor and click on the image again to define the end point of the first segment; move your cursor again and click on the image for a third time to define the end point of the second segment.

Image Removed

The drawn annotations will be overlaid on the image and show across all time frames of an image sequence. The annotations will be overlaid on the image when you export the image to snapshot or to a movie.

View measurements

A new entry will be added to the Annotations data table along with the relevant measurements for the selected annotations type. In the data table, multiple measurements are shown at once. The list of available measurements by annotation type is summarized in a table in the next section.

When you hover the mouse cursor over the drawn annotations, a tooltip appears with measurement for the given annotation type (see right). The tooltip measurement shown are as follows:

  • Line: length
  • Freehand region: area
  • Rectangular ROI: area
  • Angle: angle (in degrees)

Select annotations

After drawing an annotation manually, it will be selected automatically on the image as well as in the data table in the Annotations panel. To select another annotation, click on the display overlay on the image or on the desired row in the table. You can select multiple annotations by holding down the Shift or Ctrl key while left-clicking on the annotations.

The selected annotation will be highlighted with a thicker and brighter outline. For freehand regions and rectangular ROIs, a bounding box is also displayed allowing you to adjust the size of the region by dragging the anchors on the bounding box.

Delete annotations

You can delete an annotation by selecting the annotation you wish to remove and press the Delete key on your keyboard or clicking the Remove annotations Image Removed icon in the data table.

Alternately, you can delete the annotation by right-clicking on the annotation and selecting the Remove annotation option in the context menu (see below).

Image Removed
Annotations tooltip and bounding box

Context menu options

When you right-click on a drawn annotation, a context menu appears next to your mouse cursor (see right). The context menu has five (5) options and their functions are summarized below:

OptionFunction descriptionCopy annotationCopies the selected annotations to clipboardPaste annotationPastes the copied annotation in the clipboard at the origin (upper left corner) of the imagePast annotation herePastes the copied annotation in the clipboard at the position of the cursorSelect frame range

Opens the select copy range dialog (see below) that lets you specify the time frame for the overlay to be shown

Image Removed

Remove annotationDeletes the selected annotation from the image and the data table

Image Removed

Annotations context menu

Filter display

You can filter the annotation data table by types of annotations by clicking on the dropdown menu next to Filter in the toolbar and selecting the annotations you wish to see. There are six (6) filter options:

  • All show all annotation types in the data table
  • Lines show only line annotations
  • Freehands show only freehand region annotations
  • ROIs show only rectangular ROI region annotations
  • Angles show only angle annotations
  • Regions show region-based annotations, or both freehand regions and rectangular ROI regions.

The table refreshes automatically to display only the specified type and hide all others. The annotation overlay on the image is not affected by this option.

Using line profiler

The line profiler is located to the right of the annotation data table. The tool lets you view the intensity changes along a drawn segment on the image.

When you manually draw an annotation using the line tool, the line profiler display will refresh automatically to show the intensity profile along the drawn segment (see right).

If you have more than one line

The Annotations tool provides a small set of tools designed to help you measure your image while you are in the 2D view. You can access a set of manual drawing tools for defining regions and lines on the image. The Annotations tool will measure the dimension of the drawn shape along with its intensity (if available).


Interface

The Annotations tool is one of the six tabs that are found in the Content panel on the bottom of the Aivia window. The Annotations tool interface is shown below.

Image Added

Annotations GUI

There are two sections, the data table and the intensity profiler, highlighted in red and blue above respectively. Each section has its own toolbar that controls the functions related to the given section.


Panel

On this page:

Table of Contents
maxLevel3
exclude[4]



Data table

The data table contains the measurement data of all manual annotations on the image. Each column represents a different measurement while each row represents a different annotation region. The data table toolbar contains a number of tools and options for interacting with the data table. The toolbar is shown below:

Image Added

Description and function for each tool are summarized in the table below:

NameIconDescription
Line tool

Image Added

Toggles the straight line tool for measuring distance between two points
Freehand region tool

Image Added

Toggles the freehand region tool for measuring the area and dimension of a drawn region
Rectangular ROI tool

Image Added

Toggles the rectangular ROI tool for measuring the area and dimension of a drawn rectangle
Angle tool

Image Added

Toggles the angle measurement tool for measuring the angle between two drawn segments
Copy selected data

Image Added

Copies the selected row in the data table to the clipboard
Annotation options

Image Added

Toggles the Annotations options pop-up
Display filter

Image Added

Filters the data table display by annotation type




Intensity profiler


Line

When you create a manual annotation using the Line tool, the Intensity Profiler section will become active and plot the intensity value on the image along the line of the first selected channel of the image.

Area (Freehand region or ROI (rectangle))

When you create a manual annotation using the Freehand region or ROI (rectangle) tool, the Intensity Profiler section will become active and plot a Histogram or (if the image is a 3D or time series) a stack profile of the intensity values on the image within the area of the first selected channel of the image.


The toolbar for the intensity profiler is shown below:

Image Added

The function for each item is summarized in the table below:

NameIconDescription
Export chart image 

Image Added

Saves the displayed intensity profiler chart as a snapshot image.
Copy chart image to clipboard

Image Added

Copies the displayed intensity profiler chart as a snapshot image to the clipboard.
Export chart data

Image Added

Exports the intensity profiler data to an Excel spreadsheet.

Switch Histogram / Stack profile (3D or time series only)

Image Added

Switches between histogram and stack profile if stack profile is available (3D or time series only).
Logarithmical scale (Histogram only)

Image Added

Plots counts (y-axis) of histogram logarithmically to enhance visibility of smaller counts (Histogram only).




Using annotations

To launch the Annotation tool, click on the Annotations Image Added button below the image panel in Aivia. This will open the Annotations tool interface.



Draw annotations

Click on the icons on the toolbar in the Annotations panel to select the tools. There are four (4) drawing tools that corresponds to four different types of annotations:

Annotation typeIconMethod of interactionExample (Click to expand)
Line

Image Added

Left-click on the image once to define the start of the line; move your cursor and click on the image again to define the end point

Image Added

Freehand region

Image Added

Hold down the left mouse button while moving your cursor to trace the desired region; to finish the region, release the mouse button

Image Added

Rectangular ROI

Image Added

Left-click on the image once to define the starting coordinate of the ROI; move your cursor and click on the image again to define the opposing coordinates

Image Added

Angle

Image Added

Left-click on the image once to define the start of the first segment; move your cursor and click on the image again to define the end point of the first segment; move your cursor again and click on the image for a third time to define the end point of the second segment.

Image Added

The drawn annotations will be overlaid on the image and show across all time frames of an image sequence. The annotations will be overlaid on the image when you export the image to snapshot or to a movie.


View measurements

A new entry will be added to the Annotations data table along with the relevant measurements for the selected annotations type. In the data table, multiple measurements are shown at once. The list of available measurements by annotation type is summarized in a table in the next section.

When you hover the mouse cursor over the drawn annotations, a tooltip appears with measurement for the given annotation type (see right). The tooltip measurement shown are as follows:

  • Line: length
  • Freehand region: area
  • Rectangular ROI: area
  • Angle: angle (in degrees)

Select annotations

After drawing an annotation manually, it will be selected automatically on the image as well as in the data table in the Annotations panel. To select another annotation, click on the display overlay on the image or on the desired row in the table. You can select multiple annotations by holding down the Shift or Ctrl key while left-clicking on the annotations.

The selected annotation will be highlighted with a thicker and brighter outline. For freehand regions and rectangular ROIs, a bounding box is also displayed allowing you to adjust the size of the region by dragging the anchors on the bounding box.

Delete annotations

You can delete an annotation by selecting the annotation you wish to remove and press the Delete key on your keyboard or clicking the Remove annotations Image Added icon in the data table.

Alternately, you can delete the annotation by right-clicking on the annotation and selecting the Remove annotation option in the context menu (see below).



Image Added
Annotations tooltip and bounding box


Context menu options

When you right-click on a drawn annotation, a context menu appears next to your mouse cursor (see right). The context menu has five (5) options and their functions are summarized below:

OptionFunction description
Copy annotationCopies the selected annotations to clipboard
Paste annotationPastes the copied annotation in the clipboard at the origin (upper left corner) of the image
Past annotation herePastes the copied annotation in the clipboard at the position of the cursor
Select frame range

Opens the select copy range dialog (see below) that lets you specify the time frame for the overlay to be shown

Image Added

Remove annotationDeletes the selected annotation from the image and the data table



Image Added

Annotations context menu



Filter display

You can filter the annotation data table by types of annotations by clicking on the dropdown menu next to Filter in the toolbar and selecting the annotations you wish to see. There are six (6) filter options:

  • All show all annotation types in the data table
  • Lines show only line annotations
  • Freehands show only freehand region annotations
  • ROIs show only rectangular ROI region annotations
  • Angles show only angle annotations
  • Regions show region-based annotations, or both freehand regions and rectangular ROI regions.

The table refreshes automatically to display only the specified type and hide all others. The annotation overlay on the image is not affected by this option.



Image Removed
Line intensity profile chart

Using intensity profiler

The intensity profiler is located to the right of the annotation data table. The tool lets you view the intensity changes along a drawn segment on the image, along a stack (3D or time series) or the histogram of counts vs intensity.

Line Profile

When you manually draw an annotation using the line tool, the intensity profiler display will refresh automatically to show the intensity profile along the drawn segment (see right).

If you have more than one line annotation drawn on the image, you can select a different line profile to display by clicking on the segment on the image or selecting the annotation in the data table. The intensity profiler display will refresh automatically to show the intensity trace of the selected line.

Adjust measurement radius

You can include additional pixels adjacent to the drawn line for plotting the intensity profile by changing the Line measurement radius option in Annotation options (see below). The line profiler will include extra pixels on either side of the drawn line specified by the value and average their intensities to update the plot.

Stack Profile (3D or time series only)

When you manually draw an annotation using the Freehand or ROI (rectangle) tool on a 3D image or a time series, the intensity profiler display will refresh automatically to show the intensity profile along the stack within the drawn area (see right). A bar within the chart will show you the position of the currently selected image within the stack.

Histogram

When you manually draw an annotation using the Freehand or ROI (rectangle) tool, the intensity profiler display will refresh automatically to show the intensity histogram within the drawn area (see right). You may switch between logarithmical and regular scaling of the y-axis (counts) to enhance visibility of lower counts.


If you have more than one area annotation drawn on the image, you can select a different line stack profile or histogram to display by clicking on the segment on the image or selecting the annotation in the data table. The line intensity profiler display will refresh automatically to show the intensity trace / histogram of the selected linearea.

Export intensity profile

The toolbar above the line intensity profiler lets you save and export the displayed intensity profile chart as an image or as raw data.

Adjust measurement radius

You can include additional pixels adjacent to the drawn line for plotting the intensity profile by changing the Line measurement radius option in Annotation options (see below). The line profiler will include extra pixels on either side of the drawn line specified by the value and average their intensities to update the plot.

Image Removed
Drawn segment on the image



Image Added
Line profile


Image Added

Stack profile (bar indicating

position within the stack)


Image Added Image Added

Histogram (normal and logarithmical)


Annotation options

Annotation options window gives you the ability to customize the display of the annotations. You can launch the window by clicking on the Options Image Modified icon (see below, right). The dialog has two tabs which allows you to control different aspects of the annotation display, they are:

  • Measurements tab lets you add intensity measurements to the annotations data table
  • Display tab lets you customize the color of the annotations

To confirm the changes you have made and to close the Annotations Options window, click Finish; or to close the window without updating, click Cancel.



Measurements

You can add intensity measurements to the data table using the Annotation Options dialog by clicking on the checkbox next to the name of the intensity measurement.

The measurements that are available for each annotation type are summarized in the table below:

Measurement name

 Line

Freehand region

Rectangular ROI

Angle

Length(tick)(error)(error)(error)
Height(tick)(tick)(tick)(error)
Width(tick)(tick)(tick)(error)
Area(tick)(tick)(tick)(error)
Centroid (X, Y)(tick)(tick)(tick)(error)
Angle(error)(error)(error)(tick)
Mean intensity(tick)(tick)(tick)(error)
Standard Deviation of intensity(tick)(tick)(tick)(error)
Total intensity(tick)(tick)(tick)(error)
Min intensity(tick)(tick)(tick)(error)
Max intensity(tick)(tick)(tick)(error)
Median intensity(tick)(tick)(tick)(error)

For line measurements, you can include additional adjacent pixels for calculating the intensity measurements by specifying the Line measurement radius value in the Annotation options dialog.



Image Modified

Annotations options (Measurements tab)



Display

In the Display tab of Annotation options, you can customize the color of the annotations (see right). To change the color, click on the color box associated with the option you wish to change. This will bring up the color picker which will allow you to choose from a standard palette of available colors. Click Finish to confirm your changes and close the Annotation options window.

The display options are grouped by annotation types and changing the option will apply the color changes to all annotations of the same type. The options are as follows:

Option nameAnnotation types affectedDescriptions
Fill opacityFreehand region, rectangular ROIAdjusts the opacity of the filled region, with 0 being fully opaque and 1 being fully transparent
Line colorLine, angleSpecifies the color of the straight line segments of the affected annotations
Border colorFreehand region, rectangular ROISpecifies the color of the border, or edge of the regions
Fill colorFreehand region, rectangular ROISpecifies the color of the fill in the region, the actual color reproduction may be different depending on the fill opacity chosen
Theta colorAngleSpecifies the color of the angle display between the segments



Image Modified

Annotation options (Display tab)



Filter by label (Content by label)
showLabelsfalse
max5
spacescom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@836
showSpacefalse
sortmodified
reversetrue
typepage
cqllabel in ( "measurements" , "spreadsheet" , "data-export" ) and type = "page" and space = "AW"
labelsrecipe-console image_analysis


Page Properties
hiddentrue


Related issues