Modules:Fiducials-Documentation-3.4 - Revision history

Nicole: /* Importing Lists into a Spreadsheet */

2010-01-22T18:49:52Z

Importing Lists into a Spreadsheet

Nicole: /* Importing Lists into a Spreadsheet */

2010-01-22T18:41:18Z

Importing Lists into a Spreadsheet

Nicole: /* Importing Lists into a Spreadsheet */

2010-01-22T18:35:10Z

Importing Lists into a Spreadsheet

Nicole: /* Importing Lists into a Spreadsheet */

2010-01-22T18:33:09Z

Importing Lists into a Spreadsheet

Nicole: /* Loading and Saving Lists */

2010-01-22T18:25:10Z

Loading and Saving Lists

Nicole: /* Source code & documentation */

2010-01-15T21:42:56Z

Source code & documentation

Nicole: /* Loading and Saving Lists */

2009-06-26T19:40:41Z

Loading and Saving Lists

Nicole: /* Loading and Saving Lists */

2009-06-26T19:38:11Z

Loading and Saving Lists

Nicole: /* Loading and Saving Lists */

2009-06-26T19:28:28Z

Loading and Saving Lists

Nicole: /* Loading and Saving Lists */

2009-06-26T19:26:47Z

Loading and Saving Lists

@@ Line 306: / Line 306: @@
 #In Slicer3, open the ''File, Save'' dialog and select the fiducial list to save.
 #Set the file name, ending with .fcsv, and the directory in which to save it
-#Click on the symbol in the top left to open the menu, select ''Open''
+#Click on the symbol in the top left to open the menu, select ''Open'' (if ''Import'' is an option, use it instead)
 #Set the filter to '''All Files (*.*)'''
 #Browse to the directory in which you saved your .fcsv file and select it, then click ''Open''

@@ Line 288: / Line 288: @@
 ==Importing Lists into a Spreadsheet==
-These instructions were written for OpenOffice.org's Calc, version 3.1.1.
+To import a fiducial list into OpenOffice.org's Calc, version 3.1.1:
 #In Slicer3, open the File, Save dialog and select the fiducial list to save.
 #Set the file name, ending with .fcsv, and the directory in which to save it
 #Open OpenOffice.org's Calc
-#Click on File, Open
+#Click on ''File, Open''
 #Expand the File type menu
-#Select Text CSV as the file type
+#Select '''Text CSV''' as the file type
-#Make sure All Files is selected for the directory listing filter
+#Make sure '''All Files''' is selected for the directory listing filter
-#Browse to the directory in which you saved your .fcsv file and select it, then click Open
+#Browse to the directory in which you saved your .fcsv file and select it, then click ''Open''
 #The Text Import window will pop up
 #In the Separator options, set it so that only comma is selected (the color and selectedColor comment lines will get separated into columns, but so will the column s comment to give headers for the rows of points)
-#Click open and the import will finish, with the fiducial points starting on row 18
+#Click ''Open'' and the import will finish, with the fiducial points starting on row 18
 == Development ==

@@ Line 292: / Line 292: @@
 #In Slicer3, open the File, Save dialog and select the fiducial list to save.
 #Set the file name, ending with .fcsv, and the directory in which to save it
-#Open OpenOffice.org's Calc (or Excel)
+#Open OpenOffice.org's Calc
-#Click on File, Open (in Excel, click on File, Import)
+#Click on File, Open
 #Expand the File type menu
 #Select Text CSV as the file type

← Older revision		Revision as of 18:33, 22 January 2010
Line 289:		Line 289:

	These instructions were written for OpenOffice.org's Calc, version 3.1.1.		These instructions were written for OpenOffice.org's Calc, version 3.1.1.
		+
		+	#In Slicer3, open the File, Save dialog and select the fiducial list to save.
		+	#Set the file name, ending with .fcsv, and the directory in which to save it
		+	#Open OpenOffice.org's Calc (or Excel)
		+	#Click on File, Open (in Excel, click on File, Import)
		+	#Expand the File type menu
		+	#Select Text CSV as the file type
		+	#Make sure All Files is selected for the directory listing filter
		+	#Browse to the directory in which you saved your .fcsv file and select it, then click Open
		+	#The Text Import window will pop up
		+	#In the Separator options, set it so that only comma is selected (the color and selectedColor comment lines will get separated into columns, but so will the column s comment to give headers for the rows of points)
		+	#Click open and the import will finish, with the fiducial points starting on row 18

	== Development ==		== Development ==

