Skip to content

Improve documentation of calcHist overload that accepts vectors#22189

Merged
opencv-pushbot merged 1 commit intoopencv:3.4from
p12tic:document-calchist-overload
Jul 5, 2022
Merged

Improve documentation of calcHist overload that accepts vectors#22189
opencv-pushbot merged 1 commit intoopencv:3.4from
p12tic:document-calchist-overload

Conversation

@p12tic
Copy link
Copy Markdown
Contributor

@p12tic p12tic commented Jul 4, 2022

Pull Request Readiness Checklist

See details at https://github.com/opencv/opencv/wiki/How_to_contribute#making-a-good-pull-request

  • I agree to contribute to the project under Apache 2 License.
  • To the best of my knowledge, the proposed patch is not based on a code under GPL or another license that is incompatible with OpenCV
  • The PR is proposed to the proper branch
  • [not applicable (documentation improvement)] There is a reference to the original bug report and related work
  • [not applicable] There is accuracy test, performance test and test data in opencv_extra repository, if applicable
    Patch to opencv_extra has the same branch name.
  • The feature is well documented and sample code can be built with the project CMake

It's not clear how ranges argument should be used in the overload of
calcHist that accepts std::vector. The main overload uses array of
arrays there, while std::vector overload uses a plain array. The code
interprets the vector as a flattened array and rebuilds array of arrays
from it. This is not obvious interpretation, so documentation has been
added to explain the expected usage.
@p12tic p12tic force-pushed the document-calchist-overload branch from 78cdb45 to 6a4c3b6 Compare July 4, 2022 09:20
Copy link
Copy Markdown
Member

@alalek alalek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍 Thank you for contribution!

@opencv-pushbot opencv-pushbot merged commit 3891b72 into opencv:3.4 Jul 5, 2022
@alalek alalek mentioned this pull request Jul 26, 2022
This was referenced Aug 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants