Skip to content

Commit 3464072

Browse files
committed
re #845 Update acquisitionRate default value, virtual devices independent dox, red arrow for required attribute.
1 parent a7c0abf commit 3464072

File tree

24 files changed

+274
-164
lines changed

24 files changed

+274
-164
lines changed

PlusLib/src/DataCollection/Ascension3DGTracking/DeviceAscension3DG.dox

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525

2626
- \xmlAtt \ref DeviceType "Type" = \c "Ascension3DG" \RequiredAtt
2727

28-
- \xmlAtt \ref DeviceAcquisitionRate "AcquisitionRate" \OptionalAtt{125}
28+
- \xmlAtt \ref DeviceAcquisitionRate "AcquisitionRate" \OptionalAtt{50}
2929
- \xmlAtt \ref LocalTimeOffsetSec \OptionalAtt{0}
3030
- \xmlAtt \ref ToolReferenceFrame \OptionalAtt{Tracker}
3131

PlusLib/src/DataCollection/BkProFocus/DeviceBkProFocus.dox

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
OEM interfaceOem
2828
- \xmlAtt \ref DeviceType "Type" = \c "BkProFocusOem" \RequiredAtt
2929

30-
- \xmlAtt \ref DeviceAcquisitionRate "AcquisitionRate" \OptionalAtt{125}
30+
- \xmlAtt \ref DeviceAcquisitionRate "AcquisitionRate". Image retrieval may slow down the exam software, so keep the frame rate low by default \OptionalAtt{1}
3131
- \xmlAtt \ref LocalTimeOffsetSec \OptionalAtt{0}
3232

3333
- \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.

PlusLib/src/DataCollection/BrachyTracking/DeviceBrachy.dox

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
\section BrachyConfigSettings Device configuration settings
1919

2020
- \xmlAtt \ref DeviceType "Type" = \c "Brachy" \RequiredAtt
21-
- \xmlAtt \ref DeviceAcquisitionRate "AcquisitionRate" \OptionalAtt{125}
21+
- \xmlAtt \ref DeviceAcquisitionRate "AcquisitionRate" \OptionalAtt{20}
2222
- \xmlAtt \ref LocalTimeOffsetSec \OptionalAtt{0}
2323
- \xmlAtt \ref ToolReferenceFrame \OptionalAtt{Tracker}
2424

PlusLib/src/DataCollection/ChRobotics/DeviceChRobotics.dox

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323

2424
- \xmlAtt \ref DeviceType "Type" = \c "ChRobotics" \RequiredAtt
2525

26-
- \xmlAtt \ref DeviceAcquisitionRate "AcquisitionRate" \OptionalAtt{125}
26+
- \xmlAtt \ref DeviceAcquisitionRate "AcquisitionRate" \OptionalAtt{20}
2727
- \xmlAtt \ref LocalTimeOffsetSec \OptionalAtt{0}
2828
- \xmlAtt \ref ToolReferenceFrame \OptionalAtt{Tracker}
2929

@@ -33,9 +33,10 @@
3333

3434
- \xmlElem \ref DataSources:
3535
- \xmlElem \ref DataSource: there must be one child element
36+
- \xmlAtt \ref PortName \RequiredAtt
3637
- \xmlAtt \ref BufferSize \OptionalAtt{150}
3738
- \xmlAtt \ref AveragedItemsForFiltering \OptionalAtt{20}
38-
- \xmlAtt \ref PortName \RequiredAtt
39+
3940

4041

4142

PlusLib/src/DataCollection/Epiphan/DeviceEpiphan.dox

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Need to install the drivers and software from <a href="http://www.epiphan.com/pr
2424

2525
- \xmlAtt \ref DeviceType "Type" = \c "Epiphan" \RequiredAtt
2626

