boofcv.abst.feature.tracker

Class PointTrackerKltPyramid<I extends boofcv.struct.image.ImageGray<I>,D extends boofcv.struct.image.ImageGray<D>>

java.lang.Object

boofcv.abst.feature.tracker.PointTrackerKltPyramid<I,D>

All Implemented Interfaces:

PointTracker<I>

Direct Known Subclasses:

PointTrackerTwoPassKltPyramid

public class PointTrackerKltPyramid<I extends boofcv.struct.image.ImageGray<I>,D extends boofcv.struct.image.ImageGray<D>>
extends java.lang.Object
implements PointTracker<I>

Wrapper around PyramidKltTracker for PointTracker. Every track will have the same size and shaped descriptor. If any fault is encountered the track will be dropped.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<boofcv.alg.tracker.klt.PyramidKltFeature>	active
protected boofcv.struct.pyramid.PyramidDiscrete<I>	basePyramid
protected boofcv.alg.tracker.klt.KltConfig	config
protected java.lang.Class<D>	derivType
protected D[]	derivX
protected D[]	derivY
protected java.util.List<boofcv.alg.tracker.klt.PyramidKltFeature>	dropped
protected boofcv.abst.filter.derivative.ImageGradient<I,D>	gradient
protected I	input
protected java.util.List<boofcv.alg.tracker.klt.PyramidKltFeature>	spawned
protected int	templateRadius
protected boofcv.alg.tracker.klt.PyramidKltTracker<I,D>	tracker
protected java.util.List<boofcv.alg.tracker.klt.PyramidKltFeature>	unused

Constructor Summary

Constructors

Constructor and Description

PointTrackerKltPyramid(boofcv.alg.tracker.klt.KltConfig config, int templateRadius, boofcv.struct.pyramid.PyramidDiscrete<I> pyramid, boofcv.alg.feature.detect.interest.GeneralFeatureDetector<I,D> detector, boofcv.abst.filter.derivative.ImageGradient<I,D> gradient, boofcv.alg.interpolate.InterpolateRectangle<I> interpInput, boofcv.alg.interpolate.InterpolateRectangle<D> interpDeriv, java.lang.Class<D> derivType) Constructor which specified the KLT track manager and how the image pyramids are computed.

Method Summary

Modifier and Type	Method and Description
protected void	addToList(java.util.List<boofcv.alg.tracker.klt.PyramidKltFeature> in, java.util.List<PointTrack> out)
PointTrack	addTrack(double x, double y) Creates a new feature track at the specified location.
protected boolean	checkValidSpawn(PointTrack p) Returns true if a new track can be spawned here.
protected void	declareOutput()
void	dropAllTracks() Drops all feature to be dropped and will no longer be tracked.
boolean	dropTrack(PointTrack track) Manually forces a track to be dropped.
java.util.List<PointTrack>	getActiveTracks(java.util.List<PointTrack> list) Returns a list of active tracks.
java.util.List<PointTrack>	getAllTracks(java.util.List<PointTrack> list) Returns a list of all features that are currently being tracked
java.util.List<PointTrack>	getDroppedTracks(java.util.List<PointTrack> list) Returns a list of tracks dropped by the tracker during the most recent update.
java.util.List<PointTrack>	getInactiveTracks(java.util.List<PointTrack> list) KLT does not have inactive tracks since all tracks are dropped if a problem occurs.
java.util.List<PointTrack>	getNewTracks(java.util.List<PointTrack> list) Returns a list of tracks that have been added since process was called.
void	process(I image) Process input image and perform tracking.
void	reset() Discard memory of all current and past tracks.
void	spawnTracks() Automatically selects new features in the image to track.

Methods inherited from class java.lang.Object

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

Field Detail

input

protected I extends boofcv.struct.image.ImageGray<I> input

gradient

protected boofcv.abst.filter.derivative.ImageGradient<I extends boofcv.struct.image.ImageGray<I>,D extends boofcv.struct.image.ImageGray<D>> gradient

basePyramid

protected boofcv.struct.pyramid.PyramidDiscrete<I extends boofcv.struct.image.ImageGray<I>> basePyramid

derivX

protected D extends boofcv.struct.image.ImageGray<D>[] derivX

derivY

protected D extends boofcv.struct.image.ImageGray<D>[] derivY

derivType

protected java.lang.Class<D extends boofcv.struct.image.ImageGray<D>> derivType

config

protected boofcv.alg.tracker.klt.KltConfig config

templateRadius

protected int templateRadius

active

protected java.util.List<boofcv.alg.tracker.klt.PyramidKltFeature> active

spawned

protected java.util.List<boofcv.alg.tracker.klt.PyramidKltFeature> spawned

dropped

protected java.util.List<boofcv.alg.tracker.klt.PyramidKltFeature> dropped

unused

protected java.util.List<boofcv.alg.tracker.klt.PyramidKltFeature> unused

tracker

protected boofcv.alg.tracker.klt.PyramidKltTracker<I extends boofcv.struct.image.ImageGray<I>,D extends boofcv.struct.image.ImageGray<D>> tracker

Constructor Detail

PointTrackerKltPyramid

