Main PST SDK class implementing tracker communication. More...

Inheritance diagram for PSTech.Pstsdk.Tracker:

Collaboration diagram for PSTech.Pstsdk.Tracker:

Public Member Functions
delegate void	OnTrackerDataCallback (TrackerData trackerData, ErrorStatus errorStatus)
	A delegate defining the signature of the callback function used to retrive tracking data. More...

	Tracker ()
	Tracker constructor. More...

	Tracker (string path)
	Tracker constructor. More...

	Tracker (string path, string configFile)
	Tracker constructor. More...

	Tracker (string path, string configFile, string dbFile)
	Tracker constructor. More...

	Tracker (string path, string configFile, string dbFile, string grabberName)
	Tracker constructor. More...

string[]	GetUncalibratedCameraUrls (bool silent=false)
	Check if cameras of the connected PST Tracker are calibrated. More...

string	GetVersionInfo ()
	Get version information of the SDK. More...

string	GetConfigPath ()
	Get the path to the current configuration directory. More...

void	AddTrackerListener (OnTrackerDataCallback onTrackerDataCallback)
	Add a listener for tracker data. More...

void	RemoveTrackerListener (OnTrackerDataCallback onTrackerDataCallback)
	Remove a listener for tracker data. More...

void	StartTracker ()
	Start tracking. More...

void	PauseTracker ()
	Pause tracking. More...

StatusMessage	Systemcheck ()
	Check if the tracker is running correctly. More...

void	SetFramerate (double fps)
	Set tracker frame rate. More...

double	GetFramerate ()
	Get current frame rate. More...

float[]	GetSupportedFramerates ()
	Get array of available frame rates. More...

void	SetExposure (double exposure)
	Set the exposure time. More...

double	GetExposure ()
	Get the current exposure time. More...

void	GetExposureRange (ref double min, ref double max)
	Get the allowed exposure range. More...

void	EnableFiltering ()
	Enable filtering of the tracking results. More...

void	DisableFiltering ()
	Disable filtering of the tracking results. More...

void	SetPositionFilter (double value)
	Set the strength of the position filter. More...

void	SetOrientationFilter (double value)
	Set the strength of the orientation filter. More...

void	EnableTremorFilter ()
	Enable the tremor filter. More...

void	DisableTremorFilter ()
	Disable the tremor filter. More...

void	EnableImageTransfer ()
	Enable image transfer from the PST Tracker. More...

void	DisableImageTransfer ()
	Disable image transfer from the PST Tracker. More...

Image	GetImage ()
	Retrieve images from the connected PST Tracker. More...

TargetStatus[]	GetTargetList ()
	Get TargetStatuses object containing all tracking targets and their status. More...

Target	GetTargetInfo (string targetName)
	Get basic tracking target information. More...

void	SetTargetStatus (string targetName, bool active)
	Set status of a single tracking Target. More...

bool	GetTargetStatus (string targetName)
	Get status of a single tracking Target. More...

TargetMarker[]	GetTargetMarkers (string targetName)
	Get 3D marker positions of stored tracking Target. More...

void	SetTargetId (string targetName, int id)
	Set the id of the tracking target. More...

void	SetReference (float[] creference, bool relative=false)
	Set the reference system in which tracking results are reported More...

void	SetDefaultReference ()
	Reset the reference system to the default reference system. More...

float[]	GetReference ()
	Gets the transformation matrix for the current reference system. More...

void	Dispose ()
	Dispose method. More...

Static Public Member Functions
static void	Shutdown ()
	Shutdown the tracking system, stopping tracking. More...

static void	EnableSharedMemory ()
	Enable shared memory communication layer. More...

static void	DisableSharedMemory ()
	Disable shared memory communication layer. More...

static void	EnableRestServer (string serverAddress="localhost", string serverPort="7278", int eventStreamRetryTimeout=3000)
	Enable a REST Server using the HTTP protocol on a local area network. More...

static void	DisableRestServer ()
	Disable the REST server communication layer. More...

static void	EnableLogging ()
	Write plug-in status information to the standard error stream. More...

static string	GetSDKVersion ()
	Retrieve the SDK version string. More...

Detailed Description

This class implements the main PST SDK functionality. Examples on how to use this class and how to get data from the PST Tracker can be found in the Examples section.

Constructor & Destructor Documentation

◆ Tracker() [1/5]

PSTech.Pstsdk.Tracker.Tracker ( )

inline

Construct Tracker object using default values and initialize connected PST tracker.Camera calibration information is checked during initialization. When calibration files for the connected tracker can not be found, a message with download links will be printed to the command line.

See also: GetUncalibratedCameraUrls

Exceptions

TrackerException	General Tracker error.
NotInitializedException	Tracker was not initialized correctly.

◆ Tracker() [2/5]

PSTech.Pstsdk.Tracker.Tracker ( string path )

inline

Construct Tracker object setting the configuration path and initialize connected PST tracker.Camera calibration information is checked during initialization. When calibration files for the connected tracker can not be found, a message with download links will be printed to the command line.

Parameters

path	Path to the configuration directory to be used for storing camera calibrations, target database and configuration files.Use "" for default. (default: "%PROGRAMDATA%\PS-Tech\PST Iris")

See also: GetUncalibratedCameraUrls

Exceptions

TrackerException	General Tracker error.
NotInitializedException	Tracker was not initialized correctly.

◆ Tracker() [3/5]

PSTech.Pstsdk.Tracker.Tracker	(	string	path,
		string	configFile
	)

inline

Construct Tracker object using a config path and config file name and initialize connected PST tracker.Camera calibration information is checked during initialization. When calibration files for the connected tracker can not be found, a message with download links will be printed to the command line.

Parameters

path	Path to the configuration directory to be used for storing camera calibrations, target database and configuration files.Use "" for default. (default: "%PROGRAMDATA%\PS-Tech\PST Iris")
configFile	Name of the server configuration file.Use "" for default. (default: "server.cfg").>

See also: GetUncalibratedCameraUrls

Exceptions

TrackerException	General Tracker error.
NotInitializedException	Tracker was not initialized correctly.

◆ Tracker() [4/5]

PSTech.Pstsdk.Tracker.Tracker	(	string	path,
		string	configFile,
		string	dbFile
	)

inline

Construct Tracker object using a config path, config file name and models database path and initialize connected PST tracker.Camera calibration information is checked during initialization. When calibration files for the connected tracker can not be found, a message with download links will be printed to the command line.

Parameters

path	Path to the configuration directory to be used for storing camera calibrations, target database and configuration files.Use "" for default. (default: "%PROGRAMDATA%\PS-Tech\PST Iris")
configFile	Name of the server configuration file.Use "" for default. (default: "server.cfg").>
dbFile	Name of the tracking target database file.Use "" for default. (default: "models.db").

See also: GetUncalibratedCameraUrls

Exceptions

TrackerException	General Tracker error.
NotInitializedException	Tracker was not initialized correctly.

◆ Tracker() [5/5]

PSTech.Pstsdk.Tracker.Tracker	(	string	path,
		string	configFile,
		string	dbFile,
		string	grabberName
	)

inline

Construct Tracker object using a config path, config file name, models database path and grabber file name and initialize connected PST tracker.Camera calibration information is checked during initialization. When calibration files for the connected tracker can not be found, a message with download links will be printed to the command line.

Parameters

path	Path to the configuration directory to be used for storing camera calibrations, target database and configuration files.Use "" for default. (default: "%PROGRAMDATA%\PS-Tech\PST Iris")
configFile	Name of the server configuration file.Use "" for default. (default: "server.cfg").>
dbFile	Name of the tracking target database file.Use "" for default. (default: "models.db").
grabberName	Name of the grabber plugin to be used.Can contain absolute or relative path to xml config file.Set to "default" to use auto-detect. (default: "default")

See also: GetUncalibratedCameraUrls

Exceptions

TrackerException	General Tracker error.
NotInitializedException	Tracker was not initialized correctly.

Member Function Documentation

◆ AddTrackerListener()

void PSTech.Pstsdk.Tracker.AddTrackerListener ( OnTrackerDataCallback onTrackerDataCallback )

