Documentation/Nightly/Developers/Units - Revision history

UpdateBot: Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887

2013-06-14T08:01:20Z

Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887

Johan.andruejol at 21:05, 28 May 2013

2013-05-28T21:05:36Z

Johan.andruejol: /* Customization */

2013-05-28T18:04:58Z

Customization

Johan.andruejol: /* In the GUI */

2013-05-28T18:04:24Z

In the GUI

Johan.andruejol: /* In the GUI */

2013-05-27T21:25:40Z

In the GUI

Johan.andruejol: /* In logic/nodes */

2013-05-27T21:24:30Z

In logic/nodes

Johan.andruejol: /* Unit Nodes */

2013-05-27T21:24:10Z

Unit Nodes

Johan.andruejol: /* Selection Node */

2013-05-27T21:22:40Z

Selection Node

Johan.andruejol: /* Settings */

2013-05-27T21:22:03Z

Settings

Johan.andruejol: /* Settings */

2013-05-27T21:21:51Z

Settings

← Older revision		Revision as of 08:01, 14 June 2013
Line 1:		Line 1:
		+	<noinclude>{{documentation/versioncheck}}</noinclude>
	= Slicer Units Overview =		= Slicer Units Overview =

@@ Line 17: / Line 17: @@
 == Unit Nodes ==
 vtkMRMLUnitNode are singleton and '''NOT''' saved in the scene. They have the following properties:
-* '''Name''': The name describes the unit itself. For example, the name of a length unit can be Milimetre, Metre, CentiMetre... Setting the node's name also sets the node's singleton tag.
+* '''Name''': The name describes the unit itself. For example, the name of a length unit can be Millimeter, Meter, Centimeter... Setting the node's name also sets the node's singleton tag.
 * '''Quantity''': This properties is an attribute so it can be observed by the GUI. It describes what types of unit it is. For example the quantity of second and day is time.
 * '''Precision''': Describes the number of digit used after the comma. For example a precision of 2 gives 12.00 and -13.61.

← Older revision		Revision as of 18:04, 28 May 2013
Line 55:		Line 55:
	In the case where one doesn't want all the parameters of its spinbox controled by the current unit node, one can choose which properties will be updated by setting the ''unitAwareProperties'' flag.		In the case where one doesn't want all the parameters of its spinbox controled by the current unit node, one can choose which properties will be updated by setting the ''unitAwareProperties'' flag.

−	[[Image:qMRMLSpinBoxInTheDesigner.png\|~~400px~~\|qMRMLSpinBox in the designer]]	+	[[Image:qMRMLSpinBoxInTheDesigner.png\|600px\|qMRMLSpinBox in the designer]]

← Older revision		Revision as of 18:04, 28 May 2013
Line 47:		Line 47:
	* qMRMLRangeWidget		* qMRMLRangeWidget

−	~~They~~ derive directly from their CTK counterpart and only add two methods. ''SetMRMLScene()'' (which is expected for a ''qMRMLWidget'') so they can observe the selection node ''UnitModifiedEvent'' ~~and the property named~~ "quantity". Setting this property (''setQuantity()'') tells the widget what kind of unit node it should refer to. If a unit node with such quantity is default in the application, the widget will automatically update its minimum value, maximum value, single step, decimals, prefix and suffix according to the unit node.	+	=== Quantity ===
		+	These widget derive directly from their CTK counterpart and only add two methods.
		+	*''SetMRMLScene()'' (which is expected for a ''qMRMLWidget'') so they can observe the selection node ''UnitModifiedEvent''
		+	*The "quantity" property. Setting this property (''setQuantity()'') tells the widget what kind of unit node it should refer to. If a unit node with such quantity is default in the application, the widget will automatically update its minimum value, maximum value, single step, decimals, prefix and suffix according to the unit node.
		+
		+	=== Customization ===
		+	In the case where one doesn't want all the parameters of its spinbox controled by the current unit node, one can choose which properties will be updated by setting the ''unitAwareProperties'' flag.
		+
		+	[[Image:qMRMLSpinBoxInTheDesigner.png\|400px\|qMRMLSpinBox in the designer]]