@@ Line 285: / Line 285: @@
 |This entry gives you the flexibility to reorder your data for each point, the default is <pre>label,x,y,z,sel,vis</pre>. It's a comma separated list of keywords giving the format of the following lines for each point.
 |}
 == Development ==

@@ Line 310: / Line 310: @@
 Links to documentation generated by doxygen:
-*[http://www.na-mic.org/Slicer/Documentation/Slicer3/html/classvtkSlicerFiducialsGUI.html vtkSlicerFiducialsGUI]
+*[http://www.na-mic.org/Slicer/Documentation/Slicer3-doc/html/classvtkSlicerFiducialsGUI.html vtkSlicerFiducialsGUI]
-*[http://www.na-mic.org/Slicer/Documentation/Slicer3/html/classvtkSlicerFiducialListWidget.html vtkSlicerFiducialListWidget]
+*[http://www.na-mic.org/Slicer/Documentation/Slicer3-doc/html/classvtkSlicerFiducialListWidget.html vtkSlicerFiducialListWidget]
-*[http://www.na-mic.org/Slicer/Documentation/Slicer3/html/classvtkSlicerFiducialsLogic.html vtkSlicerFiducialsLogic]
+*[http://www.na-mic.org/Slicer/Documentation/Slicer3-doc/html/classvtkSlicerFiducialsLogic.html vtkSlicerFiducialsLogic]
 == More Information ==

@@ Line 237: / Line 237: @@
 |-
 |symbolType
-|Integer selected from the range representing glyph types, default is 11 for starburst.
+|Integer selected from the range representing glyph types, default is 11 for a star burst. <pre>0    Vertex2D
 |-
 |visibility

@@ Line 224: / Line 224: @@
 {|border="1"
 |+Fiducial List file header
 | name
-| a name for the list, new points will be named according to this string and the point number
+| A name for the list, new points will be named according to this string and the point number
 |-
 | numPoints
-| the number of points in the list, skipped for now, as the list is built up by adding a point for each line in the points section of the file
+| The number of points in the list, skipped for now, as the list is built up by adding a point for each line in the points section of the file
 |-
 |symbolScale
-|floating point, size of the symbols
+|Floating point, used to scale the glyphs for all the fiducial points.
 |}

← Older revision		Revision as of 19:28, 26 June 2009
Line 173:		Line 173:

	Fiducial list files are plain text, with the extension ''fcvs''.		Fiducial list files are plain text, with the extension ''fcvs''.
		+
		+	An example file:
		+
		+	<pre>
		+	# Fiducial List file /home/username/L.fcsv
		+	# name = L
		+	# numPoints = 5
		+	# symbolScale = 5.5
		+	# symbolType = 11
		+	# visibility = 1
		+	# textScale = 12.5
		+	# color = 0.4,1,1
		+	# selectedColor = 0.807843,0.560784,1
		+	# opacity = 1
		+	# ambient = 0
		+	# diffuse = 1
		+	# specular = 0
		+	# power = 1
		+	# locked = 0
		+	# columns = label,x,y,z,sel,vis
		+	L-P,-58.0508,64.4069,0,1,1
		+	L-P1,31.7797,-1.69492,0,1,1
		+	L-P2,-2.11864,-49.1527,0,0,1
		+	L-P3,-72.4576,-54.2374,0,1,0
		+	L-P4,-63.1356,3.38984,0,1,1
		+	</pre>

	Lines are commented out by placing a hash mark (#) at the beginning of the line. There is an optional header section that lists display options. If no display options are included, the defaults are used when the list is read into Slicer. The header line formats follow the description of the point format.		Lines are commented out by placing a hash mark (#) at the beginning of the line. There is an optional header section that lists display options. If no display options are included, the defaults are used when the list is read into Slicer. The header line formats follow the description of the point format.

@@ Line 173: / Line 173: @@
 Fiducial list files are plain text, with the extension ''fcvs''.
 Lines are commented out by placing a hash mark (#) at the beginning of the line.
 The points are listed one per line in the following format:
    pointName,X,Y,Z,selected,visibility
-pointName is a text string that is displayed at the location of the fiducial.
+{|border="1"
+|pointName
-X,Y,Z are floating points that represent the 3D RAS location of the fiducial, in mm.
+|a text string that is displayed at the location of the fiducial.
-selected is an integer value, either 0 or 1, denoting if the fiducial is selected or not.
+The header section of the fiducial list file consists of lines starting with a hash mark and a space (# ). A keyword = value pair follows the space. The keyword is parsed and compared against the list of known keywords:
-visibility is an integer value, either 0 or 1, denoting if the fiducial is visible or not.
+{|border="1"
 == Development ==