re #845 ToolReference attribute frame only for trackers, portName required for most of trackers, PortUsImageOrientation for most imaging devices

garciaguevara · garciaguevara · commit 57ae9fc5daf2 · 2014-06-25T20:51:56.000Z
diff --git a/PlusLib/src/DataCollection/3dConnexionTracking/Device3dConnexion.dox b/PlusLib/src/DataCollection/3dConnexionTracking/Device3dConnexion.dox
@@ -12,8 +12,6 @@
 - \ref PlatformWin32
 - \ref PlatformWin64
 - \ref PlatformWin32Embedded
-- \ref PlatformMacOs
-- \ref PlatformLinux
 
 \section D3dConnexionInstallation Installation
 
diff --git a/PlusLib/src/DataCollection/Ascension3DGTracking/DeviceAscension3DG.dox b/PlusLib/src/DataCollection/Ascension3DGTracking/DeviceAscension3DG.dox
@@ -38,7 +38,7 @@
 - \xmlElem \ref DataSources:
   - \xmlElem \ref DataSource: there must be one child element
     - \xmlAtt \b Type = \c "Tool"
-    - \xmlAtt \b PortName Identifies the connector (0, 1, 2, or 3) or a virtual tool that contains the quality values (\c quality1 for tool ports 0, 1, and 2; \c quality2 for tool port 3).
+    - \xmlAtt \b PortName Identifies the connector (0, 1, 2, or 3) or a virtual tool that contains the quality values (\c quality1 for tool ports 0, 1, and 2; \c quality2 for tool port 3). \RequiredAtt
     - \xmlAtt \b QualityErrorSlope The slope should have a value between -127 and +127. \OptionalAtt{0}
     - \xmlAtt \b QualityErrorOffset default: The offset should have a value between -127 and +127. \OptionalAtt{0}
     - \xmlAtt \b QualityErrorSensitivity: The sensitivity should have a value between 0 and 127 \OptionalAtt{2}
diff --git a/PlusLib/src/DataCollection/BkProFocus/DeviceBkProFocus.dox b/PlusLib/src/DataCollection/BkProFocus/DeviceBkProFocus.dox
@@ -33,7 +33,8 @@ OEM interfaceOem
 - \xmlAtt \b IniFileName. INI file name. If a relative path is specified then it is relative to the device set configuration directory. See an example \ref inifile "INI file" below.
 - \xmlElem \ref DataSources:
   - \xmlElem \ref DataSource: there must be one child element
-    - \xmlAtt \ref PortUsImageOrientation
+    - \xmlAtt \ref PortUsImageOrientation \RequiredAtt
+    - \xmlAtt \ref ImageType \OptionalAtt{BRIGHTNESS}
     - \xmlAtt \ref BufferSize \OptionalAtt{150}
     - \xmlAtt \ref AveragedItemsForFiltering \OptionalAtt{20}
 
@@ -52,7 +53,8 @@ RF acquisition through the CameraLink interface
 
 - \xmlElem \ref DataSources:
   - \xmlElem \ref DataSource: there must be one child element
-    - \xmlAtt \ref PortUsImageOrientation
+    - \xmlAtt \ref PortUsImageOrientation \RequiredAtt
+    - \xmlAtt \ref ImageType \OptionalAtt{BRIGHTNESS}
     - \xmlAtt \ref BufferSize \OptionalAtt{150}
     - \xmlAtt \ref AveragedItemsForFiltering \OptionalAtt{20}
 
diff --git a/PlusLib/src/DataCollection/BkProFocus/PlusBkProFocusCameraLinkReceiver.cxx b/PlusLib/src/DataCollection/BkProFocus/PlusBkProFocusCameraLinkReceiver.cxx
@@ -112,7 +112,7 @@ bool PlusBkProFocusCameraLinkReceiver::DataAvailable(int lines, int pitch, void
   }
   else if (numberOfSamplePairsInOutput<numberOfSamplePairsInInput)
   {
-	  LOG_WARNING("Not enough space allocated to store all the RF samples. Input: "<<numberOfSamplePairsInInput<<", output: "<<numberOfSamplePairsInOutput);
+    LOG_WARNING("Not enough space allocated to store all the RF samples. Input: "<<numberOfSamplePairsInInput<<", output: "<<numberOfSamplePairsInOutput);
     numberOfSamplePairsToCopy=numberOfSamplePairsInOutput;
   }
   else // numberOfSamplePairsInInput < numberOfSamplePairsInOutput
diff --git a/PlusLib/src/DataCollection/BrachyTracking/DeviceBrachy.dox b/PlusLib/src/DataCollection/BrachyTracking/DeviceBrachy.dox
@@ -22,6 +22,13 @@
 - \xmlAtt \ref LocalTimeOffsetSec \OptionalAtt{0}
 - \xmlAtt \ref ToolReferenceFrame \OptionalAtt{Tracker}
 
+- \xmlElem \ref DataSources:
+  - \xmlElem \ref DataSource: there must be one child element
+    - \xmlAtt \ref PortName \RequiredAtt
+    - \xmlAtt \ref BufferSize \OptionalAtt{150}
+    - \xmlAtt \ref AveragedItemsForFiltering \OptionalAtt{20}
+
+
 \section BrachyExampleConfigFile Example configuration file
 
 \include "data/ConfigFiles/PlusDeviceSet_Server_Brachy.xml"
diff --git a/PlusLib/src/DataCollection/Epiphan/DeviceEpiphan.dox b/PlusLib/src/DataCollection/Epiphan/DeviceEpiphan.dox
@@ -31,8 +31,8 @@ Need to install the drivers and software from <a href="http://www.epiphan.com/pr
 
 - \xmlElem \ref DataSources:
   - \xmlElem \ref DataSource: there must be one child element
-    - \xmlAtt \ref PortUsImageOrientation
-    - \xmlAtt \ref ImageType. Color image acquisition is supported by setting the imaging device's common attribute \c ImageType="RGB_COLOR" as shown in the Epiphan Color Video Capture example.
+    - \xmlAtt \ref PortUsImageOrientation \RequiredAtt
+    - \xmlAtt \ref ImageType. Color image acquisition is supported by setting the imaging device's common attribute \c ImageType="RGB_COLOR" as shown in the Epiphan Color Video Capture example. \OptionalAtt{BRIGHTNESS}
     - \xmlAtt \ref BufferSize \OptionalAtt{150}
     - \xmlAtt \ref AveragedItemsForFiltering \OptionalAtt{20}
 
diff --git a/PlusLib/src/DataCollection/FakeTracking/DeviceFake.dox b/PlusLib/src/DataCollection/FakeTracking/DeviceFake.dox
@@ -22,6 +22,12 @@
 - \xmlAtt \ref LocalTimeOffsetSec \OptionalAtt{0}
 - \xmlAtt \ref ToolReferenceFrame \OptionalAtt{Tracker}
 
+- \xmlElem \ref DataSources:
+  - \xmlElem \ref DataSource: there must be one child element
+    - \xmlAtt \ref PortName \RequiredAtt
+    - \xmlAtt \ref BufferSize \OptionalAtt{150}
+    - \xmlAtt \ref AveragedItemsForFiltering \OptionalAtt{20}
+
 \section FakeExampleConfigFile Example configuration file
 
 \include "data/ConfigFiles/PlusDeviceSet_Server_Fake.xml"
diff --git a/PlusLib/src/DataCollection/ICCapturing/DeviceICCapturing.dox b/PlusLib/src/DataCollection/ICCapturing/DeviceICCapturing.dox
@@ -20,7 +20,13 @@
 - \xmlAtt \ref DeviceType "Type" = \c "ICCapturing" \RequiredAtt
 - \xmlAtt \ref DeviceAcquisitionRate "AcquisitionRate" \OptionalAtt{125} 
 - \xmlAtt \ref LocalTimeOffsetSec \OptionalAtt{0}
-- \xmlAtt \ref ToolReferenceFrame \OptionalAtt{Tracker}
+
+- \xmlElem \ref DataSources:
+  - \xmlElem \ref DataSource: there must be one child element
+    - \xmlAtt \ref PortUsImageOrientation \RequiredAtt
+    - \xmlAtt \ref ImageType \OptionalAtt{BRIGHTNESS}
+    - \xmlAtt \ref BufferSize \OptionalAtt{150}
+    - \xmlAtt \ref AveragedItemsForFiltering \OptionalAtt{20}
 
 \section ICCapturingExampleConfigFile Example configuration file
 
