Modules:Measurements-Documentation-3.6 - Revision history

Nicole: /* Quick Tour of Features and Use */

2010-04-29T17:03:46Z

Quick Tour of Features and Use

Kikinis: /* Quick Tour of Features and Use */

2010-04-25T18:07:07Z

Quick Tour of Features and Use

Nicole: /* Measurements */

2010-04-21T16:16:43Z

Measurements

Nicole: /* Use Cases, Examples */

2010-04-21T15:55:25Z

Use Cases, Examples

Nicole: /* Usage */

2010-04-21T15:44:55Z

Usage

Nicole: /* Quick Tour of Features and Use */

2010-04-16T23:56:58Z

Quick Tour of Features and Use

Nicole: /* Quick Tour of Features and Use */

2010-04-16T23:47:37Z

Quick Tour of Features and Use

Nicole: /* Quick Tour of Features and Use */

2010-04-16T23:46:24Z

Quick Tour of Features and Use

Nicole: /* Measurements */

2010-04-16T23:45:27Z

Measurements

Nicole: /* Quick Tour of Features and Use */

2010-04-16T21:33:37Z

Quick Tour of Features and Use

@@ Line 112: / Line 112: @@
 *****1 decimal
 *****2 decimals
-****Angle Annotation Format: how to display the angle annotation, use string formatting strings, %g for an auto formatted floating point, %.2f to show two decimal places. Any text is allowed after the numerical specification. The angle is in degrees.
+****Angle Annotation Format: how to display the angle annotation, use string formatting strings, %g for an auto formatted floating point, %.2f to show two decimal places. Any text is allowed after the numerical specification. The angle is in degrees. Please see the following [http://www.cplusplus.com/reference/clibrary/cstdio/sprintf/ link] for more info about formatting options.
 ****Angle Annotation Scale: how large to render the angle annotation text
 |[[Image:Slicer3.6MeasurementsAngleGUI.jpg|thumb|280px|Angle User Interface]]

@@ Line 83: / Line 83: @@
 *****2 decimals
 *****Scientific Notation
-****Distance Annotation Format: how to display the distance annotation, use string formatting strings, %g for an auto formatted floating point, %.2f to show two decimal places. Any text is allowed, defaults to mm (millimeters).
+****Distance Annotation Format: how to display the distance annotation, use string formatting strings, %g for an auto formatted floating point, %.2f to show two decimal places. Any text is allowed, defaults to mm (millimeters). Please see the following [http://www.cplusplus.com/reference/clibrary/cstdio/sprintf/ link] for more info about formatting options.
 ****Distance Annotation Scale: how large to render the distance annotation text
 |[[Image:Slicer3.6MeasurementsRulerGUI.jpg|thumb|280px|Ruler User Interface]]

@@ Line 10: / Line 10: @@
 |[[Image:Slicer3.6MeasurementsRulerGUI.jpg|thumb|280px|Measurements: Ruler GUI]]
 |[[Image:Slicer3.6MeasurementsAngleGUI.jpg|thumb|280px|Measurements: Angle GUI]]
-|[[Image:Slicer3.5MeasurementsRulersModel.jpeg|thumb|280px|Using a ruler to measure between points on a model]]
+|[[Image:Slicer3.6MeasurementsRulersModel.jpg|thumb|480px|Using a ruler to measure between points on a model, and an angle to measure between points on a model]]
 |}

@@ Line 47: / Line 47: @@
 Examples of the module in use:
-* Example 1: Place two fiducial points, press Control-m to create a new ruler between the fiducials and delete the fiducials.
+* Example 1: Place two fiducial points, press Control-m to create a new ruler between the fiducials, and then the two fiducials.are deleted. A name can be given to add to the ruler annotation text. Uses the last two selected fiducials of the active fiducial list.
 * Example 2: Attach/constrain end points of the widgets to volume slices to measure distances and angles between image features.
 * Example 3: Attach/constrain end points of the widgets to models to measure distances and angles between 3D structures.

@@ Line 31: / Line 31: @@
 == Usage ==
 In order to get the end points of the ruler or the angle to move along a selected model surface, you currently need to rotate the view so that the handle is rendered on top of the model, the next click will snap it to the model surface. If you move the model or slice plane, the measurement point won't move with it, the constraint only works when moving the end point handle. If you make the model or slice invisible, the end point cannot be moved, as the constraint will always be false.
@@ Line 45: / Line 47: @@
 Examples of the module in use:
-* Example 1:  Attach/constrain end points of the widgets to volume slices to measure distances and angles between image features.
+* Example 1: Place two fiducial points, press Control-m to create a new ruler between the fiducials and delete the fiducials.
-* Example 2: Attach/constrain end points of the widgets to models to measure distances and angles between 3D structures.
+* Example 2: Attach/constrain end points of the widgets to volume slices to measure distances and angles between image features.
 ===Tutorials===

@@ Line 93: / Line 93: @@
 **'''Modify Selected Angle Node panel:'''
 ***Angle Node Select: create a new angle node, show the parameters of a previously created angle node, delete or rename an angle
-***Toggle Visibility: if checked, this angle is visible, if not, this angle is invisible.
+***Angle: the angle between the rays of the current ruler, updated as the end points move. In degrees.
-***Position 1 and Position 2 and Center: angle end point and center positions, updates when the angle handles are moved in 3D or 2D, and can be used to update the points by typing in a value.
+***The next three rows of widgets refer to the three end points that make up the angle, first, center, second:
-***'''Constrain Angle To Models:'''
+****Set End Point Color: set the colour used to show the angle end point
-****Select Angle Model 1 and 2 and Center: constrain the motion of the angle end points to be on the surface of the selected model or volume slice plane. In order to get the end points of the angle to move along a selected model surface, you currently need to rotate the view so that the handle is rendered on top of the model, the next click will snap it to the model surface. If you move the model or slice plane, the measurement point won't move with it, the constraint only works when moving the end point handle. If you make the model or slice invisible, the end point cannot be moved, as the constraint will always be false.
+****Constraint: constrain the motion of the angle end points to be on the surface of the selected model or volume slice plane. In order to get the end points of the angle to move along a selected model surface, you currently need to rotate the view so that the handle is rendered on top of the model, the next click will snap it to the model surface. If you move the model or slice plane, the measurement point won't move with it, the constraint only works when moving the end point handle. If you make the model or slice invisible, the end point cannot be moved, as the constraint will always be false.
 ***'''Display Options:'''
-****Set End Point Color: set the colour used to show the angle end points
+****Visibility: if the eye is open, this angle is visible, if it is closed, this angle is invisible. Click on it to toggle the state.
-****Set Line Color: set the colour used to show the angle lines
+****Line Color: set the color used to show the angle lines
-****Toggle Ray 1 Visibility: if checked, show the ray from the first end point to the center
+****Text Color: set the color used to show the angle annotation text
-****Toggle Ray 2 Visibility: if checked, show the ray from the second end point to the center
+****Ray visibility: toggle visibility for the two rays that make up the angle. If the eye is open, this ray is visible, if it is closed, this ray is invisible. Click on it to toggle the state. The first ray is from the first point to the center point, the second ray is from the second point to the center point.
-****Toggle Arc Visibility: if checked, show the arc between the two angle arms.
+****Arc Visibility: If the eye is open, show the arc between the two angle arms. If it is close, the arc is invisible. Click on it to toggle the state.
-****Angle Annotation Format: how to display the angle annotation, use string formatting strings, %g for an auto formatted floating point, %.2f to show two decimal places. Any text is allowed after the numerical specification.
+****Arc Color: set the color used to show the arc between the rays.
 ****Angle Annotation Scale: how large to render the angle annotation text
 |[[Image:Slicer3.6MeasurementsAngleGUI.jpg|thumb|280px|Angle User Interface]]

@@ Line 62: / Line 62: @@
 ***Select the visibility of all ruler nodes. Set all rulers invisible or set all rulers visible.
 ***Delete all ruler nodes from the scene.
-***Generate Report: saves basic information about all rulers in the scene to a file on disk (distance, position, annotation)
+***Generate Report: saves basic information about all rulers in the scene to a file on disk (distance, position, annotation). If a CSV (comma separated value) format is chosen, the information is separated by commas, if .txt is chosen, the information is separated by tabs.
 **'''Modify Selected Ruler Node panel'''
 ***Ruler Node Select: create a new ruler node, show the parameters of a previously created ruler node, delete or rename a ruler node