several issues in the documentation (Bug #2410)


Added by Victor Eruhimov over 4 years ago. Updated almost 2 years ago.


Status:Open Start date:2012-10-03
Priority:Normal Due date:
Assignee:- % Done:

0%

Category:documentation
Target version:Next Hackathon
Affected version:branch '2.4' Operating System:
Difficulty: HW Platform:
Pull request:

Description

  1. putText: fontScale -- not clear what is the base font size
  2. CvRTParams: there is no description of the structure members. So it is completely unclear how to alter a default value for one of the parameters without specifying all of them.
  3. findContours: the description of hierarchy should explicitly say it should be a vector<Vec4i>. If hierarchy is a Mat, the results are confusing (one row matrix is returned)
  4. goodFeaturesToTrack: not clear what is the type of 'corners' matrix
  5. matrix concatenation: I am sure there was one (Vadim has told me) but it is not in the documentation (search on 'concatenate' does not bring anything relevant)
  6. CvStatModel::train: "For classification problems, the responses are discrete class labels". Well, thank you very much, as if I didn't know that. However the real goal of this would be to tell me what is the expected type of the response matrix. And I can't find it in the documentation. The whole documentation for this class method has to be made rigorous, describing the meaning of each argument.
    VideoWriter: add a link to fourcc codes page
    getTextSize: "Use "y" to show that the baseline is about" - comment is unclear-
    findContours: description of hierarchy has a typo 'same hierarchical level: the first' -> 'same hierarchical level, the first'
    CvBoost: returnSum in function declaration, but return_sum in parameters description
    opticalFlow: not clear what is the type of 'status' matrix

Associated revisions

Revision fe5b9df4
Added by Daniil Osokin over 4 years ago

Fixed multiple issues in docs (bug #2410)

History

Updated by Alexander Smorkalov over 4 years ago

  • Target version set to 2.4.3

Updated by Vadim Pisarevsky over 4 years ago

  • Target version deleted (2.4.3)
  • Assignee deleted (Vadim Pisarevsky)

Updated by Kirill Kornyakov over 4 years ago

  • Description changed from VideoWriter: add a link to fourcc codes page putText: fontScale -- not clear ... to # @VideoWriter@: add a link to fourcc codes page # @putText@: fontScale -- no... More

Updated by Vsevolod Glumov over 4 years ago

  • Assignee set to Vsevolod Glumov

Updated by Kirill Kornyakov over 4 years ago

  • Target version set to Next Hackathon

Updated by Vadim Pisarevsky over 4 years ago

  • Target version deleted (Next Hackathon)

Updated by Vadim Pisarevsky over 4 years ago

  • Assignee deleted (Vsevolod Glumov)

Updated by Daniil Osokin over 4 years ago

  • Affected version set to branch '2.4'
  • Assignee set to Daniil Osokin

Updated by Daniil Osokin over 4 years ago

  • Description changed from # @VideoWriter@: add a link to fourcc codes page # @putText@: fontScale -- no... to # @putText@: fontScale -- not clear what is the base font size # @CvRTParams@... More
  • Assignee deleted (Daniil Osokin)

Updated by Kirill Kornyakov over 4 years ago

  • Target version set to Next Hackathon

Updated by Maksim Shabunin almost 2 years ago

Issue has been transferred to GitHub: https://github.com/Itseez/opencv/issues/4432

Also available in: Atom PDF