Skip to content

Add limitations section to README.md #3

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add limitations section to README.md #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,14 @@ try (Service python : env.python()) {
// Wrap the NDArray to an Img.
Img<FloatType> 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.
// ...
}
Expand Down