diff --git a/README.md b/README.md index 3d6c8fd..e66916f 100644 --- a/README.md +++ b/README.md @@ -97,6 +97,14 @@ try (Service python : env.python()) { // Wrap the NDArray to an Img. Img blurredImg = new ShmImg<>(blurred); +## Limitations + +The current maximum size of an image that can be backed by an `ShmImg` is `2^31 - 1` bytes, + +i.e. `ShmImg.copyOf( ArrayImgs.unsignedShorts( 1024, 1024, 1023 ) );` is possible, + +while `ShmImg.copyOf( ArrayImgs.unsignedShorts( 1024, 1024, 1024 ) );` leads to an Exception. + // Now do whatever you want with `blurredImg` as usual. // ... }