Adding MRML - Revision history

Klawson: /* Undo/Redo Mechanism */

2007-06-17T22:27:35Z

Undo/Redo Mechanism

2007-06-17T22:27:24Z

Creating Custom MRML Node Classes

2007-06-17T22:27:09Z

MRML Events and Observers

2007-06-17T22:26:40Z

References to MRML Nodes

2007-06-17T22:25:44Z

MRML Nodes

2007-06-17T22:25:04Z

MRML Scene

2007-06-17T22:24:23Z

Adding in MRML to Slicer

2007-06-17T21:58:06Z

MRML API Documentation

2007-06-17T21:57:46Z

Path-based MRML proposal

2007-06-17T21:56:49Z

History

@@ Line 98: / Line 98: @@
   –By user request: use vtkSlicerNodeSelectorWidget that creates a new node from the module’s UI.
-= Undo/Redo Mechanism =
+=== Undo/Redo Mechanism ===
 *Undo/Redo is based on saving and restoring the state of MRML nodes in the Scene.

@@ Line 78: / Line 78: @@
 *ProcessMRMLEvents method should be implemented in MRML nodes, Logic, and GUI classes in order to process events from the observed nodes.
-= Creating Custom MRML Node Classes=
+=== Creating Custom MRML Node Classes===
 *Custom MRML nodes provide persistent storage for the module parameters.
@@ Line 96: / Line 96: @@
 *To add node to the MRML scene:
   –In the code: use standard vtk New() and add node to the scene using vtkMRMLScene::AddNode(vtkMRMLNode *)
   –By user request: use vtkSlicerNodeSelectorWidget that creates a new node from the module’s UI.
 = Undo/Redo Mechanism =

@@ Line 60: / Line 60: @@
 |}
-= MRML Events and Observers =
+=== MRML Events and Observers ===
 *Use vtk AddObserver() and InvokeEvent() methods. vtk SetMacro generates ModifiedEvent.
 *The command-observer mechanism for MRML is implemented using  helper vtkObserverManager, class, MRML Observer macros, and ProcessMRMLEvents method.

@@ Line 50: / Line 50: @@
 |}
-= References to MRML Nodes =
+=== References to MRML Nodes ===
 *Use vtkSetReferenceStringMacro to set reference ID (it registers reference with the scene).
 *Access methods should check if the referenced node is still in the MRML scene using its ID.

@@ Line 14: / Line 14: @@
 * Undo/Redo mechanism that restores a previous state of the scene and individual nodes.
-= MRML Nodes =
+=== MRML Nodes ===
-*The MRML nodes are designed to store the state of the Slicer application, both raw data and visualization parameters.
+The MRML nodes are designed to store the state of the Slicer application, both raw data and visualization parameters. The following is a set of core MRLN nodes that store the state of core Slicer modules:
 * vtkMRMLCameraNode
@@ Line 47: / Line 45: @@
 <br />
-*MRML nodes are organized into C++ class hierarchies, all derived from vtkMRMLNode class.
+MRML nodes are organized into C++ class hierarchies, all derived from vtkMRMLNode class. For example vtkMRMLTransformableNode is the parent class of Volume, Model, Fiducial, and Transformation nodes; vtkVolumeNode is a parent of vtkMRMLScalarVolumeNode and vtkMRMLVectorVolumeNode. All MRML nodes have to implement certain standard API: ReadAttributes, WriteAttributes, Copy, etc.
 {|
 |[[Image: Slicer3_MRML_Node_Hier.jpg|thumb|400px]]

@@ Line 7: / Line 7: @@
 Slicer MRML data model is implemented independent of the visualization and algorithmic components of the system. Other Slicer components (Logic and GUI) observe changes in the MRML scene and individual nodes and process change MRML events
-= MRML Scene =
+=== MRML Scene ===
-*MRML Scene manages MRML nodes : add, delete, find, find by type, etc.
+MRML Scene manages MRML nodes : add, delete, find, find by type, etc. It also provides
-*MRML Scene provides persistence of MRML nodes (reading/writing to/from XML file).
-*MRML  Scene provides Undo/Redo mechanism that restores a previous state of the scene and individual nodes.
+* persistence of MRML nodes (reading/writing to/from XML file), and
 = MRML Nodes =

@@ Line 1: / Line 1: @@
 = Adding in MRML to Slicer =
-*MRML Library provides API for managing medical image data types (Volumes, Models, Transforms, Fiducials, Cameras, etc) and their visualization. Aull. [[Media: Slicer 3_MRML.ppt|Click here]] for a slide presentation on MRML.
+MRML is the scene description used in Slicer and maps to its data model. The MRML Library provides an API for managing medical image data types (volumes, models, transforms, fiducials, cameras, etc) and their visualization. Aull. [[Media: Slicer 3_MRML.ppt|Click here]] for a slide presentation on MRML.
-*Within MRML, each data type is represented by a special MRML node. A collection of nodes is a MRML scene.
-*Slicer MRML data model is implemented independent of the visualization and algorithmic components of the system.
+Within MRML, each data type is represented by a special MRML node. A collection of nodes is a MRML scene.
-*Other Slicer components (Logic and GUI) observe changes in the MRML scene and individual nodes and process change MRML events.
 = MRML Scene =

← Older revision		Revision as of 21:58, 17 June 2007
Line 135:		Line 135:

	The detailed documentation of MRML API can be found in [http://www.na-mic.org/Slicer/Documentation/Slicer3/html/classes.html <nowiki> Slicer3 Doxygen pages</nowiki>]		The detailed documentation of MRML API can be found in [http://www.na-mic.org/Slicer/Documentation/Slicer3/html/classes.html <nowiki> Slicer3 Doxygen pages</nowiki>]
−
−
−
−

	== Slicer Daemon ==		== Slicer Daemon ==

← Older revision		Revision as of 21:57, 17 June 2007
Line 138:		Line 138:


−	~~== Path-based MRML proposal ==~~

−	~~Mike's proposal for a [[Slicer3:MRML3_Path\|path-based MRML3 representation]], based on extending the Coordinate Space Manager ideas to the entire MRML3 tree~~

	== Slicer Daemon ==		== Slicer Daemon ==

← Older revision		Revision as of 21:56, 17 June 2007
Line 136:		Line 136:
	The detailed documentation of MRML API can be found in [http://www.na-mic.org/Slicer/Documentation/Slicer3/html/classes.html <nowiki> Slicer3 Doxygen pages</nowiki>]		The detailed documentation of MRML API can be found in [http://www.na-mic.org/Slicer/Documentation/Slicer3/html/classes.html <nowiki> Slicer3 Doxygen pages</nowiki>]

−	~~== History ==~~

−	~~See Data Model notes in [[AHM_2006:ProjectsSlicerDataModel\|AHM 2006 Programming week project]].~~

	== Path-based MRML proposal ==		== Path-based MRML proposal ==