com.wikitude.tracker

Class ImageTrackerConfiguration

java.lang.Object

com.wikitude.tracker.ImageTrackerConfiguration

public final class ImageTrackerConfiguration
extends Object

Configuration class for Image Trackers

Nested Class Summary

Nested Classes

Modifier and Type

Class and Description

static class

ImageTrackerConfiguration.ImageRecognitionRangeExtension ImageRecognitionRangeExtension defines if ImageTracker should use an optimized algorithm to detect target images in greater distance to the camera. Extending the recognition range requires HD camera frames processing and therefore needs more CPU power than the default recognition range. Extending the recognition distance requires more computational power of the CPU.

Constructor Summary

Constructors

Constructor and Description
ImageTrackerConfiguration()

Method Summary

Modifier and Type	Method and Description
int	getDistanceChangedThreshold() Returns the threshold the distance between targets has to exceed in order for ImageTarget.OnDistanceBetweenTargetsListener.onDistanceBetweenTargetsChanged(int, com.wikitude.tracker.ImageTarget, com.wikitude.tracker.ImageTarget) to be triggered.
String[]	getExtendedTargets()
ImageTrackerConfiguration.ImageRecognitionRangeExtension	getImageRecognitionRangeExtension() Returns the ImageTrackerConfiguration.ImageRecognitionRangeExtension that should be used when target image recognition is active.
int	getMaximumNumberOfConcurrentlyTrackableTargets() Returns the maximum number of targets that can be tracked concurrently.
HashMap<String,Integer>	getPhysicalTargetImageHeights() Returns a map of target names and their physical image height in mm.
TrackerEfficiencyMode	getTrackerEfficiencyMode() Returns the efficiency mode of the tracker.
void	setDistanceChangedThreshold(int distanceChangedThreshold) Sets the threshold the distance between targets has to exceed in order for ImageTarget.OnDistanceBetweenTargetsListener.onDistanceBetweenTargetsChanged(int, com.wikitude.tracker.ImageTarget, com.wikitude.tracker.ImageTarget) to be triggered.
void	setExtendedTargets(String[] extendedTargets)
void	setImageRecognitionRangeExtension(ImageTrackerConfiguration.ImageRecognitionRangeExtension imageRecognitionRangeExtension) Sets the ImageTrackerConfiguration.ImageRecognitionRangeExtension that should be used when target image recognition is active.
void	setMaximumNumberOfConcurrentlyTrackableTargets(int maximumNumberOfConcurrentlyTrackableTargets) Sets the maximum number of targets that can be tracked concurrently.
void	setPhysicalTargetImageHeights(HashMap<String,Integer> physicalTargetImageHeights) Sets a map of target names and their physical image height in mm.
void	setTrackerEfficiencyMode(TrackerEfficiencyMode trackerEfficiencyMode) Use this to specify the efficiency mode of the tracker.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ImageTrackerConfiguration

public ImageTrackerConfiguration()

Method Detail

getExtendedTargets

public String[] getExtendedTargets()

Returns:

Returns the currently set extended targets. Returns null if it was not set before.

setExtendedTargets

public void setExtendedTargets(String[] extendedTargets)

Parameters:

extendedTargets - The targets that should run in extended tracking mode

getImageRecognitionRangeExtension

public ImageTrackerConfiguration.ImageRecognitionRangeExtension getImageRecognitionRangeExtension()

Returns the ImageTrackerConfiguration.ImageRecognitionRangeExtension that should be used when target image recognition is active.

Returns:

imageRecognitionRangeExtension ImageTrackerConfiguration.ImageRecognitionRangeExtension used for image recognition.

setImageRecognitionRangeExtension

public void setImageRecognitionRangeExtension(ImageTrackerConfiguration.ImageRecognitionRangeExtension imageRecognitionRangeExtension)

Sets the ImageTrackerConfiguration.ImageRecognitionRangeExtension that should be used when target image recognition is active. Setting this property to ImageTrackerConfiguration.ImageRecognitionRangeExtension.ON on 32 bit devices will work but slow down computer vision algorithms performance noticeably. This is ImageTrackerConfiguration.ImageRecognitionRangeExtension.AUTO by default.

