Hyperspy

===================

This is a maintenance release that adds compatibility with Numpy 1.17 and Dask

===================

This is a maintenance release that fixes some regressions introduced in v1.5.
Follow the following links for details on all the `bugs fixed
<https://github.com/hyperspy/hyperspy/issues?q=label%3A"type%3A+bug"+is%3Aclosed+milestone%3Av1.5.1>`__.


.. _changes_1.5:

===================

NEW
---

* New method :py:meth:`hyperspy.component.Component.print_current_values`. See
:ref:`the User Guide for details <Component.print_current_values>`.
* New :py:class:`hyperspy._components.skew_normal.SkewNormal` component.
* New :py:meth:`hyperspy.api.signals.BaseSignal.apply_apodization` method and
``apodization`` keyword for :py:meth:`hyperspy.api.signals.BaseSignal.fft`. See
:ref:`signal.fft` for details.
* Estimation of number of significant components by the elbow method.
See :ref:`mva.scree_plot`.

Enhancements
------------

* The contrast adjustment tool has been hugely improved. Test it by pressing the ``h`` key on any image.
* The :ref:`Developer Guide <dev_guide>` has been extended, enhanced and divided into
chapters.
* Signals with signal dimension equal to 0 and navigation dimension 1 or 2 are
automatically transposed when using
:py:func:`hyperspy.api.plot.plot_images`
or :py:func:`hyperspy.api.plot.plot_spectra` respectively. This is
specially relevant when plotting the result of EDS quantification. See
:external+exspy:ref:`eds-label` for examples.
* The following components have been rewritten using
:py:class:`hyperspy._components.expression.Expression`, boosting their
speeds among other benefits. Multiple issues have been fixed on the way.

* :py:class:`hyperspy._components.lorentzian.Lorentzian`
* :py:class:`hyperspy._components.exponential.Exponential`
* :py:class:`hyperspy._components.bleasdale.Bleasdale`
* :py:class:`hyperspy._components.rc.RC`
* :py:class:`hyperspy._components.logistic.Logistic`
* :py:class:`hyperspy._components.error_function.Erf`
* :py:class:`hyperspy._components.gaussian2d.Gaussian2D`
* :py:class:`exspy.components.VolumePlasmonDrude`
* :py:class:`exspy.components.DoublePowerLaw`
* The ``hyperspy._components.polynomial_deprecated.Polynomial``
component will be deprecated in HyperSpy 2.0 in favour of the new
:py:class:`hyperspy._components.polynomial.Polynomial` component, that is based on
:py:class:`hyperspy._components.expression.Expression` and has an improved API. To
start using the new component pass the ``legacy=False`` keyword to the
the ``hyperspy._components.polynomial_deprecated.Polynomial`` component
constructor.


For developers
--------------
* Drop support for python 3.5
* New extension mechanism that enables external packages to register HyperSpy
objects. See :ref:`writing_extensions-label` for details.


.. _changes_1.4.2:

===================

This is a maintenance release. Among many other fixes and enhancements, this
release fixes compatibility issues with Matplotlib v 3.1. Follow the
following links for details on all the `bugs fixed
<https://github.com/hyperspy/hyperspy/issues?q=label%3A"type%3A+bug"+is%3Aclosed+milestone%3Av1.4.2>`__
and `enhancements
<https://github.com/hyperspy/hyperspy/issues?q=is%3Aclosed+milestone%3Av1.4.2+label%3A"type%3A+enhancement">`__.


.. _changes_1.4.1:

===================

This is a maintenance release. Follow the following links for details on all
the `bugs fixed
<https://github.com/hyperspy/hyperspy/issues?q=label%3A"type%3A+bug"+is%3Aclosed+milestone%3Av1.4.1>`__
and `enhancements
<https://github.com/hyperspy/hyperspy/issues?q=is%3Aclosed+milestone%3Av1.4.1+label%3A"type%3A+enhancement">`__.

This release fixes compatibility issues with Python 3.7.


.. _changes_1.4:

===================

This is a minor release. Follow the following links for details on all
the `bugs fixed
<https://github.com/hyperspy/hyperspy/issues?utf8=%E2%9C%93&q=is%3Aclosed+milestone%3Av1.4+label%3A%22type%3A+bug%22+>`__,
`enhancements
<https://github.com/hyperspy/hyperspy/issues?q=is%3Aclosed+milestone%3Av1.4+label%3A%22type%3A+enhancement%22>`__
and `new features
<https://github.com/hyperspy/hyperspy/issues?q=is%3Aclosed+milestone%3Av1.4+label%3A%22type%3A+New+feature%22>`__.

NEW
---

* Support for three new file formats:

* Reading FEI's Velox EMD file format based on the HDF5 open standard. See :external+rsciio:ref:`emd_fei-format`.
* Reading Bruker's SPX format. See :external+rsciio:ref:`bruker-format`.
* Reading and writing the mrcz open format. See :external+rsciio:ref:`mrcz-format`.
* New ``hyperspy.datasets.artificial_data`` module which contains functions for generating
artificial data, for use in things like docstrings or for people to test
HyperSpy functionalities. See :ref:`example-data-label`.
* New :meth:`~.api.signals.BaseSignal.fft` and :meth:`~.api.signals.BaseSignal.ifft` signal methods. See :ref:`signal.fft`.
* New :meth:`holospy.signals.HologramImage.statistics` method to compute useful hologram parameters. See :external+holospy:ref:`holography.stats-label`.
* Automatic axes units conversion and better units handling using `pint <https://pint.readthedocs.io/en/latest/>`__.
See :ref:`quantity_and_converting_units`.
* New :class:`~.roi.Line2DROI` :meth:`~.roi.Line2DROI.angle` method. See :ref:`roi-label` for details.

Enhancements
------------

* :py:func:`~.api.plot.plot_images` improvements (see :ref:`plot.images` for details):

* The ``cmap`` option of :py:func:`~.api.plot.plot_images`
supports iterable types, allowing the user to specify different colormaps
for the different images that are plotted by providing a list or other
generator.
* Clicking on an individual image updates it.
* New customizable keyboard shortcuts to navigate multi-dimensional datasets. See :ref:`visualization-label`.
* The :py:meth:`~.api.signals.Signal1D.remove_background` method now operates much faster
in multi-dimensional datasets and adds the options to interatively plot the remainder of the operation and
to set the removed background to zero. See :ref:`signal1D.remove_background` for details.
* The :py:meth:`~.api.signals.Signal2D.plot` method now takes a ``norm`` keyword that can be "linear", "log",
"auto" or a matplotlib norm. See :ref:`plot.customize_images` for details.
Moreover, there are three new extra keyword
arguments, ``fft_shift`` and ``power_spectrum``, that are useful when plotting fourier transforms. See
:ref:`signal.fft`.
* The :py:meth:`~.api.signals.Signal2D.align2D` and :py:meth:`~.api.signals.Signal2D.estimate_shift2D`
can operate with sub-pixel accuracy using skimage's upsampled matrix-multiplication DFT. See :ref:`signal2D.align`.


.. _changes_1.3.2: