FASTFeatureDetector incorrect parameter description in documentation (Bug #3050)

Added by Dominik Van Opdenbosch almost 12 years ago. Updated about 10 years ago.

Status:Cancelled Start date:2013-05-29
Priority:Normal Due date:
Assignee:Steven Puttemans % Done:

0%
Category:documentation
Target version:-
Affected version:branch '2.4' (2.4-dev) Operating System:Any
Difficulty: HW Platform:Any
Pull request:https://github.com/Itseez/opencv/pull/3731

Description

The documentation for FastFeatureDetector is incorrect:

The documentation for version 2.4.5 describes the wrapping class as:
FastFeatureDetector( int threshold=1, bool nonmaxSuppression=true, type=FastFeatureDetector::TYPE_9_16 );
http://docs.opencv.org/2.4.5/modules/features2d/doc/common_interfaces_of_feature_detectors.html

However, in the sources of 2.4.5 it is still the old version, as described in the docs until 2.4.2
FastFeatureDetector( int threshold=10, bool nonmaxSuppression=true );
http://docs.opencv.org/2.4.2/modules/features2d/doc/common_interfaces_of_feature_detectors.html

In the current master, the signature is the new one.

Associated revisions

Revision ce0297ed
Added by Vadim Pisarevsky over 10 years ago

Merge pull request #3050 from ElenaGvozdeva:ocl_fixed_impg

History

#1
Updated by Steven Puttemans about 10 years ago

It is indeed a bug in the header file. The cpp file contains the correct functionality.

https://github.com/Itseez/opencv/blob/2.4/modules/features2d/include/opencv2/features2d/features2d.hpp#L583

I will make a PR for this.

  • Assignee changed from Vadim Pisarevsky to Steven Puttemans
  • HW Platform set to Any
  • Operating System set to Any
  • Affected version changed from 2.4.5 (latest release) to branch '2.4' (2.4-dev)

#2
Updated by Steven Puttemans about 10 years ago

  • Pull request set to https://github.com/Itseez/opencv/pull/3731

#3
Updated by Steven Puttemans about 10 years ago

The PR cannot be merged to 2.4 as breaks binary compatibility.

--> Remark in PR. Will close this one down for now!

  • Status changed from Open to Cancelled

#4
Updated by Alexander Smorkalov about 10 years ago

OpenCV team saves binary compatibility between releases in 2.4. It means that we cannot change functions signatures. If it cannot be worked around we have to apply fix for master only. The problem is not relevant ot master, so the ticket canceled.

Also available in: Atom PDF