Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reference to non-existent parameter name in documentation of StereoSGBM::create #9392

Closed
dustsigns opened this issue Aug 17, 2017 · 4 comments
Assignees
Labels
affected: 3.4 bug category: documentation Documentation fix or update Hackathon https://opencv.org/opencv-hackathon-starts-next-week/
Milestone

Comments

@dustsigns
Copy link

System information (version)
  • OpenCV => 3.3
  • Operating System / Platform => -
  • Compiler => -
Detailed description

The documentation for StereoSGBM::create mentions SADWindowSize which is not a parameter of the constructor:

See stereo_match.cpp sample where some reasonably good P1 and P2 values are shown (like 8*number_of_image_channels*SADWindowSize*SADWindowSize and 32*number_of_image_channels*SADWindowSize*SADWindowSize , respectively).

I suppose that is due to the fact that the parameter blockSize was called SADWindowSize in OpenCV 2.4.0 (cf. http://docs.opencv.org/2.4.0/modules/calib3d/doc/camera_calibration_and_3d_reconstruction.html#stereosgbm-stereosgbm). Maybe the documentation in the current version should be updated to avoid confusion. This seems to have been introduced with OpenCV 3.0.

Steps to reproduce

Replace SADWindowSize with blocksize in the documentation of StereoSGBM::create.

@saskatchewancatch
Copy link
Contributor

@dustsigns Not too familiar with this area, but just taking a quick look, does cv::getValidDisparityROI's SADWindowSize deserve to be renamed to blockSize if it's related to StereoSGBM?

@dustsigns
Copy link
Author

It seems so, but maybe someone more experienced with the use of this function should be the judge of that.

@sturkmen72
Copy link
Contributor

sturkmen72 commented Aug 18, 2017

replacing SADWindowSize with blocksize or replacing blocksize with SADWindowSize

maybe looking places where SADWindowSize used will help to understand better.

@alalek what it your suggestion to fix this?

@asmorkalov asmorkalov added the Hackathon https://opencv.org/opencv-hackathon-starts-next-week/ label Jan 14, 2020
@alalek
Copy link
Member

alalek commented Jan 30, 2020

Lets do this:

replacing SADWindowSize with blocksize blockSize

in public headers only:

modules/calib3d/include

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
affected: 3.4 bug category: documentation Documentation fix or update Hackathon https://opencv.org/opencv-hackathon-starts-next-week/
Projects
None yet
Development

No branches or pull requests

6 participants