Documentation/4.1/Developers/IO - Revision history

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

2013-06-14T07:22:48Z

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

Finetjul: /* How to add support for reading a new file format ? */

2012-08-22T22:48:13Z

How to add support for reading a new file format ?

Finetjul at 02:51, 21 August 2012

2012-08-21T02:51:32Z

Finetjul: Created page with '=Read= == Main classes == * `vtkSlicerXYZNode` is a [[http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Libs/MRML/Core/vtkMRMLStorableNode.h?view=markup storabl…'

2012-08-21T02:00:49Z

Created page with '=Read= == Main classes == * <code>vtkSlicerXYZNode</code> is a [[http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Libs/MRML/Core/vtkMRMLStorableNode.h?view=markup storabl…'

New page

=Read=
== Main classes ==
* <code>vtkSlicerXYZNode</code> is a [[http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Libs/MRML/Core/vtkMRMLStorableNode.h?view=markup storable node]] that represents the data from file (e.g. [[http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Libs/MRML/Core/vtkMRMLModelNode.h?view=markup vtkMRMLModelNode]])
* <code>vtkSlicerXYZStorageNode</code> is the file reader. It populates the storable node using the method <code>vtkMRMLXYZStorageNode::ReadData(vtkMRMLStorableNode*,bool)</code>.
* <code>vtkSlicerXYZsLogic</code> is the MRML logic of the <code>XYZ</code> module. It exposes a convenient method <code>AddXYZ(const char* fileName, const char* nodeName=0);</code> that creates a MRML XYZ node (<code>vtkMRMLXYZNode</code>)and its associated storage node (<code>vtkMRMLXYZStorageNode</code>), add them into the scene, and call <code>vtkMRMLXYZStorageNode::ReadData(vtkMRMLStorableNode*,bool);</code> on the storage node to load the file. If the loading fails, it removes the previously created nodes from the scene.
* <code>qSlicerXYZsIO</code> is a plugin that is registered by modules into the <code>qSlicerCoreIOManager</code>. It is the interface between Qt and MRML logics. It internally calls <code>vtkSlicerXYZsLogic::AddXYZ</code>().
* <code>qSlicerXYZsIOOptionsWidget</code> is a widget that sets loading options that gets passed to the logic.
* <code>qSlicerCoreIOManager</code> is the central class where any IO operation must go through. qSlicerIOs can be registered using <code>qSlicerCoreIOManager::registerIO(qSlicerIO*)</code> and nodes can be loaded using <code>qSlicerCoreIOManager::loadNodes(...)</code>. It exposes a set of convenient methods such as "what reader must be used for what file".
* <code>qSlicerDataDialog</code> is the dialog that allows the user to select the files to load.

== ModifiedSinceRead ==
In order to inform the user what data has been changed since it was last read, a ModifiedSinceRead mechanism is in place to track when was the file last read and when was the data last modified. If a modification happened , the storable node <code>vtkMRMLStorableNode::GetModifiedSinceRead()</code> must return true. If the data in the node is the same as in the file, then <code>vtkMRMLStorableNode::GetModifiedSinceRead()</code> must return false.

<code>vtkMRMLStorageNode</code> keeps track of when a file was last read or written (<code>vtkTimeStamp* vtkMRMLStorageNode::StoredTime</code>). <code>vtkMRMLStorableNode</code> keeps track of when the data was last modified (<code>vtkTimeStamp vtkMRMLStorableNode::StorableModifiedTime</code>). Anytime a <code>vtkMRMLStorableNode</code> property that is saved in file is modified, the <code>StorableModifiedTime</code> time stamp must be modified.

At exit time (<code>qSlicerMainWindow::closeEvent()</code>), <code>vtkMRMLStorableNode::GetModifiedSinceRead()</code> is called to check if the data in the node is the same as in the file or if it has been modified after the file was last read or written. It internally checks <code>vtkTimeStamp* vtkMRMLStorageNode::StoredTime</code> and <code>vtkTimeStamp vtkMRMLStorableNode::StorableModifiedTime</code>. If the data is more recent, then a message dialog is shown to the user telling him that some data is different from file; leaving without saving will loose the changes.

==How to add support for reading a new file format ?==
# Write method <code>vtkMRMLXYZStorageNode::ReadDataInternal(vtkMRMLStorableNode*, bool temporary);</code>
# Write method <code>vtkMRMLXYZsLogic::AddXYZ(const char* fileName, const char nodeName =0);</code>
# Write class <code>qSlicerXYZsIO</code>
# Optional: Write class <code>qSlicerXYZsIOOptionsWidget</code> if you want the user to optionally specify loading options.
# In <code>qSlicerXYZsModule::setup()</code>, instantiate and register <code>qSlicerXYZsIO</code> to <code>qSlicerCoreIOManager</code>
# Add file format to [Documentation/{{documentation/version}}/SlicerApplication/SupportedDataFormat|SupportedDataFormat] wiki page

=Write=
The mechanism is very similar to '''Read'''.

=IO Dialogs=
By default, all the IOs must be done through <code>qSlicerDataDialog</code> for reading files and <code>qSlicerSaveDataDialog</code> for writting files. However, due to historical reasons, it is possible to have custom dialogs for each node types.

← Older revision		Revision as of 07:22, 14 June 2013
Line 1:		Line 1:
		+	<noinclude>{{documentation/versioncheck}}</noinclude>
	=Read=		=Read=
	[[Image:IOOverview.png\|600px\|center]]		[[Image:IOOverview.png\|600px\|center]]