diff --git a/PlusLib/src/DataCollection/Interson/DeviceInterson.dox b/PlusLib/src/DataCollection/Interson/DeviceInterson.dox
@@ -20,7 +20,13 @@
 - \xmlAtt \ref DeviceType "Type" = \c "Interson" \RequiredAtt
 - \xmlAtt \ref DeviceAcquisitionRate "AcquisitionRate" \OptionalAtt{125} 
 - \xmlAtt \ref LocalTimeOffsetSec \OptionalAtt{0}
-- \xmlAtt \ref ToolReferenceFrame \OptionalAtt{Tracker}
+
+- \xmlElem \ref DataSources:
+  - \xmlElem \ref DataSource: there must be one child element
+    - \xmlAtt \ref PortUsImageOrientation \RequiredAtt
+    - \xmlAtt \ref ImageType \OptionalAtt{BRIGHTNESS}
+    - \xmlAtt \ref BufferSize \OptionalAtt{150}
+    - \xmlAtt \ref AveragedItemsForFiltering \OptionalAtt{20}
 
 \section IntersonExampleConfigFile Example configuration file
 
diff --git a/PlusLib/src/DataCollection/MicronTracking/DeviceMicron.dox b/PlusLib/src/DataCollection/MicronTracking/DeviceMicron.dox
@@ -30,9 +30,10 @@ The 1394 interface that your computer already has may not work with the camera.
 
 - \xmlElem \ref DataSources:
   - \xmlElem \ref DataSource: there must be one child element
+    - \xmlAtt \ref PortName \RequiredAtt
     - \xmlAtt \ref BufferSize \OptionalAtt{150}
     - \xmlAtt \ref AveragedItemsForFiltering \OptionalAtt{20}
-    - \xmlAtt \ref PortName \RequiredAtt
+
 
 \section MicronExampleConfigFile Example configuration file
 
diff --git a/PlusLib/src/DataCollection/MicrosoftMediaFoundation/DeviceMicrosoftMediaFoundation.dox b/PlusLib/src/DataCollection/MicrosoftMediaFoundation/DeviceMicrosoftMediaFoundation.dox
@@ -20,7 +20,13 @@
 - \xmlAtt \ref DeviceType "Type" = \c "MicrosoftMediaFoundation" \RequiredAtt
 - \xmlAtt \ref DeviceAcquisitionRate "AcquisitionRate" \OptionalAtt{125} 
 - \xmlAtt \ref LocalTimeOffsetSec \OptionalAtt{0}
-- \xmlAtt \ref ToolReferenceFrame \OptionalAtt{Tracker}
+
+- \xmlElem \ref DataSources:
+  - \xmlElem \ref DataSource: there must be one child element
+    - \xmlAtt \ref PortUsImageOrientation \RequiredAtt
+    - \xmlAtt \ref ImageType Color image acquisition is supported by setting the imaging device's common attribute \c ImageType="RGB_COLOR". \OptionalAtt{BRIGHTNESS}
+    - \xmlAtt \ref BufferSize \OptionalAtt{150}
+    - \xmlAtt \ref AveragedItemsForFiltering \OptionalAtt{20}
 
 \section MicrosoftMediaFoundationExampleConfigFile Example configuration file
 
diff --git a/PlusLib/src/DataCollection/NDICertusTracking/DeviceNDICertus.dox b/PlusLib/src/DataCollection/NDICertusTracking/DeviceNDICertus.dox
@@ -22,6 +22,12 @@
 - \xmlAtt \ref LocalTimeOffsetSec \OptionalAtt{0}
 - \xmlAtt \ref ToolReferenceFrame \OptionalAtt{Tracker}
 
+- \xmlElem \ref DataSources:
+  - \xmlElem \ref DataSource: there must be one child element
+    - \xmlAtt \ref PortName \RequiredAtt
+    - \xmlAtt \ref BufferSize \OptionalAtt{150}
+    - \xmlAtt \ref AveragedItemsForFiltering \OptionalAtt{20}
+
 \section NDICertusExampleConfigFile Example configuration file
 
 \include "data/ConfigFiles/PlusDeviceSet_Server_NDICertus.xml"
