-
Notifications
You must be signed in to change notification settings - Fork 163
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
Image Processing docs #388
Conversation
The docs are written with a beginner in mind and has a basics section. The pictures and paper links are to be inserted.
This commit fills in the template left by the previous commit
Since GitHub doesn't allow Mathjax, the formula parts have been replaced with code blocks
It doesn't seem like the concept is used often, so postponed for now
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
First, thank you very much for kickstarting the prose documentation for the image processing. I hope @miralshah365 will also fill it in with some content.
Since we rely on Sphinx, see https://github.com/boostorg/gil/blob/develop/doc/README.md, all prose docs must be written in reStructuredText, not Markdown.
Second, in order to tell Sphinx to integrate your pages, you need to add to the table of contets in the doc/index.rst
lines like this
image_processing/basics
image_processing/<other page without .rst extension>
e.g. somewhere after design_guide
and before extensions.
This commit cites and adds a link to paper about Hessian detector and a review paper about affine region detectors
Space extrema detector doesn't seem to be a widespread usage of detector the detector class. There is a paper that uses "Affine region detector" term, which has quite a few citations
I agree with @mloskot : markdown documentation such as the toplevel *.md files is intended to be browsed by contributors who review the repo on github (which provides markdown rendering built into their portal) or quickly glance over them in purely textual form on your local machine. |
Fix mistakes related to terminology and algorithm steps
Make sure ip docs are built and are in the final output
@@ -0,0 +1,54 @@ | |||
Basics | |||
------ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Any reason you don't follow GIL's markup for headings?
GIL (should) follows markup for sections recommended by Python guide for documenting and equivalent Sphinx reStructuredText Primer, that is:
=, for sections
-, for subsections
^, for subsubsections
", for paragraphs
However, in future, this may and we may decide to distinguish chapters and parts as well.is intentional.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good to me.
I just had a general comment in #388 (review)
It seems like some lines are not properly formatted and rendered file containes unreadable lines. Fixed by not formatting it.
Move image processing sections before I/O extension page. Refines #388
Description
Expanded documentation for Harris and Hessian detectors.
References
#350, #364
Tasklist