inline

Register a callback function to receive tracking information from the connected PST Tracker.

Parameters

onTrackerDataCallback A function whose signature matches the PSTech.pstsdk.Tracker.OnTrackerDataCallback() delegate and should be called when the Tracker has new data available.

See also: TrackerData, RemoveTrackerListener

◆ DisableFiltering()

void PSTech.Pstsdk.Tracker.DisableFiltering ( )

inline

Switch off filtering of the tracking results using the double exponential-based prediction filter (DESP).

See also: EnableFiltering, DisableTremorFilter

◆ DisableImageTransfer()

void PSTech.Pstsdk.Tracker.DisableImageTransfer ( )

inline

Disable transferring grayscale image data from the PST Tracker. When using a standard PST Iris or PST Base tracker, the frame rate of the tracker will be restored to the frame rate that was set before enabling image transfer.

See also: EnableImageTransfer

◆ DisableRestServer()

static void PSTech.Pstsdk.Tracker.DisableRestServer ( )

inlinestatic

Disable the REST server communication layer. If a REST server is running, the connections will be closed and the REST server will be destroyed. If no REST server is running a call to DisableRestServer() does nothing.

See also: EnableRestServer

◆ DisableSharedMemory()

static void PSTech.Pstsdk.Tracker.DisableSharedMemory ( )

inlinestatic

Disable the shared memory-based communication layer. The PST-Client application will no longer be able to connect to the PST Tracker.

See also: EnableSharedMemory

◆ DisableTremorFilter()

void PSTech.Pstsdk.Tracker.DisableTremorFilter ( )

inline

Disables the tremor filter. The tremor filter will no longer be used to filter the estimated target pose.

See also: EnableTremorFilter, DisableFiltering

◆ Dispose()

void PSTech.Pstsdk.Tracker.Dispose ( )

inline

This function should always be called before terminating an application using the PST Tracker. See the "Safe tracker termination" section for more information.

◆ EnableFiltering()

void PSTech.Pstsdk.Tracker.EnableFiltering ( )

inline

Switch on filtering of the tracker results using a double exponential-based prediction filter(DESP). This will result in smoother tracking with less noise.It can have a small impact on tracker accuracy.

Note: When the shared memory communication pipeline is used to connect the PST-Client application to the SDK, filtering will be disabled upon starting the PST-Client application.To prevent multiple filter passes, filtering should not be re-enabled until the PST-Client application is closed.

See also: DisableFiltering, SetPositionFilter, SetOrientationFilter, EnableTremorFilter, EnableSharedMemory

◆ EnableImageTransfer()

void PSTech.Pstsdk.Tracker.EnableImageTransfer ( )

inline

Enable transferring grayscale image data from the PST Tracker. After enabling image transfer, call GetImage() in order to receive the captured images. When no calls are made to GetImage() for more than 4 seconds, image transfer will be automatically disabled. Note that for the standard PST Iris and standard PST Base trackers, enabling image transfer will result in a reduced framerate of 30 fps. The frame rate will be restored to the original setting after image transfer is disabled.

See also: GetImage, DisableImageTransfer

◆ EnableLogging()

static void PSTech.Pstsdk.Tracker.EnableLogging ( )

inlinestatic

Provides information about the status of the tracker plug-in. Information is written to the standard error stream. Useful when debugging.

Note: This should be called before creating any Tracker objects. Calling this afterwards will have no effect.

◆ EnableRestServer()

static void PSTech.Pstsdk.Tracker.EnableRestServer	(	string	serverAddress = `"localhost"`,
		string	serverPort = `"7278"`,
		int	eventStreamRetryTimeout = `3000`
	)

inlinestatic

Enable a REST Server that uses the HTTP protocol to enable access to the PST Tracker over a local area network. Parameters from the tracker can be accessed using GET requests. Tracking results and image can be streamed using an Event-stream based communication pipeline. The state of the tracker and parameters can be set through POST calls. If a REST server is aleady running, calling EnableRestServer() will terminate the current server and restart it with the new parameters. More information on how to use the REST server can be found in the REST documentation.

