v2.0.4

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

v2.0.3 (2024-10-30)

Bug Fixes

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

v2.0.2

v2.0.2 (2024-10-29)

Bug Fixes

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

v2.0.1

v2.0.1 (2024-10-23)

Bug Fixes

• fix: revert commit 851521b (960957d)

v2.0.0

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 d3945b4 (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

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)

Feature

• 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

v1.12.0 (2024-09-04)

Feature

• 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

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

• 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

Warning

Package has wrong version number (1.11.0dev0 instead of 1.11.0)

v1.11.0 (2024-09-02)

Chore

• chore: update .pre-commit-config.yaml

add submodule checkout, add custom autoupdate commit message, change sphinx building stage to pre-push (8998a73)

• chore: update LICENSE.txt

include License statement for qmeasure submodule, fix file paths, update style (4ec7e17)

Ci

• ci: add recursive checkout (ef72c4a)

• ci: make checkout branch variable for wheel and sdist building

set checkout branch for semantic_release to main (59d0375)

• ci: remove sleep step in job test_install (fde39ba)

Feature

• feat: add function to crop images

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

Refactor

• refactor: add warning to visualize method in class ImageArray

add warning that parameter slices will be ignored if method is called on a 2D image (cd496be)

• refactor: handle data loading in interface classes

move data loading and checking to score methods of metrics interface classes (1ad011b)

• refactor: use qmeasure submodule (1c1ae61)

v1.10.0

v1.10.0 (2024-08-27)

Chore

• chore: update docs config to autodocument inherited members (9bc640f)

• chore: update documentation build

add dependencies for Sphinx in GitHub Actions job (4596169)

• chore: update release process

build only after semantic_release job ran (5fe798c)

Documentation

• docs: update docs

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

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

Feature

• 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)

Refactor

• refactor: add new parent class metric

rename export_csv to export_results, restructure abstract base classes for metrics (4bc3bef)

Unknown

• book: update Image_Comparison.ipynb accordingly to 6f4f8a7 (8ac53e8)