Skip to content

Commit

Permalink
docs: fix rst format
Browse files Browse the repository at this point in the history
  • Loading branch information
glichtner committed Oct 3, 2024
1 parent 89df317 commit eceb7f3
Show file tree
Hide file tree
Showing 2 changed files with 68 additions and 40 deletions.
107 changes: 67 additions & 40 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -1,70 +1,97 @@
#########
Changelog
#########
=========

0.2.8
-----

.. _0.2.8-fixed:

Fixed
~~~~~
- add numpy2 support


0.2.7
=====
-----

.. _0.2.7-fixed:

fixed
------
Fixed
~~~~~
- Axis argument not used for method "mean" in register_stack() (`PR #26 <https://github.com/glichtner/pystackreg/pull/26>`_)

0.2.6
=====

added
-----
- exposing simple_slice and running_mean functions in util package
- added conversion function to any integer dtype

0.2.5
=====
.. _0.2.6-added:

fixed
Added
~~~~~
- Exposing `simple_slice` and `running_mean` functions in the util package
- Added conversion function to any integer dtype

0.2.5
-----
- Compilation in environment without numpy

0.2.3
=====
.. _0.2.5-fixed:

Fixed
~~~~~
- Compilation in environments without NumPy

added
0.2.3
-----

.. _0.2.3-added:

Added
~~~~~
- Added example data and tutorial notebook
- Added unit tests
- Additional documentation
- Detection of time series axis in stacks - will raise a warning if supplied axis in
stack registration does not correspond to the detected axis
- Detection of time series axis in stacks – will raise a warning if supplied axis in stack registration does not correspond to the detected axis

changed
-------
- `progress_callback` function now gets called with the iteration number, not
iteration index (iteration number = iteration index + 1)
.. _0.2.3-changed:

fixed
-----
Changed
~~~~~~~
- `progress_callback` function now gets called with the iteration number, not the iteration index (iteration number = iteration index + 1)

.. _0.2.3-fixed:

Fixed
~~~~~
- Fixed exception when using a different axis than 0 for registering stacks

0.2.2
=====
-----

changed
-------
- License changed to allow distribution on python package repositories
.. _0.2.2-changed:

0.2.1
=====
Changed
~~~~~~~
- License changed to allow distribution on Python package repositories

added
0.2.1
-----
- progress callback function can be supplied to `register_stack()` and `register_transform_stack()` functions via the `progress_callback` that is then called after every iteration (i.e. after each image registration)

changed
-------
- progress bar output not shown by default, has to be enabled by using the `verbose=True` parameter in the `register_stack()` and `register_transform_stack()` functions
.. _0.2.1-added:

0.2.0
=====
Added
~~~~~
- Progress callback function can be supplied to `register_stack()` and `register_transform_stack()` functions via the `progress_callback` parameter. It is called after every iteration (i.e., after each image registration).

.. _0.2.1-changed:

Changed
~~~~~~~
- Progress bar output is not shown by default, has to be enabled by using the `verbose=True` parameter in the `register_stack()` and `register_transform_stack()` functions

added
0.2.0
-----
- bilinear transformation

.. _0.2.0-added:

Added
~~~~~
- Bilinear transformation
1 change: 1 addition & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ def __str__(self):
"Plugin TurboReg/StackReg)"
),
long_description="\n\n".join([readme, change]),
long_description_content_type="text/x-rst",
version=__version__,
author=(
"Gregor Lichtner (python/C++ port);"
Expand Down

0 comments on commit eceb7f3

Please sign in to comment.