From 88f7038edb1d8e5f20d37993d543841e9fea795b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Johannes=20Sch=C3=B6nberger?= Date: Sat, 30 Nov 2013 10:49:43 +0100 Subject: [PATCH] Add note about usage of ORB --- skimage/feature/orb.py | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/skimage/feature/orb.py b/skimage/feature/orb.py index 35f0ad45..ac9631db 100644 --- a/skimage/feature/orb.py +++ b/skimage/feature/orb.py @@ -192,6 +192,11 @@ class ORB(FeatureDetector, DescriptorExtractor): def extract(self, image, keypoints, scales, orientations): """Extract rBRIEF binary descriptors for given keypoints in image. + Note that the keypoints must be extracted using the same `downscale` + and `n_scales` parameters. Additionally, if you want to extract both + keypoints and descriptors you should use the faster + `detect_and_extract`. + Parameters ---------- image : 2D array @@ -254,6 +259,9 @@ class ORB(FeatureDetector, DescriptorExtractor): def detect_and_extract(self, image): """Detect oriented FAST keypoints and extract rBRIEF descriptors. + Note that this is faster than first calling `detect` and then + `extract`. + Parameters ---------- image : 2D array