diff --git a/PlusLib/src/DataCollection/OpenIGTLinkVideo/DeviceOpenIGTLinkVideo.dox b/PlusLib/src/DataCollection/OpenIGTLinkVideo/DeviceOpenIGTLinkVideo.dox
@@ -20,7 +20,13 @@
 - \xmlAtt \ref DeviceType "Type" = \c "OpenIGTLinkVideo" \RequiredAtt
 - \xmlAtt \ref DeviceAcquisitionRate "AcquisitionRate" \OptionalAtt{30} 
 - \xmlAtt \ref LocalTimeOffsetSec \OptionalAtt{0}
-- \xmlAtt \ref ToolReferenceFrame \OptionalAtt{Tracker}
+
+- \xmlElem \ref DataSources:
+  - \xmlElem \ref DataSource: there must be one child element
+    - \xmlAtt \ref PortUsImageOrientation \RequiredAtt
+    - \xmlAtt \ref ImageType \OptionalAtt{BRIGHTNESS}
+    - \xmlAtt \ref BufferSize \OptionalAtt{150}
+    - \xmlAtt \ref AveragedItemsForFiltering \OptionalAtt{20}
 
 \section OpenIGTLinkVideoExampleConfigFile Example configuration file
 
diff --git a/PlusLib/src/DataCollection/PhidgetSpatialTracking/DevicePhidgetSpatial.dox b/PlusLib/src/DataCollection/PhidgetSpatialTracking/DevicePhidgetSpatial.dox
@@ -22,6 +22,12 @@
 - \xmlAtt \ref LocalTimeOffsetSec \OptionalAtt{0}
 - \xmlAtt \ref ToolReferenceFrame \OptionalAtt{Tracker}
 
+- \xmlElem \ref DataSources:
+  - \xmlElem \ref DataSource: there must be one child element
+    - \xmlAtt \ref PortName \RequiredAtt
+    - \xmlAtt \ref BufferSize \OptionalAtt{150}
+    - \xmlAtt \ref AveragedItemsForFiltering \OptionalAtt{20}
+
 \section PhidgetSpatialExampleConfigFile Example configuration file
 
 \include "data/ConfigFiles/PlusDeviceSet_Server_PhidgetSpatial.xml"
diff --git a/PlusLib/src/DataCollection/PolarisTracking/DevicePolaris.dox b/PlusLib/src/DataCollection/PolarisTracking/DevicePolaris.dox
@@ -22,6 +22,12 @@
 - \xmlAtt \ref LocalTimeOffsetSec \OptionalAtt{0}
 - \xmlAtt \ref ToolReferenceFrame \OptionalAtt{Tracker}
 
+- \xmlElem \ref DataSources:
+  - \xmlElem \ref DataSource: there must be one child element
+    - \xmlAtt \ref RomFile \RequiredAtt
+    - \xmlAtt \ref BufferSize \OptionalAtt{150}
+    - \xmlAtt \ref AveragedItemsForFiltering \OptionalAtt{20}
+
 \section PolarisExampleConfigFile Example configuration file
 
 \include "data/ConfigFiles/PlusDeviceSet_Server_Polaris.xml"
diff --git a/PlusLib/src/DataCollection/SavedDataSource/DeviceSavedDataSource.dox b/PlusLib/src/DataCollection/SavedDataSource/DeviceSavedDataSource.dox
@@ -22,6 +22,8 @@
 - \xmlAtt \ref LocalTimeOffsetSec \OptionalAtt{0}
 - \xmlAtt \ref ToolReferenceFrame \OptionalAtt{Tracker}
 
+- \xmlAtt \ref ImageType Color image acquisition is supported by setting the imaging device's common attribute \c ImageType="RGB_COLOR". \OptionalAtt{BRIGHTNESS}
+
 \section SavedDataSourceExampleConfigFile Example configuration file
 
 \include "data/ConfigFiles/PlusDeviceSet_Server_SavedDataSource.xml"
