org.bytedeco.opencv.opencv_features2d

Class BOWImgDescriptorExtractor

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.opencv.opencv_features2d.BOWImgDescriptorExtractor

All Implemented Interfaces:

AutoCloseable

@Namespace(value="cv")
 @NoOffset
 @Properties(inherit=opencv_features2d.class)
public class BOWImgDescriptorExtractor
extends Pointer

\brief Class to compute an image descriptor using the *bag of visual words*.

Such a computation consists of the following steps:

1. Compute descriptors for a given image and its keypoints set. 2. Find the nearest visual words from the vocabulary for each keypoint descriptor. 3. Compute the bag-of-words image descriptor as is a normalized histogram of vocabulary words encountered in the image. The i-th bin of the histogram is a frequency of i-th word of the vocabulary in the given image.

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
BOWImgDescriptorExtractor(DescriptorMatcher dmatcher) \overload
BOWImgDescriptorExtractor(Feature2D dextractor, DescriptorMatcher dmatcher) \brief The constructor.
BOWImgDescriptorExtractor(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
void	compute(GpuMat keypointDescriptors, GpuMat imgDescriptor)
void	compute(GpuMat keypointDescriptors, GpuMat imgDescriptor, IntVectorVector pointIdxsOfClusters)
void	compute(GpuMat image, KeyPointVector keypoints, GpuMat imgDescriptor)
void	compute(GpuMat image, KeyPointVector keypoints, GpuMat imgDescriptor, IntVectorVector pointIdxsOfClusters, Mat descriptors)
void	compute(Mat image, KeyPointVector keypoints, Mat imgDescriptor)
void	compute(Mat image, KeyPointVector keypoints, Mat imgDescriptor, IntVectorVector pointIdxsOfClusters, Mat descriptors) \brief Computes an image descriptor using the set visual vocabulary.
void	compute(Mat keypointDescriptors, Mat imgDescriptor)
void	compute(Mat keypointDescriptors, Mat imgDescriptor, IntVectorVector pointIdxsOfClusters) \overload
void	compute(UMat image, KeyPointVector keypoints, UMat imgDescriptor)
void	compute(UMat image, KeyPointVector keypoints, UMat imgDescriptor, IntVectorVector pointIdxsOfClusters, Mat descriptors)
void	compute(UMat keypointDescriptors, UMat imgDescriptor)
void	compute(UMat keypointDescriptors, UMat imgDescriptor, IntVectorVector pointIdxsOfClusters)
int	descriptorSize() \brief Returns an image descriptor size if the vocabulary is set.
int	descriptorType() \brief Returns an image descriptor type.
Mat	getVocabulary() \brief Returns the set vocabulary.
void	setVocabulary(Mat vocabulary) \brief Sets a visual vocabulary.

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, parseBytes, physicalBytes, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, toString, totalBytes, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BOWImgDescriptorExtractor

public BOWImgDescriptorExtractor(Pointer p)

Pointer cast constructor. Invokes Pointer.Pointer(Pointer).

BOWImgDescriptorExtractor

public BOWImgDescriptorExtractor(@Cast(value="cv::DescriptorExtractor*") @opencv_core.Ptr
                                 Feature2D dextractor,
                                 @opencv_core.Ptr
                                 DescriptorMatcher dmatcher)

\brief The constructor.

Parameters:

dextractor - Descriptor extractor that is used to compute descriptors for an input image and its keypoints.

dmatcher - Descriptor matcher that is used to find the nearest word of the trained vocabulary for each keypoint descriptor of the image.

BOWImgDescriptorExtractor

public BOWImgDescriptorExtractor(@opencv_core.Ptr
                                 DescriptorMatcher dmatcher)

\overload

Method Detail

setVocabulary

public void setVocabulary(@Const @ByRef
                          Mat vocabulary)

\brief Sets a visual vocabulary.

Parameters:

vocabulary - Vocabulary (can be trained using the inheritor of BOWTrainer ). Each row of the vocabulary is a visual word (cluster center).

getVocabulary

@Const
 @ByRef
public Mat getVocabulary()

\brief Returns the set vocabulary.

compute

public void compute(@ByVal
                    Mat image,
                    @ByRef
                    KeyPointVector keypoints,
                    @ByVal
                    Mat imgDescriptor,
                    IntVectorVector pointIdxsOfClusters,
                    Mat descriptors)

\brief Computes an image descriptor using the set visual vocabulary.

Parameters:

image - Image, for which the descriptor is computed.

keypoints - Keypoints detected in the input image.

imgDescriptor - Computed output image descriptor.

pointIdxsOfClusters - Indices of keypoints that belong to the cluster. This means that pointIdxsOfClusters[i] are keypoint indices that belong to the i -th cluster (word of vocabulary) returned if it is non-zero.

descriptors - Descriptors of the image keypoints that are returned if they are non-zero.

compute

public void compute(@ByVal
                    Mat image,
                    @ByRef
                    KeyPointVector keypoints,
                    @ByVal
                    Mat imgDescriptor)

compute

public void compute(@ByVal
                    UMat image,
                    @ByRef
                    KeyPointVector keypoints,
                    @ByVal
                    UMat imgDescriptor,
                    IntVectorVector pointIdxsOfClusters,
                    Mat descriptors)

compute

public void compute(@ByVal
                    UMat image,
                    @ByRef
                    KeyPointVector keypoints,
                    @ByVal
                    UMat imgDescriptor)

compute

public void compute(@ByVal
                    GpuMat image,
                    @ByRef
                    KeyPointVector keypoints,
                    @ByVal
                    GpuMat imgDescriptor,
                    IntVectorVector pointIdxsOfClusters,
                    Mat descriptors)

compute

public void compute(@ByVal
                    GpuMat image,
                    @ByRef
                    KeyPointVector keypoints,
                    @ByVal
                    GpuMat imgDescriptor)

compute

public void compute(@ByVal
                    Mat keypointDescriptors,
                    @ByVal
                    Mat imgDescriptor,
                    IntVectorVector pointIdxsOfClusters)

\overload

Parameters:

keypointDescriptors - Computed descriptors to match with vocabulary.

imgDescriptor - Computed output image descriptor.

pointIdxsOfClusters - Indices of keypoints that belong to the cluster. This means that pointIdxsOfClusters[i] are keypoint indices that belong to the i -th cluster (word of vocabulary) returned if it is non-zero.

compute

public void compute(@ByVal
                    Mat keypointDescriptors,
                    @ByVal
                    Mat imgDescriptor)

compute

public void compute(@ByVal
                    UMat keypointDescriptors,
                    @ByVal
                    UMat imgDescriptor,
                    IntVectorVector pointIdxsOfClusters)

compute

public void compute(@ByVal
                    UMat keypointDescriptors,
                    @ByVal
                    UMat imgDescriptor)

compute

public void compute(@ByVal
                    GpuMat keypointDescriptors,
                    @ByVal
                    GpuMat imgDescriptor,
                    IntVectorVector pointIdxsOfClusters)

compute

public void compute(@ByVal
                    GpuMat keypointDescriptors,
                    @ByVal
                    GpuMat imgDescriptor)

descriptorSize

public int descriptorSize()

\brief Returns an image descriptor size if the vocabulary is set. Otherwise, it returns 0.

descriptorType

public int descriptorType()

\brief Returns an image descriptor type.