Skip to main content

Improved structural similarity metrics for comparing microscopy data.

Project description

MicroSSIM

License PyPI Python Version CI codecov

MicroSSIM is an image measure aimed at addressing the shortcomings of the Structural Similarity Index Measure (SSIM), in particular in the context of microscopy images. Indeed, in microscopy, degraded images (e.g. lower signal to noise ratio) often have a different dynamic range than the original images. This can lead to a poor performance of SSIM.

The measure normalizes the images using background subtraction and a more appropriate range estimation. It then estimates a scaling factor used to scale the image to the target (original image or ground truth). The metric is then computed similarly to the SSIM.

MicroSSIM is easily extensible to other SSIM-like measures, such as Multi-Scale SSIM (MS-SSIM), for which we provide an example.

See the paper for more details.

Installation

pip install microssim

Usage

import numpy as np
from microssim import MicroSSIM, micro_structural_similarity
from skimage.metrics import structural_similarity

rng = np.random.default_rng(42)
N = 5
gt = 200 + rng.integers(0, 65535, (N, 256, 256)) # stack of different images
pred = rng.poisson(gt) / 10

# using the convenience function
result = micro_structural_similarity(gt, pred)
print(f"MicroSSIM: {result} (convenience function)")

# using the class allows fitting a large dataset, then scoring a subset
microssim = MicroSSIM()
microssim.fit(gt, pred) # fit the parameters

for i in range(N):
    score = microssim.score(gt[i], pred[i]) # score a single pair
    print(f"MicroSSIM ({i}): {score}")

# compare with SSIM from skimage
for i in range(N):
    score = structural_similarity(gt[i], pred[i], data_range=65535)
    print(f"SSIM ({i}): {score}")

The code is similar for MicroMS3IM.

Tips for deep learning

MicroSSIM was developed in the context of deep-learning, in which SSIM is often used as a measure to compare denoised and ground-truth images. The tips presented here are valid beyond deep-learning.

The larger the dataset, the better the estimate of the scaling factor will be. Therefore, it is recommended to fit the measure on the entire dataset (e.g. the whole training dataset). Once the data fitted, the MSSIM class has registered the parameters used for normalization and scaling. You can then score a subset of the data (e.g. the validation or test datasets) using the score method.

Cite us

If you use MicroSSIM in your research, please cite us:

Ashesh, Ashesh, Joran Deschamps, and Florian Jug. "MicroSSIM: Improved Structural Similarity for Comparing Microscopy Data." arXiv preprint arXiv:2408.08747 (2024). link.

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

microssim-0.0.4.tar.gz (5.4 MB view details)

Uploaded Source

Built Distribution

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

microssim-0.0.4-py3-none-any.whl (21.0 kB view details)

Uploaded Python 3

File details

Details for the file microssim-0.0.4.tar.gz.

File metadata

  • Download URL: microssim-0.0.4.tar.gz
  • Upload date:
  • Size: 5.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for microssim-0.0.4.tar.gz
Algorithm Hash digest
SHA256 460e1d9fa42ce3c8dd105b6450aa2f2a7a20a1e53ec24443b32bc5d73244ecdf
MD5 3551ae24d835c1109843b882180cee7d
BLAKE2b-256 7e0f81732b586aef5664fa58fd133ff528ee0454fe97ed11822e79d39470c127

See more details on using hashes here.

Provenance

The following attestation bundles were made for microssim-0.0.4.tar.gz:

Publisher: ci.yml on juglab/MicroSSIM

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file microssim-0.0.4-py3-none-any.whl.

File metadata

  • Download URL: microssim-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 21.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for microssim-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 80ac846b1c4b60ad70e0dcbaf04f5634b89d9ac931971414509cd6f1ff4fab77
MD5 80f01c36ac0c203847f718bb3ba62dc3
BLAKE2b-256 f988096413034f1182d404a2177e44c2880e0e1cdb3dc4f1fd539b5b47a916ee

See more details on using hashes here.

Provenance

The following attestation bundles were made for microssim-0.0.4-py3-none-any.whl:

Publisher: ci.yml on juglab/MicroSSIM

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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