Parameters

serverAddress	The IP address on which the REST server should be accessible.
serverPort	The port number on which the REST server should be accessible.
eventStreamRetryTimeout	Timeout in milliseconds before an eventstream attempt to reconnect to the server automatically.

See also: DisableRestServer

Exceptions

HttpException	The REST server failed to initialize properly. A possible cause could be an invalid IP address or port number.
NotInitializedException	A Tracker object must have been initialized before enabling the REST server.

◆ EnableSharedMemory()

static void PSTech.Pstsdk.Tracker.EnableSharedMemory ( )

inlinestatic

Enable a shared memory-based communication layer. Enabling shared memory will allow the PST-Client application to connect to the SDK. This will allow receiving tracking data and setting parameters using the PST-Client application. Note that a PST-Client that is connected in this way will not be updated when settings are changed through the SDK. This could cause instabilities in the PST software.It is recommended to only use this function when setting up a PST Tracker (e.g.adding tracking targets or retrieving calibration data). When using a tracker in normal operation, it is recommended to choose to use either the PST-Client application or the SDK and not mix usage.

Note: When using shared memory on Windows the application needs to have elevated access(run as Administrator). When running without elevated access the PST-Client will not be able to connect.; When the shared memory communication pipeline is used to connect the PST-Client application to the SDK, filtering will be disabled upon starting the PST-Client application.To prevent multiple filter passes, filtering should not be re-enabled until the PST-Client application is closed.; A Tracker object must have been initialized before enabling shared memory.

Exceptions

NotInitializedException A Tracker object must have been initialized before enabling shared memory.

See also: DisableSharedMemory, EnableFiltering, EnableTremorFilter

◆ EnableTremorFilter()

void PSTech.Pstsdk.Tracker.EnableTremorFilter ( )

inline

Enables the tremor filter. This filter greatly reduces the noise levels of the estimated target pose. However, using the filter introduces latency to the tracking results received and lowers tracking accuracy.This filter is mainly useful when using the PST Tracker in an interaction-type setting. When the PST Tracker is used for measurement purposes, enabling the tremor filter is not recommended.

Note: When the shared memory communication pipeline is used to connect the PST-Client application to the SDK, filtering will be disabled upon starting the PST-Client application.To prevent multiple filter passes, filtering should not be re-enabled until the PST-Client application is closed.

See also: DisableTremorFilter, EnableFiltering

◆ GetConfigPath()

string PSTech.Pstsdk.Tracker.GetConfigPath ( )

inline

Retrieves the full path to the configuration directory currently being used by the PST Tracker. The default path is "%PROGRAMDATA%\PS-Tech\PST Iris". The configuration directory contains the target model database, server configuration, reference file and tracker calibration information.

Returns: The full path to the configuration directory.

Exceptions

OutOfMemoryException Failed to allocate memory.

◆ GetExposure()

double PSTech.Pstsdk.Tracker.GetExposure ( )

inline

Get the current exposure time as set on the PST Tracker.

Returns: The current exposure time in seconds.

See also: SetExposure

◆ GetExposureRange()

void PSTech.Pstsdk.Tracker.GetExposureRange	(	ref double	min,
		ref double	max
	)

inline

Get the minimum and maximum exposure value that can be set with the current frame rate. The maximum exposure value differs for different frame rates and PST Trackers. In general, lower frame rates allow for higher exposures and higher frame rates have a lower maximum exposure value. After changing the frame rate it is advised to check the currently allowed range before changing exposure values.

Parameters

min	The minimum exposure value that can be set.
max	The maximum exposure value that can be set.

See also: SetExposure, GetExposure, SetFramerate

◆ GetFramerate()

double PSTech.Pstsdk.Tracker.GetFramerate ( )

inline

Get the current frame rate as set on the PST Tracker.

Returns: Current frame rate in frames per second (fps).

See also: SetFramerate, GetSupportedFramerates

◆ GetImage()

Image PSTech.Pstsdk.Tracker.GetImage ( )

inline

