0002464: Document python "load" method properties

ID	Project	Category	View Status	Date Submitted	Last Update

0002464	Slicer4	Core: Documentation and Wiki	public	2012-09-03 07:50	2016-04-01 10:39

Reporter	jcfr	Assigned To	jcfr
Priority	low	Severity	minor	Reproducibility	have not tried
Status	acknowledged	Resolution	open
Product Version
Target Version		Fixed in Version

Summary	0002464: Document python "load" method properties
Description	Within Base/Python/slicer/utils.py, there are methods like "loadVolume", "loadScene", ... All these methods take a properties dict as parameter, would be ideal to document these. To avoid redundant documentation, the associated cpp IO could be documented and a link added from the python doc to the cpp one. For example, loadScene properties should be documented in Modules/Loadable/Data/qSlicerSceneIO.h
Tags	No tags attached.

nicole 2016-04-01 10:32 administrator ~0013852	From a post I made to the mailing list when asked about other properties that loadNode uses for volumes: If you look at the doxygen page for the volumes reader, the load function has some of the information requested: https://www.slicer.org/doc/html/classqSlicerVolumesReader.html#a397af0a4fdfd1762b3c85a7292cfbd0a But it’s just copied from the qSlicerFileReader superclass. I’ll see if I can update it, the volumes reader uses fileName, name, label map, center, singleFile, autoWindowLevel, discardOrientation, fileNames, colorNodeID: https://github.com/Slicer/Slicer/blob/master/Modules/Loadable/Volumes/qSlicerVolumesReader.cxx#L116

Date Modified	Username	Field	Change
2012-09-03 07:50	jcfr	New Issue
2012-09-03 07:50	jcfr	Status	new => assigned
2012-09-03 07:50	jcfr	Assigned To	=> jcfr
2012-09-03 07:50	jcfr	Assigned To	jcfr => crmullin
2012-09-03 07:50	jcfr	Target Version	=> Slicer 4.3.0
2012-09-03 07:50	jcfr	Relationship added	related to 0002441
2013-01-30 14:01	jcfr	Description Updated
2013-01-30 14:01	jcfr	Assigned To	crmullin => sankhesh
2013-06-03 05:15	jcfr	Assigned To	sankhesh => jcfr
2013-06-14 19:26	jcfr	Priority	normal => low
2013-08-27 11:25	jcfr	Relationship added	related to 0003322
2013-08-27 11:25	jcfr	Target Version	Slicer 4.3.0 => Slicer 4.4.0
2014-05-12 11:46	jcfr	Status	assigned => acknowledged
2014-05-12 11:46	jcfr	Target Version	Slicer 4.4.0 =>
2016-04-01 10:32	nicole	Note Added: 0013852
2016-06-20 14:15	jcfr	Category	Core: Documentation & Wiki => Core: Documentation and Wiki

related to	0002441	closed	jcfr	Slicer/Base/Python/slicer/util.py loadScene function missing "from slicer import app"?
related to	0003322	acknowledged	jcfr	Re-factor qSlicerIO code