Parameters:

imageRecognitionRangeExtension - ImageTrackerConfiguration.ImageRecognitionRangeExtension used for image recognition.

Throws:

IllegalArgumentException - If imageRecognitionRangeExtension is null.

getPhysicalTargetImageHeights

public HashMap<String,Integer> getPhysicalTargetImageHeights()

Returns a map of target names and their physical image height in mm.

Returns:

Map of target names and physical image heights in mm.

setPhysicalTargetImageHeights

public void setPhysicalTargetImageHeights(HashMap<String,Integer> physicalTargetImageHeights)

Sets a map of target names and their physical image height in mm.

Parameters:

physicalTargetImageHeights - Map of target names and physical image heights in mm.

Throws:

IllegalArgumentException - If physicalTargetImageHeights is null.

getMaximumNumberOfConcurrentlyTrackableTargets

public int getMaximumNumberOfConcurrentlyTrackableTargets()

Returns the maximum number of targets that can be tracked concurrently.

Returns:

The maximum number of targets that can be tracked concurrently.

setMaximumNumberOfConcurrentlyTrackableTargets

public void setMaximumNumberOfConcurrentlyTrackableTargets(int maximumNumberOfConcurrentlyTrackableTargets)

Sets the maximum number of targets that can be tracked concurrently.
This value is 1 by default and may only be set to more than 1.

Note it takes more processing power to recognize a target than it takes to track it. Because of that, even though the maximum number can be arbitrarily high, it should be set to the expected maximum number of targets. This would lead to less processing power needed once the maximumNumberOfConcurrentlyTrackableTargets are tracked.

Parameters:

maximumNumberOfConcurrentlyTrackableTargets - The maximum number of targets that can be tracked concurrently.

Throws:

IllegalArgumentException - If the maximumNumberOfConcurrentlyTrackableTargets is less than 1.

getDistanceChangedThreshold

public int getDistanceChangedThreshold()

Returns the threshold the distance between targets has to exceed in order for ImageTarget.OnDistanceBetweenTargetsListener.onDistanceBetweenTargetsChanged(int, com.wikitude.tracker.ImageTarget, com.wikitude.tracker.ImageTarget) to be triggered.

Returns:

Threshold to trigger ImageTarget.OnDistanceBetweenTargetsListener.onDistanceBetweenTargetsChanged(int, com.wikitude.tracker.ImageTarget, com.wikitude.tracker.ImageTarget).

See Also:

ImageTarget.OnDistanceBetweenTargetsListener, ImageTarget.setOnDistanceBetweenTargetsListener(com.wikitude.tracker.ImageTarget.OnDistanceBetweenTargetsListener)

setDistanceChangedThreshold

public void setDistanceChangedThreshold(int distanceChangedThreshold)

Sets the threshold the distance between targets has to exceed in order for ImageTarget.OnDistanceBetweenTargetsListener.onDistanceBetweenTargetsChanged(int, com.wikitude.tracker.ImageTarget, com.wikitude.tracker.ImageTarget) to be triggered.

Parameters:

distanceChangedThreshold - Threshold to trigger ImageTarget.OnDistanceBetweenTargetsListener.onDistanceBetweenTargetsChanged(int, com.wikitude.tracker.ImageTarget, com.wikitude.tracker.ImageTarget).

Throws:

IllegalArgumentException - If the distanceChangedThreshold is negative.

See Also:

ImageTarget.OnDistanceBetweenTargetsListener, ImageTarget.setOnDistanceBetweenTargetsListener(com.wikitude.tracker.ImageTarget.OnDistanceBetweenTargetsListener)

getTrackerEfficiencyMode

public TrackerEfficiencyMode getTrackerEfficiencyMode()

Returns the efficiency mode of the tracker. Please refer to the TrackerEfficiencyMode documentation for more details.

setTrackerEfficiencyMode

public void setTrackerEfficiencyMode(TrackerEfficiencyMode trackerEfficiencyMode)

Use this to specify the efficiency mode of the tracker. Please refer to the TrackerEfficiencyMode documentation for more details.

Parameters:

trackerEfficiencyMode - the tracker efficiency mode that should be used