Retrieve images from the PST Tracker when image transfer has been enabled. When image transfer has not been enabled by calling EnableImageTransfer() before calling this method, Image.image will be an empty vector. Note that image transfer will be automatically disabled when no call to this method is made for 4 seconds.

Returns: Image object containing the image information retrieved from the PST Tracker.

See also: Image, EnableImageTransfer

Exceptions

OutOfMemoryException	Failed to allocate memory.
ImageRetrievalException	Image retrieval failed.

◆ GetReference()

float [] PSTech.Pstsdk.Tracker.GetReference ( )

inline

Tracking results are reported relative to a predefined right-handed Cartesian coordinate system, called the reference system. The default reference system is located at 1 meter from the PST Tracker.It is oriented such that the Z-axis points away from the PST tracker and the X-axis is parallel to the PST tracker.The transformation matrix defining the reference system is a row-major 4x4 homogeneous transformation matrix.

Returns: The transformation matrix for the current reference system.

See also: SetReference, SetDefaultReference

◆ GetSDKVersion()

static string PSTech.Pstsdk.Tracker.GetSDKVersion ( )

inlinestatic

Retrieves the SDK version information as a string. The SDK version can differ from the internal tracker version which can be retrieved using GetVersionInfo.

Returns: Returns version.

See also: GetVersionInfo

◆ GetSupportedFramerates()

float [] PSTech.Pstsdk.Tracker.GetSupportedFramerates ( )

inline

Get a vector containing all frame rates that are available for the currently connected PST Tracker. The range of available frame rates differs for different types of PST Trackers. When using SetFramerate() to set a new frame rate, the frame rate of the PST Tracker will be set to the value provided by this function nearest to the value supplied to SetFramerate().

Returns: A array of available frame rates.

See also: SetFramerate, GetFramerate

Exceptions

OutOfMemoryException Failed to allocate memory.

◆ GetTargetInfo()

Target PSTech.Pstsdk.Tracker.GetTargetInfo ( string targetName )

inline

Retrieves the name, uuid and id for the requested tracking target.

Parameters

targetName The name of the tracking target.

Returns: Target object containing the basic target information.

See also: Target

Exceptions

NotFoundException The requested data could not be found.

◆ GetTargetList()

TargetStatus [] PSTech.Pstsdk.Tracker.GetTargetList ( )

inline

Retrieves the list of all tracking targets defined in the tracking target database and returns them as a array of TargetStatus objects.

Returns: Array of TargetStatus elements containing the information and status of all available tracking Targets.

See also: TargetStatus, SetTargetStatus, GetTargetStatus

Exceptions

OutOfMemoryException Failed to allocate memory.

◆ GetTargetMarkers()

TargetMarker [] PSTech.Pstsdk.Tracker.GetTargetMarkers ( string targetName )

inline

Gets a list of the 3D positions of the markers making up the specified tracking Target. The returned positions are relative to the tracking Target origin.

Parameters

targetName Name of the tracking Target to get the marker positions of.

Returns: Array of TargetMarker elements containing 3D marker positions.

See also: TargetMarker, Target

Exceptions

OutOfMemoryException	Failed to allocate memory.
NotFoundException	The requested data could not be found.

◆ GetTargetStatus()

bool PSTech.Pstsdk.Tracker.GetTargetStatus ( string targetName )

inline

Retrieves the status of a single tracking Target. Tracking targets can be either active (true) or inactive (false).

Parameters

targetName The name of the tracking Target to get the status of.

Returns: Status of the tracking Target.

Exceptions

NotFoundException The requested data could not be found.

◆ GetUncalibratedCameraUrls()

string [] PSTech.Pstsdk.Tracker.GetUncalibratedCameraUrls ( bool silent = false )

inline

Check for calibration information of the cameras of the connected PST Tracker. When not all calibration information can be retrieved, download urls for the uncalibrated cameras will be returned. Furthermore, a message will be shown at the command line specifying which files are missing and where they can be downloaded.

Parameters

silent Set to true in order to disable printing of missing calibration information. (default: false)

Returns: Array of URLs specifying the download location of calibration information for uncalibrated cameras. The size of the vector is the number of uncalibrated cameras.

Exceptions

OutOfMemoryException Failed to allocate memory.

◆ GetVersionInfo()

string PSTech.Pstsdk.Tracker.GetVersionInfo ( )

inline

Retrieves version information of the PST Server used by the SDK.

Returns: The version number of the PST Server.

Exceptions

OutOfMemoryException Failed to allocate memory.

◆ OnTrackerDataCallback()

delegate void PSTech.Pstsdk.Tracker.OnTrackerDataCallback	(	TrackerData	trackerData,
		ErrorStatus	errorStatus
	)

A delegate defining the signature of the callback function used to receive tracking data from the Tracker object when it becomes available. By defining a callback function with this signature and adding it to the Tracker object using PSTech.pstsdk.Tracker.AddListener(), tacking data can be received and processed.

Parameters

trackerData	Tracking information retrieved from tracker.
errorStatus	Return OK on success or ErrorStatus.

See also: TrackerData, AddTrackerListener, RemoveTrackerListener

◆ PauseTracker()

void PSTech.Pstsdk.Tracker.PauseTracker ( )

inline

Pause the tracking system, stop producing tracking results and enter low-power mode. Tracking can be resumed with a subsequent call to StartTracker().

See also: StartTracker

◆ RemoveTrackerListener()

void PSTech.Pstsdk.Tracker.RemoveTrackerListener ( OnTrackerDataCallback onTrackerDataCallback )

inline

Remove a callback function receiving tracking information from the connected PST Tracker.

Parameters

onTrackerDataCallback A function whose signature matches the PSTech.pstsdk.Tracker.OnTrackerDataCallback() delegate and should be called when the Tracker has new data available.

See also: AddTrackerListener

◆ SetDefaultReference()

void PSTech.Pstsdk.Tracker.SetDefaultReference ( )

inline

Resets the currently set reference system to the default reference system. The default system is defined by a 4x4 identity matrix. This places the origin of the reference system 1 meter away from the PST Tracker.It is oriented such that the Z-axis points away from the PST tracker and the X-axis is parallel to the PST tracker.

See also: SetReference, GetReference

◆ SetExposure()

void PSTech.Pstsdk.Tracker.SetExposure ( double exposure )

inline

/// Set the PST Tracker exposure time to the supplied time.This adjusts both the shutter speed of the PST Tracker and the time the IR illumination panel will be turned on.

Parameters

exposure Exposure time in seconds.

See also: SetFramerate, GetFramerate

Exceptions

OutOfRangeException	The supplied value is outside of the accepted range.
NotSupportedException	Exposure could not be set on the Tracker.

◆ SetFramerate()

void PSTech.Pstsdk.Tracker.SetFramerate ( double fps )

inline

Set the PST Tracker frame rate to the value available for the connected PST Tracker nearest to the supplied value.

Parameters

fps	The new frame rate to be set.

See also: GetFramerate, GetSupportedFramerates

Exceptions

NotSupportedException Framerate could not be set on the Tracker.

◆ SetOrientationFilter()

void PSTech.Pstsdk.Tracker.SetOrientationFilter ( double value )

inline

Set the strength of the double exponential-based prediction filter (DESP) that filters the estimated positions of the tracked tracking targets. The supplied filtering value should be between 0 (no filtering) and 0.99 (maximum filtering).

Parameters

value Filtering strength to be used in range [0, 0.99].

See also: EnableFiltering, SetPositionFilter

◆ SetPositionFilter()

void PSTech.Pstsdk.Tracker.SetPositionFilter ( double value )

inline

Set the strength of the double exponential-based prediction filter (DESP) that filters the estimated positions of the tracked tracking targets. The supplied filtering value should be between 0 (no filtering) and 0.99 (maximum filtering).

Parameters

value Filtering strength to be used in range [0, 0.99].

See also: EnableFiltering, SetOrientationFilter

◆ SetReference()

void PSTech.Pstsdk.Tracker.SetReference	(	float[]	creference,
		bool	relative = `false`
	)

inline

