Skip to main content

a napari plug-in for biochemical annotation of mass spectrometry imaging data

Project description

MSI-Explorer

License BSD-3 PyPI Python Version tests codecov napari hub

User Manual

The MSI-Explorer napari plugin is a powerful tool designed for targeted biochemical annotations in MSI data. This user manual provides a comprehensive guide on how to install, use, and explore the functionalities of the plugin within the napari platform. It covers data import, visualization, mean intensity calculation, region of interest (ROI) analysis, annotation with selected databases and pre-processing such as noise reduction and normalization.

[MSI-Explorer]

Installation

Install napari by using this command.

 pip install "napari[all]"

You can install MSI-Explorer via pip:

 pip install MSI-Explorer

Usage

Start napari from the console with:

napari

Navigate to Plugins -> MSI-Explorer (MSI-Explorer) Plugin

1. Uploading and visualization of mass spectrometry imaging data

  • Select imzml file using Load imzML.
  • Metadata can be checked by View Metadata. Uploading MSI data_v1

Visualization of MSI data_v1

Upon uploading profile mode data, a pop-up appears prompting you to convert it to centroid mode. Selecting Yes converts the data, while No keeps it in its original profile format.

profile_centroid

2. Calculating mean (average) intensity

  • To calculate the mean spectrum, click on Show true mean spectrum.
  • Clicking Show image will create an image view of the currently plotted data
  • To export the plotted data as .csv file, click Export spectrum data.
  • To save the spectrum plot as image, click Export spectrum plot.

Calculating mean spectrum

Calculating mean spectrum_v1

2.1. Calculating mean (average) intensity of selected m/z value

To focus on a specific m/z value, zoom in on the spectrum plot. The figure will be as shown as below. Calculating mean spectrum specific mz_v1

It is recommended to use Multi panel view. The image can be displayed by Show image and the data can be exported as .csv file by using Export spectrum data.

3. Pre-processing

The pre-processing capabilities of MSI-Explorer enhance data quality and prepare MSI data for downstream analysis. Pre-processing steps involve:

(a) Noise reduction

Users can choose their desired level of noise reduction (shown as a percentage) for their experiment.

Noise reduction_v1

(b) Normalization

The normalization methods that the user can apply are

  • Total ion current (TIC)
  • Root mean square (RMS)
  • Medium
  • Reference peak (or internal standard)

normalization_v1

(c) Hotspot removal

Hotspot removal can also be applied using a default threshold of 99.99%. hotspot removal_v1

After pre-processing steps are chosen, click Execute and Show true mean spectrum to calculate the mean intensity.

The figure shows the spectrum and image of the TIC normalization with 3% noise reduction and hotspot removal for the 99.9% quantile. pre-processed_v1

4. Database

To use the database search, click on Select and a pop-up window will appear. There, select Metabolite_database_ver2, which is a built-in database, and click Confirm.

Database

The features of the database function are

  1. Charge (neutral, positive or negative)
  2. Adduct (based on the charge chosen)
  3. Range of the m/z value for the image display
  4. custom search with molecule name or m/z value

Database_search

Users can customize the database with exact mass, molecule name, or molecular formula. The format should be as shown in the table and the headers are not needed in the database.

Exact mass Molecule name Molecula formula
176.0950 Cotinine C10H12N2O
174.1117 Arginine C6H14N4O2
244.0881 Biotin C10H16N2O3S

5. Region of interest (ROI) selection

  • To select the ROI, click on Select ROI for mean spectrum. Adjust the brush size and label color. You can fill the area by using paint icon.
  • Then click on the Calculate ROI mean spectrum.
  • You can export as .csv file by using Export spectrum data.
  • If one m/z is needed, just zoom-in the spectrum plot window and export.
  • Before selecting the second ROI, remove the first selected area by using eraser or label 0.

ROI selection_v1

Contributing

Contributions are very welcome. Tests can be run with tox, please ensure the coverage at least stays the same before you submit a pull request.

License

Distributed under the terms of the BSD-3 license, "MSI-Explorer" is free and open source software

Issues

If you encounter any problems, please file an issue along with a detailed description.

Project details


Download files

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

Source Distribution

MSI-Explorer-1.0.1.tar.gz (940.2 kB view details)

Uploaded Source

Built Distribution

MSI_Explorer-1.0.1-py3-none-any.whl (937.1 kB view details)

Uploaded Python 3

File details

Details for the file MSI-Explorer-1.0.1.tar.gz.

File metadata

  • Download URL: MSI-Explorer-1.0.1.tar.gz
  • Upload date:
  • Size: 940.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for MSI-Explorer-1.0.1.tar.gz
Algorithm Hash digest
SHA256 3be879e291e9d9d6f254fac62304d818139db46ca2864d9bff6017265e453767
MD5 8f7ed1d5f96e2901329110e5c8e4c0d2
BLAKE2b-256 d9557475db3645f8f24421344f8d6224005ac202bccd78edc639dc2b1168133a

See more details on using hashes here.

File details

Details for the file MSI_Explorer-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: MSI_Explorer-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 937.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for MSI_Explorer-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 27339a6995f435c857f20d3a5eedca606feb2743ec4001a8a62c80a3ab8c14d9
MD5 8ce7fb279c6edfb3bf99a75117ace3fa
BLAKE2b-256 b55646e0c88119a63503f8c97bd2b87b82cd1583f2831fb37fb9d4103ef24d65

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page