public PointTrackerKltPyramid(boofcv.alg.tracker.klt.KltConfig config,
                              int templateRadius,
                              boofcv.struct.pyramid.PyramidDiscrete<I> pyramid,
                              boofcv.alg.feature.detect.interest.GeneralFeatureDetector<I,D> detector,
                              boofcv.abst.filter.derivative.ImageGradient<I,D> gradient,
                              boofcv.alg.interpolate.InterpolateRectangle<I> interpInput,
                              boofcv.alg.interpolate.InterpolateRectangle<D> interpDeriv,
                              java.lang.Class<D> derivType)

Constructor which specified the KLT track manager and how the image pyramids are computed.

Parameters:

config - KLT tracker configuration

templateRadius - Radius of square templates that are tracked

pyramid - The image pyramid which KLT is tracking inside of

detector - Feature detector. If null then no feature detector will be available and spawn won't work.

gradient - Computes gradient image pyramid.

interpInput - Interpolation used on input image

interpDeriv - Interpolation used on gradient images

derivType - Type of image the gradient is

Method Detail

addTrack

public PointTrack addTrack(double x,
                           double y)

Creates a new feature track at the specified location. Must only be called after process(ImageGray) has been called. It can fail if there is insufficient texture

Parameters:

x - x-coordinate

y - y-coordinate

Returns:

the new track if successful or null if no new track could be created

spawnTracks

public void spawnTracks()

Description copied from interface: PointTracker

Automatically selects new features in the image to track. Returned tracks must be unique and not duplicates of any existing tracks. This includes both active and inactive tracks. NOTE: This function may or may not also modify the active and inactive lists.

Specified by:

spawnTracks in interface PointTracker<I extends boofcv.struct.image.ImageGray<I>>

checkValidSpawn

protected boolean checkValidSpawn(PointTrack p)

Returns true if a new track can be spawned here. Intended to be overloaded

dropAllTracks

public void dropAllTracks()

Description copied from interface: PointTracker

Drops all feature to be dropped and will no longer be tracked. Tracks dropped using this function will not appear in the dropped list.

Specified by:

dropAllTracks in interface PointTracker<I extends boofcv.struct.image.ImageGray<I>>

process

public void process(I image)

Description copied from interface: PointTracker

Process input image and perform tracking.

Specified by:

process in interface PointTracker<I extends boofcv.struct.image.ImageGray<I>>

Parameters:

image - Next image in the sequence

declareOutput

protected void declareOutput()

dropTrack

public boolean dropTrack(PointTrack track)

Description copied from interface: PointTracker

Manually forces a track to be dropped. Tracks dropped using this function will not appear in the dropped list and their data is subject to being immediately recycled. New requests to all and active lists will not include the track after it has been dropped using this function. If request is made to drop a track that is not being tracked (in the internal all list), then the request is ignored.

Specified by:

dropTrack in interface PointTracker<I extends boofcv.struct.image.ImageGray<I>>

Parameters:

track - The track which is to be dropped

Returns:

true if the request to drop the track was done or if it was ignored because the track wasn't being tracked

getActiveTracks

public java.util.List<PointTrack> getActiveTracks(java.util.List<PointTrack> list)

Description copied from interface: PointTracker

Returns a list of active tracks. An active track is defined as a track which was found in the most recently processed image.

Specified by:

getActiveTracks in interface PointTracker<I extends boofcv.struct.image.ImageGray<I>>

Parameters:

list - Optional storage for the list of tracks. If null a new list will be declared internally.

Returns:

List of tracks.

getInactiveTracks

public java.util.List<PointTrack> getInactiveTracks(java.util.List<PointTrack> list)

KLT does not have inactive tracks since all tracks are dropped if a problem occurs.

Specified by:

getInactiveTracks in interface PointTracker<I extends boofcv.struct.image.ImageGray<I>>

Parameters:

list - Optional storage for the list of tracks. If null a new list will be declared internally.

Returns:

List of tracks.

getDroppedTracks

public java.util.List<PointTrack> getDroppedTracks(java.util.List<PointTrack> list)

Description copied from interface: PointTracker

Returns a list of tracks dropped by the tracker during the most recent update. Tracks dropped by user request are not included in this list.

Specified by:

getDroppedTracks in interface PointTracker<I extends boofcv.struct.image.ImageGray<I>>

Parameters:

list - Optional storage for the list of tracks. If null a new list will be declared internally.

Returns:

List of tracks.

getNewTracks

public java.util.List<PointTrack> getNewTracks(java.util.List<PointTrack> list)

Description copied from interface: PointTracker

Returns a list of tracks that have been added since process was called.

Specified by:

getNewTracks in interface PointTracker<I extends boofcv.struct.image.ImageGray<I>>

Parameters:

list - Optional storage for the list of tracks. If null a new list will be declared internally.

Returns:

List of tracks.

getAllTracks

public java.util.List<PointTrack> getAllTracks(java.util.List<PointTrack> list)

Description copied from interface: PointTracker

Returns a list of all features that are currently being tracked

Specified by:

getAllTracks in interface PointTracker<I extends boofcv.struct.image.ImageGray<I>>

Parameters:

list - Optional storage for the list of tracks. If null a new list will be declared internally.

Returns:

List of tracks.

addToList

protected void addToList(java.util.List<boofcv.alg.tracker.klt.PyramidKltFeature> in,
                         java.util.List<PointTrack> out)

reset

public void reset()

Description copied from interface: PointTracker

Discard memory of all current and past tracks. Growing buffered might not be reset to their initial size by this method.

Specified by:

reset in interface PointTracker<I extends boofcv.struct.image.ImageGray<I>>