API - C

API functions available to a C or .NET program. More...

Functions
CDLL_EXPORT QueuedTracker *DLL_CALLCONV	QTrkCreateInstance (QTrkSettings *cfg)
	Create a QueuedTracker instance and return a pointer to it. More...
CDLL_EXPORT void DLL_CALLCONV	QTrkFreeInstance (QueuedTracker *qtrk)
	Free a QueuedTracker instance. More...
CDLL_EXPORT void DLL_CALLCONV	QTrkSetLocalizationMode (QueuedTracker *qtrk, LocMode_t locType)
	Select which algorithm is to be used. More...
CDLL_EXPORT void DLL_CALLCONV	QTrkScheduleLocalization (QueuedTracker *qtrk, void *data, int pitch, QTRK_PixelDataType pdt, const LocalizationJob *jobInfo)
	Add a job to the queue to be processed. A job entails running the required algorithms on a single region of interest. More...
CDLL_EXPORT void DLL_CALLCONV	QTrkClearResults (QueuedTracker *qtrk)
CDLL_EXPORT void DLL_CALLCONV	QTrkFlush (QueuedTracker *qtrk)
CDLL_EXPORT int DLL_CALLCONV	QTrkScheduleFrame (QueuedTracker *qtrk, void *imgptr, int pitch, int width, int height, ROIPosition *positions, int numROI, QTRK_PixelDataType pdt, const LocalizationJob *jobInfo)
CDLL_EXPORT void DLL_CALLCONV	QTrkSetRadialZLUT (QueuedTracker *qtrk, float *data, int count, int planes, float *zcmp=0)
CDLL_EXPORT void DLL_CALLCONV	QTrkGetRadialZLUT (QueuedTracker *qtrk, float *dst)
CDLL_EXPORT void DLL_CALLCONV	QTrkGetRadialZLUTSize (QueuedTracker *qtrk, int *count, int *planes, int *radialsteps)
CDLL_EXPORT void DLL_CALLCONV	QTrkBuildLUT (QueuedTracker *qtrk, void *data, int pitch, QTRK_PixelDataType pdt, bool imageLUT, int plane)
CDLL_EXPORT void DLL_CALLCONV	QTrkFinalizeLUT (QueuedTracker *qtrk)
CDLL_EXPORT int DLL_CALLCONV	QTrkGetResultCount (QueuedTracker *qtrk)
CDLL_EXPORT int DLL_CALLCONV	QTrkFetchResults (QueuedTracker *qtrk, LocalizationResult *results, int maxResults)
CDLL_EXPORT int DLL_CALLCONV	QTrkGetQueueLength (QueuedTracker *qtrk, int *maxQueueLen)
CDLL_EXPORT bool DLL_CALLCONV	QTrkIsIdle (QueuedTracker *qtrk)
CDLL_EXPORT void DLL_CALLCONV	QTrkGetProfileReport (QueuedTracker *qtrk, char *dst, int maxStrLen)
CDLL_EXPORT void DLL_CALLCONV	QTrkGetWarnings (QueuedTracker *qtrk, char *dst, int maxStrLen)
CDLL_EXPORT void DLL_CALLCONV	QTrkGetComputedConfig (QueuedTracker *qtrk, QTrkComputedConfig *cfg)

Detailed Description

API functions available to a C or .NET program.

These DLLs are compiled by the cputrack and cudatrack projects.

Function Documentation

QTrkBuildLUT()

CDLL_EXPORT void DLL_CALLCONV QTrkBuildLUT	(	QueuedTracker *	qtrk,
		void *	data,
		int	pitch,
		QTRK_PixelDataType	pdt,
		bool	imageLUT,
		int	plane
	)

Definition at line 64 of file qtrk_c_api.cpp.

{
    qtrk->BuildLUT(data, pitch, pdt, /*imageLUT,*/ plane);
}

QTrkClearResults()

CDLL_EXPORT void DLL_CALLCONV QTrkClearResults

(

QueuedTracker *

qtrk

)

Definition at line 30 of file qtrk_c_api.cpp.

{
    qtrk->ClearResults();
}

QTrkCreateInstance()

CDLL_EXPORT QueuedTracker* DLL_CALLCONV QTrkCreateInstance

(

QTrkSettings *

cfg

)

Create a QueuedTracker instance and return a pointer to it.

Parameters

[in]

cfg

Pointer to the structure with the desired tracking settings.

Returns

Pointer to the created QTrk instance.

Definition at line 5 of file qtrk_c_api.cpp.

{
    return CreateQueuedTracker(*cfg);
}

QTrkFetchResults()

CDLL_EXPORT int DLL_CALLCONV QTrkFetchResults	(	QueuedTracker *	qtrk,
		LocalizationResult *	results,
		int	maxResults
	)

Definition at line 80 of file qtrk_c_api.cpp.

{
    return qtrk->FetchResults(results, maxResults);
}

QTrkFinalizeLUT()

CDLL_EXPORT void DLL_CALLCONV QTrkFinalizeLUT

(

QueuedTracker *

qtrk

)

Definition at line 69 of file qtrk_c_api.cpp.

{
    qtrk->FinalizeLUT();
}

QTrkFlush()

CDLL_EXPORT void DLL_CALLCONV QTrkFlush

(

QueuedTracker *

qtrk

)

Definition at line 35 of file qtrk_c_api.cpp.

{
    qtrk->Flush();
}

QTrkFreeInstance()

CDLL_EXPORT void DLL_CALLCONV QTrkFreeInstance

