Update tutorial for erosion / dilation by malliaridis · Pull Request #17839 · opencv/opencv

malliaridis · 2020-07-14T19:04:49Z

PR Information

The tutorial for erosion and dilation lack on explanation for java and python. With this PR I want to improve the tutorial by modifying and expanding the information provided.

This PR addresses the following:

Add python explanation
Add java explanation
Restructure python tutorial code
Expand explanation texts for missing code sections
~~Provide a troubleshooting section for known errors~~ (removed as discussed)
Discuss tutorial code refactoring (resulting window varies between languages)

Feedback and opinions about the changes are appreciated.

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 OpenCV (BSD) License.
To the best of my knowledge, the proposed patch is not based on a code under GPL or other license that is incompatible with OpenCV
The PR is proposed to proper branch
~~There is reference to original bug report and related work~~ (not a bug)
~~There is accuracy test, performance test and test data in opencv_extra repository, if applicable
Patch to opencv_extra has the same branch name.~ ((not applicable)
~~The feature is well documented and sample code can be built with the project CMake~~ (not applicable)

force_builders=docs

asmorkalov · 2020-07-29T06:23:32Z

@malliaridis Is the patch ready for review? Please change PR status, when you are done.

malliaridis · 2020-07-29T08:00:23Z

@asmorkalov I have till next week a tight schedule. The java part is completely missing yet and I would like to add and test it before changing the status of the PR.

malliaridis · 2020-08-21T19:04:03Z

Because of vacation it takes more time to complete this PR. Sorry for the circumstances. If you have any feedback yet however let me know. I will read it when I return back to work.

alalek · 2020-08-21T19:36:56Z

doc/tutorials/imgproc/erosion_dilatation/erosion_dilatation.markdown

+
+Troubleshooting
+---
+@add_toggle_python


Not sure that function's tutorial is a right section for Python troubleshooting (both are about misused OpenCV version - samples assume OpenCV binaries from the same version and for right Python version)

@alalek I know, that was my first thought too. However, I confronted a lot of issues while installing OpenCV for python under Ubuntu. I also have trouble for the java installation. The sites and tutorials found in docs and online are very error prune or are for older versions. Some tutorials aren't working at all or install OpenCV and the version is shown but nothing more (executing example code throws errors). That's why I though it would be useful to bring some clarification as a "troubleshooting" section. But of course I can remove the section.

What's your opinion about the other content (except the troubleshooting section now)?

P.S. I want to start also a discussion somewhere about simplifying the installation process by collecting some opinions and discuss various installation options and the problems beginners have while starting learning OpenCV. That way the troubleshooting section won't be necessary at all and the beginners can get started much faster. My experience for example wasn't that great and the installation process was too complicated for "just trying it out". Finding the right resources and explanations was quite difficult.

I believe this content should be contributed into this document instead: https://github.com/opencv/opencv/wiki/FAQ (maintained by @asmorkalov )
Please open a new issue with proposals for Wiki updates (GitHub doesn't support PRs for Wiki)

There is PR with updating of installation process: #18195
Feel free to discuss it there.

@asmorkalov do you think we can fit somehow this kind of content in the FAQ?

And about the mentioned PR, I'll check it out, thanks. Looks like a lot of improvements are being made.

asmorkalov · 2020-08-31T07:11:15Z

@malliaridis Friendly reminder.

Remove troubleshooting section as discussed in PR opencv#17839.

malliaridis · 2020-09-03T17:02:21Z

I would like to mention that the code snippets that were found and reused are implemented with different resulting windows, preventing a comparison or squashing of the explanation texts.

Also, some optional parameters in functions from the python library seem to be required in java (no defaults).

asmorkalov · 2020-11-16T09:57:00Z

@malliaridis I reviewed the PR and it looks good to me 👍 . Please squash commits and we can merge it.

alalek · 2020-11-16T10:41:24Z

This patch should go into 3.4 branch first.
We will merge changes from 3.4 into master regularly (weekly/bi-weekly).

So, please:

change "base" branch of this PR: master => 3.4 (use "Edit" button near PR title)
rebase your commits from master onto 3.4 branch. For example:
git rebase -i --onto upstream/3.4 upstream/master
(check list of your commits, save and quit (Esc + "wq" + Enter)
where upstream is configured by following this GitHub guide and fetched (git fetch upstream).
push rebased commits into source branch of your fork (with --force option)

Note: no needs to re-open PR, apply changes "inplace".

- Add python explanation for erosion and dilation - Add java explanation for erosion and dilation - Restructure and reword specific sections

malliaridis · 2020-11-18T12:43:45Z

This patch should go into 3.4 branch first.
We will merge changes from 3.4 into master regularly (weekly/bi-weekly).

So, please:

change "base" branch of this PR: master => 3.4 (use "Edit" button near PR title)

rebase your commits from master onto 3.4 branch. For example:
git rebase -i --onto upstream/3.4 upstream/master
(check list of your commits, save and quit (Esc + "wq" + Enter)
where upstream is configured by following this GitHub guide and fetched (git fetch upstream).

push rebased commits into source branch of your fork (with --force option)

Note: no needs to re-open PR, apply changes "inplace".

I hopefully followed all steps correctly. Let me know if I missed something. I also stashed the commits as requested.

alalek · 2020-11-18T13:10:22Z

Demo page for this PR.

asmorkalov

Well done!

asmorkalov added the category: documentation Documentation fix or update label Aug 5, 2020

alalek reviewed Aug 21, 2020

View reviewed changes

malliaridis added a commit to malliaridis/opencv that referenced this pull request Sep 3, 2020

Remove troubleshooting section

d7ebd28

Remove troubleshooting section as discussed in PR opencv#17839.

malliaridis changed the title ~~WIP: Update tutorial for erosion / dilation~~ Update tutorial for erosion / dilation Sep 3, 2020

malliaridis marked this pull request as ready for review September 3, 2020 17:08

asmorkalov added the pr: needs rebase Rebase patch (and squash fixup commits) on the top of target branch label Nov 17, 2020

malliaridis changed the base branch from master to 3.4 November 18, 2020 12:04

Update and expand erosion / dilation tutorial

3c25fd1

- Add python explanation for erosion and dilation - Add java explanation for erosion and dilation - Restructure and reword specific sections

malliaridis force-pushed the master branch from d7ebd28 to 3c25fd1 Compare November 18, 2020 12:38

asmorkalov self-requested a review November 18, 2020 13:42

asmorkalov self-assigned this Nov 18, 2020

asmorkalov approved these changes Nov 18, 2020

View reviewed changes

opencv-pushbot merged commit 87ed750 into opencv:3.4 Nov 18, 2020

This was referenced Nov 20, 2020

Merge 3.4 #18881

Merged

Merge 4.x #18951

Merged

Uh oh!

Conversation

malliaridis commented Jul 14, 2020 • edited by alalek Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Information

Pull Request Readiness Checklist

Uh oh!

asmorkalov commented Jul 29, 2020

Uh oh!

malliaridis commented Jul 29, 2020

Uh oh!

malliaridis commented Aug 21, 2020

Uh oh!

alalek Aug 21, 2020

Choose a reason for hiding this comment

Uh oh!

malliaridis Aug 31, 2020

Choose a reason for hiding this comment

Uh oh!

alalek Aug 31, 2020

Choose a reason for hiding this comment

Uh oh!

malliaridis Aug 31, 2020

Choose a reason for hiding this comment

Uh oh!

asmorkalov commented Aug 31, 2020

Uh oh!

malliaridis commented Sep 3, 2020

Uh oh!

asmorkalov commented Nov 16, 2020

Uh oh!

alalek commented Nov 16, 2020

Uh oh!

malliaridis commented Nov 18, 2020

Uh oh!

alalek commented Nov 18, 2020

Uh oh!

asmorkalov left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

malliaridis commented Jul 14, 2020 •

edited by alalek

Loading