Skip to content

O
opencv
Commit 6be9fbfa authored by Bernat Gabor's avatar Bernat Gabor
Browse files
Options

Reformatted the TOC tables in tutorials to look just as good in PDFs as in HTML.… 

Reformatted the TOC tables in tutorials to look just as good in PDFs as in HTML. Updated the default.css_t too for this. Added the "Windows Install" tutorial (with videos).
parent 43097c6a
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 278 additions and 157 deletions
doc/_themes/blue/static/default.css_t
View file @ 6be9fbfa
......@@ -309,6 +309,47 @@ ul.simple {
list-style: none;
}
.enumeratevisibleitems .simple {
.enumeratevisibleitemswithsquare ul {
list-style: square;
}
\ No newline at end of file
margin-bottom: 0px;
margin-left: 0px;
margin-right: 0px;
margin-top: 0px;
}
.enumeratevisibleitemswithsquare li {
margin-bottom: 0.2em;
margin-left: 0px;
margin-right: 0px;
margin-top: 0.2em;
}
.enumeratevisibleitemswithsquare p {
margin-bottom: 0px;
}
.enumeratevisibleitemswithsquare dl{
margin-bottom: 0px;
margin-left: 0px;
margin-right: 0px;
margin-top: 0px;
}
.toctableopencv
{
width: 100% ;
table-layout: fixed;
}
.toctableopencv colgroup col:first-child
{
width: 100pt !important;
max-width: 100pt !important;
min-width: 100pt !important;
}
.toctableopencv colgroup col:nth-child(2)
{
width: 100% !important;
}
\ No newline at end of file
doc/tutorials/core/table_of_content_core/table_of_content_core.rst
View file @ 6be9fbfa
......@@ -5,84 +5,90 @@
Here you will learn the about the basic building blocks of the library. A must read and know for understanding how to manipulate the images on a pixel level.
.. toctree::
:hidden:
../adding_images/adding_images
../basic_linear_transform/basic_linear_transform
../basic_geometric_drawing/basic_geometric_drawing
../random_generator_and_text/random_generator_and_text
.. |Author_AnaH| unicode:: Ana U+0020 Huam U+00E1 n
.. include:: ../../definitions/tocDefinitions.rst
* :ref:`Adding_Images`
+
.. tabularcolumns:: m{100pt} m{300pt}
.. cssclass:: toctableopencv
=============== ======================================================
|Beginners_4| *Title:* **Linear Blending**
|Beginners_4| **Title:** :ref:`Adding_Images`
*Compatibility:* > OpenCV 2.0
*Author:* |Author_AnaH|
We will learn how to blend two images!
=============== ======================================================
.. |Beginners_4| image:: images/Adding_Images_Tutorial_Result_0.png
:height: 100pt
:width: 100pt
.. |Beginners_4| image:: images/Adding_Images_Tutorial_Result_0.png
:height: 90pt
:width: 90pt
* :ref:`Basic_Linear_Transform`
+
.. tabularcolumns:: m{100pt} m{300pt}
.. cssclass:: toctableopencv
=============== ====================================================
|Bas_Lin_Tran| *Title:* **Changing the contrast and brightness of an image**
|Bas_Lin_Tran| **Title:** :ref:`Basic_Linear_Transform`
*Compatibility:* > OpenCV 2.0
*Author:* |Author_AnaH|
We will learn how to change our image appearance!
=============== ====================================================
.. |Bas_Lin_Tran| image:: images/Basic_Linear_Transform_Tutorial_Result_0.png
:height: 100pt
:width: 100pt
:height: 90pt
:width: 90pt
* :ref:`Drawing_1`
+
.. tabularcolumns:: m{100pt} m{300pt}
.. cssclass:: toctableopencv
=============== ======================================================
|Beginners_6| *Title:* **Basic Drawing**
|Beginners_6| **Title:** :ref:`Drawing_1`
*Compatibility:* > OpenCV 2.0
*Author:* |Author_AnaH|
We will learn how to draw simple geometry with OpenCV!
=============== ======================================================
.. |Beginners_6| image:: images/Drawing_1_Tutorial_Result_0.png
:height: 100pt
:width: 100pt
=============== ======================================================
.. |Beginners_6| image:: images/Drawing_1_Tutorial_Result_0.png
:height: 90pt
:width: 90pt
* :ref:`Drawing_2`
+
.. tabularcolumns:: m{100pt} m{300pt}
.. cssclass:: toctableopencv
=============== ======================================================
|Beginners_7| *Title:* **Cool Drawing**
|Beginners_7| **Title:** * :ref:`Drawing_2`
*Compatibility:* > OpenCV 2.0
*Author:* |Author_AnaH|
We will draw some *fancy-looking* stuff using OpenCV!
=============== ======================================================
.. |Beginners_7| image:: images/Drawing_2_Tutorial_Result_7.png
:height: 100pt
:width: 100pt
:height: 90pt
:width: 90pt
.. toctree::
:hidden:
../adding_images/adding_images
../basic_linear_transform/basic_linear_transform
../basic_geometric_drawing/basic_geometric_drawing
../random_generator_and_text/random_generator_and_text
\ No newline at end of file
doc/tutorials/definitions/formatStyleSizeDef.rst 0 → 100644
View file @ 6be9fbfa
.. |TOC_Image_Width| replace:: 100pt
.. |TOC_Image_Height| replace:: 100pt
.. |TOC
doc/tutorials/definitions/tocDefinitions.rst 0 → 100644
View file @ 6be9fbfa
.. |Author_AnaH| unicode:: Ana U+0020 Huam U+00E1 n
.. |Author_BernatG| unicode:: Bern U+00E1 t U+0020 G U+00E1 bor
doc/tutorials/introduction/linux_eclipse/linux_eclipse.rst
View file @ 6be9fbfa
......@@ -177,6 +177,7 @@ Making a project
My output (in case you want to check) was:
.. code-block:: bash
-L/usr/local/lib -lopencv_core -lopencv_imgproc -lopencv_highgui -lopencv_ml -lopencv_video -lopencv_features2d -lopencv_calib3d -lopencv_objdetect -lopencv_contrib -lopencv_legacy -lopencv_flann
Now you are done. Click **OK**
......
doc/tutorials/introduction/table_of_content_introduction/table_of_content_introduction.rst
View file @ 6be9fbfa
......@@ -5,127 +5,148 @@ Introduction to OpenCV
Here you can read tutorials about how to set up your computer to work with the OpenCV library. Additionaly you can find a few very basic sample source code that will let introduce you to the world of the OpenCV.
.. We use a custom table of content format and as the table of content only imforms Sphinx about the hierarchy of the files, no need to show it.
.. toctree::
:hidden:
../linux_install/linux_install
../linux_gcc_cmake/linux_gcc_cmake
../linux_eclipse/linux_eclipse
../windows_install/windows_install
../display_image/display_image
../load_save_image/load_save_image
.. include:: ../../definitions/tocDefinitions.rst
.. |Author_AnaH| unicode:: Ana U+0020 Huam U+00E1 n
.. |Author_BernatG| unicode:: Bern U+00E1 t U+0020 G U+00E1 bor
* **Linux**
* :ref:`Linux-Installation`
.. tabularcolumns:: m{100pt} m{300pt}
.. cssclass:: toctableopencv
=========== ======================================================
|Install_1| *Title:* **Installation steps in Linux**
=========== ======================================================
|Install_1| **Title:** :ref:`Linux-Installation`
*Compatibility:* > OpenCV 2.0
*Author:* |Author_AnaH|
*Compatibility:* > OpenCV 2.0
We will learn how to setup OpenCV in your computer!
=========== ======================================================
.. |Install_1| image:: images/ubuntu_logo.jpeg
:height: 100pt
:width: 100pt
*Author:* |Author_AnaH|
We will learn how to setup OpenCV in your computer!
* :ref:`Linux_GCC_Usage`
=========== ======================================================
=========== ======================================================
|Usage_1| *Title:* **Using OpenCV with gcc (and CMake)**
.. |Install_1| image:: images/ubuntu_logo.jpeg
:height: 90pt
:width: 90pt
*Compatibility:* > OpenCV 2.0
*Author:* |Author_AnaH|
.. tabularcolumns:: m{100pt} m{300pt}
.. cssclass:: toctableopencv
=========== ======================================================
|Usage_1| **Title:** :ref:`Linux_GCC_Usage`
We will learn how to compile your first project using gcc and CMake
=========== ======================================================
.. |Usage_1| image:: images/gccegg-65.png
:height: 100pt
:width: 100pt
*Compatibility:* > OpenCV 2.0
*Author:* |Author_AnaH|
* :ref:`Linux_Eclipse_Usage`
We will learn how to compile your first project using gcc and CMake
=========== ======================================================
|Usage_2| *Title:* **Using OpenCV with Eclipse (CDT plugin)**
=========== ======================================================
*Compatibility:* > OpenCV 2.0
*Author:* |Author_AnaH|
.. |Usage_1| image:: images/gccegg-65.png
:height: 90pt
:width: 90pt
.. tabularcolumns:: m{100pt} m{300pt}
.. cssclass:: toctableopencv
=========== ======================================================
|Usage_2| **Title:** :ref:`Linux_Eclipse_Usage`
*Compatibility:* > OpenCV 2.0
*Author:* |Author_AnaH|
We will learn how to compile your first project using the Eclipse environment
=========== ======================================================
We will learn how to compile your first project using the Eclipse environment
=========== ======================================================
.. |Usage_2| image:: images/eclipse_cpp_logo.jpeg
:height: 100pt
:width: 100pt
:height: 90pt
:width: 90pt
* **Windows**
* :ref:`Windows_Installation`
.. tabularcolumns:: m{100pt} m{300pt}
.. cssclass:: toctableopencv
=========== ======================================================
|WinInstal| **Title:** :ref:`Windows_Installation`
*Compatibility:* > OpenCV 2.0
*Author:* |Author_BernatG|
You will learn how to setup OpenCV in your Windows Operating System!
=========== ======================================================
.. |WinInstal| image:: images/windows_logo.jpg
:height: 90pt
:width: 90pt
.. tabularcolumns:: m{100pt} m{300pt}
.. cssclass:: toctableopencv
=========== ======================================================
|Install_2| *Title:* **Installation steps in Windows**
=========== ======================================================
|WinVSHowT| **Title:** :ref:`Windows_Visual_Studio_How_To`
*Compatibility:* > OpenCV 2.0
*Author:* |Author_BernatG|
*Compatibility:* > OpenCV 2.0
You will learn how to setup OpenCV in your Windows Operating System!
*Author:* |Author_BernatG|
=========== ======================================================
You will learn what steps you need to perform in order to use the OpenCV library inside a new Microsoft Visual Studio project.
.. |Install_2| image:: images/windows_logo.jpg
:height: 100pt
:width: 100pt
=========== ======================================================
.. |WinVSHowT| image:: images/visual-studio-2010-logo.jpg
:height: 90pt
:width: 90pt
* **From where to start?**
* :ref:`Display_Image`
.. tabularcolumns:: m{100pt} m{300pt}
.. cssclass:: toctableopencv
=============== ======================================================
|Beginners_1| *Title:* **Display an Image**
============= ======================================================
|Beginners_1| **Title:** :ref:`Display_Image`
*Compatibility:* > OpenCV 2.0
*Author:* |Author_AnaH|
*Compatibility:* > OpenCV 2.0
We will learn how to display an image using OpenCV
=============== ======================================================
.. |Beginners_1| image:: images/Display_Image_Tutorial_Result.png
:height: 100pt
:width: 100pt
*Author:* |Author_AnaH|
We will learn how to display an image using OpenCV
* :ref:`Load_Save_Image`
============= ======================================================
=============== ======================================================
|Beginners_2| *Title:* **Load and save an Image**
.. |Beginners_1| image:: images/Display_Image_Tutorial_Result.png
:height: 90pt
:width: 90pt
*Compatibility:* > OpenCV 2.0
*Author:* |Author_AnaH|
.. tabularcolumns:: m{100pt} m{300pt}
.. cssclass:: toctableopencv
=============== ======================================================
|Beginners_2| **Title:** :ref:`Load_Save_Image`
We will learn how to save an Image in OpenCV...plus a small conversion to grayscale
=============== ======================================================
.. |Beginners_2| image:: images/Load_Save_Image_Result_1.png
:height: 100pt
:width: 100pt
*Compatibility:* > OpenCV 2.0
*Author:* |Author_AnaH|
We will learn how to save an Image in OpenCV...plus a small conversion to grayscale
=============== ======================================================
.. |Beginners_2| image:: images/Load_Save_Image_Result_1.png
:height: 90pt
:width: 90pt
.. We use a custom table of content format and as the table of content only imforms Sphinx about the hierarchy of the files, no need to show it.
.. toctree::
:hidden:
../linux_install/linux_install
../linux_gcc_cmake/linux_gcc_cmake
../linux_eclipse/linux_eclipse
../windows_install/windows_install
../windows_visual_studio_Opencv/windows_visual_studio_Opencv
../display_image/display_image
../load_save_image/load_save_image
doc/tutorials/introduction/windows_visual_studio_Opencv/windows_visual_studio_Opencv.rst 0 → 100644
View file @ 6be9fbfa
.. _Windows_Visual_Studio_How_To:
How to build applications with OpenCV inside the *Microsoft Visual Studio*
**************************************************************************
One.
\ No newline at end of file
doc/tutorials/tutorials.rst
View file @ 6be9fbfa
Tutorials
###########
###############
OpenCV Tutorials
###############
The following links describe a set of basic OpenCV tutorials. All the source code mentioned here is provide as part of the OpenCV regular releases, so check before you start copy & pasting the code. The list of tutorials below is automatically generated from reST files located in our SVN repository.
As always, we would be happy to hear your comments and receive your contributions on any tutorial.
.. toctree::
:maxdepth: 2
:hidden:
introduction/table_of_content_introduction/table_of_content_introduction
core/table_of_content_core/table_of_content_core
imgproc/table_of_content_imgproc/table_of_content_imgproc
highgui/table_of_content_highgui/table_of_content_highgui
calib3d/table_of_content_calib3d/table_of_content_calib3d
features2d/table_of_content_features2d/table_of_content_features2d
video/table_of_content_video/table_of_content_video
objdetect/table_of_content_objdetect/table_of_content_objdetect
ml/table_of_content_ml/table_of_content_ml
gpu/table_of_content_gpu/table_of_content_gpu
general/table_of_content_general/table_of_content_general
* :ref:`Table-Of-Content-Introduction`
.. tabularcolumns:: m{100pt} m{300pt}
.. cssclass:: toctableopencv
=========== =======================================================
|Introduct| You will learn how to setup OpenCV on your computer!
......@@ -35,6 +23,9 @@ As always, we would be happy to hear your comments and receive your contribution
* :ref:`Table-Of-Content-Core`
.. tabularcolumns:: m{100pt} m{300pt}
.. cssclass:: toctableopencv
=========== =======================================================
|Core| Here you will learn the about the basic building blocks of the library. A must read and know for understanding how to manipulate the images on a pixel level.
......@@ -47,6 +38,9 @@ As always, we would be happy to hear your comments and receive your contribution
* :ref:`Table-Of-Content-ImgProc`
.. tabularcolumns:: m{100pt} m{300pt}
.. cssclass:: toctableopencv
=========== =======================================================
|ImgProc| In this section you will learn about the image processing (manipulation) functions inside OpenCV.
......@@ -59,6 +53,9 @@ As always, we would be happy to hear your comments and receive your contribution
* :ref:`Table-Of-Content-HighGui`
.. tabularcolumns:: m{100pt} m{300pt}
.. cssclass:: toctableopencv
=========== =======================================================
|HighGui| This section contains valuable tutorials about how to read/save your image/video files and how to use the built-in graphical user interface of the library.
......@@ -71,6 +68,9 @@ As always, we would be happy to hear your comments and receive your contribution
* :ref:`Table-Of-Content-Calib3D`
.. tabularcolumns:: m{100pt} m{300pt}
.. cssclass:: toctableopencv
=========== =======================================================
|Calib3D| Although we got most of our images in a 2D format they do come from a 3D world. Here you will learn how to find out from the 2D images information about the 3D world.
......@@ -83,6 +83,9 @@ As always, we would be happy to hear your comments and receive your contribution
* :ref:`Table-Of-Content-Feature2D`
.. tabularcolumns:: m{100pt} m{300pt}
.. cssclass:: toctableopencv
=========== =======================================================
|Featur2D| Learn about how to use the feature points detectors, descriptors and matching framework found inside OpenCV.
......@@ -94,7 +97,10 @@ As always, we would be happy to hear your comments and receive your contribution
:alt: feature2D Icon
* :ref:`Table-Of-Content-Video`
.. tabularcolumns:: m{100pt} m{300pt}
.. cssclass:: toctableopencv
=========== =======================================================
|Video| Look here in order to find use on your video stream algoritms like: motion extraction, feature tracking and foreground extractions.
......@@ -107,6 +113,9 @@ As always, we would be happy to hear your comments and receive your contribution
* :ref:`Table-Of-Content-ObjDetect`
.. tabularcolumns:: m{100pt} m{300pt}
.. cssclass:: toctableopencv
=========== =======================================================
|ObjDetect| Ever wondered how your digital camera detects peoples and faces? Look here to find out!
......@@ -118,7 +127,10 @@ As always, we would be happy to hear your comments and receive your contribution
:alt: objdetect Icon
* :ref:`Table-Of-Content-Ml`
.. tabularcolumns:: m{100pt} m{300pt}
.. cssclass:: toctableopencv
=========== =======================================================
|ml| Use the powerfull machine learning classes for statistical classification, regression and clustering of data.
......@@ -131,6 +143,9 @@ As always, we would be happy to hear your comments and receive your contribution
* :ref:`Table-Of-Content-GPU`
.. tabularcolumns:: m{100pt} m{300pt}
.. cssclass:: toctableopencv
=========== =======================================================
|GPU| Squeeze out every little computation power from your system by using the power of your video card to run the OpenCV algorithms.
......@@ -143,6 +158,9 @@ As always, we would be happy to hear your comments and receive your contribution
* :ref:`Table-Of-Content-General`
.. tabularcolumns:: m{100pt} m{300pt}
.. cssclass:: toctableopencv
=========== =======================================================
|General| These tutorials are the bottom of the iceberg as they link together multiple of the modules presented above in order to solve complex problems.
......@@ -153,3 +171,18 @@ As always, we would be happy to hear your comments and receive your contribution
:width: 80pt
:alt: General Icon
.. toctree::
:maxdepth: 2
:hidden:
introduction/table_of_content_introduction/table_of_content_introduction
core/table_of_content_core/table_of_content_core
imgproc/table_of_content_imgproc/table_of_content_imgproc
highgui/table_of_content_highgui/table_of_content_highgui
calib3d/table_of_content_calib3d/table_of_content_calib3d
features2d/table_of_content_features2d/table_of_content_features2d
video/table_of_content_video/table_of_content_video
objdetect/table_of_content_objdetect/table_of_content_objdetect
ml/table_of_content_ml/table_of_content_ml
gpu/table_of_content_gpu/table_of_content_gpu
general/table_of_content_general/table_of_content_general
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment