org.bytedeco.opencv.opencv_features2d

Class Feature2D

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.opencv.opencv_core.Algorithm

org.bytedeco.opencv.opencv_features2d.Feature2D

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

AffineFeature, AffineFeature2D, AgastFeatureDetector, AKAZE, BEBLID, BoostDesc, BriefDescriptorExtractor, BRISK, DAISY, FastFeatureDetector, Feature2DAsync, FREAK, GFTTDetector, HarrisLaplaceFeatureDetector, KAZE, LATCH, LUCID, MSDDetector, MSER, ORB, SIFT, SimpleBlobDetector, StarDetector, SURF, TEBLID, VGG

@Namespace(value="cv")
 @Properties(inherit=opencv_features2d.class)
public class Feature2D
extends Algorithm

\brief Abstract base class for 2D image feature detectors and descriptor extractors

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
Feature2D() Default native constructor.
Feature2D(Algorithm pointer) Downcast constructor.
Feature2D(long size) Native array allocator.
Feature2D(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
Algorithm	asAlgorithm()
static Algorithm	asAlgorithm(Feature2D pointer)
void	compute(GpuMat image, KeyPointVector keypoints, GpuMat descriptors)
void	compute(GpuMatVector images, KeyPointVectorVector keypoints, GpuMatVector descriptors)
void	compute(Mat image, KeyPointVector keypoints, Mat descriptors) \brief Computes the descriptors for a set of keypoints detected in an image (first variant) or image set (second variant).
void	compute(MatVector images, KeyPointVectorVector keypoints, MatVector descriptors) \overload
void	compute(UMat image, KeyPointVector keypoints, UMat descriptors)
void	compute(UMatVector images, KeyPointVectorVector keypoints, UMatVector descriptors)
int	defaultNorm()
int	descriptorSize()
int	descriptorType()
void	detect(GpuMat image, KeyPointVector keypoints)
void	detect(GpuMat image, KeyPointVector keypoints, GpuMat mask)
void	detect(GpuMatVector images, KeyPointVectorVector keypoints)
void	detect(GpuMatVector images, KeyPointVectorVector keypoints, GpuMatVector masks)
void	detect(Mat image, KeyPointVector keypoints)
void	detect(Mat image, KeyPointVector keypoints, Mat mask) \brief Detects keypoints in an image (first variant) or image set (second variant).
void	detect(MatVector images, KeyPointVectorVector keypoints)
void	detect(MatVector images, KeyPointVectorVector keypoints, MatVector masks) \overload
void	detect(UMat image, KeyPointVector keypoints)
void	detect(UMat image, KeyPointVector keypoints, UMat mask)
void	detect(UMatVector images, KeyPointVectorVector keypoints)
void	detect(UMatVector images, KeyPointVectorVector keypoints, UMatVector masks)
void	detectAndCompute(GpuMat image, GpuMat mask, KeyPointVector keypoints, GpuMat descriptors)
void	detectAndCompute(GpuMat image, GpuMat mask, KeyPointVector keypoints, GpuMat descriptors, boolean useProvidedKeypoints)
void	detectAndCompute(Mat image, Mat mask, KeyPointVector keypoints, Mat descriptors)
void	detectAndCompute(Mat image, Mat mask, KeyPointVector keypoints, Mat descriptors, boolean useProvidedKeypoints) Detects keypoints and computes the descriptors
void	detectAndCompute(UMat image, UMat mask, KeyPointVector keypoints, UMat descriptors)
void	detectAndCompute(UMat image, UMat mask, KeyPointVector keypoints, UMat descriptors, boolean useProvidedKeypoints)
boolean	empty() Return true if detector object is empty
BytePointer	getDefaultName() Returns the algorithm string identifier.
Feature2D	getPointer(long i)
Feature2D	position(long position)
void	read(BytePointer fileName)
void	read(FileNode arg0) \brief Reads algorithm parameters from a file storage
void	read(String fileName)
void	write(BytePointer fileName)
void	write(FileStorage arg0) \brief Stores algorithm parameters in a file storage
void	write(FileStorage fs, BytePointer name) \overload
void	write(FileStorage fs, String name)
void	write(String fileName)

Methods inherited from class org.bytedeco.opencv.opencv_core.Algorithm

clear, save, save

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, getDirectBufferAddress, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

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

Constructor Detail

Feature2D

public Feature2D()

Default native constructor.

Feature2D

public Feature2D(long size)

Native array allocator. Access with Pointer.position(long).

Feature2D

public Feature2D(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Feature2D

public Feature2D(Algorithm pointer)

Downcast constructor.

Method Detail

position

public Feature2D position(long position)

Overrides:

position in class Algorithm

getPointer

public Feature2D getPointer(long i)

Overrides:

getPointer in class Algorithm

asAlgorithm

public Algorithm asAlgorithm()

Overrides:

asAlgorithm in class Algorithm

asAlgorithm

@Namespace
 @Name(value="static_cast<cv::Algorithm*>")
public static Algorithm asAlgorithm(Feature2D pointer)

detect

public void detect(@ByVal
                   Mat image,
                   @ByRef
                   KeyPointVector keypoints,
                   @ByVal(nullValue="cv::InputArray(cv::noArray())")
                   Mat mask)

\brief Detects keypoints in an image (first variant) or image set (second variant).

Parameters:

image - Image.

keypoints - The detected keypoints. In the second variant of the method keypoints[i] is a set of keypoints detected in images[i] .

mask - Mask specifying where to look for keypoints (optional). It must be a 8-bit integer matrix with non-zero values in the region of interest.

detect

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

detect

public void detect(@ByVal
                   UMat image,
                   @ByRef
                   KeyPointVector keypoints,
                   @ByVal(nullValue="cv::InputArray(cv::noArray())")
                   UMat mask)

detect

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

detect

public void detect(@ByVal
                   GpuMat image,
                   @ByRef
                   KeyPointVector keypoints,
                   @ByVal(nullValue="cv::InputArray(cv::noArray())")
                   GpuMat mask)

detect

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

detect

public void detect(@ByVal
                   MatVector images,
                   @ByRef
                   KeyPointVectorVector keypoints,
                   @ByVal(nullValue="cv::InputArrayOfArrays(cv::noArray())")
                   MatVector masks)

\overload

Parameters:

images - Image set.

keypoints - The detected keypoints. In the second variant of the method keypoints[i] is a set of keypoints detected in images[i] .

masks - Masks for each input image specifying where to look for keypoints (optional). masks[i] is a mask for images[i].

detect

public void detect(@ByVal
                   MatVector images,
                   @ByRef
                   KeyPointVectorVector keypoints)

detect

public void detect(@ByVal
                   UMatVector images,
                   @ByRef
                   KeyPointVectorVector keypoints,
                   @ByVal(nullValue="cv::InputArrayOfArrays(cv::noArray())")
                   UMatVector masks)

detect

public void detect(@ByVal
                   UMatVector images,
                   @ByRef
                   KeyPointVectorVector keypoints)

detect

public void detect(@ByVal
                   GpuMatVector images,
                   @ByRef
                   KeyPointVectorVector keypoints,
                   @ByVal(nullValue="cv::InputArrayOfArrays(cv::noArray())")
                   GpuMatVector masks)

detect

public void detect(@ByVal
                   GpuMatVector images,
                   @ByRef
                   KeyPointVectorVector keypoints)

compute

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

\brief Computes the descriptors for a set of keypoints detected in an image (first variant) or image set (second variant).

Parameters:

image - Image.

keypoints - Input collection of keypoints. Keypoints for which a descriptor cannot be computed are removed. Sometimes new keypoints can be added, for example: SIFT duplicates keypoint with several dominant orientations (for each orientation).

descriptors - Computed descriptors. In the second variant of the method descriptors[i] are descriptors computed for a keypoints[i]. Row j is the keypoints (or keypoints[i]) is the descriptor for keypoint j-th keypoint.

compute

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

compute

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

compute

public void compute(@ByVal
                    MatVector images,
                    @ByRef
                    KeyPointVectorVector keypoints,
                    @ByVal
                    MatVector descriptors)

\overload

Parameters:

images - Image set.

keypoints - Input collection of keypoints. Keypoints for which a descriptor cannot be computed are removed. Sometimes new keypoints can be added, for example: SIFT duplicates keypoint with several dominant orientations (for each orientation).

descriptors - Computed descriptors. In the second variant of the method descriptors[i] are descriptors computed for a keypoints[i]. Row j is the keypoints (or keypoints[i]) is the descriptor for keypoint j-th keypoint.

compute

public void compute(@ByVal
                    UMatVector images,
                    @ByRef
                    KeyPointVectorVector keypoints,
                    @ByVal
                    UMatVector descriptors)

compute

public void compute(@ByVal
                    GpuMatVector images,
                    @ByRef
                    KeyPointVectorVector keypoints,
                    @ByVal
                    GpuMatVector descriptors)

detectAndCompute

public void detectAndCompute(@ByVal
                             Mat image,
                             @ByVal
                             Mat mask,
                             @ByRef
                             KeyPointVector keypoints,
                             @ByVal
                             Mat descriptors,
                             @Cast(value="bool")
                             boolean useProvidedKeypoints)

Detects keypoints and computes the descriptors

detectAndCompute

public void detectAndCompute(@ByVal
                             Mat image,
                             @ByVal
                             Mat mask,
                             @ByRef
                             KeyPointVector keypoints,
                             @ByVal
                             Mat descriptors)

detectAndCompute

public void detectAndCompute(@ByVal
                             UMat image,
                             @ByVal
                             UMat mask,
                             @ByRef
                             KeyPointVector keypoints,
                             @ByVal
                             UMat descriptors,
                             @Cast(value="bool")
                             boolean useProvidedKeypoints)

detectAndCompute

public void detectAndCompute(@ByVal
                             UMat image,
                             @ByVal
                             UMat mask,
                             @ByRef
                             KeyPointVector keypoints,
                             @ByVal
                             UMat descriptors)

detectAndCompute

public void detectAndCompute(@ByVal
                             GpuMat image,
                             @ByVal
                             GpuMat mask,
                             @ByRef
                             KeyPointVector keypoints,
                             @ByVal
                             GpuMat descriptors,
                             @Cast(value="bool")
                             boolean useProvidedKeypoints)

detectAndCompute

public void detectAndCompute(@ByVal
                             GpuMat image,
                             @ByVal
                             GpuMat mask,
                             @ByRef
                             KeyPointVector keypoints,
                             @ByVal
                             GpuMat descriptors)

descriptorSize

public int descriptorSize()

descriptorType

public int descriptorType()

defaultNorm

public int defaultNorm()

write

public void write(@opencv_core.Str
                  BytePointer fileName)

write

public void write(@opencv_core.Str
                  String fileName)

read

public void read(@opencv_core.Str
                 BytePointer fileName)

read

public void read(@opencv_core.Str
                 String fileName)

write

public void write(@ByRef
                  FileStorage arg0)

Description copied from class: Algorithm

\brief Stores algorithm parameters in a file storage

Overrides:

write in class Algorithm

read

public void read(@Const @ByRef
                 FileNode arg0)

Description copied from class: Algorithm

\brief Reads algorithm parameters from a file storage

Overrides:

read in class Algorithm

empty

@Cast(value="bool")
public boolean empty()

Return true if detector object is empty

Overrides:

empty in class Algorithm

getDefaultName

@opencv_core.Str
public BytePointer getDefaultName()

Description copied from class: Algorithm

Returns the algorithm string identifier. This string is used as top level xml/yml node tag when the object is saved to a file or string.

Overrides:

getDefaultName in class Algorithm

write

public void write(@ByRef
                  FileStorage fs,
                  @opencv_core.Str
                  BytePointer name)

Description copied from class: Algorithm

\overload

Overrides:

write in class Algorithm

write

public void write(@ByRef
                  FileStorage fs,
                  @opencv_core.Str
                  String name)

Overrides:

write in class Algorithm