Package boofcv.alg.similar

Class SimilarImagesData

java.lang.Object

boofcv.alg.similar.SimilarImagesData

All Implemented Interfaces:

LookUpSimilarImages

public class SimilarImagesData
extends Object
implements LookUpSimilarImages

Storage for the raw results of finding similar images. Everything is stored in memory in an uncompressed format.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SimilarImagesData.Info	All the information for a single view.
static class	SimilarImagesData.Relationship	Specifies how two views are related by saying which image features are matched with which other image features.

Field Summary

Fields

Modifier and Type	Field	Description
final Map<String,SimilarImagesData.Info>	imageMap
final List<String>	listImages

Constructor Summary

Constructors

Constructor	Description
SimilarImagesData()

Method Summary

Modifier and Type	Method	Description
void	add(String id, List<Point2D_F64> features)	Adds a new view.
void	findSimilar(String target, BoofLambdas.Filter<String> filter, List<String> similarImages)	Given an imageID, it will find list of similar images.
List<String>	getImageIDs()	Returns a list of all images by ID that it has in its data base
boolean	lookupAssociated(String similarD, 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	lookupPixelFeats(String target, DogArray<Point2D_F64> features)	Looks up pixel observations of features in the specified view.
void	reset()	Clears all references to other objects
void	setRelationship(String viewA, String viewB, List<AssociatedIndex> matches)	Used to specify the relationship between two similar views by providing which features match up

Methods inherited from class java.lang.Object

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

Field Details

listImages

public final List<String> listImages

imageMap

public final Map<String,SimilarImagesData.Info> imageMap

Constructor Details

SimilarImagesData

public SimilarImagesData()

Method Details

reset

public void reset()

Clears all references to other objects

add

public void add(String id,
 List<Point2D_F64> features)

Adds a new view.

Parameters:

id - The unique ID for the view

features - List of image features. Pixel coordinates.

setRelationship

public void setRelationship(String viewA,
 String viewB,
 List<AssociatedIndex> matches)

Used to specify the relationship between two similar views by providing which features match up

Parameters:

viewA - The 'src' view of the matches

viewB - The 'dst' view of the matches

matches - List of matching image features

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 similarD,
 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:

similarD - 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