Skip to main content

fsleyes-plugin-mrs

An FSLeyes plugin for viewing the NIfTI-MRS format.

This plugin adds an additional MRS specific view panel to FSLeyes which displays spectra in the frequency domain. Higher dimensions of data stored in NIfTI-MRS format may be explored.

This plugin also loads and displays results from FSL-MRS's mrsi fitting routine fsl_mrsi. The plugin displays the spectral fit for each voxel and creates an interface for loading output metabolite maps easily.

Installation

Relies on FSLeyes (version >= 1.20.0). This package must be installed in the same environment as FSLeyes is run from.

Install using conda, pip, or by cloning this repository. For full installation instructions please see the documentation.

Conda

After activating the target environment run

conda install -c conda-forge fsleyes-plugin-mrs

PyPI

pip install fsleyes-plugin-mrs

Cloning from git

git clone https://git.fmrib.ox.ac.uk/wclarke/fsleyes-plugin-mrs
cd fsleyes-plugin-mrs
pip install .

Quick start guide

For full instructions please see the documentation.

NIfTI-MRS viewer

Start the dedicated MRSView by selecting MRSView in the View menu.

Once open the NIfTI-MRS dimension selector can be opened by clicking the icon.

Alternatively, a built-in MRS layout can be loaded from the View - Layouts menu, or the command line using:

fsleyes -smrs ...

for example with data

fsleyes -smrs t1.nii.gz svs.nii.gz

MRSI results viewer

A results folder generated by FSL-MRS's fsl_mrsi script can be loaded by using the Tools - Load FSL-MRS fit menu item.

The spectral fit, baseline, and residual is displayed in the MRSView. Metabolite maps and QC metrics can be loaded using the FSL-MRS Results panel added to the bottom of the orthographic view.

Acknowledgements and referencing

If you use this tool in your research please cite: TBC

Thanks to Paul McCarthy for his significant input into development of this plugin.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fsleyes_plugin_mrs-0.1.13.tar.gz (49.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fsleyes_plugin_mrs-0.1.13-py3-none-any.whl (115.2 kB view details)

Uploaded Python 3

File details

Details for the file fsleyes_plugin_mrs-0.1.13.tar.gz.

File metadata

  • Download URL: fsleyes_plugin_mrs-0.1.13.tar.gz
  • Upload date:
  • Size: 49.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.12.13

File hashes

Hashes for fsleyes_plugin_mrs-0.1.13.tar.gz
Algorithm Hash digest
SHA256 5671bb5eb1f51550fde95b902fc6707e6a0965ec31d2e3535701c7c8c704b676
MD5 936400a9c55f2f172a33c1369f77aa3d
BLAKE2b-256 697627836858c868839426fd764ae103a28d20d286644f1d0a96e4c3affb4ac2

See more details on using hashes here.

File details

Details for the file fsleyes_plugin_mrs-0.1.13-py3-none-any.whl.

File metadata

File hashes

Hashes for fsleyes_plugin_mrs-0.1.13-py3-none-any.whl
Algorithm Hash digest
SHA256 432d9fba75dbc3ccf89fb46523be42426d414a8996ec1a22b657dcaea4522800
MD5 26ee2ae5405a32f9deeb52a1d1ed0d61
BLAKE2b-256 7bd078d2adb62dc3e73558048c527867c8d74339c134a1d5df431bd3983ce517

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.1.13 This release

2 files

0.1.12

2 files

0.1.11

2 files

0.1.10

2 files

0.1.9

2 files

0.1.8

2 files

0.1.7

2 files

0.1.6

2 files

0.1.5.post1

2 files

0.1.5

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

0.0.8

2 files

0.0.7

2 files

0.0.6

2 files

0.0.5

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page