Structure for the settings used by the algorithms implemented in QueuedTracker. More...

#include <qtrk_c_api.h>

Inheritance diagram for QTrkSettings:

Public Member Functions
	QTrkSettings ()

Public Attributes
int	width
	Width of regions of interest to be handled. Typically equals height (square ROI). More...

int	height
	Height of regions of interest to be handled. Typically equals width (square ROI). More...

int	numThreads
	Number of threads/streams to use. Defaults differ between CPU and GPU implementations. More...

int	cuda_device
	CUDA only. Flag for device selection. More...

float	com_bgcorrection
	Background correction factor for COM. Defines the number of standard deviations data needs to be away from the image mean to be taken into account. More...

float	zlut_minradius
	Distance in pixels from the bead center from which to start sampling profiles. Default 1.0. More...

float	zlut_radial_coverage
	Sampling points per radial pixel. Default 3.0. More...

float	zlut_angular_coverage
	Factor of the sampling perimeter to cover with angular sampling steps. Between 0 and 1, default 0.7. More...

float	zlut_roi_coverage
	Factor of the ROI to include in sampling. Between 0 and 1, default 1. Maxradius = ROI/2*roi_coverage. More...

int	qi_iterations
	Number of times to run the QI algorithm, sampling around the last found position. More...

float	qi_minradius
	Distance in pixels from the bead center from which to start sampling profiles. Default 1.0. More...

float	qi_radial_coverage
	Sampling points per radial pixel. Default 3.0. More...

float	qi_angular_coverage
	Factor of the sampling perimeter to cover with angular sampling steps. Between 0 and 1, default 0.7. More...

float	qi_roi_coverage
	Factor of the ROI to include in sampling. Between 0 and 1, default 1. Maxradius = ROI/2*roi_coverage. More...

float	qi_angstep_factor
	Factor to reduce angular steps on lower iterations. Default 1.0 (no effect). More...

int	xc1_profileLength
	Profile length for the cross correlation. More...

int	xc1_profileWidth
	Profile width for the cross correlation. More...

int	xc1_iterations
	Number of times to run the cross correlation algorithm. More...

int	gauss2D_iterations
	Number of times to run the 2D gaussian algorithm. More...

float	gauss2D_sigma
	Standard deviation to use in the 2D gaussian algorithm. More...

int	downsample
	Image downsampling factor. Applied before anything else. 0 = original, 1 = 1x (W=W/2,H=H/2). More...

bool	testRun
	Flag to run a test run. More...

Detailed Description

Structure for the settings used by the algorithms implemented in QueuedTracker.

Compiled without padding to line up with LabVIEW alignment.

Warning: Changing this requires changing of the linked LabVIEW cluster QTrkSettings.ctl.

Note: All settings are always defined, eventhough only one of the three 2D localization algorithms is used.

Definition at line 82 of file qtrk_c_api.h.

Constructor & Destructor Documentation

§ QTrkSettings()

QTrkSettings::QTrkSettings ( )

inline

Set default values on initialization

Definition at line 83 of file qtrk_c_api.h.

                    { 
         width = height = 100;
         numThreads = -1;
         xc1_profileLength = 128;
         xc1_profileWidth = 32;
         xc1_iterations = 2;
         zlut_minradius = 1.0f;
         zlut_angular_coverage = 0.7f;
         zlut_radial_coverage = 3.0f;
         zlut_roi_coverage = 1.0f;
         qi_iterations = 5;
         qi_minradius = 1;
         qi_angular_coverage = 0.7f;
         qi_radial_coverage = 3.0f; 
         qi_roi_coverage = 1.0f;
         qi_angstep_factor = 1.0f;
         cuda_device = -2;
         com_bgcorrection = 0.0f;
         gauss2D_iterations = 6;
         gauss2D_sigma = 4;
         downsample = 0;
         //testRun = false; // CHANGED! Comment/remove when compiling for labview
     }

Member Data Documentation

§ com_bgcorrection

float QTrkSettings::com_bgcorrection

Background correction factor for COM. Defines the number of standard deviations data needs to be away from the image mean to be taken into account.

Definition at line 133 of file qtrk_c_api.h.

§ cuda_device

int QTrkSettings::cuda_device

CUDA only. Flag for device selection.

cuda_device >= 0	Use as hardware device index.
cuda_device < 0	Use flags below

