Skip to content

Allow read-only h5 access, define IMTYPE_RGB, explicit error on too-large Waveforms #87

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
kspaceKelvin wants to merge 6 commits into
base: master
Choose a base branch
from
+12 −5
Open

Allow read-only h5 access, define IMTYPE_RGB, explicit error on too-large Waveforms #87

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8bf00db
Fix compatibility with xsdata 26.1
kspaceKelvin Jan 20, 2026
5d944c2
Add definition of IMTYPE_RGB
kspaceKelvin Jul 4, 2025
bdc0c8e
Add option to specify mode when opening h5 files to allow read-only a…
kspaceKelvin Jul 4, 2025
eeaa2a4
Raise exception if the number of samples exceeds the limit for Waveforms
kspaceKelvin Jul 4, 2025
bf8a7c9
Remove deprecated macOS 13 GitHub action
kspaceKelvin Jan 21, 2026
5fca37c
Merge branch 'master' into master
kspaceKelvin Jan 21, 2026
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
1 change: 1 addition & 0 deletions ismrmrd/constants.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@
IMTYPE_REAL = 3
IMTYPE_IMAG = 4
IMTYPE_COMPLEX = 5
IMTYPE_RGB = 6
Copy link
Contributor

@naegelejd naegelejd Jan 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see where this is defined in the C++ implementation?

What does RGB mean for each of the possible ISMRMRD image types? i.e. How is RGB decoded from a 32-bit complex float? How many bits for each RGB channel if the image is 32-bit vs 16-bit?

Copy link
Contributor

@naegelejd naegelejd Jan 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see this in the docs now (https://ismrmrd.readthedocs.io/en/latest/mrd_image_data.html#image-types).

But I still don't understand. How long has this been documented without actually being implemented in ISMRMRD or ismrmrd-python?


# Image flags
IMAGE_IS_NAVIGATION_DATA = 1
Expand Down
13 changes: 8 additions & 5 deletions ismrmrd/hdf5.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,12 +144,15 @@ def fileinfo(fname):


class Dataset(object):
def __init__(self, filename, dataset_name="dataset", create_if_needed=True):
def __init__(self, filename, dataset_name="dataset", create_if_needed=True, mode=None):
Copy link
Contributor

@naegelejd naegelejd Jan 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should document the valid arguments for mode: https://docs.h5py.org/en/stable/high/file.html#opening-creating-files

# Open the file
if create_if_needed:
self._file = h5py.File(filename, 'a')
else:
self._file = h5py.File(filename, 'r+')
if mode is None:
if create_if_needed:
mode = 'a'
else:
mode = 'r+'

self._file = h5py.File(filename, mode)

self._dataset_name = dataset_name

Expand Down
3 changes: 3 additions & 0 deletions ismrmrd/waveform.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,9 @@ def from_array(data, **kwargs):

channels, nsamples = data.shape

if nsamples > np.iinfo(np.uint16).max:
raise TypeError(f"Array has {nsamples} samples, which is greater than the maximum of {np.iinfo(np.uint16).max}")
Copy link
Contributor

@naegelejd naegelejd Jan 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a ValueError not a TypeError.


array_data = {
'version': 1,
'channels': channels,
Expand Down
Loading