Package boofcv.io.recognition

Class RecognitionIO

java.lang.Object

boofcv.io.recognition.RecognitionIO

public class RecognitionIO
extends Object

Reading and writing data structures related to recognition.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_NAME
static final String	DATABASE_NAME
static final String	DICTIONARY_NAME
static final String	IMAGE_ID_NAME
static final String	INVERTED_NAME

Constructor Summary

Constructors

Constructor	Description
RecognitionIO()

Method Summary

Modifier and Type	Method	Description
static <Image extends ImageBase<Image>, TD extends TupleDesc<TD>> WrapFeatureToSceneRecognition<Image,TD>	downloadDefaultSceneRecognition(File destination, ImageType<Image> imageType)	Downloads then loads the pre-built default scene recognition model.
static <TD extends TupleDesc<TD>> void	loadBin(InputStream in, RecognitionVocabularyTreeNister2006<TD> db)	Loads RecognitionVocabularyTreeNister2006 from a binary format.
static <TD extends TupleDesc<TD>> List<TD>	loadDictionaryBin(File file)
static <TD extends TupleDesc<TD>> List<TD>	loadDictionaryBin(InputStream in)
static <Image extends ImageBase<Image>, TD extends TupleDesc<TD>> WrapFeatureToSceneRecognition<Image,TD>	loadFeatureToScene(File dir, ImageType<Image> imageType)
static void	loadNearestNeighborBin(File file, RecognitionNearestNeighborInvertedFile<?> nn)
static void	loadNearestNeighborBin(InputStream in, RecognitionNearestNeighborInvertedFile<?> nn)
static <TD extends TupleDesc<TD>> void	loadNister2006(File dir, FeatureSceneRecognitionNister2006<TD> recognizer)	Loads FeatureSceneRecognitionNister2006
static <TD extends TupleDesc<TD>> HierarchicalVocabularyTree<TD>	loadTreeBin(File file, @Nullable HierarchicalVocabularyTree<TD> tree)
static <TD extends TupleDesc<TD>> void	loadTreeBin(File file, RecognitionVocabularyTreeNister2006<TD> db)
static <TD extends TupleDesc<TD>> HierarchicalVocabularyTree<TD>	loadTreeBin(InputStream in, @Nullable HierarchicalVocabularyTree<TD> tree)
static <TD extends TupleDesc<TD>> void	readBin(TD tuple, DataInputStream in)
static <TD extends TupleDesc<TD>> void	saveBin(RecognitionVocabularyTreeNister2006<TD> db, OutputStream out)	Saves RecognitionVocabularyTreeNister2006 to a binary format.
static <TD extends TupleDesc<TD>> void	saveBin(HierarchicalVocabularyTree<TD> tree, File file)
static <TD extends TupleDesc<TD>> void	saveDictionaryBin(List<TD> dictionary, int dof, Class<TD> descType, File file)
static <TD extends TupleDesc<TD>> void	saveDictionaryBin(List<TD> dictionary, int dof, Class<TD> descType, OutputStream out)	Saves a TupleDesc dictionary in a binary format
static <TD extends TupleDesc<TD>> void	saveFeatureToScene(WrapFeatureToSceneRecognition<?,TD> def, File dir)	Saves WrapFeatureToSceneRecognition to disk inside of the specified directory
static void	saveNearestNeighborBin(RecognitionNearestNeighborInvertedFile<?> nn, File file)
static void	saveNearestNeighborBin(RecognitionNearestNeighborInvertedFile<?> nn, OutputStream out)
static <TD extends TupleDesc<TD>> void	saveNister2006(FeatureSceneRecognitionNister2006<TD> def, File dir)	Saves FeatureSceneRecognitionNister2006 to disk inside of the specified directory
static <TD extends TupleDesc<TD>> void	saveTreeBin(RecognitionVocabularyTreeNister2006<TD> db, File file)
static <TD extends TupleDesc<TD>> void	saveTreeBin(HierarchicalVocabularyTree<TD> tree, OutputStream out)	Saves the tree in binary format.
static <TD extends TupleDesc<TD>> void	writeBin(TD tuple, DataOutputStream dout)

Methods inherited from class java.lang.Object

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

Field Details

CONFIG_NAME

public static final String CONFIG_NAME

See Also:

• Constant Field Values

IMAGE_ID_NAME

public static final String IMAGE_ID_NAME

See Also:

• Constant Field Values

DATABASE_NAME

public static final String DATABASE_NAME

See Also:

• Constant Field Values

DICTIONARY_NAME

public static final String DICTIONARY_NAME

See Also:

• Constant Field Values

INVERTED_NAME

public static final String INVERTED_NAME

See Also:

• Constant Field Values

Constructor Details

RecognitionIO

public RecognitionIO()

Method Details

downloadDefaultSceneRecognition

public static <Image extends ImageBase<Image>,
TD extends TupleDesc<TD>>
WrapFeatureToSceneRecognition<Image,TD> downloadDefaultSceneRecognition(File destination,
 ImageType<Image> imageType)