QTrkCUDA_UseList	-3	Use list defined by SetCUDADevices.
QTrkCUDA_UseAll	-2	Use all available devices. Default option.
QTrkCUDA_UseBest	-1	Only use the best device.

Definition at line 131 of file qtrk_c_api.h.

§ downsample

int QTrkSettings::downsample

Image downsampling factor. Applied before anything else. 0 = original, 1 = 1x (W=W/2,H=H/2).

Definition at line 166 of file qtrk_c_api.h.

§ gauss2D_iterations

int QTrkSettings::gauss2D_iterations

Number of times to run the 2D gaussian algorithm.

Definition at line 163 of file qtrk_c_api.h.

§ gauss2D_sigma

float QTrkSettings::gauss2D_sigma

Standard deviation to use in the 2D gaussian algorithm.

Definition at line 164 of file qtrk_c_api.h.

§ height

int QTrkSettings::height

Height of regions of interest to be handled. Typically equals width (square ROI).

Definition at line 107 of file qtrk_c_api.h.

§ numThreads

int QTrkSettings::numThreads

Number of threads/streams to use. Defaults differ between CPU and GPU implementations.

[CPU]: Default -1 chooses threads equal to the number of CPUs available.
[CUDA]: Default -1 chooses 4 streams per available device.

Definition at line 114 of file qtrk_c_api.h.

§ qi_angstep_factor

float QTrkSettings::qi_angstep_factor

Factor to reduce angular steps on lower iterations. Default 1.0 (no effect).

Using this will scale the number of angular steps actually taken per iteration. The final number, QTrkComputedConfig::qi_angstepspq is taken on the final iteration. A starting number is calculated such that

$angstepspq = start * angstepFactor^{iterations}$

That is, the amount of steps used is increased by this factor on every iteration until the maximum is reached on the final iteration.

Increase for faster early iterations but more image noise sensitivity.

Definition at line 157 of file qtrk_c_api.h.

§ qi_angular_coverage

float QTrkSettings::qi_angular_coverage

Factor of the sampling perimeter to cover with angular sampling steps. Between 0 and 1, default 0.7.

Definition at line 143 of file qtrk_c_api.h.

§ qi_iterations

int QTrkSettings::qi_iterations

Number of times to run the QI algorithm, sampling around the last found position.

Definition at line 140 of file qtrk_c_api.h.

§ qi_minradius

float QTrkSettings::qi_minradius

Distance in pixels from the bead center from which to start sampling profiles. Default 1.0.

Definition at line 141 of file qtrk_c_api.h.

§ qi_radial_coverage

float QTrkSettings::qi_radial_coverage

Sampling points per radial pixel. Default 3.0.

Definition at line 142 of file qtrk_c_api.h.

§ qi_roi_coverage

float QTrkSettings::qi_roi_coverage

Factor of the ROI to include in sampling. Between 0 and 1, default 1. Maxradius = ROI/2*roi_coverage.

Definition at line 144 of file qtrk_c_api.h.

§ testRun

bool QTrkSettings::testRun

Flag to run a test run.

A test run dumps a lot of intermediate data to the disk for algorithm inspection (only QI & ZLUT). See CPUTracker::testRun.

Warning: CHANGED compared to LabVIEW! Comment/remove when compiling for LabVIEW.

Todo:: Add to LabVIEW cluster.

Definition at line 174 of file qtrk_c_api.h.

§ width

int QTrkSettings::width

Width of regions of interest to be handled. Typically equals height (square ROI).

Definition at line 106 of file qtrk_c_api.h.

§ xc1_iterations

int QTrkSettings::xc1_iterations

Number of times to run the cross correlation algorithm.

Definition at line 161 of file qtrk_c_api.h.

§ xc1_profileLength

int QTrkSettings::xc1_profileLength

Profile length for the cross correlation.

Definition at line 159 of file qtrk_c_api.h.

§ xc1_profileWidth

int QTrkSettings::xc1_profileWidth

Profile width for the cross correlation.

Definition at line 160 of file qtrk_c_api.h.

§ zlut_angular_coverage

float QTrkSettings::zlut_angular_coverage

Factor of the sampling perimeter to cover with angular sampling steps. Between 0 and 1, default 0.7.

Definition at line 137 of file qtrk_c_api.h.

§ zlut_minradius

float QTrkSettings::zlut_minradius