Skip to content

Commit

Permalink
Merge pull request #94 from oncoray/dev2.2.4
Browse files Browse the repository at this point in the history
Release version 2.2.4
  • Loading branch information
alexzwanenburg authored Jun 23, 2024
2 parents 31d2b8a + 9c14b3b commit fb5a23c
Show file tree
Hide file tree
Showing 61 changed files with 359 additions and 224 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/auto-test-dependencies_timed.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# Automated tests are run at 6:30 UTC on the first and fifteenth day of each month.

name: Run automated tests on multiple platforms to detect dependency issues
name: build-check

on:
workflow_dispatch:
Expand Down
8 changes: 7 additions & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# Version 2.2.4

## Fixes

- Masks can now be plotted in images without causing an error when using `matplotlib` version 3.9.0 or later.

# Version 2.2.3

## Minor changes
Expand All @@ -7,7 +13,7 @@

- MIRP now checks whether there are potential problems between the frames of reference of image and mask files.

# Fixes
## Fixes

- Fixed an error that occurs when attempting to create a deep copy `ImageITKFile` objects.

Expand Down
31 changes: 26 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,35 @@
<img src="https://raw.githubusercontent.com/oncoray/mirp/master/icon/mirp.svg" align="right" width="120"/>

![GitHub License](https://img.shields.io/github/license/oncoray/mirp)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mirp)
[![PyPI - Version](https://img.shields.io/pypi/v/mirp)](https://pypi.org/project/mirp/)
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/oncoray/mirp/auto-test-dependencies_timed.yml)
[![JOSS](https://joss.theoj.org/papers/165c85b1ecad891550a21b12c8b2e577/status.svg)](https://joss.theoj.org/papers/165c85b1ecad891550a21b12c8b2e577)

# Medical Image Radiomics Processor

Medical Image Radiomics Processor (MIRP) is a python package for medical image analysis that is compliant with the
reference standards of the Image Biomarker Standardisation Initiative (IBSI). MIRP focuses on radiomics applications
and supports computation of features for conventional radiomics and image processing for deep-learning applications.
MIRP is a python package for quantitative analysis of medical images. It focuses on processing images for integration
with radiomics workflows. These workflows either use quantitative features computed using MIRP, or directly use MIRP
to process images as input for neural networks and other deep learning models.

MIRP offers the following main functionality:

- [Extract and collect metadata](https://oncoray.github.io/mirp/image_metadata.html) from medical images.
- [Find and collect labels or names](https://oncoray.github.io/mirp/mask_labels.html) of regions of interest from image
segmentations.
- [Compute quantitative features](https://oncoray.github.io/mirp/quantitative_image_analysis.html) from regions of interest in medical images.
- [Process images for deep learning](https://oncoray.github.io/mirp/deep_learning.html).

## Tutorials

We currently offer the following tutorials:

- [Computing quantitative features from MR images](https://oncoray.github.io/mirp/tutorial_compute_radiomics_features_mr.html)
- [Applying filters to images](https://oncoray.github.io/mirp/tutorial_apply_image_filter.html)

## Documentation and tutorials
## Documentation

Documentation and tutorials can be found here: https://oncoray.github.io/mirp/
Documentation can be found here: https://oncoray.github.io/mirp/

## Supported Python and OS

Expand Down
2 changes: 1 addition & 1 deletion docs/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: b7d3c05f6bec86800f0a1510ac564b73
config: 92a05a2b300f0adee19d846b9e8f30a1
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 4 additions & 4 deletions docs/_modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview: module code &mdash; mirp 2.2.3 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
<title>Overview: module code &mdash; mirp 2.2.4 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=92fd9be5" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />


Expand All @@ -14,7 +14,7 @@

<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=85e56e6b"></script>
<script src="../_static/documentation_options.js?v=4e6cfea6"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
Expand Down Expand Up @@ -52,7 +52,7 @@
<li class="toctree-l1"><a class="reference internal" href="../tutorial_compute_radiomics_features_mr.html">Tutorial: Computing radiomics features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorial_apply_image_filter.html">Tutorial: Applying image filters</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Deep Dive</span></p>
<p class="caption" role="heading"><span class="caption-text">Documentation and API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../image_mask_import.html">Configure image and mask import</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration.html">Configure the image processing and feature extraction workflow</a></li>
Expand Down
8 changes: 4 additions & 4 deletions docs/_modules/mirp/data_import/import_image_and_mask.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>mirp.data_import.import_image_and_mask &mdash; mirp 2.2.3 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
<title>mirp.data_import.import_image_and_mask &mdash; mirp 2.2.4 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=92fd9be5" />
<link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=19f00094" />


Expand All @@ -14,7 +14,7 @@

<script src="../../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../../_static/documentation_options.js?v=85e56e6b"></script>
<script src="../../../_static/documentation_options.js?v=4e6cfea6"></script>
<script src="../../../_static/doctools.js?v=888ff710"></script>
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
Expand Down Expand Up @@ -52,7 +52,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../../tutorial_compute_radiomics_features_mr.html">Tutorial: Computing radiomics features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../tutorial_apply_image_filter.html">Tutorial: Applying image filters</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Deep Dive</span></p>
<p class="caption" role="heading"><span class="caption-text">Documentation and API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../image_mask_import.html">Configure image and mask import</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../configuration.html">Configure the image processing and feature extraction workflow</a></li>
Expand Down
8 changes: 4 additions & 4 deletions docs/_modules/mirp/deep_learning_preprocessing.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>mirp.deep_learning_preprocessing &mdash; mirp 2.2.3 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
<title>mirp.deep_learning_preprocessing &mdash; mirp 2.2.4 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=92fd9be5" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />


Expand All @@ -14,7 +14,7 @@

<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=85e56e6b"></script>
<script src="../../_static/documentation_options.js?v=4e6cfea6"></script>
<script src="../../_static/doctools.js?v=888ff710"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
Expand Down Expand Up @@ -52,7 +52,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../tutorial_compute_radiomics_features_mr.html">Tutorial: Computing radiomics features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tutorial_apply_image_filter.html">Tutorial: Applying image filters</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Deep Dive</span></p>
<p class="caption" role="heading"><span class="caption-text">Documentation and API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../image_mask_import.html">Configure image and mask import</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../configuration.html">Configure the image processing and feature extraction workflow</a></li>
Expand Down
8 changes: 4 additions & 4 deletions docs/_modules/mirp/extract_features_and_images.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>mirp.extract_features_and_images &mdash; mirp 2.2.3 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
<title>mirp.extract_features_and_images &mdash; mirp 2.2.4 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=92fd9be5" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />


Expand All @@ -14,7 +14,7 @@

<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=85e56e6b"></script>
<script src="../../_static/documentation_options.js?v=4e6cfea6"></script>
<script src="../../_static/doctools.js?v=888ff710"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
Expand Down Expand Up @@ -52,7 +52,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../tutorial_compute_radiomics_features_mr.html">Tutorial: Computing radiomics features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tutorial_apply_image_filter.html">Tutorial: Applying image filters</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Deep Dive</span></p>
<p class="caption" role="heading"><span class="caption-text">Documentation and API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../image_mask_import.html">Configure image and mask import</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../configuration.html">Configure the image processing and feature extraction workflow</a></li>
Expand Down
8 changes: 4 additions & 4 deletions docs/_modules/mirp/extract_image_parameters.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>mirp.extract_image_parameters &mdash; mirp 2.2.3 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
<title>mirp.extract_image_parameters &mdash; mirp 2.2.4 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=92fd9be5" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />


Expand All @@ -14,7 +14,7 @@

<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=85e56e6b"></script>
<script src="../../_static/documentation_options.js?v=4e6cfea6"></script>
<script src="../../_static/doctools.js?v=888ff710"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
Expand Down Expand Up @@ -52,7 +52,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../tutorial_compute_radiomics_features_mr.html">Tutorial: Computing radiomics features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tutorial_apply_image_filter.html">Tutorial: Applying image filters</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Deep Dive</span></p>
<p class="caption" role="heading"><span class="caption-text">Documentation and API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../image_mask_import.html">Configure image and mask import</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../configuration.html">Configure the image processing and feature extraction workflow</a></li>
Expand Down
8 changes: 4 additions & 4 deletions docs/_modules/mirp/extract_mask_labels.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>mirp.extract_mask_labels &mdash; mirp 2.2.3 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
<title>mirp.extract_mask_labels &mdash; mirp 2.2.4 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=92fd9be5" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />


Expand All @@ -14,7 +14,7 @@

<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=85e56e6b"></script>
<script src="../../_static/documentation_options.js?v=4e6cfea6"></script>
<script src="../../_static/doctools.js?v=888ff710"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
Expand Down Expand Up @@ -52,7 +52,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../tutorial_compute_radiomics_features_mr.html">Tutorial: Computing radiomics features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tutorial_apply_image_filter.html">Tutorial: Applying image filters</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Deep Dive</span></p>
<p class="caption" role="heading"><span class="caption-text">Documentation and API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../image_mask_import.html">Configure image and mask import</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../configuration.html">Configure the image processing and feature extraction workflow</a></li>
Expand Down
8 changes: 4 additions & 4 deletions docs/_modules/mirp/settings/feature_parameters.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>mirp.settings.feature_parameters &mdash; mirp 2.2.3 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
<title>mirp.settings.feature_parameters &mdash; mirp 2.2.4 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=92fd9be5" />
<link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=19f00094" />


Expand All @@ -14,7 +14,7 @@

<script src="../../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../../_static/documentation_options.js?v=85e56e6b"></script>
<script src="../../../_static/documentation_options.js?v=4e6cfea6"></script>
<script src="../../../_static/doctools.js?v=888ff710"></script>
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
Expand Down Expand Up @@ -52,7 +52,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../../tutorial_compute_radiomics_features_mr.html">Tutorial: Computing radiomics features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../tutorial_apply_image_filter.html">Tutorial: Applying image filters</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Deep Dive</span></p>
<p class="caption" role="heading"><span class="caption-text">Documentation and API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../image_mask_import.html">Configure image and mask import</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../configuration.html">Configure the image processing and feature extraction workflow</a></li>
Expand Down
8 changes: 4 additions & 4 deletions docs/_modules/mirp/settings/general_parameters.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>mirp.settings.general_parameters &mdash; mirp 2.2.3 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
<title>mirp.settings.general_parameters &mdash; mirp 2.2.4 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=92fd9be5" />
<link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=19f00094" />


Expand All @@ -14,7 +14,7 @@

<script src="../../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../../_static/documentation_options.js?v=85e56e6b"></script>
<script src="../../../_static/documentation_options.js?v=4e6cfea6"></script>
<script src="../../../_static/doctools.js?v=888ff710"></script>
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
Expand Down Expand Up @@ -52,7 +52,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../../tutorial_compute_radiomics_features_mr.html">Tutorial: Computing radiomics features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../tutorial_apply_image_filter.html">Tutorial: Applying image filters</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Deep Dive</span></p>
<p class="caption" role="heading"><span class="caption-text">Documentation and API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../image_mask_import.html">Configure image and mask import</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../configuration.html">Configure the image processing and feature extraction workflow</a></li>
Expand Down
Loading

0 comments on commit fb5a23c

Please sign in to comment.