Skip to content

Commit 9cb82c9

Browse files
committed
scijava-ops-opencv: update readme
Claiming to be code-free was misleading.
1 parent 5704a60 commit 9cb82c9

1 file changed

Lines changed: 20 additions & 5 deletions

File tree

scijava-ops-opencv/README.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,36 @@
11
# SciJava Ops OpenCV
22

3-
This module contains a code-free (YAML-based) wrapping of the
4-
[JavaCV](https://github.com/bytedeco/javacv) Java interface to
5-
[OpenCV](https://opencv.org/).
3+
This module contains a YAML-based wrapping of the
4+
[Bytedeco](https://github.com/bytedeco/javacv) Java interface to
5+
[OpenCV](https://opencv.org/), with minimal code to provide
6+
interoperability with ImgLib2 data structures.
67

7-
YAML generated using the `scijava-ops-ext-parser` component.
8+
YAML is generated from `opencv-ops.yaml` using the `scijava-ops-ext-parser`
9+
component.
10+
11+
## Usage
812

913
To use these Ops simply add a Maven dependency on:
1014

1115
```xml
1216
<dependency>
1317
<groupId>org.scijava</groupId>
1418
<artifactId>scijava-ops-opencv</artifactId>
19+
<scope>runtime</scope>
1520
</dependency>
1621
```
1722

1823
Ops can be accessed in one of two ways:
1924

2025
1. Classic OpenCV nomenclature, e.g. `cv.GaussianBlur`
21-
2. Ops-style nomenclature, e.g. `filter.gauss`
26+
2. Aligned with Ops-style namespaces, e.g. `filter.gauss`
27+
28+
## Caveats
29+
30+
ImageJ-OpenCV currently only supports [single-channel
31+
Mats](https://github.com/imagej/imagej-opencv/issues/2). Thus if you are using
32+
multi-channel images, we currently recommend:
33+
34+
* Calling the OpenCV Op as a `Computer` with pre-allocated output
35+
* Avoiding interuse of multi-channel `Mats` and `RandomAccessibleIntervals` (or
36+
their subclasses)

0 commit comments

Comments
 (0)