Documentation/Labs/ParameterSerializer - Revision history

Johan.andruejol: /* TODO */

2016-09-09T18:38:00Z

TODO

Johan.andruejol: /* TODO */

2016-09-09T18:36:08Z

TODO

JChris.FillionR at 21:16, 9 August 2016

2016-08-09T21:16:26Z

Johan.andruejol at 20:21, 9 August 2016

2016-08-09T20:21:13Z

Johan.andruejol: Created page with "== Overview == This page gathers the information regarding the integration of the Parameter Serializer. == Limitations of the current infrastructure == * The only way to se..."

2016-08-09T19:08:14Z

Created page with "== Overview == This page gathers the information regarding the integration of the Parameter Serializer. == Limitations of the current infrastructure == * The only way to se..."

New page

== Overview ==

This page gathers the information regarding the integration of the Parameter Serializer.

== Limitations of the current infrastructure ==

* The only way to serialize CLIs is through the MRML scene, it's hard to save the configuration of just one CLI.
* When running a CLI with the command line, you have to specify all the arguments that are not default. It would be nice to be able to use a file instead.

== Proposed improvements ==

By adding support for the [https://github.com/Slicer/ParameterSerializer/tree/master/cmake Parameter Serializer] users would be able to save(/load) their
CLI configuration to(/from) a JSON file. That would be applicable both for using CLI through the command line and for using CLIs in the Slicer application.
That serialization should also mesh well with the python infrastructure.

== Plan of integration ==

=== What already exists ===

* [https://github.com/Slicer/SlicerExecutionModel Slicer Execution Model] already supports using the Parameter Serializer.

=== TODO ===

* Build JsonCpp in Slicer
** Branch for improving JsonCpp support in [https://github.com/Slicer/SlicerExecutionModel Slicer Execution Model]
** Branch for being able to build & package Slicer with JsonCpp.

* Build Parameter Serializer in Slicer

* Make CLI storable in Json files
** Make the vtkMRMLCommandLineModuleNode a vtkMRMLStorableNode
** Implement vtkMRMLCommandLineModuleStorageNode

* Make Python module storable in Json files
** Make the vtkMRMLScriptedNode a vtkMRMLStorableNode
** Implement vtkMRMLScriptedStorageNode to save the parameter node like a CLI node.

← Older revision		Revision as of 18:36, 9 September 2016
Line 37:		Line 37:

	=== TODO ===		=== TODO ===
−
−	* Build JsonCpp in Slicer
−	** Branch for improving JsonCpp support in [https://github.com/Slicer/SlicerExecutionModel Slicer Execution Model]
−	** Branch for being able to build & package Slicer with JsonCpp.
−
−	* Build Parameter Serializer in Slicer

	* Make CLI storable in Json files		* Make CLI storable in Json files

@@ Line 15: / Line 15: @@
 Example of a Json file obtained from the Gaussian Blur Filter:
-:{
+<pre>
-::"Parameters" :
-:::{
+  "Parameters" :
-::::"IO" :
-:::::{
+    "IO" :
-::::::"inputVolume" : "W:/Slicer/Data/MRHead.nrrd",
-::::::"outputVolume" : "W:/Slicer/Data/MRHead-blurred.nrrd",
+      "inputVolume" : "W:/Slicer/Data/MRHead.nrrd",
-::::::"sigma" : 1
+      "outputVolume" : "W:/Slicer/Data/MRHead-blurred.nrrd",
-:::::}
+      "sigma" : 1
-::::}
-:}

← Older revision		Revision as of 18:38, 9 September 2016
Line 37:		Line 37:

	=== TODO ===		=== TODO ===
		+
		+	* Build JsonCpp in Slicer
		+	** Branch for improving JsonCpp support in [https://github.com/Slicer/SlicerExecutionModel Slicer Execution Model]
		+	** Branch for being able to build & package Slicer with JsonCpp.
		+	[DONE, see r25335, r25336 and r25337]
		+	* Build Parameter Serializer in Slicer
		+	[DONE, see r25335, r25336 and r25337]

	* Make CLI storable in Json files		* Make CLI storable in Json files

@@ Line 13: / Line 13: @@
 CLI configuration to(/from) a JSON file. That would be applicable both for using CLI through the command line and for using CLIs in the Slicer application.
 That serialization should also mesh well with the python infrastructure.
 == Plan of integration ==