27-
- \xmlAtt \ref DeviceAcquisitionRate "AcquisitionRate" \OptionalAtt{125}
27+
- \xmlAtt \ref DeviceAcquisitionRate "AcquisitionRate" \OptionalAtt{30}
2828
- \xmlAtt \b SerialNumber it is an optional parameter to set the \c ID of the preferred a framegrabber device (if multiple devices are connected).
2929
- \xmlAtt \b ClipRectangleOrigin and \b cClipRectangleSize define a screen region to capture information from, the clip rectangle width has to be typically a mulitple of 4 (e.g., \b ClipRectangleOrigin \c ="20 40" \b ClipRectangleSize \c ="512 512" ).
3030
- \xmlAtt \b GrabberLocation it is used to choose a specific epiphan device (in the format local:[SERIAL], net:[ADDRESS[:PORT]], sn:SERIAL, id:INDEX). If nothing is specified then the auto-detection is attempted.
@@ -35,8 +35,6 @@ Need to install the drivers and software from <a href="http://www.epiphan.com/pr
3535
- \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.
3636
- \xmlAtt \ref BufferSize \OptionalAtt{150}
3737
- \xmlAtt \ref AveragedItemsForFiltering \OptionalAtt{20}
38-
- \xmlAtt \ref PortName \RequiredAtt
39-
4038

4139
\section EpiphanExampleConfigFile Example configuration file
4240

PlusLib/src/DataCollection/FakeTracking/DeviceFake.dox

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
\section FakeConfigSettings Device configuration settings
1919

2020
- \xmlAtt \ref DeviceType "Type" = \c "Fake" \RequiredAtt
21-
- \xmlAtt \ref DeviceAcquisitionRate "AcquisitionRate" \OptionalAtt{125}
21+
- \xmlAtt \ref DeviceAcquisitionRate "AcquisitionRate" \OptionalAtt{30}
2222
- \xmlAtt \ref LocalTimeOffsetSec \OptionalAtt{0}
2323
- \xmlAtt \ref ToolReferenceFrame \OptionalAtt{Tracker}
2424

PlusLib/src/DataCollection/MicronTracking/DeviceMicron.dox

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The 1394 interface that your computer already has may not work with the camera.
2020

2121
- \xmlAtt \ref DeviceType "Type" = \c "MicronTracker" \RequiredAtt
2222

23-
- \xmlAtt \ref DeviceAcquisitionRate "AcquisitionRate" \OptionalAtt{125}
23+
- \xmlAtt \ref DeviceAcquisitionRate "AcquisitionRate" \OptionalAtt{20}
2424
- \xmlAtt \ref LocalTimeOffsetSec \OptionalAtt{0}
2525
- \xmlAtt \ref ToolReferenceFrame \OptionalAtt{Tracker}
2626

PlusLib/src/DataCollection/NDICertusTracking/DeviceNDICertus.dox

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
\section NDICertusConfigSettings Device configuration settings
1919

2020
- \xmlAtt \ref DeviceType "Type" = \c "NDICertus" \RequiredAtt
21-
- \xmlAtt \ref DeviceAcquisitionRate "AcquisitionRate" \OptionalAtt{125}
21+
- \xmlAtt \ref DeviceAcquisitionRate "AcquisitionRate" \OptionalAtt{50}
2222
- \xmlAtt \ref LocalTimeOffsetSec \OptionalAtt{0}
2323
- \xmlAtt \ref ToolReferenceFrame \OptionalAtt{Tracker}
2424

