Difference between revisions of "Modules:Measurements-Documentation-3.6"
(4 intermediate revisions by 2 users not shown) | |||
Line 10: | Line 10: | ||
|[[Image:Slicer3.6MeasurementsRulerGUI.jpg|thumb|280px|Measurements: Ruler GUI]] | |[[Image:Slicer3.6MeasurementsRulerGUI.jpg|thumb|280px|Measurements: Ruler GUI]] | ||
|[[Image:Slicer3.6MeasurementsAngleGUI.jpg|thumb|280px|Measurements: Angle GUI]] | |[[Image:Slicer3.6MeasurementsAngleGUI.jpg|thumb|280px|Measurements: Angle GUI]] | ||
− | |[[Image:Slicer3. | + | |[[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 31: | Line 31: | ||
== Usage == | == Usage == | ||
+ | |||
+ | A ruler can be created between fiducial points by pressing Control-m . | ||
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. | 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: | Examples of the module in use: | ||
− | * Example 1: | + | * 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 | + | * 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. | ||
===Tutorials=== | ===Tutorials=== | ||
Line 80: | Line 83: | ||
*****2 decimals | *****2 decimals | ||
*****Scientific Notation | *****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 | ****Distance Annotation Scale: how large to render the distance annotation text | ||
|[[Image:Slicer3.6MeasurementsRulerGUI.jpg|thumb|280px|Ruler User Interface]] | |[[Image:Slicer3.6MeasurementsRulerGUI.jpg|thumb|280px|Ruler User Interface]] | ||
Line 109: | Line 112: | ||
*****1 decimal | *****1 decimal | ||
*****2 decimals | *****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 | ****Angle Annotation Scale: how large to render the angle annotation text | ||
|[[Image:Slicer3.6MeasurementsAngleGUI.jpg|thumb|280px|Angle User Interface]] | |[[Image:Slicer3.6MeasurementsAngleGUI.jpg|thumb|280px|Angle User Interface]] |
Latest revision as of 17:03, 29 April 2010
Home < Modules:Measurements-Documentation-3.6Return to Slicer 3.6 Documentation
Measurements
Measurements
General Information
Module Type & Category
Type: Interactive
Category: Base
Authors, Collaborators & Contact
- Nicole Aucoin (3D): BWH
- Steve Pieper (2D): BWH
- Karthik Krishnan and Will Schroeder: Kitware
- Contact: Nicole Aucoin, nicole@bwh.harvard.edu
Module Description
The Measurements module allows you to add rulers and angle widgets to the scene and they will be displayed and able to be manipulated in both the 3D and 2D windows.
Usage
A ruler can be created between fiducial points by pressing Control-m .
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.
When you add a new angle or affine transform widget, you have to click once in the 3D window to render the transform widget, and three times to place the angle widget end points. After that, you can move the widgets around by dragging the handles.
Use Cases, Examples
This module is especially appropriate for these use cases:
- Use Case 1: Useful for measuring tumor diameters.
- Use Case 2: Measuring angles between bones.
Examples of the module in use:
- 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.
Tutorials
Links to tutorials explaining how to use this module:
- Tutorial 1: coming soon
Quick Tour of Features and Use
|
|
Development
Notes from the Developer(s)
- This module was added at version 3.5, and expanded at version 3.6, and it will not work unless Slicer3 is compiled with VTK5.6 or higher.
Dependencies
No other modules or packages are required for this module's use.
Tests
On the Dashboard, these tests verify that the module is working on various platforms:
- vtkMRMLMeasurementsNodeTest1 vtkMRMLMeasurementsNodeTest1.cxx
- vtkMRMLMeasurementsAngleNodeTest1 vtkMRMLMeasurementsAngleNodeTest1.cxx
- vtkMRMLMeasurementsRulerNodeTest1 vtkMRMLMeasurementsRulerNodeTest1.cxx
Known bugs
Links to known bugs in the Slicer3 bug tracker:
Usability issues
Follow this link to the Slicer3 bug tracker. Please select the usability issue category when browsing or contributing.
Source code & documentation
Documentation generated by doxygen:
- vtkMeasurementsGUI
- vtkMeasurementsLogic
- vtkMeasurementsDistanceWidgetClass
- vtkMeasurementsAngleWidgetClass
- vtkMRMLMeasurementsNode
- vtkMRMLMeasurementsRulerNode
- vtkMRMLMeasurementsAngleNode
More Information
Acknowledgment
This work is part of the National Alliance for Medical Image Computing (NAMIC), funded by the National Institutes of Health through the NIH Roadmap for Medical Research, Grant U54 EB005149.