Skip to main content

No project description provided

Project description

Deep Quality Estimation

Python Versions Stable Version Documentation Status tests License

Quality prediction for brain tumor segmentation on scale ranging from 1 to 6 stars ⭐.
Can be used to estimate the quality of a segmentation for evaluation purposes or as e.g. as part of a loss function during model training.

[!NOTE]
This package expects images in atlas space and segmentation labels in brats style, i.e.

  • label 1 is the necrotic and non-enhancing tumor core
  • label 2 is the peritumoral edema
  • label 3 is the GD-enhancing tumor (used to be label 4 in older data, both are supported)

Installation

With a Python 3.9+ environment, you can install deep_quality_estimation directly from PyPI:

pip install deep_quality_estimation

Use Cases and Tutorials

A minimal example to predict the quality of a segmentation could look like this:

from deep_quality_estimation import DQE

# shown parameters are default values but can be adapted to usecase
dqe = DQE(device="cuda", cuda_devices="0") 

# inputs can be Paths (str or pathlib.Path object), NumPy NDArrays or a mix
mean_score, scores_per_view = dqe.predict(
    t1c="t1c.nii.gz",
    t1="t1.nii.gz",
    t2="t2.nii.gz",
    flair="flair.nii.gz",
    segmentation="segmentation.nii.gz",
)

Citation

If you use deep_quality_estimation in your research, please cite it to support the development!

https://arxiv.org/abs/2205.10355

@misc{kofler2022deepqualityestimationcreating,
      title={Deep Quality Estimation: Creating Surrogate Models for Human Quality Ratings}, 
      author={Florian Kofler and Ivan Ezhov and Lucas Fidon and Izabela Horvath and Ezequiel de la Rosa and John LaMaster and Hongwei Li and Tom Finck and Suprosanna Shit and Johannes Paetzold and Spyridon Bakas and Marie Piraud and Jan Kirschke and Tom Vercauteren and Claus Zimmer and Benedikt Wiestler and Bjoern Menze},
      year={2022},
      eprint={2205.10355},
      archivePrefix={arXiv},
      primaryClass={cs.CV},
      url={https://arxiv.org/abs/2205.10355}, 
}

Contributing

We welcome all kinds of contributions from the community!

Reporting Bugs, Feature Requests and Questions

Please open a new issue here.

Code contributions

Nice to have you on board! Please have a look at our CONTRIBUTING.md file.

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

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

deep_quality_estimation-0.0.1-py3-none-any.whl (26.2 MB view details)

Uploaded Python 3

File details

Details for the file deep_quality_estimation-0.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for deep_quality_estimation-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 23a8f30beff1e9f108ba493941910d444303876ac2b85bb34da3e51bcb2fe282
MD5 6e0a8d7597061405ac61f3975373572f
BLAKE2b-256 b93d798b8702d0f3327a9e163fd7775c7a299a328ed969c296a08cab667d012c

See more details on using hashes here.

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