Lines changed: 130 additions & 130 deletions
Original file line numberDiff line numberDiff line change
@@ -1,135 +1,135 @@
1-
/*=Plus=header=begin======================================================
2-
Program: Plus
3-
Copyright (c) Laboratory for Percutaneous Surgery. All rights reserved.
4-
See License.txt for details.
5-
=========================================================Plus=header=end*/
6-
7-
#ifndef __vtkNDICertusTracker_h
8-
#define __vtkNDICertusTracker_h
9-
10-
#include "vtkPlusDevice.h"
11-
#include <map>
12-
13-
/*! the number of tools this class can handle */
14-
#define VTK_CERTUS_NTOOLS 12
15-
16-
/*!
17-
\class vtkNDICertusTracker
18-
\brief Interface for the NDI Optotrak Certus tracking device
19-
20-
The vtkNDICertusTracker class provides an interface to the Optotrak
21-
Certus (Northern Digital Inc., Waterloo, Canada)
22-
23-
\ingroup PlusLibDataCollection
24-
*/
25-
class VTK_EXPORT vtkNDICertusTracker : public vtkPlusDevice
26-
{
27-
public:
28-
1+
/*=Plus=header=begin======================================================
2+
Program: Plus
3+
Copyright (c) Laboratory for Percutaneous Surgery. All rights reserved.
4+
See License.txt for details.
5+
=========================================================Plus=header=end*/
6+
7+
#ifndef __vtkNDICertusTracker_h
8+
#define __vtkNDICertusTracker_h
9+
10+
#include "vtkPlusDevice.h"
11+
#include <map>
12+
13+
/*! the number of tools this class can handle */
14+
#define VTK_CERTUS_NTOOLS 12
15+
16+
/*!
17+
\class vtkNDICertusTracker
18+
\brief Interface for the NDI Optotrak Certus tracking device
19+
20+
The vtkNDICertusTracker class provides an interface to the Optotrak
21+
Certus (Northern Digital Inc., Waterloo, Canada)
22+
23+
\ingroup PlusLibDataCollection
24+
*/
25+
class VTK_EXPORT vtkNDICertusTracker : public vtkPlusDevice
26+
{
27+
public:
28+
2929
enum LedState
3030
{
3131
TR_LED_OFF = 0,
3232
TR_LED_ON = 1,
3333
TR_LED_FLASH = 2
34-
};
35-
36-
static vtkNDICertusTracker *New();
37-
vtkTypeMacro(vtkNDICertusTracker,vtkPlusDevice);
38-
void PrintSelf(ostream& os, vtkIndent indent);
39-
40-
/*! Hardware device SDK version. */
41-
virtual std::string GetSdkVersion();
42-
43-
/*! Connect to device */
44-
virtual PlusStatus InternalConnect();
45-
46-
/*! Disconnect from device */
47-
virtual PlusStatus InternalDisconnect();
48-
49-
/*!
50-
Probe to check whether there is an attached Certus system that
51-
is able to track. After Probe is called, you can call
52-
GetVersion() to get information about the attached Certus system.
53-
*/
54-
PlusStatus Probe();
55-
56-
/*! Get the a string (perhaps a long one) describing the type and version of the device. */
57-
vtkGetStringMacro(Version);
58-
59-
/*! Get an update from the tracking system and push the new transforms to the tools. */
60-
PlusStatus InternalUpdate();
61-
62-
virtual bool IsTracker() const { return true; }
63-
64-
/*! Set the specified tool LED to the specified state. */
65-
PlusStatus SetToolLED(int portNumber, int led, LedState state);
66-
67-
protected:
68-
vtkNDICertusTracker();
69-
~vtkNDICertusTracker();
70-
71-
/*! Set the version information. */
72-
vtkSetStringMacro(Version);
73-
74-
/*!
75-
Start the tracking system. The tracking system is brought from
76-
its ground state into full tracking mode. The device will
77-
only be reset if communication cannot be established without
78-
a reset.
79-
*/
80-
PlusStatus InternalStartRecording();
81-
82-
/*! Stop the tracking system and bring it back to its ground state: Initialized, not tracking, at 9600 Baud. */
83-
PlusStatus InternalStopRecording();
84-
85-
/*! Initialize communication with the Certus system. */
86-
PlusStatus InitializeCertusSystem();
87-
88-
/*! Terminate communication with the Certus system. */
89-
PlusStatus ShutdownCertusSystem();
90-
91-
/*! Activate the markers for tracking. */
92-
PlusStatus ActivateCertusMarkers();
93-
94-
/*! Deactivate all markers. */
95-
PlusStatus DeActivateCertusMarkers();
96-
97-
/*! Methods for detecting which ports have tools in them, and auto-enabling those tools. */
98-
PlusStatus EnableToolPorts();
99-
PlusStatus DisableToolPorts();
100-
101-
/*! Find the tool for a specific port handle (-1 if not found). */
102-
int GetToolFromHandle(int handle);
103-
104-
/*! Version information */
105-
char *Version;
106-
107-
/*! Number of markers */
108-
int NumberOfMarkers;
109-
110-
/*! Number of rigid bodies */
111-
int NumberOfRigidBodies;
112-
113-
/*! Internal matrix used for storing the actual tool matrix */
114-
vtkMatrix4x4 *SendMatrix;
115-
116-
/*! Container used for storing enabled tools */
117-
int PortEnabled[VTK_CERTUS_NTOOLS];
118-
119-
/*! Container used for storing tool handles */
120-
int PortHandle[VTK_CERTUS_NTOOLS];
121-
122-
/*! Container used for storing rigid body maps */
123-
std::map<int,int> RigidBodyMap;
124-
125-
private:
126-
vtkNDICertusTracker(const vtkNDICertusTracker&);
127-
void operator=(const vtkNDICertusTracker&);
128-
};
129-
130-
#endif
131-
132-
133-
134-
135-
34+
};
35+
36+
static vtkNDICertusTracker *New();
37+
vtkTypeMacro(vtkNDICertusTracker,vtkPlusDevice);
38+
void PrintSelf(ostream& os, vtkIndent indent);
39+
40+
/*! Hardware device SDK version. */
41+
virtual std::string GetSdkVersion();
42+
43+
/*! Connect to device */
44+
virtual PlusStatus InternalConnect();
45+
46+
/*! Disconnect from device */
47+
virtual PlusStatus InternalDisconnect();
48+
49+
/*!
50+
Probe to check whether there is an attached Certus system that
51+
is able to track. After Probe is called, you can call
52+
GetVersion() to get information about the attached Certus system.
53+
*/
54+
PlusStatus Probe();
55+
56+
/*! Get the a string (perhaps a long one) describing the type and version of the device. */
57+
vtkGetStringMacro(Version);
58+
59+
/*! Get an update from the tracking system and push the new transforms to the tools. */
60+
PlusStatus InternalUpdate();
61+
62+
virtual bool IsTracker() const { return true; }
63+
64+
/*! Set the specified tool LED to the specified state. */
65+
PlusStatus SetToolLED(int portNumber, int led, LedState state);
66+
67+
protected:
68+
vtkNDICertusTracker();
69+
~vtkNDICertusTracker();
70+
71+
/*! Set the version information. */
72+
vtkSetStringMacro(Version);
73+
74+
/*!
75+
Start the tracking system. The tracking system is brought from
76+
its ground state into full tracking mode. The device will
77+
only be reset if communication cannot be established without
78+
a reset.
79+
*/
80+
PlusStatus InternalStartRecording();
81+
82+
/*! Stop the tracking system and bring it back to its ground state: Initialized, not tracking, at 9600 Baud. */
83+
PlusStatus InternalStopRecording();
84+
85+
/*! Initialize communication with the Certus system. */
86+
PlusStatus InitializeCertusSystem();
87+
88+
/*! Terminate communication with the Certus system. */
89+
PlusStatus ShutdownCertusSystem();
90+
91+
/*! Activate the markers for tracking. */
92+
PlusStatus ActivateCertusMarkers();
93+
94+
/*! Deactivate all markers. */
95+
PlusStatus DeActivateCertusMarkers();
96+
97+
/*! Methods for detecting which ports have tools in them, and auto-enabling those tools. */
98+
PlusStatus EnableToolPorts();
99+
PlusStatus DisableToolPorts();
100+
101+
/*! Find the tool for a specific port handle (-1 if not found). */
102+
int GetToolFromHandle(int handle);
103+
104+
/*! Version information */
105+
char *Version;
106+
107+
/*! Number of markers */
108+
int NumberOfMarkers;
109+
110+
/*! Number of rigid bodies */
111+
int NumberOfRigidBodies;
112+
113+
/*! Internal matrix used for storing the actual tool matrix */
114+
vtkMatrix4x4 *SendMatrix;
115+
116+
/*! Container used for storing enabled tools */
117+
int PortEnabled[VTK_CERTUS_NTOOLS];
118+
119+
/*! Container used for storing tool handles */
120+
int PortHandle[VTK_CERTUS_NTOOLS];
121+
122+
/*! Container used for storing rigid body maps */
123+
std::map<int,int> RigidBodyMap;
124+
125+
private:
126+
vtkNDICertusTracker(const vtkNDICertusTracker&);
127+
void operator=(const vtkNDICertusTracker&);
128+
};
129+
130+
#endif
131+
132+
133+
134+
135+

PlusLib/src/DataCollection/OpenIGTLinkTracking/DeviceOpenIGTLink.dox

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
\section OpenIGTLinkConfigSettings Device configuration settings
1919

2020
- \xmlAtt \ref DeviceType "Type" = \c "OpenIGTLink" \RequiredAtt
21-
- \xmlAtt \ref DeviceAcquisitionRate "AcquisitionRate" \OptionalAtt{125}
21+
- \xmlAtt \ref DeviceAcquisitionRate "AcquisitionRate" \OptionalAtt{30}
2222
- \xmlAtt \ref LocalTimeOffsetSec \OptionalAtt{0}
2323
- \xmlAtt \ref ToolReferenceFrame \OptionalAtt{Tracker}
2424

0 commit comments

Comments
 (0)