35 | 
37 |
38 | Articles
36 |
39 |
47 | All vignettes
40 | 41 | 42 |- 1 - Installing ROpenCVLite 43 |
- 44 |
- 2 - Using ROpenCVLite 45 |
- 46 |
33 |
59 |
60 |
61 |
62 |
63 |
64 |
65 |
66 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # ROpenCVLite - Install OpenCV with R
34 |
48 |
49 |
50 | 
2 |
3 |
4 | [](https://github.com/swarm-lab/ROpenCVLite/actions/workflows/R-CMD-check.yaml)
5 | [](https://app.codecov.io/gh/swarm-lab/ROpenCVLite?branch=master)
6 | [](https://CRAN.R-project.org/package=ROpenCVLite)
7 | [](https://cran.r-project.org/package=ROpenCVLite)
8 |
9 |
10 |
11 | ## Description
12 |
13 | [`ROpenCVLite`](https://github.com/swarm-lab/ROpenCVLite) is a utility package
14 | that installs [`OpenCV`](https://opencv.org/) within [`R`](https://cran.r-project.org)
15 | for use by other packages. This package is not a wrapper around [`OpenCV`](https://opencv.org/)
16 | (it does not provide access to [`OpenCV`](https://opencv.org/) functions in R),
17 | not is it a computer vision package for [`R`](https://cran.r-project.org). All
18 | it does is compiling and installing [`OpenCV`](https://opencv.org/) within your
19 | [`R`](https://cran.r-project.org) installation so that other packages can easily
20 | find it and compile against it.
21 |
22 | ---
23 |
24 | ## Quick start guides
25 |
26 | 1. [Installing ROpenCVLite](https://swarm-lab.github.io/ROpenCVLite/articles/install.html)
27 | 2. [Using ROpenCVLite](https://swarm-lab.github.io/ROpenCVLite/articles/usage.html)
28 | 3. [Function documentation](https://swarm-lab.github.io/ROpenCVLite/reference/)
29 |
30 | ---
31 |
32 | ## FAQ
33 |
34 | ### What is OpenCV?
35 |
36 | [`OpenCV`](https://opencv.org/) is one of the most - if not the most - popular
37 | and efficient open-source computer vision library available today. If you want
38 | to develop fast video processing software or implement real time computer vision
39 | algorithms, you pretty much have to use [`OpenCV`](https://opencv.org/) nowadays.
40 |
41 | ### Why is [`ROpenCVLite`](https://github.com/swarm-lab/ROpenCVLite) necessary?
42 |
43 | There are no computer vision package available for [`R`](https://cran.r-project.org)
44 | currently. There are some very good image processing packages (see
45 | [imager](https://dahtah.github.io/imager/) for instance) but none of them can
46 | handle fast processing of large videos.
47 |
48 | The goal of [`ROpenCVLite`](https://github.com/swarm-lab/ROpenCVLite) is to
49 | promote the development of efficient computer vision packages for [`R`](https://cran.r-project.org)
50 | based on [`OpenCV`](https://opencv.org/). [`ROpenCVLite`](https://github.com/swarm-lab/ROpenCVLite)
51 | facilitates the installation of [`OpenCV`](https://opencv.org/) in a convenient
52 | location for other packages to find it and compile against it.
53 |
54 | ### Couldn't you just ship [`OpenCV`](https://opencv.org/)'s binaries with your package?
55 |
56 | Yes, but... it is fairly difficult to ship binary files compiled against
57 | [`OpenCV`](https://opencv.org/) that will work for sure on someone else's computer.
58 | It is not [`OpenCV`](https://opencv.org/)'s fault; it is because there are so many
59 | video formats and standards for peripherals out there that nobody can be certain
60 | what interfaces and libraries will be available on anyone's computer to grab
61 | images from videos and camera streams. The least worst solution for developers
62 | is therefore to make sure that there is a copy of [`OpenCV`](https://opencv.org/)
63 | on each user's computer that has been compiled taking into account the
64 | specificities of said computer.
65 |
66 | HOWEVER...
67 |
68 | [`OpenCV`](https://opencv.org/) is notoriously difficult to compile and install
69 | from scratch, especially for people without experience with low level languages.
70 | This is where [`ROpenCVLite`](https://github.com/swarm-lab/ROpenCVLite) come into
71 | play. This package tries as much as possible to cleanly compile [`OpenCV`](https://opencv.org/)
72 | and to install it in a standardized location that all [`R`](https://cran.r-project.org)
73 | package developers can easily find.
74 |
75 | ### Why "Lite"? Are you keeping something from us?
76 |
77 | [`ROpenCVLite`](https://github.com/swarm-lab/ROpenCVLite) compiles and installs
78 | the core modules of the [`OpenCV`](https://opencv.org/) library but does not
79 | compile or install its [contributed extra modules](https://github.com/opencv/opencv_contrib).
80 | This is to reduce the compilation time (which is already long enough) and also
81 | because most of these extra modules are (1) too specific for most applications of
82 | [`OpenCV`](https://opencv.org/), and (2) they do not always compile nicely.
83 |
84 | We will work toward providing a mechanism to install the extra modules, but this
85 | is not part of our immediate plans.
86 |
--------------------------------------------------------------------------------
/NEWS.md:
--------------------------------------------------------------------------------
1 | # ROpenCVLite 4.110.0
2 |
3 | ## New features
4 |
5 | * Upgrades package to OpenCV 4.11.0.
6 |
7 | ## Minor improvements and fixes
8 |
9 | * Fixes issue with CMake 4.
10 |
11 | ---
12 |
13 | # ROpenCVLite 4.90.2
14 |
15 | ## New features
16 |
17 | * N/A.
18 |
19 | ## Minor improvements and fixes
20 |
21 | * Removes pkgbuild dependency.
22 |
23 | ---
24 |
25 | # ROpenCVLite 4.90.1
26 |
27 | ## New features
28 |
29 | * Adds WeChat QR code module (thanks to @wresch).
30 | * Adds pkgconfig files (thanks to @wresch).
31 |
32 | ## Minor improvements and fixes
33 |
34 | * Remove some processor optimization to avoid errors on Windows with recent CPUs.
35 |
36 | ---
37 |
38 | # ROpenCVLite 4.90.0
39 |
40 | ## New features
41 |
42 | * Upgrade package to OpenCV 4.9.0.
43 | * Remove support for R < 4.0.0.
44 |
45 | ## Minor improvements and fixes
46 |
47 | * Add compilation flags required to avoid errors on Windows 11.
48 | * Overhaul of the installation functions for easier update management.
49 |
50 | ---
51 |
52 | # ROpenCVLite 4.80.1
53 |
54 | ## New features
55 |
56 | * N/A.
57 |
58 | ## Minor improvements and fixes
59 |
60 | * Add compilation flags required with latest Rtools on Windows.
61 |
62 | ---
63 |
64 | # ROpenCVLite 4.80.0
65 |
66 | ## New features
67 |
68 | * Upgrade package to OpenCV 4.8.0.
69 |
70 | ## Minor improvements and fixes
71 |
72 | * N/A.
73 |
74 | ---
75 |
76 | # ROpenCVLite 4.70.0
77 |
78 | ## New features
79 |
80 | * Upgrade package to OpenCV 4.7.0.
81 |
82 | ## Minor improvements and fixes
83 |
84 | * N/A.
85 |
86 | ---
87 |
88 | # ROpenCVLite 4.60.3
89 |
90 | ## New features
91 |
92 | * Adds ximgproc "extra" module.
93 |
94 | ## Minor improvements and fixes
95 |
96 | * N/A.
97 |
98 | ---
99 |
100 | # ROpenCVLite 4.60.2
101 |
102 | ## New features
103 |
104 | * Adds function to remove OpenCV.
105 |
106 | ## Minor improvements and fixes
107 |
108 | * Removes unnecessary messages during package installation.
109 |
110 | ---
111 |
112 | # ROpenCVLite 4.60.1
113 |
114 | ## New features
115 |
116 | * Upgrade package to OpenCV 4.6.0.
117 |
118 | ## Minor improvements and fixes
119 |
120 | * N/A.
121 |
122 | ---
123 |
124 | # ROpenCVLite 4.55.2
125 |
126 | ## New features
127 |
128 | * N/A.
129 |
130 | ## Minor improvements and fixes
131 |
132 | * Compatible with new RTools 4.2 toolchain.
133 |
134 | ---
135 |
136 | # ROpenCVLite 4.55.1
137 |
138 | ## New features
139 |
140 | * Add possibility to install OpenCV in custom directory.
141 | * Change default installation directory.
142 |
143 | ## Minor improvements and fixes
144 |
145 | * Fix documentation.
146 |
147 | ---
148 |
149 | # ROpenCVLite 4.55.0
150 |
151 | ## New features
152 |
153 | * Upgrade package to OpenCV 4.5.5.
154 |
155 | ## Minor improvements and fixes
156 |
157 | * N/A.
158 |
159 | ---
160 |
161 | # ROpenCVLite 4.52.1
162 |
163 | ## New features
164 |
165 | * N/A.
166 |
167 | ## Minor improvements and fixes
168 |
169 | * Fix installation bug on Windows after upgrade to latest pkgbuild version.
170 |
171 | ---
172 |
173 | # ROpenCVLite 4.52.0
174 |
175 | ## New features
176 |
177 | * Upgrade package to OpenCV 4.5.2
178 |
179 | ## Minor improvements and fixes
180 |
181 | * N/A.
182 |
183 | ---
184 |
185 | # ROpenCVLite 4.51.0
186 |
187 | ## New features
188 |
189 | * Upgrade package to OpenCV 4.5.1
190 | * OpenCV compiles with OpenCL support and other optimizations when possible.
191 |
192 | ## Minor improvements and fixes
193 |
194 | * N/A.
195 |
196 | ---
197 |
198 | # ROpenCVLite 4.50.0
199 |
200 | ## New features
201 |
202 | * Upgrade package to OpenCV 4.5.0
203 | * OpenCV compiles with OpenMP support when possible.
204 |
205 | ## Minor improvements and fixes
206 |
207 | * N/A.
208 |
209 | ---
210 |
211 | # ROpenCVLite 4.430.2
212 |
213 | ## New features
214 |
215 | N/A
216 |
217 | ## Minor improvements and fixes
218 |
219 | * Fix an issue with detecting when a new version of OpenCV is available.
220 |
221 | ---
222 |
223 | # ROpenCVLite 4.430.1
224 |
225 | ## New features
226 |
227 | N/A
228 |
229 | ## Minor improvements and fixes
230 |
231 | * Fix an issue with detecting Rtools with R 3.x on Windows.
232 |
233 | ---
234 |
235 | # ROpenCVLite 4.430.0
236 |
237 | ## New features
238 |
239 | * Package updated to use the latest OpenCV release (4.3.0).
240 | * Package updated to work with RTools 4.0 (Windows only).
241 |
242 | ## Minor improvements and fixes
243 |
244 | * A CMake check is now made during the package installation.
245 |
246 | ---
247 |
248 | # ROpenCVLite 3.412.1
249 |
250 | ## New features
251 |
252 | N/A
253 |
254 | ## Minor improvements and fixes
255 |
256 | * If an old installation exists, it is deleted before upgrading/reinstalling OpenCV.
257 |
258 | ---
259 |
260 | # ROpenCVLite 0.3.412
261 |
262 | ## New features
263 |
264 | * Package updated to use the latest OpenCV release (4.1.2).
265 |
266 | ## Minor improvements and fixes
267 |
268 | N/A
269 |
270 | ---
271 |
272 | # ROpenCVLite 0.3.410
273 |
274 | ## New features
275 |
276 | * Package ready for release to CRAN.
277 |
278 | ## Minor improvements and fixes
279 |
280 | N/A
--------------------------------------------------------------------------------
/docs/pkgdown.js:
--------------------------------------------------------------------------------
1 | /* http://gregfranko.com/blog/jquery-best-practices/ */
2 | (function($) {
3 | $(function() {
4 |
5 | $('nav.navbar').headroom();
6 |
7 | Toc.init({
8 | $nav: $("#toc"),
9 | $scope: $("main h2, main h3, main h4, main h5, main h6")
10 | });
11 |
12 | if ($('#toc').length) {
13 | $('body').scrollspy({
14 | target: '#toc',
15 | offset: $("nav.navbar").outerHeight() + 1
16 | });
17 | }
18 |
19 | // Activate popovers
20 | $('[data-bs-toggle="popover"]').popover({
21 | container: 'body',
22 | html: true,
23 | trigger: 'focus',
24 | placement: "top",
25 | sanitize: false,
26 | });
27 |
28 | $('[data-bs-toggle="tooltip"]').tooltip();
29 |
30 | /* Clipboard --------------------------*/
31 |
32 | function changeTooltipMessage(element, msg) {
33 | var tooltipOriginalTitle=element.getAttribute('data-bs-original-title');
34 | element.setAttribute('data-bs-original-title', msg);
35 | $(element).tooltip('show');
36 | element.setAttribute('data-bs-original-title', tooltipOriginalTitle);
37 | }
38 |
39 | if(ClipboardJS.isSupported()) {
40 | $(document).ready(function() {
41 | var copyButton = "";
42 |
43 | $("div.sourceCode").addClass("hasCopyButton");
44 |
45 | // Insert copy buttons:
46 | $(copyButton).prependTo(".hasCopyButton");
47 |
48 | // Initialize tooltips:
49 | $('.btn-copy-ex').tooltip({container: 'body'});
50 |
51 | // Initialize clipboard:
52 | var clipboard = new ClipboardJS('[data-clipboard-copy]', {
53 | text: function(trigger) {
54 | return trigger.parentNode.textContent.replace(/\n#>[^\n]*/g, "");
55 | }
56 | });
57 |
58 | clipboard.on('success', function(e) {
59 | changeTooltipMessage(e.trigger, 'Copied!');
60 | e.clearSelection();
61 | });
62 |
63 | clipboard.on('error', function(e) {
64 | changeTooltipMessage(e.trigger,'Press Ctrl+C or Command+C to copy');
65 | });
66 |
67 | });
68 | }
69 |
70 | /* Search marking --------------------------*/
71 | var url = new URL(window.location.href);
72 | var toMark = url.searchParams.get("q");
73 | var mark = new Mark("main#main");
74 | if (toMark) {
75 | mark.mark(toMark, {
76 | accuracy: {
77 | value: "complementary",
78 | limiters: [",", ".", ":", "/"],
79 | }
80 | });
81 | }
82 |
83 | /* Search --------------------------*/
84 | /* Adapted from https://github.com/rstudio/bookdown/blob/2d692ba4b61f1e466c92e78fd712b0ab08c11d31/inst/resources/bs4_book/bs4_book.js#L25 */
85 | // Initialise search index on focus
86 | var fuse;
87 | $("#search-input").focus(async function(e) {
88 | if (fuse) {
89 | return;
90 | }
91 |
92 | $(e.target).addClass("loading");
93 | var response = await fetch($("#search-input").data("search-index"));
94 | var data = await response.json();
95 |
96 | var options = {
97 | keys: ["what", "text", "code"],
98 | ignoreLocation: true,
99 | threshold: 0.1,
100 | includeMatches: true,
101 | includeScore: true,
102 | };
103 | fuse = new Fuse(data, options);
104 |
105 | $(e.target).removeClass("loading");
106 | });
107 |
108 | // Use algolia autocomplete
109 | var options = {
110 | autoselect: true,
111 | debug: true,
112 | hint: false,
113 | minLength: 2,
114 | };
115 | var q;
116 | async function searchFuse(query, callback) {
117 | await fuse;
118 |
119 | var items;
120 | if (!fuse) {
121 | items = [];
122 | } else {
123 | q = query;
124 | var results = fuse.search(query, { limit: 20 });
125 | items = results
126 | .filter((x) => x.score <= 0.75)
127 | .map((x) => x.item);
128 | if (items.length === 0) {
129 | items = [{dir:"Sorry 😿",previous_headings:"",title:"No results found.",what:"No results found.",path:window.location.href}];
130 | }
131 | }
132 | callback(items);
133 | }
134 | $("#search-input").autocomplete(options, [
135 | {
136 | name: "content",
137 | source: searchFuse,
138 | templates: {
139 | suggestion: (s) => {
140 | if (s.title == s.what) {
141 | return `${s.dir} > ${s.title}
`;
142 | } else if (s.previous_headings == "") {
143 | return `${s.dir} > ${s.title}
> ${s.what}`;
144 | } else {
145 | return `${s.dir} > ${s.title}
> ${s.previous_headings} > ${s.what}`;
146 | }
147 | },
148 | },
149 | },
150 | ]).on('autocomplete:selected', function(event, s) {
151 | window.location.href = s.path + "?q=" + q + "#" + s.id;
152 | });
153 | });
154 | })(window.jQuery || window.$)
155 |
156 | document.addEventListener('keydown', function(event) {
157 | // Check if the pressed key is '/'
158 | if (event.key === '/') {
159 | event.preventDefault(); // Prevent any default action associated with the '/' key
160 | document.getElementById('search-input').focus(); // Set focus to the search input
161 | }
162 | });
163 |
--------------------------------------------------------------------------------
/docs/404.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
60 |
82 |
83 |
84 |
85 |
86 |
87 |
88 |
89 |
--------------------------------------------------------------------------------
/docs/authors.html:
--------------------------------------------------------------------------------
1 |
2 |
61 |
70 |
71 |
72 |
81 |
62 | 
65 |
66 | Content not found. Please use links in the navbar.
67 |
68 | Page not found (404)
63 | 64 |
33 |
78 |
79 |
80 |
81 |
82 |
83 |
84 |
85 |
--------------------------------------------------------------------------------
/docs/reference/isCmakeInstalled.html:
--------------------------------------------------------------------------------
1 |
2 |
34 |
67 |
68 |
69 |
35 | 
37 |
38 | Authors and Citation
36 |
39 |
50 |
51 | Authors
40 | 41 |-
42 |
Simon Garnier. Author, maintainer. 43 |
44 |
45 | -
46 |
Muschelli John. Contributor. 47 |
48 |
49 |
52 |
64 |
65 | Citation
53 |Source: inst/CITATION
Simon Garnier and John Muschelli (2025). ROpenCVLite - Helper package for installing OpenCV with R. R package version 4.110.0.
56 |@Manual{,
57 | title = {{ROpenCVLite} - Helper package for installing OpenCV with R},
58 | author = {Simon Garnier and John Muschelli},
59 | year = {2025},
60 | note = {R package version 4.110.0},
61 | url = {https://swarm-lab.github.io/ROpenCVLite/},
62 | }
63 |
33 |
78 |
79 |
80 |
81 |
82 |
83 |
84 |
85 |
--------------------------------------------------------------------------------
/docs/reference/isOpenCVInstalled.html:
--------------------------------------------------------------------------------
1 |
2 |
34 |
39 |
40 |
67 |
68 |
69 |
41 |
43 |
44 |
48 |
49 |
53 | This function checks that Cmake is installed on the system.
42 |
54 |
57 |
58 |
65 | Author
55 |Simon Garnier, garnier@njit.edu
56 |
33 |
78 |
79 |
80 |
81 |
82 |
83 |
84 |
85 |
--------------------------------------------------------------------------------
/docs/reference/index.html:
--------------------------------------------------------------------------------
1 |
2 |
34 |
39 |
40 |
67 |
68 |
69 |
41 |
43 |
44 |
48 |
49 |
53 | This function checks that OpenCV is installed and accessible.
42 |
54 |
57 |
58 |
65 | Author
55 |Simon Garnier, garnier@njit.edu
56 |
33 |
116 |
117 |
118 |
119 |
120 |
121 |
122 |
123 |
--------------------------------------------------------------------------------
/docs/reference/ROpenCVLite-package.html:
--------------------------------------------------------------------------------
1 |
2 |
34 |
105 |
106 |
107 |
35 |
37 |
38 | Package index
36 |
45 |
46 |
47 |
48 |
49 |
104 | -
50 |
51 |
OpenCVPath()52 | 53 |
54 | - Install Location of OpenCV 55 |
-
56 |
57 |
ROpenCVLiteROpenCVLite-package58 | 59 |
60 | - ROpenCVLite: A package to install OpenCV within R 61 |
-
62 |
63 |
defaultOpenCVPath()64 | 65 |
66 | - Default Install Location of OpenCV 67 |
-
68 |
69 |
installOpenCV()70 | 71 |
72 | - Install OpenCV 73 |
-
74 |
75 |
isCmakeInstalled()76 | 77 |
78 | - Check Cmake Installation 79 |
-
80 |
81 |
isOpenCVInstalled()82 | 83 |
84 | - Check OpenCV Installation 85 |
-
86 |
87 |
opencvConfig()88 | 89 |
90 | - C/C++ configuration options 91 |
-
92 |
93 |
opencvVersion()94 | 95 |
96 | - OpenCV Version 97 |
-
98 |
99 |
removeOpenCV()100 | 101 |
102 | - Remove OpenCV 103 |
37 |
76 |
77 |
78 |
79 |
80 |
81 |
82 |
83 |
--------------------------------------------------------------------------------
/docs/reference/removeOpenCV.html:
--------------------------------------------------------------------------------
1 |
2 |
38 |
65 |
66 |
67 |
39 |
42 |
43 |
44 | ROpenCVLite: A package to install OpenCV within R
40 | Source:R/ROpenCVLite.R
41 | ROpenCVLite-package.Rd
45 |
49 |
50 |
51 | This is a utility package that installs OpenCV within R for use 46 | by other packages. This Lite version does not contain any of the contributed 47 | modules of OpenCV.
48 |
52 |
57 |
58 | See also
53 |Useful links:
- 54 |
- 55 |
Report bugs at https://github.com/swarm-lab/ROpenCVLite/issues
56 |
59 |
62 |
63 | Author
60 |Simon Garnier, garnier@njit.edu
61 |
33 |
79 |
80 |
81 |
82 |
83 |
84 |
85 |
86 |
--------------------------------------------------------------------------------
/docs/reference/OpenCVPath.html:
--------------------------------------------------------------------------------
1 |
2 |
34 |
39 |
40 |
68 |
69 |
70 |
41 |
43 |
44 |
48 |
49 |
53 | This function removes OpenCV from the system.
42 |
54 |
57 |
58 | Author
55 |Simon Garnier, garnier@njit.edu
56 |
59 |
65 |
66 | Examples
60 |if (FALSE) { # \dontrun{
61 | installOpenCV()
62 | } # }
63 |
64 |
33 |
79 |
80 |
81 |
82 |
83 |
84 |
85 |
86 |
--------------------------------------------------------------------------------
/docs/reference/opencvVersion.html:
--------------------------------------------------------------------------------
1 |
2 |
34 |
39 |
40 |
68 |
69 |
70 |
41 |
43 |
44 |
48 |
49 |
53 | This function returns the location at which OpenCV is installed.
42 |
54 |
57 |
58 |
66 | Author
55 |Simon Garnier, garnier@njit.edu
56 |
35 |
83 |
84 |
85 |
86 |
87 |
88 |
89 |
90 |
--------------------------------------------------------------------------------
/docs/reference/defaultOpenCVPath.html:
--------------------------------------------------------------------------------
1 |
2 |
36 |
41 |
42 |
72 |
73 |
74 |
43 |
46 |
47 |
51 |
52 |
56 | This function determines the version of OpenCV installed within 44 | R.
45 |
57 |
60 |
61 | Author
58 |Simon Garnier, garnier@njit.edu
59 |
62 |
69 |
70 | Examples
63 |if (isOpenCVInstalled()) {
64 | opencvVersion()
65 | }
66 | #> [1] "Version 4.11.0"
67 |
68 |
35 |
82 |
83 |
84 |
85 |
86 |
87 |
88 |
89 |
--------------------------------------------------------------------------------
/docs/articles/usage.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
36 |
41 |
42 |
71 |
72 |
73 |
43 |
46 |
47 |
51 |
52 |
56 | This function returns the location at which OpenCV should be 44 | installed by default.
45 |
57 |
60 |
61 |
69 | Author
58 |Simon Garnier, garnier@njit.edu
59 |
59 |
60 |
61 |
62 |
63 |
128 |
129 |
130 |
131 |
132 |
133 |
134 |
135 |
--------------------------------------------------------------------------------
/docs/reference/installOpenCV.html:
--------------------------------------------------------------------------------
1 |
2 |
64 |
84 |
115 |
116 |
117 |
118 |
127 |
65 |
72 |
73 |
74 |
75 |
76 | 2 - Using ROpenCVLite
66 |Simon 67 | Garnier
68 | 69 | 70 | Source:vignettes/usage.Rmd
71 | usage.RmdThe goal of ROpenCVLite
77 | is to enable developers to create their own packages for R based on OpenCV. Computer vision is
78 | just one of the possible applications for OpenCV. It can do many more
79 | things, such as fast matrix processing and GPU computing. By providing
80 | access to a standardized installation of OpenCV, we hope to help the
81 | R community take
82 | advantage of this fantastic library.
84 |
85 | Create a package using
87 |
112 | Create a package using ROpenCVLite
86 |
87 | Follow these steps to configure your package for ROpenCVLite:
-
89 |
- Set
ROpenCVLite90 | as a dependency in the DESCRIPTION file of your package.
91 | - Use the
opencvConfig92 | function provided withROpenCVLite93 | to: 94 |-
95 |
- set the
PKG_LIBSvalue of the Makevars and Makevars.win 96 | files of your package (usingopencvConfig("libs")).
97 | - set the
PKG_CPPFLAGS() value of the Makevars and 98 | Makevars.win files of your package (using 99 |opencvConfig("cflags")).
100 |
102 | - set the
You can find an example of how to set up your package with ROpenCVLite
104 | in our Rvision
105 | package:
-
107 |
- DESCRIPTION 108 |
- Makevars 109 |
- Makevars.win 110 |
35 |
99 |
100 |
101 |
102 |
103 |
104 |
105 |
106 |
--------------------------------------------------------------------------------
/vignettes/install.Rmd:
--------------------------------------------------------------------------------
1 | ---
2 | author: "Simon Garnier"
3 | title: "1 - Installing ROpenCVLite"
4 | output: rmarkdown::html_vignette
5 | vignette: >
6 | %\VignetteIndexEntry{1 - Installing ROpenCVLite}
7 | %\VignetteEngine{knitr::rmarkdown}
8 | %\VignetteEncoding{UTF-8}
9 | ---
10 |
11 | Installing [`ROpenCVLite`](https://github.com/swarm-lab/ROpenCVLite) should go
12 | smoothly on all major operating systems (Mac, Windows, and most major Linux
13 | distributions). There are a few steps to follow before installing the package
14 | itself in order to prepare all the necessary external (i.e. non-R) dependencies
15 | for [`OpenCV`](https://opencv.org/). You should also make sure that your R
16 | version is 4.0 or higher. Support for older versions of R has been removed.
17 |
18 | All installation steps are described below.
19 |
20 | ---
21 |
22 | + [1 - Before installing ](#before-installing )
23 | + [1.1 - Windows](#windows)
24 | + [1.2 - Mac](#mac)
25 | + [1.3 - Linux](#linux)
26 | + [1.4 - Mac, Linux and Windows](#mac-linux-and-windows)
27 | + [2 - Installing `ROpenCVLite`](#installing-ropencvlite)
28 |
29 | ---
30 |
31 | ## 1 - Before installing
32 |
33 | ### 1.1 - Windows
34 |
35 | Before installing `ROpenCVLite`, you will need to install
36 | [`Rtools`](https://cran.r-project.org/bin/windows/Rtools/) and
37 | [`CMake`](https://cmake.org/).
38 |
39 | #### 1.1.1 - Rtools
40 |
41 | You will need to install the version of `Rtools` that corresponds to your version
42 | of R. You can check your version of R by typing `R.version` in the R console.
43 |
44 | + If your R version starts with 4.0 or 4.1, you will need to install `Rtools40`.
45 | + If your R version starts with 4.2, you will need to install `Rtools42`.
46 | + If your R version starts with 4.3 or 4.4 (devel), you will need to install `Rtools43`.
47 |
48 | There are multiple ways to install `Rtools` on Windows:
49 |
50 | ##### **Option 1**
51 |
52 | Use the convenience function provided by the `installr` library:
53 |
54 | ```{r eval=FALSE}
55 | if (!require("installr"))
56 | install.packages("installr")
57 |
58 | installr::install.Rtools()
59 | ```
60 |
61 | *Note:* If you install `Rtools40`, make sure to tell the installer to add `Rtools`
62 | to your "PATH" during the installation process. This is not required anymore
63 | with `Rtools42` and `Rtools43`.
64 |
65 | ##### **Option 2**
66 |
67 | If you have the [`rig`](https://github.com/r-lib/rig) utility installed on your
68 | computer, you can install `Rtools` from a terminal running PowerShell:
69 |
70 | ```{bash eval=FALSE}
71 | # For Rtools40
72 | rig add rtools40
73 |
74 | # For Rtools42
75 | rig add rtools42
76 |
77 | # For Rtools43
78 | rig add rtools43
79 | ```
80 |
81 | ##### **Option 3**
82 |
83 | If you have the [`winget`](https://learn.microsoft.com/en-us/windows/package-manager/)
84 | utility installed on your computer, you can install `Rtools` from a terminal
85 | running PowerShell:
86 |
87 | ```{bash eval=FALSE}
88 | winget install RProject.Rtools
89 | ```
90 |
91 | *Note:* Only `Rtools42` seems to be available through `winget` at the moment.
92 |
93 | ##### **Option 4**
94 |
95 | You can manually download `Rtools` at
96 | [https://cran.r-project.org/bin/windows/Rtools/](https://cran.r-project.org/bin/windows/Rtools/).
97 |
98 | *Note:* If you install `Rtools40`, make sure to tell the installer to add `Rtools`
99 | to your "PATH" during the installation process. This is not required anymore
100 | with `Rtools42` and `Rtools43`.
101 |
102 | #### 1.1.1 - Cmake
103 |
104 | Installing `Cmake` is only required if your R version starts with 4.0 or 4.1 and,
105 | therefore, you have installed `Rtools40`. For newer versions of R, `Cmake` is
106 | included in `Rtools42` and `Rtools43` and you can skip this step.
107 |
108 | Any version of `Cmake` 3.24 or higher should work. There are multiple ways to
109 | install `Cmake` on Windows:
110 |
111 | ##### **Option 1**
112 |
113 | Use the convenience function provided by the `installr` library:
114 |
115 | ```{r eval=FALSE}
116 | if (!require("installr"))
117 | install.packages("installr")
118 |
119 | installr::install.CMake()
120 | ```
121 |
122 | During the installation process, make sure to tell the installer to add `CMake`
123 | to your "PATH".
124 |
125 | ##### **Option 2**
126 |
127 | If you have the [`winget`](https://learn.microsoft.com/en-us/windows/package-manager/)
128 | utility installed on your computer, you can install `Cmake` from a terminal
129 | running PowerShell:
130 |
131 | ```{bash eval=FALSE}
132 | winget install cmake
133 | ```
134 |
135 | ##### **Option 3**
136 |
137 | You can manually download the `CMake` installer for Windows at
138 | [https://cmake.org/download/](https://cmake.org/download/). Make sure to tell
139 | the installer to add `CMake` to your "PATH" during the installation process.
140 |
141 | ---
142 |
143 | ### 1.2 - Mac
144 |
145 | Before installing `ROpenCVLite`, you will need to install the latest version of
146 | [`CMake`](https://cmake.org/). There are multiple ways to install `Cmake` on Mac:
147 |
148 | ##### **Option 1**
149 |
150 | If you have [`homebrew`](https://brew.sh/) installed, run the following command
151 | in your terminal:
152 |
153 | ```bash
154 | brew install cmake
155 | ```
156 |
157 | ##### **Option 2**
158 |
159 | If you have [`MacPorts`](https://www.macports.org/) installed, run the following
160 | command in your terminal:
161 |
162 | ```bash
163 | sudo port install cmake
164 | ```
165 |
166 | ##### **Option 3**
167 |
168 | Go to [https://cmake.org/download/](https://cmake.org/download/). Scroll down
169 | until you reach the "Latest Release" section. Download the installer for Mac OS
170 | X (.dmg file). Once the download is complete, double-click on the installer and
171 | accept the license agreement. Drag and drop the `Cmake` app into your
172 | `Applications` folder.
173 |
174 | To make `Cmake` accessible to `R`, open a terminal and type:
175 |
176 | `sudo "/Applications/CMake.app/Contents/bin/cmake-gui" --install`
177 |
178 | It will ask for your administrator password.
179 |
180 | ---
181 |
182 | ### 1.3 - Linux
183 |
184 | Before installing `ROpenCVLite`, you will need to install the latest version of
185 | [`CMake`](https://cmake.org/). Hereafter are two options to do this on Linux.
186 |
187 | + **Option 1**
188 |
189 | Use your distribution's package management system. For instance on Ubuntu-like
190 | systems, you can install `Cmake` by typing the following command in your terminal:
191 |
192 | ```bash
193 | sudo apt install cmake
194 | ```
195 |
196 | Other distributions will have different package managers. Refer to the
197 | documentation of your distribution for finding the proper way to install `Cmake`
198 | on your system.
199 |
200 | + **Option 2**
201 |
202 | Download `CMake` for Linux at [https://cmake.org/download/](https://cmake.org/download/).
203 | However it is recommended that you install it using your distribution's package
204 | management system.
205 |
206 | ---
207 |
208 | ### 1.4 - Mac, Linux and Windows
209 |
210 | Before installing `ROpenCVLite`, you will need to install the `devtools` package
211 | in `R`.
212 |
213 | ```{r eval=FALSE}
214 | install.packages("devtools")
215 | ```
216 |
217 | ---
218 |
219 | ## 2 - Installing `ROpenCVLite`
220 |
221 | You can install `ROpenCVLite` from CRAN as follows:
222 |
223 | ```{r eval=FALSE}
224 | install.packages("ROpenCVLite")
225 | ```
226 |
227 | Or you can install the latest development version (not recommended) as follows:
228 |
229 | ```{r eval=FALSE}
230 | devtools::install_github("swarm-lab/ROpenCVLite")
231 | ```
232 |
233 | This will not install `OpenCV` yet. You will be asked whether you want to install
234 | it the first time you load the package.
235 |
236 | ```{r eval=FALSE}
237 | library(ROpenCVLite)
238 | ```
239 |
240 | This step can take some time. Go make yourself a cup of coffee or two while
241 | `ROpenCVLite` downloads, compiles and installs `OpenCV` on your system.
242 |
243 | In addition, you can also request the (re)installation of `OpenCV` at any time
244 | as follows:
245 |
246 | ```{r eval=FALSE}
247 | ROpenCVLite::installOpenCV()
248 | ```
249 |
250 | `ROpenCVLite` will also automatically detect when a new version of `OpenCV` is
251 | available and will offer to update it for you.
252 |
--------------------------------------------------------------------------------
/R/utils.R:
--------------------------------------------------------------------------------
1 | #' @title Install Location of OpenCV
2 | #'
3 | #' @description This function returns the location at which OpenCV is installed.
4 | #'
5 | #' @return A character string.
6 | #'
7 | #' @author Simon Garnier, \email{garnier@@njit.edu}
8 | #'
9 | #' @examples
10 | #' \dontrun{
11 | #' OpenCVPath()
12 | #' }
13 | #'
14 | #' @export
15 | OpenCVPath <- function() {
16 | pkgPath <- find.package("ROpenCVLite")
17 |
18 | if (file.exists(paste0(pkgPath, "/path"))) {
19 | path <- readLines(paste0(pkgPath, "/path"), 1)
20 | } else {
21 | path <- character()
22 | }
23 |
24 | if (length(path) == 0)
25 | path <- defaultOpenCVPath()
26 |
27 | if (dir.exists(paste0(path, "/include/"))) {
28 | path
29 | } else {
30 | stop("OpenCV is not installed on this system. Please use installOpenCV() to install it.")
31 | }
32 | }
33 |
34 |
35 | #' @title Check OpenCV Installation
36 | #'
37 | #' @description This function checks that OpenCV is installed and accessible.
38 | #'
39 | #' @return A boolean.
40 | #'
41 | #' @author Simon Garnier, \email{garnier@@njit.edu}
42 | #'
43 | #' @examples
44 | #' isOpenCVInstalled()
45 | #'
46 | #' @export
47 | isOpenCVInstalled <- function() {
48 | path <- try(OpenCVPath(), silent = TRUE)
49 |
50 | if (inherits(path, "try-error")) {
51 | FALSE
52 | } else {
53 | dir.exists(paste0(path, "/include/"))
54 | }
55 | }
56 |
57 |
58 | #' @title Check Cmake Installation
59 | #'
60 | #' @description This function checks that Cmake is installed on the system.
61 | #'
62 | #' @return A boolean.
63 | #'
64 | #' @author Simon Garnier, \email{garnier@@njit.edu}
65 | #'
66 | #' @examples
67 | #' isCmakeInstalled()
68 | #'
69 | #' @export
70 | isCmakeInstalled <- function() {
71 | cmake <- system("cmake --version", ignore.stdout = TRUE) == 0
72 |
73 | if (cmake) {
74 | cmake
75 | } else {
76 | cat("------------------ CMAKE NOT FOUND --------------------\n")
77 | cat("\n")
78 | cat("CMake was not found on the PATH. Please install CMake:\n")
79 | cat("\n")
80 | cat(" - installr::install.cmake() (Windows; inside the R console)\n")
81 | cat(" - yum install cmake (Fedora/CentOS; inside a terminal)\n")
82 | cat(" - apt install cmake (Debian/Ubuntu; inside a terminal)\n")
83 | cat(" - brew install cmake (MacOS; inside a terminal with Homebrew)\n")
84 | cat(" - port install cmake (MacOS; inside a terminal with MacPorts)\n")
85 | cat("\n")
86 | cat("Alternatively install CMake from:
36 |
41 |
42 |
88 |
89 |
90 |
43 |
46 |
47 | This function attempts to download, compile and install OpenCV 44 | on the system. This process will take several minutes.
45 |
48 |
50 |
51 |
52 | Usage
49 |installOpenCV(install_path = defaultOpenCVPath(), batch = FALSE)
53 |
69 |
73 | Arguments
54 | 55 | 56 |- install_path 57 |
A character string indicating the location at which 58 | OpenCV should be installed. By default, it is the value returned by 59 |
defaultOpenCVPath.
60 |
61 |
62 | - batch 63 |
A boolean indicating whether to skip (
TRUE) or not 64 | (FALSE, the default) the interactive installation dialog. This is 65 | useful when OpenCV needs to be installed in a non-interactive environment 66 | (e.g., during a batch installation on a server).
67 |
68 |
74 |
77 |
78 |
86 | Author
75 |Simon Garnier, garnier@njit.edu
76 |2 - Using ROpenCVLite
240 |Simon Garnier
241 | 242 | 243 | 244 |The goal of ROpenCVLite
245 | is to enable developers to create their own packages for R based on OpenCV. Computer vision is
246 | just one of the possible applications for OpenCV. It can do many more
247 | things, such as fast matrix processing and GPU computing. By providing
248 | access to a standardized installation of OpenCV, we hope to help the
249 | R community take
250 | advantage of this fantastic library.
252 |
253 | Create a package using
254 |
278 |
279 |
280 |
281 |
282 |
283 |
284 |
285 |
293 |
294 |
295 |
296 |
--------------------------------------------------------------------------------
/docs/reference/opencvConfig.html:
--------------------------------------------------------------------------------
1 |
2 | Create a package using ROpenCVLite
254 | Follow these steps to configure your package for ROpenCVLite:
-
256 |
- Set
ROpenCVLite257 | as a dependency in the DESCRIPTION file of your package.
258 | - Use the
opencvConfig259 | function provided withROpenCVLite260 | to: 261 |-
262 |
- set the
PKG_LIBSvalue of the Makevars and Makevars.win 263 | files of your package (usingopencvConfig("libs")).
264 | - set the
PKG_CPPFLAGS() value of the Makevars and 265 | Makevars.win files of your package (using 266 |opencvConfig("cflags")).
267 |
268 | - set the
You can find an example of how to set up your package with ROpenCVLite
270 | in our Rvision
271 | package:
-
273 |
- DESCRIPTION 274 |
- Makevars 275 |
- Makevars.win 276 |
35 |
101 |
102 |
103 |
104 |
105 |
106 |
107 |
108 |
--------------------------------------------------------------------------------
/R/install.R:
--------------------------------------------------------------------------------
1 | #' @title Default Install Location of OpenCV
2 | #'
3 | #' @description This function returns the location at which OpenCV should be
4 | #' installed by default.
5 | #'
6 | #' @return A character string.
7 | #'
8 | #' @author Simon Garnier, \email{garnier@@njit.edu}
9 | #'
10 | #' @examples
11 | #' \dontrun{
12 | #' defaultOpenCVPath()
13 | #' }
14 | #'
15 | #' @export
16 | defaultOpenCVPath <- function() {
17 | pkgPath <- find.package("ROpenCVLite")
18 | paste0(gsub("ROpenCVLite", "", pkgPath), "ROpenCV")
19 | }
20 |
21 |
22 | .configure <- function(install_path = defaultOpenCVPath(), version) {
23 | config <- list()
24 |
25 | config$arch <- unname(Sys.info()["machine"])
26 | if (!grepl("64", config$arch)) {
27 | stop("Unsupported CPU architecture.")
28 | }
29 |
30 | config$os_type <- .Platform$OS.type
31 |
32 | if (config$os_type == "windows") {
33 | config$install_path <- utils::shortPathName(install_path)
34 | config$pkg_path <- utils::shortPathName(find.package("ROpenCVLite"))
35 | config$os <- gsub("\r", "", gsub("Caption=", "", system("wmic os get Caption,CSDVersion /value", intern = TRUE)[3]))
36 | config$core <- paste0("https://github.com/opencv/opencv/archive/", version, ".tar.gz")
37 | config$contrib <- paste0("https://github.com/opencv/opencv_contrib/archive/", version, ".tar.gz")
38 | rtools <- .findRtools()
39 | config$rtools_path <- rtools$path
40 | config$rtools_version <- rtools$version
41 |
42 | if (config$rtools_version < "4.2") {
43 | config$cmake_path <- utils::shortPathName(system("where cmake.exe", intern = TRUE))
44 |
45 | if (length(config$cmake_path) > 1) {
46 | v <- sapply(config$cmake_path, function(cmake) gsub("cmake version ", "", system(paste0(cmake, " --version"), intern = TRUE)[1]))
47 | config$cmake_path <- config$cmake_path[which(v == max(v))]
48 | }
49 |
50 | config$gcc_path <- paste0(config$rtools_path, "\\mingw64\\bin\\gcc.exe")
51 | config$gpp_path <- paste0(config$rtools_path, "\\mingw64\\bin\\g++.exe")
52 | config$windres_path <- paste0(config$rtools_path, "\\mingw64\\bin\\windres.exe")
53 | config$make_path <- paste0(config$rtools_path, "\\usr\\bin\\make.exe")
54 | } else {
55 | config$cmake_path <- paste0(config$rtools_path, "\\x86_64-w64-mingw32.static.posix\\bin\\cmake.exe")
56 | config$gcc_path <- paste0(config$rtools_path, "\\x86_64-w64-mingw32.static.posix\\bin\\gcc.exe")
57 | config$gpp_path <- paste0(config$rtools_path, "\\x86_64-w64-mingw32.static.posix\\bin\\g++.exe")
58 | config$windres_path <- paste0(config$rtools_path, "\\x86_64-w64-mingw32.static.posix\\bin\\windres.exe")
59 | config$make_path <- paste0(config$rtools_path, "\\usr\\bin\\make.exe")
60 | }
61 |
62 | config$tmp_dir <- base::tempdir()
63 | config$source_dir <- paste0(config$tmp_dir, "\\opencv-", version, "\\")
64 | config$contrib_dir <- paste0(config$tmp_dir, "\\opencv_contrib-", version, "\\modules")
65 | config$build_dir <- paste0(config$source_dir, "build")
66 |
67 | ix <- grepl("path", names(config)) | grepl("dir", names(config))
68 | config[ix] <- lapply(config[ix], function(st) gsub("\\\\", "/", utils::shortPathName(st)))
69 | } else if (config$os_type == "unix") {
70 | config$install_path <- install_path
71 | config$pkg_path <- find.package("ROpenCVLite")
72 | config$os <- unname(Sys.info()["sysname"])
73 | config$core <- paste0("https://github.com/opencv/opencv/archive/", version, ".zip")
74 | config$contrib <- paste0("https://github.com/opencv/opencv_contrib/archive/", version, ".zip")
75 | config$cmake_path <- system("which cmake", intern = TRUE)
76 | config$gcc_path <- system("which gcc", intern = TRUE)
77 | config$gpp_path <- system("which g++", intern = TRUE)
78 | config$make_path <- system("which make", intern = TRUE)
79 | config$tmp_dir <- base::tempdir()
80 | config$source_dir <- paste0(config$tmp_dir, "/opencv-", version, "/")
81 | config$contrib_dir <- paste0(config$tmp_dir, "/opencv_contrib-", version, "/modules")
82 | config$build_dir <- paste0(config$source_dir, "build")
83 |
84 | ix <- grepl("path", names(config)) | grepl("dir", names(config))
85 | config[ix] <- lapply(config[ix], normalizePath, mustWork = FALSE, winslash = "/")
86 | } else {
87 | stop("Unsupported OS type.")
88 | }
89 |
90 | config
91 | }
92 |
93 |
94 | .cmake <- function(config) {
95 | paste0(
96 | '"', config$cmake_path, '"',
97 | ' -G "Unix Makefiles"',
98 | " -Wno-dev",
99 | ' -DCMAKE_C_COMPILER="', config$gcc_path, '"',
100 | ' -DCMAKE_CXX_COMPILER="', config$gpp_path, '"',
101 | switch(config$os_type,
102 | windows = paste0(
103 | ' -DCMAKE_RC_COMPILER="', config$windres_path, '"',
104 | " -DOpenCV_ARCH=x64",
105 | " -DOpenCV_RUNTIME=mingw",
106 | " -DBUILD_SHARED_LIBS=ON",
107 | " -DCPU_DISPATCH=SSE4_1,SSE4_2,FP16,AV"
108 | )
109 | ),
110 | ' -DCMAKE_MAKE_PROGRAM="', config$make_path, '"',
111 | " -DCMAKE_CXX_STANDARD=11",
112 | " -DENABLE_PRECOMPILED_HEADERS=OFF",
113 | " -DOPENCV_EXTRA_MODULES_PATH=", config$contrib_dir,
114 | " -DBUILD_LIST=calib3d,core,dnn,features2d,flann,gapi,highgui,imgcodecs,imgproc,ml,objdetect,photo,stitching,video,videoio,ximgproc,wechat_qrcode",
115 | " -DOPENCV_GENERATE_PKGCONFIG=ON",
116 | " -DWITH_OPENMP=ON",
117 | " -DWITH_TBB=ON",
118 | " -DWITH_EIGEN=ON",
119 | " -DWITH_LAPACK=ON",
120 | " -DBUILD_opencv_world=OFF",
121 | " -DBUILD_opencv_contrib_world=OFF",
122 | " -DBUILD_PERF_TESTS=OFF",
123 | " -DBUILD_TESTS=OFF",
124 | ' -DCMAKE_C_FLAGS_RELEASE="-fstack-protector-strong"',
125 | ' -DCMAKE_CXX_FLAGS_RELEASE="-fstack-protector-strong"',
126 | " -DINSTALL_CREATE_DISTRIB=ON",
127 | " -DCMAKE_BUILD_TYPE=RELEASE",
128 | ' -DCMAKE_INSTALL_PREFIX="', config$install_path, '"',
129 | ' -B"', config$build_dir, '"',
130 | ' -H"', config$source_dir, '"'
131 | )
132 | }
133 |
134 |
135 | #' @title Install OpenCV
136 | #'
137 | #' @description This function attempts to download, compile and install OpenCV
138 | #' on the system. This process will take several minutes.
139 | #'
140 | #' @param install_path A character string indicating the location at which
141 | #' OpenCV should be installed. By default, it is the value returned by
142 | #' \code{\link{defaultOpenCVPath}}.
143 | #'
144 | #' @param batch A boolean indicating whether to skip (\code{TRUE}) or not
145 | #' (\code{FALSE}, the default) the interactive installation dialog. This is
146 | #' useful when OpenCV needs to be installed in a non-interactive environment
147 | #' (e.g., during a batch installation on a server).
148 | #'
149 | #' @return A boolean.
150 | #'
151 | #' @author Simon Garnier, \email{garnier@@njit.edu}
152 | #'
153 | #' @examples
154 | #' \dontrun{
155 | #' installOpenCV()
156 | #' }
157 | #'
158 | #' @export
159 | installOpenCV <- function(install_path = defaultOpenCVPath(), batch = FALSE) {
160 | install <- 0
161 | pkg_version <- "4.11.0"
162 |
163 | if (interactive()) {
164 | if (isOpenCVInstalled()) {
165 | cv_version <- gsub("Version ", "", opencvVersion())
166 |
167 | if (pkg_version == cv_version) {
168 | install <- utils::menu(
169 | c("yes", "no"),
170 | title = "OpenCV is already installed on this system. Would you like to reinstall it now? This will take several minutes."
171 | )
172 | } else {
173 | install <- utils::menu(
174 | c("yes", "no"),
175 | title = "A new version of OpenCV is available. Would you like to install it now? This will take several minutes."
176 | )
177 | }
178 | } else {
179 | install <- utils::menu(
180 | c("yes", "no"),
181 | title = "OpenCV is not installed on this system. Would you like to install it now? This will take several minutes."
182 | )
183 | }
184 | } else {
185 | if (batch) {
186 | packageStartupMessage("OpenCV being installed in non-interactive mode!")
187 | install <- 1
188 | } else {
189 | packageStartupMessage("OpenCV can only be installed in interactive mode. To override this in a non-interactive context, use installOpenCV(batch = TRUE).")
190 | }
191 | }
192 |
193 | if (!isCmakeInstalled()) {
194 | install <- 0
195 | }
196 |
197 | if (install == 1) {
198 | config <- .configure(normalizePath(install_path, mustWork = FALSE), pkg_version)
199 | message(paste0("OpenCV will be installed in ", config$install_path))
200 | old <- try(OpenCVPath(), silent = TRUE)
201 |
202 | if (dir.exists(config$install_path)) {
203 | message("Clearing install path.")
204 | unlink(config$install_path, recursive = TRUE)
205 | }
206 |
207 | if (inherits(config$install_path, "try-error")) {
208 | if (dir.exists(old)) {
209 | message("Removing old OpenCV installation.")
210 | unlink(old, recursive = TRUE)
211 | }
212 | }
213 |
214 | dir.create(config$install_path, showWarnings = FALSE)
215 | dir.create(config$tmp_dir, showWarnings = FALSE)
216 |
217 | if (config$os_type == "windows") {
218 | utils::download.file(config$core, paste0(config$tmp_dir, "/opencv.tar.gz"))
219 | utils::untar(paste0(config$tmp_dir, "/opencv.tar.gz"), exdir = config$tmp_dir)
220 | utils::download.file(config$contrib, paste0(config$tmp_dir, "/opencv_contrib.tar.gz"))
221 | utils::untar(paste0(config$tmp_dir, "/opencv_contrib.tar.gz"), exdir = config$tmp_dir)
222 | } else {
223 | utils::download.file(config$core, paste0(config$tmp_dir, "/opencv.zip"))
224 | utils::unzip(paste0(config$tmp_dir, "/opencv.zip"), exdir = config$tmp_dir)
225 | utils::download.file(config$contrib, paste0(config$tmp_dir, "/opencv_contrib.zip"))
226 | utils::unzip(paste0(config$tmp_dir, "/opencv_contrib.zip"), exdir = config$tmp_dir)
227 |
228 | tmp <- readLines(paste0(config$source_dir, "cmake/OpenCVModule.cmake"))
229 | ix <- which(grepl("# adds dependencies to OpenCV module", tmp)) - 1
230 | insert <- c(
231 | '# set CMAKE_INSTALL_NAME_DIR if CMAKE_INSTALL_PREFIX isn\'t default value of "/usr/local"',
232 | 'if(UNIX AND NOT ${CMAKE_INSTALL_PREFIX} STREQUAL "/usr/local")',
233 | " set(CMAKE_INSTALL_NAME_DIR ${CMAKE_INSTALL_PREFIX}/lib)",
234 | '# message ("setting CMAKE_INSTALL_NAME_DIR: ${CMAKE_INSTALL_NAME_DIR}")',
235 | "endif()",
236 | ""
237 | )
238 | writeLines(
239 | c(tmp[1:ix], insert, tmp[(ix + 1):length(tmp)]),
240 | paste0(config$source_dir, "cmake/OpenCVModule.cmake")
241 | )
242 | }
243 |
244 | # To be removed once the CMake 4 issue is resolved in the next OpenCV release
245 | tmp <- readLines(paste0(config$source_dir, "cmake/OpenCVGenPkgconfig.cmake"))
246 | ix <- which(grepl("cmake_minimum_required", tmp))
247 | insert <- "cmake_minimum_required(VERSION 3.5)"
248 | writeLines(
249 | c(tmp[1:(ix - 1)], insert, tmp[(ix + 1):length(tmp)]),
250 | paste0(config$source_dir, "cmake/OpenCVGenPkgconfig.cmake")
251 | )
252 |
253 | dir.create(config$build_dir, showWarnings = FALSE)
254 | system(.cmake(config))
255 | system(paste0(config$make_path, " -j", parallel::detectCores(), " -C ", config$build_dir))
256 | system(paste0(config$make_path, " -C", config$build_dir, " install"))
257 | writeLines(config$install_path, con = paste0(config$pkg_path, "/path"))
258 | } else {
259 | packageStartupMessage("OpenCV was not installed at this time. You can install it at any time by using the installOpenCV() function.")
260 | }
261 |
262 | isOpenCVInstalled()
263 | }
264 |
265 |
266 | #' @title Remove OpenCV
267 | #'
268 | #' @description This function removes OpenCV from the system.
269 | #'
270 | #' @return A boolean.
271 | #'
272 | #' @author Simon Garnier, \email{garnier@@njit.edu}
273 | #'
274 | #' @examples
275 | #' \dontrun{
276 | #' installOpenCV()
277 | #' }
278 | #'
279 | #' @export
280 | removeOpenCV <- function() {
281 | if (isOpenCVInstalled()) {
282 | uninstall <- utils::menu(
283 | c("yes", "no"),
284 | title = "Would you like to completely remove OpenCV from your R installation? You can reinstall it at any time by using the installOpenCV() function."
285 | )
286 | print(uninstall)
287 |
288 | if (uninstall == 1) {
289 | unlink(OpenCVPath(), recursive = TRUE)
290 | !isOpenCVInstalled()
291 | } else {
292 | !isOpenCVInstalled()
293 | }
294 | } else {
295 | message("OpenCV is not installed on this system. Nothing to be done.")
296 | !isOpenCVInstalled()
297 | }
298 | }
299 |
--------------------------------------------------------------------------------
/docs/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
36 |
41 |
42 |
90 |
91 |
92 |
43 |
46 |
47 |
51 |
52 |
66 | This function returns the configuration options for compiling
44 | C/C++-based packages against OpenCV installed by ROpenCVLite.
67 |
71 | Value
68 |A concatenated character string (with cat) of the
69 | configuration options.
72 |
75 |
76 | Author
73 |Simon Garnier, garnier@njit.edu
74 |
77 |
87 |
88 | Examples
78 |if (FALSE) { # \dontrun{
79 | if (isOpenCVInstalled()) {
80 | opencvConfig()
81 | opencvConfig(output = "cflags")
82 | opencvConfig(arch = R.version$arch)
83 | }
84 | } # }
85 |
86 |
62 |
173 |
174 |
175 |
176 |
177 |
178 |
179 |
180 |
--------------------------------------------------------------------------------
63 |
161 |
162 |
163 |
172 |
64 |
68 |
69 |
70 |
71 |
116 |
72 |
76 |
77 | Description 73 |
74 |ROpenCVLite is a utility package that installs OpenCV within R for use by other packages. This package is not a wrapper around OpenCV (it does not provide access to OpenCV functions in R), not is it a computer vision package for R. All it does is compiling and installing OpenCV within your R installation so that other packages can easily find it and compile against it.
76 |
78 |
86 |
87 | Quick start guides 79 |
80 |-
81 |
- Installing ROpenCVLite 82 |
- Using ROpenCVLite 83 |
- Function documentation 84 |
86 |
88 |
115 | FAQ 89 |
90 |
91 |
95 | What is OpenCV? 92 |
93 |OpenCV is one of the most - if not the most - popular and efficient open-source computer vision library available today. If you want to develop fast video processing software or implement real time computer vision algorithms, you pretty much have to use OpenCV nowadays.
96 | Why is
98 |
101 | Why is ROpenCVLite necessary?
97 |
98 | There are no computer vision package available for R currently. There are some very good image processing packages (see imager for instance) but none of them can handle fast processing of large videos.
The goal of ROpenCVLite is to promote the development of efficient computer vision packages for R based on OpenCV. ROpenCVLite facilitates the installation of OpenCV in a convenient location for other packages to find it and compile against it.
102 | Couldn’t you just ship
104 |
108 | Couldn’t you just ship OpenCV’s binaries with your package?
103 |
104 | Yes, but… it is fairly difficult to ship binary files compiled against OpenCV that will work for sure on someone else’s computer. It is not OpenCV’s fault; it is because there are so many video formats and standards for peripherals out there that nobody can be certain what interfaces and libraries will be available on anyone’s computer to grab images from videos and camera streams. The least worst solution for developers is therefore to make sure that there is a copy of OpenCV on each user’s computer that has been compiled taking into account the specificities of said computer.
HOWEVER…
106 |OpenCV is notoriously difficult to compile and install from scratch, especially for people without experience with low level languages. This is where ROpenCVLite come into play. This package tries as much as possible to cleanly compile OpenCV and to install it in a standardized location that all R package developers can easily find.
109 |
114 | Why “Lite”? Are you keeping something from us? 110 |
111 |ROpenCVLite compiles and installs the core modules of the OpenCV library but does not compile or install its contributed extra modules. This is to reduce the compilation time (which is already long enough) and also because most of these extra modules are (1) too specific for most applications of OpenCV, and (2) they do not always compile nicely.
We will work toward providing a mechanism to install the extra modules, but this is not part of our immediate plans.
113 |