The reference system is defined by a homogeneous transformation matrix (a row-major 4x4 matrix) representing a right-handed Cartesian coordinate system.The function checks if a valid, orthogonal transformation matrix has been supplied. When an invalid matrix has been supplied, it will not be applied.To check if the function was successful, please use GetReference() and compare the result.As an optional parameter, the reference system can be set relative to the current reference system. When this option is used, the current reference system is transformed using the supplied transformation matrix. Otherwise, the current reference system is replaced by the supplied reference system.

Parameters

creference	The transformation matrix for the new reference system.
relative	When set to true, the current transformation matrix is transformed using the supplied transformation matrix.

See also: GetReference, SetDefaultReference

◆ SetTargetId()

void PSTech.Pstsdk.Tracker.SetTargetId	(	string	targetName,
		int	id
	)

inline

This function changes the id of the tracking target. This id is mainly used when connecting to the PST Tracker through VRPN.

Parameters

targetName	The name of the tracking target to change the id of.
id	The new id of the tracking target.

See also: Target

Exceptions

NotFoundException The requested data could not be found.

◆ SetTargetStatus()

void PSTech.Pstsdk.Tracker.SetTargetStatus	(	string	targetName,
		bool	active
	)

inline

Sets the status of a single tracking Target to active (true) or inactive (false).

Parameters

targetName	The name of the tracking Target to set the status of.
active	New status of the tracking Target.

See also: TargetStatus, GetTargetStatus, GetTargetList

Exceptions

NotFoundException The requested data could not be found.

◆ Shutdown()

static void PSTech.Pstsdk.Tracker.Shutdown ( )

inlinestatic

Fully shutdown the tracking system, disconnecting from the PST Tracker and rendering the Tracker object useless. When the shared memory interface has been enabled it will be disabled as well. In order to restart the tracker, a new instance of the Tracker class has to be created.

See also: Tracker(string, string, string, string), DisableSharedMemory

◆ StartTracker()

void PSTech.Pstsdk.Tracker.StartTracker ( )

inline

Start the tracking system and produce tracking results.

See also: PauseTracker

◆ Systemcheck()

StatusMessage PSTech.Pstsdk.Tracker.Systemcheck ( )

inline

Perform a system check, checking if the PST Tracker has been initialized correctly and if the system is running properly. In order to get continuous feedback on the status of the PST Tracker it is recommended to implement regular polling of this function. This way, issues that will not cause the software to crash (e.g. a camera disconnect) can be handled.

Returns: Current system status code as StatusMessage enumeration member.

See also: StatusMessage

The documentation for this class was generated from the following file:

C:/CI/builds/aS8LEeTG/0/ps-tech/pst-installer/pstsdk/csharp/src/Tracker.cs

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Tracker() [1/5]

◆ Tracker() [2/5]

◆ Tracker() [3/5]

◆ Tracker() [4/5]

◆ Tracker() [5/5]

Member Function Documentation

◆ AddTrackerListener()

◆ DisableFiltering()

◆ DisableImageTransfer()

◆ DisableRestServer()

◆ DisableSharedMemory()

◆ DisableTremorFilter()

◆ Dispose()

◆ EnableFiltering()

◆ EnableImageTransfer()

◆ EnableLogging()

◆ EnableRestServer()

◆ EnableSharedMemory()

◆ EnableTremorFilter()

◆ GetConfigPath()

◆ GetExposure()

◆ GetExposureRange()

◆ GetFramerate()

◆ GetImage()

◆ GetReference()

◆ GetSDKVersion()

◆ GetSupportedFramerates()

◆ GetTargetInfo()

◆ GetTargetList()

◆ GetTargetMarkers()

◆ GetTargetStatus()

◆ GetUncalibratedCameraUrls()

◆ GetVersionInfo()

◆ OnTrackerDataCallback()

◆ PauseTracker()

◆ RemoveTrackerListener()

◆ SetDefaultReference()

◆ SetExposure()

◆ SetFramerate()

◆ SetOrientationFilter()

◆ SetPositionFilter()

◆ SetReference()

◆ SetTargetId()

◆ SetTargetStatus()

◆ Shutdown()

◆ StartTracker()

◆ Systemcheck()