Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

Function reference

Configuration

Package-wide defaults, validated and overridable.

rcparamsPackage-wide defaults, in one validated mapping.

Data Model

Core classes representing a GE exam and its series.

GEExam.ExamBaseBase class for a GE exam, loading series metadata and providing series access.
GEExam.DMIExamExam containing anatomical, MRS, and MRSI series for a DMI acquisition.
GEExam.MS_DMIExamDMI exam for a multi-slice acquisition with a single MRSI and two MRS series.
GEExam.DMIinjExamDMI exam for an intravenous injection, splitting series into pre-/post-injection.
GESeries.NiiBaseWraps a NIfTI image with orientation-aware loading, display, and I/O helpers.
GESeries.MRISeriesA reconstructed MRI series, loaded as a NIfTI (found by its sidecar’s SeriesNumber).
GESeries.RawMRISeriesAn MRI series with the associated raw reconstructed .mat data loaded.
GESeries.MRSISeriesA raw MRSI series: spectroscopic imaging spectra, fitting, and voxel maps.
GESeries.MRSSeriesA single-voxel MRS series: FIDs, spectra, averaging, and fitting.
GESeries.MRSWashinSeriesAn MRS washin series: repeated spectra fitted and grouped over time.

Data Loading & File Handling

Loading raw/reconstructed data and general file helpers.

NIfTI & Imaging

DICOM/NIfTI conversion and image utilities.

utils.nifti
utils.partial_volumeFractional occupancy of a high-resolution mask on a coarse (MRSI) voxel grid.
utils.images

Plotting

Plotting for images and spectra.

plotting.images
plotting.spectra
utils.spectra
plotting.savingSaving matplotlib figures with per-context (poster/talk/paper) presets.

Fitting

Spectral fitting, wrapping xmris/pyAMARES.

MATLAB Bridge

MATLAB Engine setup and invocation.