diff --git a/PlusLib/src/DataCollection/SonixVideo/DeviceSonixVideo.dox b/PlusLib/src/DataCollection/SonixVideo/DeviceSonixVideo.dox
@@ -20,7 +20,13 @@
 - \xmlAtt \ref DeviceType "Type" = \c "SonixVideo" \RequiredAtt OR "Type" = \c "SonixVideoPorta" \RequiredAtt
 - \xmlAtt \ref DeviceAcquisitionRate "AcquisitionRate" \OptionalAtt{30} 
 - \xmlAtt \ref LocalTimeOffsetSec \OptionalAtt{0}
-- \xmlAtt \ref ToolReferenceFrame \OptionalAtt{Tracker}
+
+- \xmlElem \ref DataSources:
+  - \xmlElem \ref DataSource: there must be one child element
+    - \xmlAtt \ref PortUsImageOrientation \RequiredAtt
+    - \xmlAtt \ref ImageType \OptionalAtt{BRIGHTNESS}
+    - \xmlAtt \ref BufferSize \OptionalAtt{150}
+    - \xmlAtt \ref AveragedItemsForFiltering \OptionalAtt{20}
 
 \section SonixVideoExampleConfigFile Example configuration file
 
diff --git a/PlusLib/src/DataCollection/UsSimulatorVideo/DeviceUsSimulatorVideo.dox b/PlusLib/src/DataCollection/UsSimulatorVideo/DeviceUsSimulatorVideo.dox
@@ -20,7 +20,13 @@
 - \xmlAtt \ref DeviceType "Type" = \c "UsSimulatorVideo" \RequiredAtt
 - \xmlAtt \ref DeviceAcquisitionRate "AcquisitionRate" \OptionalAtt{30} 
 - \xmlAtt \ref LocalTimeOffsetSec \OptionalAtt{0}
-- \xmlAtt \ref ToolReferenceFrame \OptionalAtt{Tracker}
+
+- \xmlElem \ref DataSources:
+  - \xmlElem \ref DataSource: there must be one child element
+    - \xmlAtt \ref PortUsImageOrientation \RequiredAtt
+    - \xmlAtt \ref ImageType \OptionalAtt{BRIGHTNESS}
+    - \xmlAtt \ref BufferSize \OptionalAtt{150}
+    - \xmlAtt \ref AveragedItemsForFiltering \OptionalAtt{20}
 
 \section UsSimulatorVideoExampleConfigFile Example configuration file
 
diff --git a/PlusLib/src/DataCollection/VideoForWindows/DeviceVideoForWindows.dox b/PlusLib/src/DataCollection/VideoForWindows/DeviceVideoForWindows.dox
@@ -20,7 +20,13 @@
 - \xmlAtt \ref DeviceType "Type" = \c "VideoForWindows" \RequiredAtt
 - \xmlAtt \ref DeviceAcquisitionRate "AcquisitionRate" \OptionalAtt{30} 
 - \xmlAtt \ref LocalTimeOffsetSec \OptionalAtt{0}
-- \xmlAtt \ref ToolReferenceFrame \OptionalAtt{Tracker}
+
+- \xmlElem \ref DataSources:
+  - \xmlElem \ref DataSource: there must be one child element
+    - \xmlAtt \ref PortUsImageOrientation \RequiredAtt
+    - \xmlAtt \ref ImageType \OptionalAtt{BRIGHTNESS}
+    - \xmlAtt \ref BufferSize \OptionalAtt{150}
+    - \xmlAtt \ref AveragedItemsForFiltering \OptionalAtt{20}
 
 \section VideoForWindowsExampleConfigFile Example configuration file
 
diff --git a/PlusLib/src/DataCollection/VirtualDevices/DeviceVirtualDevices.dox b/PlusLib/src/DataCollection/VirtualDevices/DeviceVirtualDevices.dox
diff --git a/PlusLib/src/DataCollection/VirtualDevices/DeviceVirtualDiscCapture.dox b/PlusLib/src/DataCollection/VirtualDevices/DeviceVirtualDiscCapture.dox
@@ -20,7 +20,7 @@
 - \xmlAtt \ref DeviceType "Type" = \c "VirtualDiscCapture" \RequiredAtt
 - \xmlAtt \ref DeviceAcquisitionRate "AcquisitionRate" \OptionalAtt{30} 
 - \xmlAtt \ref LocalTimeOffsetSec \OptionalAtt{0}
-- \xmlAtt \ref ToolReferenceFrame \OptionalAtt{Tracker}
+
 
 \section VirtualDiscCaptureExampleConfigFile Example configuration file
 
diff --git a/PlusLib/src/DataCollection/VirtualDevices/DeviceVirtualSwitcher.dox b/PlusLib/src/DataCollection/VirtualDevices/DeviceVirtualSwitcher.dox
@@ -20,7 +20,6 @@
 - \xmlAtt \ref DeviceType "Type" = \c "VirtualSwitcher" \RequiredAtt
 - \xmlAtt \ref DeviceAcquisitionRate "AcquisitionRate" \OptionalAtt{50} 
 - \xmlAtt \ref LocalTimeOffsetSec \OptionalAtt{0}
-- \xmlAtt \ref ToolReferenceFrame \OptionalAtt{Tracker}
 
 \section VirtualSwitcherExampleConfigFile Example configuration file
 
diff --git a/PlusLib/src/DataCollection/VirtualDevices/DeviceVirtualVolumeReconstruction.dox b/PlusLib/src/DataCollection/VirtualDevices/DeviceVirtualVolumeReconstruction.dox
@@ -20,10 +20,10 @@
 - \xmlAtt \ref DeviceType "Type" = \c "VirtualVolumeReconstructor" \RequiredAtt
 - \xmlAtt \ref DeviceAcquisitionRate "AcquisitionRate" \OptionalAtt{30} 
 - \xmlAtt \ref LocalTimeOffsetSec \OptionalAtt{0}
-- \xmlAtt \ref ToolReferenceFrame \OptionalAtt{Tracker}
 
 \section VirtualVolumeReconstructorExampleConfigFile Example configuration file
 
 \include "data/ConfigFiles/PlusDeviceSet_Server_VirtualVolumeReconstructor.xml"
+\ref UsSimulatorVideoSupportedHwDevices
 
 */
diff --git a/PlusLib/src/Documentation/PlusDoxygenStyle.css b/PlusLib/src/Documentation/PlusDoxygenStyle.css
@@ -10,6 +10,31 @@ H1 {
   font-size: 105%;
   font-weight: bold
 }
+
+
+H1, H2, H3, H4, H5, H6 {
+  -webkit-transition: text-shadow 2s linear;
+  -moz-transition: text-shadow 2s linear;
+  -ms-transition: text-shadow 2s linear;
+  -o-transition: text-shadow 2s linear;
+  transition: text-shadow 2s linear;
+  margin-right: 15px;
+}
+
+H1.glow, H2.glow, H3.glow, H4.glow, H5.glow, H6.glow {
+         text-shadow: 0 0 15px cyan;
+}
+
+div.anchor{
+  -webkit-transition: text-shadow 2s linear;
+  -moz-transition: text-shadow 2s linear;
+  -ms-transition: text-shadow 2s linear;
+  -o-transition: text-shadow 2s linear;
+  transition: text-shadow 2s linear;
+  margin-right: 15px;
+}
+
+
 H2 {
   font-size: 103%;
   font-weight: bold;
@@ -42,4 +67,4 @@ div.caption{
   text-align: left;
   display:inline;
   font-weight:normal
-}
+}

Original file line number	Diff line number	Diff line change
`@@ -112,7 +112,7 @@ bool PlusBkProFocusCameraLinkReceiver::DataAvailable(int lines, int pitch, void`
`112`	`112`	`}`
`113`	`113`	`else if (numberOfSamplePairsInOutput<numberOfSamplePairsInInput)`
`114`	`114`	`{`
`115`		`- LOG_WARNING("Not enough space allocated to store all the RF samples. Input: "<<numberOfSamplePairsInInput<<", output: "<<numberOfSamplePairsInOutput);`
	`115`	`+ LOG_WARNING("Not enough space allocated to store all the RF samples. Input: "<<numberOfSamplePairsInInput<<", output: "<<numberOfSamplePairsInOutput);`
`116`	`116`	`numberOfSamplePairsToCopy=numberOfSamplePairsInOutput;`
`117`	`117`	`}`
`118`	`118`	`else // numberOfSamplePairsInInput < numberOfSamplePairsInOutput`