Downloads then loads the pre-built default scene recognition model. The image DB will of course be empty. If the decompressed directory already exists then it will skip the download step.

Parameters:

destination - Where it should download the model to

imageType - Type of image the resulting algorithm will process

Returns:

A new instance of SceneRecognition with an already built model.

saveFeatureToScene

public static <TD extends TupleDesc<TD>> void saveFeatureToScene(WrapFeatureToSceneRecognition<?,TD> def,
 File dir)

Saves WrapFeatureToSceneRecognition to disk inside of the specified directory

Parameters:

def - What is to be saved

dir - Direction that it is to be saved

loadFeatureToScene

public static <Image extends ImageBase<Image>,
TD extends TupleDesc<TD>>
WrapFeatureToSceneRecognition<Image,TD> loadFeatureToScene(File dir,
 ImageType<Image> imageType)

saveNister2006

public static <TD extends TupleDesc<TD>> void saveNister2006(FeatureSceneRecognitionNister2006<TD> def,
 File dir)

Saves FeatureSceneRecognitionNister2006 to disk inside of the specified directory

Parameters:

def - What is to be saved

dir - Direction that it is to be saved

loadNister2006

public static <TD extends TupleDesc<TD>> void loadNister2006(File dir,
 FeatureSceneRecognitionNister2006<TD> recognizer)

Loads FeatureSceneRecognitionNister2006

Parameters:

dir - Directory containing saved graph

recognizer - (Output) where it's loaded into

saveBin

public static <TD extends TupleDesc<TD>> void saveBin(HierarchicalVocabularyTree<TD> tree,
 File file)

loadTreeBin

public static <TD extends TupleDesc<TD>>
HierarchicalVocabularyTree<TD> loadTreeBin(File file,
 @Nullable
 @Nullable HierarchicalVocabularyTree<TD> tree)

saveDictionaryBin

public static <TD extends TupleDesc<TD>> void saveDictionaryBin(List<TD> dictionary,
 int dof,
 Class<TD> descType,
 File file)

loadDictionaryBin

public static <TD extends TupleDesc<TD>> List<TD> loadDictionaryBin(File file)

saveNearestNeighborBin

public static void saveNearestNeighborBin(RecognitionNearestNeighborInvertedFile<?> nn,
 File file)

loadNearestNeighborBin

public static void loadNearestNeighborBin(File file,
 RecognitionNearestNeighborInvertedFile<?> nn)

saveTreeBin

public static <TD extends TupleDesc<TD>> void saveTreeBin(HierarchicalVocabularyTree<TD> tree,
 OutputStream out)

Saves the tree in binary format. The format is described in an ascii header.

Parameters:

tree - (Input) Tree that's saved

out - (Output) Stream the tree is written to

loadTreeBin

public static <TD extends TupleDesc<TD>>
HierarchicalVocabularyTree<TD> loadTreeBin(InputStream in,
 @Nullable
 @Nullable HierarchicalVocabularyTree<TD> tree)

saveDictionaryBin

public static <TD extends TupleDesc<TD>> void saveDictionaryBin(List<TD> dictionary,
 int dof,
 Class<TD> descType,
 OutputStream out)

Saves a TupleDesc dictionary in a binary format

Parameters:

dictionary - (Input) Tree that's saved

out - (Output) Stream the tree is written to

loadDictionaryBin

public static <TD extends TupleDesc<TD>> List<TD> loadDictionaryBin(InputStream in)

saveNearestNeighborBin

public static void saveNearestNeighborBin(RecognitionNearestNeighborInvertedFile<?> nn,
 OutputStream out)

loadNearestNeighborBin

public static void loadNearestNeighborBin(InputStream in,
 RecognitionNearestNeighborInvertedFile<?> nn)

writeBin

public static <TD extends TupleDesc<TD>> void writeBin(TD tuple,
 DataOutputStream dout)
                                                throws IOException

Throws:

IOException

readBin

public static <TD extends TupleDesc<TD>> void readBin(TD tuple,
 DataInputStream in)
                                               throws IOException

Throws:

IOException

saveTreeBin

public static <TD extends TupleDesc<TD>> void saveTreeBin(RecognitionVocabularyTreeNister2006<TD> db,
 File file)

loadTreeBin

public static <TD extends TupleDesc<TD>> void loadTreeBin(File file,
 RecognitionVocabularyTreeNister2006<TD> db)

saveBin

public static <TD extends TupleDesc<TD>> void saveBin(RecognitionVocabularyTreeNister2006<TD> db,
 OutputStream out)

Saves RecognitionVocabularyTreeNister2006 to a binary format.

Parameters:

db - (Input) Structure to be encoded

out - Stream it's written to

loadBin

public static <TD extends TupleDesc<TD>> void loadBin(InputStream in,
 RecognitionVocabularyTreeNister2006<TD> db)

Loads RecognitionVocabularyTreeNister2006 from a binary format.

Parameters:

in - Input stream

db - (Ouput) Decoded structure