(

QueuedTracker *

qtrk

)

Free a QueuedTracker instance.

Parameters

[in]

qtrk

Pointer to the qtrk instance of destroy.

Definition at line 10 of file qtrk_c_api.cpp.

{
    delete qtrk;
}

QTrkGetComputedConfig()

CDLL_EXPORT void DLL_CALLCONV QTrkGetComputedConfig	(	QueuedTracker *	qtrk,
		QTrkComputedConfig *	cfg
	)

Definition at line 107 of file qtrk_c_api.cpp.

{
    *cfg = qtrk->cfg;
}

QTrkGetProfileReport()

CDLL_EXPORT void DLL_CALLCONV QTrkGetProfileReport	(	QueuedTracker *	qtrk,
		char *	dst,
		int	maxStrLen
	)

Definition at line 96 of file qtrk_c_api.cpp.

{
    strncpy(dst, qtrk->GetProfileReport().c_str(), maxStrLen);
}

QTrkGetQueueLength()

CDLL_EXPORT int DLL_CALLCONV QTrkGetQueueLength	(	QueuedTracker *	qtrk,
		int *	maxQueueLen
	)

Definition at line 86 of file qtrk_c_api.cpp.

{
    return qtrk->GetQueueLength(maxQueueLen);
}

QTrkGetRadialZLUT()

CDLL_EXPORT void DLL_CALLCONV QTrkGetRadialZLUT	(	QueuedTracker *	qtrk,
		float *	dst
	)

Definition at line 53 of file qtrk_c_api.cpp.

{
    qtrk->GetRadialZLUT(dst);
}

QTrkGetRadialZLUTSize()

CDLL_EXPORT void DLL_CALLCONV QTrkGetRadialZLUTSize	(	QueuedTracker *	qtrk,
		int *	count,
		int *	planes,
		int *	radialsteps
	)

Definition at line 58 of file qtrk_c_api.cpp.

{
    qtrk->GetRadialZLUTSize(*count, *planes, *radialsteps);
}

QTrkGetResultCount()

CDLL_EXPORT int DLL_CALLCONV QTrkGetResultCount

(

QueuedTracker *

qtrk

)

Definition at line 75 of file qtrk_c_api.cpp.

{
    return qtrk->GetResultCount();
}

QTrkGetWarnings()

CDLL_EXPORT void DLL_CALLCONV QTrkGetWarnings	(	QueuedTracker *	qtrk,
		char *	dst,
		int	maxStrLen
	)

Definition at line 101 of file qtrk_c_api.cpp.

{
    strncpy(dst, qtrk->GetWarnings().c_str(), maxStrLen);
}

QTrkIsIdle()

CDLL_EXPORT bool DLL_CALLCONV QTrkIsIdle

(

QueuedTracker *

qtrk

)

Definition at line 91 of file qtrk_c_api.cpp.

{
    return qtrk->IsIdle();
}

QTrkScheduleFrame()

CDLL_EXPORT int DLL_CALLCONV QTrkScheduleFrame	(	QueuedTracker *	qtrk,
		void *	imgptr,
		int	pitch,
		int	width,
		int	height,
		ROIPosition *	positions,
		int	numROI,
		QTRK_PixelDataType	pdt,
		const LocalizationJob *	jobInfo
	)

Definition at line 41 of file qtrk_c_api.cpp.

{
    return qtrk->ScheduleFrame(imgptr, pitch, width, height, positions, numROI, pdt, jobInfo);
}

QTrkScheduleLocalization()

CDLL_EXPORT void DLL_CALLCONV QTrkScheduleLocalization	(	QueuedTracker *	qtrk,
		void *	data,
		int	pitch,
		QTRK_PixelDataType	pdt,
		const LocalizationJob *	jobInfo
	)

Add a job to the queue to be processed. A job entails running the required algorithms on a single region of interest.

Note

Frame and timestamp in jobInfo are ignored by tracking code itself, but usable for the calling code

Parameters

[in]	qtrk	Pointer to the QueuedTracker instance to be used.
[in]	data	Pointer to the data. Type specified by pdt.
[in]	pitch	Distance in bytes between two successive rows of pixels (e.g. address of (0,0) - address of (0,1)).
[in]	pdt	Type of data, specified by QTRK_PixelDataType.
[in]	jobInfo	Structure with metadata for the ROI to be handled. See LocalizationJob.

Definition at line 25 of file qtrk_c_api.cpp.

{
    qtrk->ScheduleLocalization(data,pitch,pdt,jobInfo);
}

QTrkSetLocalizationMode()

CDLL_EXPORT void DLL_CALLCONV QTrkSetLocalizationMode	(	QueuedTracker *	qtrk,
		LocMode_t	locType
	)

Select which algorithm is to be used.

Parameters

[in]	qtrk	A pointer to the QueuedTracker instance to use.
[in]	locType	An integer used as a bitmask for settings based on LocalizeModeEnum.

Definition at line 17 of file qtrk_c_api.cpp.

{
    qtrk->SetLocalizationMode(locType);
}

QTrkSetRadialZLUT()

CDLL_EXPORT void DLL_CALLCONV QTrkSetRadialZLUT	(	QueuedTracker *	qtrk,
		float *	data,
		int	count,
		int	planes,
		float *	zcmp = 0
	)

Definition at line 48 of file qtrk_c_api.cpp.

{
    qtrk->SetRadialZLUT(data, count, planes /*, zcmp*/);
}