Package boofcv.alg.similar

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

java.lang.Object

boofcv.alg.similar.SimilarImagesSceneRecognition<Image,TD>

All Implemented Interfaces:

LookUpSimilarImages, VerbosePrint

public class SimilarImagesSceneRecognition<Image extends ImageBase<Image>,TD extends TupleDesc<TD>>
extends Object
implements LookUpSimilarImages, VerbosePrint

Identifies similar images using FeatureSceneRecognition. For each image which is added a set of image features (descriptions and pixel coordinate) is found using the detector. After all the images have been added fixate() is called and after sometime a fast but not 100% reliable model which be required for looking up which images are similar. In this case similar means that they are of the same physical scene but from a "similar" perspective. Then for each image all the "similar" images are found and the image features are associated. Theses associated image features are tested to see if the two images really are related using the logic specified by similarityTest. If they are related their pairwise information is saved for later fast retrieval. While building there is significant cost in building the retrieval system, this is in general much faster than considering every possible image pair and trying to match them. The main down side is that it will not be 100% reliable.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	SimilarImagesSceneRecognition.PairInfo	Describes the relationship between two images
static interface	SimilarImagesSceneRecognition.SimilarityTest	Contains logic for deciding if two images are similar or not from associated features and their image coordinates.

Field Summary

Fields

Modifier and Type	Field	Description
double	timeFixateAddMS	Time fixate() took to add images to the database.
double	timeFixateLearnMS	Time fixate() took to learn the model.

Constructor Summary

Constructors

Constructor	Description
SimilarImagesSceneRecognition(DetectDescribePoint<Image,TD> detector, AssociateDescriptionHashSets<TD> asscociator, FeatureSceneRecognition<TD> recognizer, BoofLambdas.Factory<PackedArray<TD>> factoryPackedDesc)

Method Summary

Modifier and Type	Method	Description
void	addImage(String id, Image image)	Adds a new image.
void	findSimilar(String target, BoofLambdas.Filter<String> filter, List<String> similarImages)	Given an imageID, it will find list of similar images.
void	fixate()	After all the images you wish to look up have been added call this function.
List<String>	getImageIDs()	Returns a list of all images by ID that it has in its data base
boolean	lookupAssociated(String viewDst, DogArray<AssociatedIndex> pairs)	Looks up pairs of associated features from a similar image which was returned in the most recent call to LookUpSimilarImages.findSimilar(java.lang.String, boofcv.misc.BoofLambdas.Filter<java.lang.String>, java.util.List<java.lang.String>).
void	lookupImageWords(String imageID, DogArray_I32 words)	Looks up the word each feature belongs in for an image
void	lookupPixelFeats(String target, DogArray<Point2D_F64> features)	Looks up pixel observations of features in the specified view.
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

timeFixateLearnMS

public double timeFixateLearnMS

Time fixate() took to learn the model. Milliseconds.

timeFixateAddMS

public double timeFixateAddMS

Time fixate() took to add images to the database. Milliseconds.

Constructor Details

SimilarImagesSceneRecognition

public SimilarImagesSceneRecognition(DetectDescribePoint<Image,TD> detector,
 AssociateDescriptionHashSets<TD> asscociator,
 FeatureSceneRecognition<TD> recognizer,
 BoofLambdas.Factory<PackedArray<TD>> factoryPackedDesc)

Method Details

addImage

public void addImage(String id,
 Image image)

Adds a new image. Must call fixate() inorder for it to be retrieved later on

Parameters:

id - Unique ID for this image

image - The image

fixate

public void fixate()

After all the images you wish to look up have been added call this function. If you add more images after calling fixate you will need to call it again.

getImageIDs

public List<String> getImageIDs()

Description copied from interface: LookUpSimilarImages

Returns a list of all images by ID that it has in its data base

Specified by:

getImageIDs in interface LookUpSimilarImages

findSimilar

public void findSimilar(String target,
 @Nullable
 BoofLambdas.Filter<String> filter,
 List<String> similarImages)

Description copied from interface: LookUpSimilarImages

Given an imageID, it will find list of similar images. Similarity is defined from the perspective of the 'target', so viewA might think viewB is similar to it, but viewB might think viewA is not similar to it.

Specified by:

findSimilar in interface LookUpSimilarImages

Parameters:

target - (Input) ID of target image

filter - (Input) Filter results by ID. true = keep, false = reject. Null means no filter.

similarImages - (Output) Storage for IDs of similar images. Cleared upon each call

lookupPixelFeats

public void lookupPixelFeats(String target,
 DogArray<Point2D_F64> features)

Description copied from interface: LookUpSimilarImages

Looks up pixel observations of features in the specified view.

Specified by:

lookupPixelFeats in interface LookUpSimilarImages

Parameters:

target - ID of target image

features - Storage for pixel observations. Cleared upon each call

lookupAssociated

public boolean lookupAssociated(String viewDst,
 DogArray<AssociatedIndex> pairs)

Description copied from interface: LookUpSimilarImages

Looks up pairs of associated features from a similar image which was returned in the most recent call to LookUpSimilarImages.findSimilar(java.lang.String, boofcv.misc.BoofLambdas.Filter<java.lang.String>, java.util.List<java.lang.String>). The src will be the target in 'findSimilar' and the dst will be the requested similar image.

Specified by:

lookupAssociated in interface LookUpSimilarImages

Parameters:

viewDst - ID of a similar image to the target when calling LookUpSimilarImages.findSimilar(java.lang.String, boofcv.misc.BoofLambdas.Filter<java.lang.String>, java.util.List<java.lang.String>).

pairs - Storage for associated features. Cleared upon each call

Returns:

true if views are similar and have known associations. False if not and results should be ignored

lookupImageWords

public void lookupImageWords(String imageID,
 DogArray_I32 words)

Looks up the word each feature belongs in for an image

setVerbose

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

Specified by:

setVerbose in interface VerbosePrint