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

Signal Processing

Core MRI/MRS fourier transforms, FID processing, and phase correction.

processing.fourier
processing.fid
processing.phasing
processing.referencingSpectral-axis referencing: conversion between relative [Hz] and absolute [ppm] axes.

Visualization

Publication-ready plotting and aesthetics.

Modeling & Fitting

Spectral NMR fitting based on pyAMARES.

fitting.simulation
fitting.prior_knowledgeBuild validated pyAMARES prior-knowledge tables from a friendly spec.
fitting.amares

Vendor Integrations

Digital filter group delay removal and vendor formats.

Core Objects & Utilities

Custom xarray accessors, configurations, and utilities.

core.accessorThe primary xarray accessor namespace for the xmris package.
core.configCore configuration and vocabulary definitions for xmris xarray objects.
core.optionsGlobal runtime options for xmris, mirroring :func:xarray.set_options.
core.utils
core.validationDecorator engine for runtime validation, domain contracts, and docstring generation.