@@ Line 17: / Line 17: @@
 # In <code>qSlicerXYZsModule::setup()</code>, instantiate and register <code>qSlicerXYZsIO</code> to <code>qSlicerCoreIOManager</code>
 # Add file format to [Documentation/{{documentation/version}}/SlicerApplication/SupportedDataFormat|SupportedDataFormat] wiki page
 == ModifiedSinceRead ==

@@ Line 1: / Line 1: @@
 =Read=
 == Main classes ==
-* <code>vtkSlicer<i>XYZ</i>Node</code> is a [[http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Libs/MRML/Core/vtkMRMLStorableNode.h?view=markup storable node]] that represents the data from file (e.g. [[http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Libs/MRML/Core/vtkMRMLModelNode.h?view=markup vtkMRMLModelNode]])
+* <code>vtkSlicer<i>XYZ</i>Node</code> is a [http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Libs/MRML/Core/vtkMRMLStorableNode.h?view=markup storable node] that represents the data from file (e.g. [[http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Libs/MRML/Core/vtkMRMLModelNode.h?view=markup vtkMRMLModelNode])
 * <code>vtkSlicer<i>XYZ</i>StorageNode</code> is the file reader. It populates the storable node using the method  <code>vtkMRML<i>XYZ</i>StorageNode::ReadData(vtkMRMLStorableNode*,bool)</code>.
 * <code>vtkSlicer<i>XYZ</i>sLogic</code> is the MRML logic of the <code>XYZ</code> module. It exposes a convenient method <code>AddXYZ(const char* fileName, const char* nodeName=0);</code> that creates a MRML <i>XYZ</i> node (<code>vtkMRML<i>XYZ</i>Node</code>)and its associated storage node (<code>vtkMRML<i>XYZ</i>StorageNode</code>), add them into the scene, and call <code>vtkMRML<i>XYZ</i>StorageNode::ReadData(vtkMRMLStorableNode*,bool);</code> on the storage node to load the file. If the loading fails, it removes the previously created nodes from the scene.
@@ Line 8: / Line 9: @@
 * <code>qSlicerCoreIOManager</code> is the central class where any IO operation must go through. qSlicerIOs can be registered using <code>qSlicerCoreIOManager::registerIO(qSlicerIO*)</code> and nodes can be loaded using <code>qSlicerCoreIOManager::loadNodes(...)</code>. It exposes a set of convenient methods such as "what reader must be used for what file".
 * <code>qSlicerDataDialog</code> is the dialog that allows the user to select the files to load.
 == ModifiedSinceRead ==
@@ Line 16: / Line 25: @@
 At exit time (<code>qSlicerMainWindow::closeEvent()</code>), <code>vtkMRMLStorableNode::GetModifiedSinceRead()</code> is called to check if the data in the node is the same as in the file or if it has been modified after the file was last read or written. It internally checks <code>vtkTimeStamp* vtkMRMLStorageNode::StoredTime</code> and <code>vtkTimeStamp vtkMRMLStorableNode::StorableModifiedTime</code>. If the data is more recent, then a message dialog is shown to the user telling him that some data is different from file; leaving without saving will loose the changes.
-==How to add support for reading a new file format ?==
+== Example ==
-# Write method <code>vtkMRMLXYZStorageNode::ReadDataInternal(vtkMRMLStorableNode*, bool temporary);</code>
+* Models
-# Write method <code>vtkMRMLXYZsLogic::AddXYZ(const char* fileName, const char nodeName =0);</code>
+** [http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Libs/MRML/Core/vtkMRMLModelNode.h?view=markup Libs/MRML/Core/vtkMRMLModelNode]
-# Write class <code>qSlicerXYZsIO</code>
+** [http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Libs/MRML/Core/vtkMRMLModelStorageNode.h?view=markup Libs/MRML/Core/vtkMRMLModelStorageNode]
-# Optional: Write class <code>qSlicerXYZsIOOptionsWidget</code> if you want the user to optionally specify loading options.
+** [http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Modules/Loadable/Models/Logic/vtkSlicerModelsLogic.h?view=markup Modules/Loadable/Models/Logic/vtkSlicerModelsLogic]
-# In <code>qSlicerXYZsModule::setup()</code>, instantiate and register <code>qSlicerXYZsIO</code> to <code>qSlicerCoreIOManager</code>
+** [http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Modules/Loadable/Models/qSlicerModelsIO.h?view=markup Modules/Loadable/Models/qSlicerModelsIO]
-# Add file format to [Documentation/{{documentation/version}}/SlicerApplication/SupportedDataFormat|SupportedDataFormat] wiki page
+** [http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Modules/Loadable/Models/qSlicerModelsModule.h?view=markup Modules/Loadable/Models/qSlicerModelsModule]
 =Write=
-The mechanism is very similar to '''Read'''.
+The mechanism is similar to '''Read'''. <code>vtkMRMLXYZStorageNode::WriteDataInternal(...)</code> and <code>qSlicerXYZWriter</code> must implemented.
 =IO Dialogs=
 By default, all the IOs must be done through <code>qSlicerDataDialog</code> for reading files and <code>qSlicerSaveDataDialog</code> for writting files. However, due to historical reasons, it is possible to have custom dialogs for each node types.

Documentation/4.1/Developers/IO - Revision history

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

Finetjul: /* How to add support for reading a new file format ? */

Finetjul at 02:51, 21 August 2012

Finetjul: Created page with '=Read= == Main classes == * vtkSlicerXYZNode is a [[http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Libs/MRML/Core/vtkMRMLStorableNode.h?view=markup storabl…'

Finetjul: Created page with '=Read= == Main classes == * `vtkSlicerXYZNode` is a [[http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Libs/MRML/Core/vtkMRMLStorableNode.h?view=markup storabl…'