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.

Sign up for GitHub

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

Jump to bottom

Add documentation on G-types, cv::MediaFrame, and G-API namespaces #20238

Merged

opencv-pushbot merged 1 commit into opencv:master from dmatveev:dm/gframe_docs

Jun 16, 2021

Contributor

dmatveev commented Jun 7, 2021 •

edited

There is also some pending changes on Inference but those parts will be pushed in a separate PR after #20169 is merged.

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 other license that is incompatible with OpenCV
The PR is proposed to proper branch
There is reference to original bug report and related work
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

force_builders=Custom,Custom Win,Custom Mac
build_gapi_standalone:Linux x64=ade-0.1.1f
build_gapi_standalone:Win64=ade-0.1.1f
build_gapi_standalone:Mac=ade-0.1.1f
build_gapi_standalone:Linux x64 Debug=ade-0.1.1f

Xbuild_image:Custom=centos:7
Xbuildworker:Custom=linux-1
build_gapi_standalone:Custom=ade-0.1.1f

build_image:Custom=ubuntu-openvino-2021.3.0:20.04
build_image:Custom Win=openvino-2021.2.0
build_image:Custom Mac=openvino-2021.2.0

test_modules:Custom=gapi,python2,python3,java
test_modules:Custom Win=gapi,python2,python3,java
test_modules:Custom Mac=gapi,python2,python3,java

buildworker:Custom=linux-1
# disabled due high memory usage: test_opencl:Custom=ON
test_opencl:Custom=OFF
test_bigdata:Custom=1
test_filter:Custom=*

dmatveev added category: documentation category: g-api / gapi labels

dmatveev added this to the 4.5.3 milestone

dmatveev requested review from TolyaTalamanov and mpashchenkov

June 7, 2021 22:29

dmatveev self-assigned this

Contributor Author

dmatveev commented Jun 7, 2021

@TolyaTalamanov @mpashchenkov please have a look

Contributor Author

dmatveev commented Jun 7, 2021

as @mpashchenkov is on vacation, kindly asking @rgarnov to review.

dmatveev requested a review from rgarnov

June 7, 2021 23:04

Contributor Author

dmatveev commented Jun 8, 2021

@TolyaTalamanov @rgarnov any comments here?

dmatveev force-pushed the dm/gframe_docs branch from 8011f9c to ba19a46 Compare

June 8, 2021 20:45

rgarnov reviewed

View reviewed changes

Contributor

rgarnov left a comment

Just a minor misprint catch from my side, and a small sample code clean-up suggestion

modules/gapi/samples/gaze_estimation.cpp Show resolved Hide resolved

modules/gapi/include/opencv2/gapi/gscalar.hpp Outdated Show resolved Hide resolved

modules/gapi/include/opencv2/gapi/garray.hpp Outdated Show resolved Hide resolved

modules/gapi/include/opencv2/gapi/garray.hpp Outdated Show resolved Hide resolved

modules/gapi/include/opencv2/gapi/gscalar.hpp Outdated Show resolved Hide resolved

TolyaTalamanov reviewed

View reviewed changes

modules/gapi/include/opencv2/gapi/garray.hpp Outdated

@@ @@ -340,21 +340,79 @@ namespace detail @@
               /** \addtogroup gapi_data_objects
                * @{
                */
+              /**
+               * @brief `cv::GArray<T>` template class represents an list of objects

Contributor

TolyaTalamanov Jun 11, 2021

an -> a

Contributor Author

dmatveev Jun 11, 2021

fixed, thanks

modules/gapi/include/opencv2/gapi/garray.hpp Outdated

+               * at the graph construction or compile time. Examples include: corner
+               * and feature detectors (`cv::GArray<cv::Point>`), object detection
+               * and tracking  results (`cv::GArray<cv::Rect>`). Programmers can use
+               * their own types in with `cv::GArray<T>` in the custom operations.

Contributor

TolyaTalamanov Jun 11, 2021

in with -> with

Contributor Author

dmatveev Jun 11, 2021

thanks

modules/gapi/include/opencv2/gapi/garray.hpp Outdated

+                   * other `cv::GArray<T>` to the object using `operator=` -- on the
+                   * assigment, the old association or value is discarded.
+                   *
+                   * @param v a std::vector<T> to assiciate with this

Contributor

TolyaTalamanov Jun 11, 2021

associate

Contributor Author

dmatveev Jun 11, 2021

Fixed

modules/gapi/include/opencv2/gapi/garray.hpp Outdated

+                   * @overload
+                   * @brief Constructs a value-initialized `cv::GArray<T>`
+                   *
+                   * @param v a std::vector<T> to assiciate with this

Contributor

TolyaTalamanov Jun 11, 2021

associate

Contributor Author

dmatveev Jun 11, 2021

Fixed!


          G-API: Documentation updates

415668e

1) Document GFrame/MediaFrame (and also other G-API types)
- Added doxygen comments for GMat, GScalar, GArray<T>, GOpaque classes;
- Documented GFrame and its host-side counterpart MediaFrame;
- Added some more notes to the data type classes.

2) Give @brief descriptions to most of the cv::gapi::* namespaces

3) Make some symbols private
- These structures are mainly internal and shouldn't be used directly

dmatveev force-pushed the dm/gframe_docs branch from ba19a46 to 415668e Compare

June 15, 2021 22:02

Contributor Author

dmatveev commented Jun 15, 2021

@rgarnov @TolyaTalamanov I've pushed the updates (had to do this earlier but could do it just now). Please, have a look

rgarnov approved these changes

View reviewed changes

alalek assigned rgarnov and unassigned dmatveev

opencv-pushbot merged commit b3db37b into opencv:master

Contributor Author

dmatveev commented Jun 21, 2021

Cool, thanks!

alalek mentioned this pull request

(5.x) Merge 4.x #20886

Merged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment