Package boofcv.abst.scene

Class WrapFeatureToSceneRecognition<Image extends ImageBase<Image>,TD extends TupleDesc<TD>>

java.lang.Object

boofcv.abst.scene.WrapFeatureToSceneRecognition<Image,TD>

All Implemented Interfaces:

SceneRecognition<Image>, VerbosePrint

public class WrapFeatureToSceneRecognition<Image extends ImageBase<Image>,TD extends TupleDesc<TD>>
extends Object
implements SceneRecognition<Image>

Converts FeatureSceneRecognition into SceneRecognition.

Nested Class Summary

Nested classes/interfaces inherited from interface boofcv.abst.scene.SceneRecognition

SceneRecognition.Match

Field Summary

Fields

Modifier and Type	Field	Description
ConfigFeatureToSceneRecognition	config	Optional reference to a config.
protected DetectDescribePoint<Image,TD>	detector	Detects image features
protected BoofLambdas.Transform<Image>	downSample
protected FeatureSceneRecognition<TD>	recognizer	The FeatureSceneRecognition

Constructor Summary

Constructors

Constructor	Description
WrapFeatureToSceneRecognition(DetectDescribePoint<Image,TD> detector, BoofLambdas.Transform<Image> downSample, FeatureSceneRecognition<TD> recognizer)

Method Summary

Modifier and Type	Method	Description
void	addImage(String id, Image image)	Adds a new image to the database
void	clearDatabase()	Removes all images from the database.
List<String>	getImageIds(@Nullable List<String> storage)	Returns a list of image IDs in the database
ImageType<Image>	getImageType()	The image data type which can be processed
<T extends FeatureSceneRecognition<TD>> T	getRecognizer()
void	learnModel(Iterator<Image> images)	Wrap the image iterator by adding detection to it
boolean	query(Image queryImage, BoofLambdas.Filter<String> filter, int limit, DogArray<SceneRecognition.Match> matches)	Finds the best matches in the database to the query image.
void	setVerbose(@Nullable PrintStream out, @Nullable Set<String> options)

Methods inherited from class java.lang.Object

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

Field Details

detector

protected DetectDescribePoint<Image extends ImageBase<Image>,TD extends TupleDesc<TD>> detector

Detects image features

downSample

protected BoofLambdas.Transform<Image extends ImageBase<Image>> downSample

recognizer

protected FeatureSceneRecognition<TD extends TupleDesc<TD>> recognizer

The FeatureSceneRecognition

config

public ConfigFeatureToSceneRecognition config

Optional reference to a config. Useful when saving to disk

Constructor Details

WrapFeatureToSceneRecognition

public WrapFeatureToSceneRecognition(DetectDescribePoint<Image,TD> detector,
 BoofLambdas.Transform<Image> downSample,
 FeatureSceneRecognition<TD> recognizer)

Method Details

learnModel

public void learnModel(Iterator<Image> images)

Wrap the image iterator by adding detection to it

Specified by:

learnModel in interface SceneRecognition<Image extends ImageBase<Image>>

clearDatabase

public void clearDatabase()

Description copied from interface: SceneRecognition

Removes all images from the database. The model is not modified

Specified by:

clearDatabase in interface SceneRecognition<Image extends ImageBase<Image>>

addImage

public void addImage(String id,
 Image image)

Description copied from interface: SceneRecognition

Adds a new image to the database

Specified by:

addImage in interface SceneRecognition<Image extends ImageBase<Image>>

Parameters:

id - The unique ID for this image

image - The image

query

public boolean query(Image queryImage,
 @Nullable
 BoofLambdas.Filter<String> filter,
 int limit,
 DogArray<SceneRecognition.Match> matches)

Description copied from interface: SceneRecognition

Finds the best matches in the database to the query image.

Specified by:

query in interface SceneRecognition<Image extends ImageBase<Image>>

Parameters:

queryImage - (Input) image being processed

filter - (Input) Used to filter results so that known matches don't pollute the results.

limit - (Input) The maximum number of results it will return. If ≤ 0 then all matches are returned.

matches - (Output) Set of matches found in best first order. List is always cleared

Returns:

true if at least one valid match was found or false if no valid matches could be found. If false that means matches is empty. This is strictly a convenience.

getImageIds

public List<String> getImageIds(@Nullable
 @Nullable List<String> storage)

Description copied from interface: SceneRecognition

Returns a list of image IDs in the database

Specified by:

getImageIds in interface SceneRecognition<Image extends ImageBase<Image>>

Parameters:

storage - (Optional) Storage for the list of images. If null a new instance is created

Returns:

List of all the image IDs.

getImageType

public ImageType<Image> getImageType()

Description copied from interface: SceneRecognition

The image data type which can be processed

Specified by:

getImageType in interface SceneRecognition<Image extends ImageBase<Image>>

setVerbose

public void setVerbose(@Nullable
 @Nullable PrintStream out,
 @Nullable
 @Nullable Set<String> options)

Specified by:

setVerbose in interface VerbosePrint

getRecognizer

public <T extends FeatureSceneRecognition<TD>> T getRecognizer()