← Older revision		Revision as of 21:25, 27 May 2013
Line 47:		Line 47:
	* qMRMLRangeWidget		* qMRMLRangeWidget

−	They derive directly from their CTK counterpart and only add two methods. ''SetMRMLScene()'' (which is expected for a ~~qMRML widget~~) so they can observe the selection node ''UnitModifiedEvent'' and the quantity ~~property~~. Setting this property (''setQuantity()'') tells the widget what kind of unit node it should refer to. If a unit node with such quantity is default in the application, the widget will automatically update its minimum value, maximum value, single step, decimals, prefix and suffix according to the unit node.	+	They derive directly from their CTK counterpart and only add two methods. ''SetMRMLScene()'' (which is expected for a ''qMRMLWidget'') so they can observe the selection node ''UnitModifiedEvent'' and the property named "quantity". Setting this property (''setQuantity()'') tells the widget what kind of unit node it should refer to. If a unit node with such quantity is default in the application, the widget will automatically update its minimum value, maximum value, single step, decimals, prefix and suffix according to the unit node.

@@ Line 37: / Line 37: @@
+     }
-If an unit needs to be accessed multiple times (very unlikely), then one can observe the selection nodes ''vtkMRMLSelectionNode::UnitModifiedEvent''.
+If a unit needs to be accessed multiple times (very unlikely), then one can observe the selection nodes ''vtkMRMLSelectionNode::UnitModifiedEvent''.
 == In the GUI==

@@ Line 16: / Line 16: @@
 == Unit Nodes ==
-The vtkMRMLUnitNode are singleton and '''NOT''' saved in the scene. They have the following properties:
+vtkMRMLUnitNode are singleton and '''NOT''' saved in the scene. They have the following properties:
-* '''Name''': The name describes the unit itself. For example the name of a length unit can be Milimetre, Metre, CentiMetre... Setting the node's name also sets the node's singleton tag.
+* '''Name''': The name describes the unit itself. For example, the name of a length unit can be Milimetre, Metre, CentiMetre... Setting the node's name also sets the node's singleton tag.
-* '''Quantity''': This properties is an attribute so it can be observed by the GUI. It describes what types of unit it is. For example second and day's quantity is time.
+* '''Quantity''': This properties is an attribute so it can be observed by the GUI. It describes what types of unit it is. For example the quantity of second and day is time.
-* '''Precision''': Describes the number of digit used after the comma. For example a precision of 2 gives 12.00 and -13.61
+* '''Precision''': Describes the number of digit used after the comma. For example a precision of 2 gives 12.00 and -13.61.
-* '''Prefix/Suffix''': The unit abbreviation/text displayed respectively before and after the unit.
+* '''Prefix/Suffix''': Abbreviation/text displayed respectively before and after the unit.
 * '''Minimum Value/Maximum Value:''' Range of value allowed for the unit. For example, the minimum for the Kelvin value would be 0.

@@ Line 12: / Line 12: @@
 == Selection Node ==
-In order to propagate the unit in the application easily, access methods were added to the selection so it could stores the information regarding the current unit for a given quantity.
+In order to propagate units in the application easily, access methods were added to the selection so it could stores the information regarding the current unit for a given quantity.
-These methods are based the reference role of the ''vtkMRMLNode''. The signal ''vtkMRMLSelectionNode::UnitModifiedEvent'' was added to the selection node so the application could be updated when an unit is modified/added/removed.
+These methods are based on the reference role of the ''vtkMRMLNode''. The signal ''vtkMRMLSelectionNode::UnitModifiedEvent'' was added to the selection node so the application could be updated when a unit is modified/added/removed.
 == Unit Nodes ==

@@ Line 9: / Line 9: @@
 = Architecture =
 == Settings ==
-Right now, there are two quantities supported (time and length). For each of these, there is an associated unit node which properties are saved in the settings. The unit nodes are not saved with the scene, they just are settings.
+Right now, there are two quantities supported (time and length). For each of these, there is an associated unit node which properties are saved in the settings. These unit nodes are not saved with the scene, they just are settings.
 == Selection Node ==