Skip to content

Latest commit

 

History

History
446 lines (209 loc) · 16.8 KB

CHANGELOG.md

File metadata and controls

446 lines (209 loc) · 16.8 KB

CHANGELOG

v2.0.4 (2024-11-11)

Bug fixes

  • fix(multiple.py): fix delimiter sniffing

fix csv delimiter sniffing, add support for tsv and txt files during loading of pairs in BatchMetrics (dbd60ee)

Documentation

  • docs: update README.md badge (b5d0713)

v2.0.3 (2024-10-30)

Bug fixes

  • fix: fix comparison operators and move them to Metric class (1af2e31)

v2.0.2 (2024-10-29)

Bug fixes

  • fix(qmeasure): fix image loading in score method (5f589c1)

v2.0.1 (2024-10-23)

Bug fixes

  • fix: revert commit 851521b2 (960957d)

v2.0.0 (2024-10-22)

Breaking

  • refactor!: move utility modules to utils subpackage

BREAKING CHANGE: major refactoring of utility functions (d3945b4)

Bug fixes

  • fix: convert rgb images to grayscale before binarization (f258f96)

  • fix: convert snr and cnr results to np.float64 (3589350)

  • fix(utils.py): fix visualization in _get_binary

add slices to image visualization for 3d data (3afad3a)

  • fix: change condition to check for provided snr and cnr parameters

fixes a NameError when calling snr or cnr methods without providing the center or radius parameters (Lookup in _parameter attribute fails when entries have not been created there before) (a6b3ec2)

  • fix: add additional checks for snr and cnr visualization (accaf51)

  • fix(utils.py): add check for image dimensions in export_image (960b833)

Documentation

  • docs(load_data): update deprecation warning in docstring (b3838f6)

  • docs: update docs to exclude deprecation warning (0a645f6)

  • docs(utils): add examples in module docstrings (dd590f6)

  • docs: update docs according to d3945b47 (772f430)

  • docs: add public attribute parameters to class documentation (1b2b00c)

Features

  • feat(export_image): add check for file extension (977b7c8)

  • feat(utils/export.py): add feature to return dict in export_results (c30d368)

  • feat: add functionality for different region types for snr and cnr

add find_largest_region to docs (7495cd1)

  • feat: add automatic background and signal center detection for cnr and snr (1ea9310)

  • feat: interactive centers for snr and cnr (bfa5364)

Performance improvements

  • perf: update SSIM

update documentation, refactor definition of variable truncate (851521b)

  • perf(ImageArray): calculate statistics only on method call

make sure that an ImageArray is returned via numpy ufunc (31524fb)

v1.13.0 (2024-09-24)

Documentation

  • docs: add internal API reference (81a5950)

  • docs: update docs

add visualize_2d to docs, fix cross-link for parameter image in MultipleMetrics.report (25f4e92)

Features

  • feat(BatchMetrics): add image export in report method (432c31e)

  • feat(export_image): add parameter show_image

add option to select if image should be printed when exporting images (5dff6a4)

  • feat: add parameter project_name to report methods

filename is constructed of project_name and default filename if project_name is given (07541a6)

v1.12.0 (2024-09-04)

Features

  • feat: add function to create image report

move print_image method to utils.py as function and rename to export_image, add parameter to change filename, fix bug when number of fr-metrics is not a multiple of four (cc8b4ff)

v1.11.1 (2024-09-04)

Documentation

  • docs: add pre-commit usage in developer guide (4c313ab)

  • docs: Update docs

update developer guide regarding docs generation, rename pages for utility modules and usage (4f35dd3)

Performance improvements

  • perf: improve performance of load_data

call ImageArray only at the end of load_data function and only if necessary (b3fdecd)

  • perf: improve performance of BatchMetrics

add checks to load images only if not already in memory, add function to calculate no-reference metrics only if not already calculated (a0f3a26)

v1.11.0 (2024-09-02)

Features

  • feat: add function to crop images

cal cropping function during loading if parameter roi is given (140d101)

v1.10.0 (2024-08-27)

Documentation

  • docs: update docs

remove sphinx-notfound-page, temporarily disable hoverxref (614d52a)

  • docs: add sphinx-autobuild to developer_guide.rst (59381a4)

Features

  • feat: add function to compute multiple metrics at once

rename batch_mode.py to multiple.py, add MultipleMetrics class, move export_metadata to it's own function in utils.py, add base class for classes of type multiple, update class BatchMetrics (6f4f8a7)

v1.9.1 (2024-08-23)

Bug fixes

  • fix: use ImageArray instead of np.ndarray

update according to 40f0d029ad416747135f79e8716de040335da592, fixes mypy (4ecfc86)

Documentation

  • docs: update docs

multiple changes to docstrings and docs rendering and docs building (080045f)

v1.9.0 (2024-08-22)

Bug fixes

  • fix: add Exception and warning to handle non 3D volumes in qmeasure.py (33e288a)

Build system

  • build: set specific meson and meson-python versions (e395ba2)

  • build: remove support for Python 3.13 until in stable

Python 3.13 build takes too long or fails, add specific dependency version for meson-python (d6dd0e6)

Features

  • feat(batch_mode.py): add parameter data_range to export_metadata (00cb4c4)

  • feat: add parameter to set order of scaling in batch_mode.py (0c3886c)

v1.8.0 (2024-08-22)

Bug fixes

  • fix: update 2D visualization for snr and cnr

fix visualization based on 4d7c3e02 (0bab2b8)

Build system

  • build: update numpy dependency for build to be lower than 2.0.0 (54ac725)

Documentation

  • docs: update Tuple order for visualization methods in snr.py and cnr.py

change Tuple order according to 4d7c3e02 and 0bab2b85 (3aef76d)

Features

  • feat: add 2D visualization for class ImageArray (d09dfad)

  • feat: add parameter to export image in visualization functions (6e418e2)

v1.7.0 (2024-08-22)

Bug fixes

  • fix: change orientation of loaded image array

add rotation and flip when loading from binary, update visualization functions for cnr and snr (4d7c3e0)

Documentation

  • docs: update docstring for load_utils.py:load_raw

add periods to sentences in the "Raises" section of docstring (c3f3591)

  • docs: add pre-commit.ci status badge (b02ca8b)

Features

  • feat: add custom visualization

add method for class ImageArray and function visualize_3d for custom visualization of slices of 3d volumes, update documentation for the respective method and function (8423592)

Performance improvements

  • perf: use attribute of class ImageArray for method describe

attribute mean_value in method describe is now used, fix documentation for class ImageArray (b0830cf)

v1.6.1 (2024-08-20)

Bug fixes

  • fix: remove init.py files for C extensions

import of the package is now possible again (e747cf7)

v1.6.0 (2024-08-20)

Documentation

  • docs: change title of Changelog page to Release History (ef913a6)

  • docs: add changelog page (730ecf1)

  • docs: add contributor covenant shield (1ab08c1)

Features

  • feat(load_utils.py): add support for .tiff files (a7c8b74)

v1.5.2 (2024-08-16)

Bug fixes

  • fix(mad.py): update check for im_slice

in (int or None) int can always be evaluated as true (a245fe9)

Build system

  • build: add stub files and init.py files for C extensions to build process (6251b98)

  • build: update build_wheels_and_publish.yaml

add fetch_depth for code checkout (1fd84d2)

  • build: update workflows

add pull_request trigger for Build, add concurrency for Documentation, add event trigger for Documentation (6e8bc98)

  • build: fix build_wheels_and_publish.yaml

add code checkout to github release job (e2c9a39)

Documentation

  • docs: update README.md

update Project Status badge to Active, clear todo list, add contributing, improve documentation (503e4f7)

  • docs: rename batch mode page

make "Module" lowercase as all other modules (e1105e1)

  • docs: restructure docs into api reference and usage page (0dad6df)

  • docs: add developer guide (5282655)

  • docs: add favicon (f2b6ee1)

v1.5.1 (2024-08-08)

Bug fixes

  • fix(msssim.py): fix scale weights

parameter scale_weights in msssim now gets converted from list to tensor. Fixes bug where using scale_weights resulted in an error. (b1aad49)

Build system

  • build: fix build_wheels_and_publish.yaml

add own job for upload to github, Fix test install from PyPI (aa6c1d5)

  • build: fix build_wheels_and_publish.yaml

fix permissions for action (23301a2)

  • build: fix build_wheels_and_publish.yaml

fix dependency for publishing to GitHub (9a48467)

  • build: add semantic release (9ab3aeb)

  • build: add test install after release

tests the install from pypi after publishing (054ffd5)

v1.5.0 (2024-08-07)

Documentation

  • docs: add docs for ImageArray

add sphinx generated .rst file for ImageArray class (a8d4b6b)

Features

  • feat: add tqdm progress bar (615d0f3)

v1.4.0 (2024-08-07)

Features

  • feat(batch_mode.py): improve metadata textfile

add underscores to structure exported textfile in export_metadata (3d00279)

v1.3.0 (2024-08-07)

Documentation

  • docs(ssim.py): Fix doc for structural_similarity()

parameter data_range default is None, not 255 (dad5432)

Features

  • feat(batch_mode.py): add exceptions for batch mode

raise an exception if file extension is not correctly specified in export_results or export_metadata (be72f3b)

v1.2.3 (2024-08-07)

v1.2.2 (2024-08-07)

Bug fixes

  • fix: use np.round instead of round

fixes problems with the new ImageArray class (96579a0)

v1.2.1 (2024-08-07)

Bug fixes

  • fix: add exception in data loading

throws exception when loading a binary image and image size and dimensions do not match; rename ImageArray.mean to ImageArray.mean_value (df53d06)

v1.2.0 (2024-08-06)

Features

  • feat(batch_mode.py): add function to export metadata

function writes custom parameters and package version to a .txt file (5b8e607)

v1.1.0 (2024-08-05)

Features

  • feat: add function to get installed version (12e20ac)

v1.0.0 (2024-08-05)

Breaking

  • feat(ImageArray)!: add class for images

subclass of np.ndarray, calculates image statistics (40f0d02)