Aspecd

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

Not yet released

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

Released 2024-10-17


New features
------------

* Plotting

* :class:`aspecd.plotting.PatchProperties` for properties of patches, as used for :class:`aspecd.annotation.VerticalSpan` and :class:`aspecd.annotation.HorizontalSpan`.
* :class:`aspecd.plotting.AnnotationProperties` and :class:`aspecd.plotting.AnnotationTextProperties` for properties of text annotations with lines, as used for :class:`aspecd.annotation.TextWithLine`.
* :class:`aspecd.plotting.AxesProperties` has new attributes ``frame_on``, ``xlabelposition``, and ``ylabelposition``.
* :class:`aspecd.plotting.Spines` and :class:`aspecd.plotting.SpineProperties` for controlling spine properties of axes.
* :class:`aspecd.plotting.MarkerProperties` for properties of markers, as used for :class:`aspecd.annotation.Marker`.

* Plot annotations

* :class:`aspecd.annotation.VerticalSpan` for adding vertical spans (rectangles) to plot(ter)s
* :class:`aspecd.annotation.HorizontalSpan` for adding horizontal spans (rectangles) to plot(ter)s
* :class:`aspecd.annotation.TextWithLine` for adding text with additional lines
* :class:`aspecd.annotation.Marker` for adding markers to plot(ter)s
* :class:`aspecd.annotation.FillBetween` for colouring the surface below a curve.

* Analysis

* :class:`aspecd.analysis.PeakFinding` can return both, peak positions and intensities, as pairs, ready to be used in :class:`aspecd.annotation.TextWithLine` annotations.
* :class:`aspecd.analysis.CentreOfMass` for calculating the centre of mass for ND datasets.

* IO

* :class:`aspecd.io.TxtImporter` has an additional parameter ``axis`` specifying which column to use for axis values when reading 2D data. (`6 <https://github.com/tillbiskup/aspecd/issues/6>`_)


Changes
-------

* Plotting: Default figure size in :class:`aspecd.plotting.FigureProperties` set to ``None`` to allow setting from matplotlibrc to take effect.

*Without adjustments, this may change the size (and aspect ratio) of your figures from 6x4 inches to 6.4x4.8 inches.*


Fixes
-----

* CompositePlotter operates on copies of plotters.
* Plot task writes correct filename for each plotter if results is used.
* PlotannotationTask saves properties to recipe history.
* PlotannotationTask can be applied to plotter and stored for later use as result at the same time.
* Text plot annotation with scalar y position set to zero works.

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

Released 2024-08-13


Fixes
-----

* CompositePlotter shares axes correctly

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

Released 2024-08-10


New features
------------

* Plotting

* Set individual properties for each of the lines of a :class:`aspecd.plotting.SinglePlotter2DStacked`
* Conveniently set identical properties for all lines of :class:`aspecd.plotting.SinglePlotter2DStacked` and :class:`aspecd.plotting.MultiPlotter1D`
* :class:`aspecd.plotting.TextProperties`
* :class:`aspecd.plotting.DrawingProperties` has attribute ``zorder``.
* :class:`aspecd.plotting.SubplotGridSpecs` for properties of the subplot grid of a CompositePlotter.
* :class:`aspecd.plotting.CompositePlotter` allows to share *x* and *y* axes.

* Plot annotations

* :class:`aspecd.annotations.Text` for text annotations to plot(ter)s

* Tasks

* :class:`aspecd.tasks.SingleplotTask` allows to set as many results as datasets, to allow for adding an individual plotter (for one of the datasets) to a :class:`aspecd.tasks.CompositeplotTask`. (`3 <https://github.com/tillbiskup/aspecd/issues/3>`_)

* Models

* :class:`aspecd.model.Voigtian` for creating Voigt profiles frequently used in spectroscopy to describe line shapes.


Fixes
-----

* Tasks

* :class:`aspecd.tasks.MultiplotTask` preserves order of datasets the task is applied to, regardless whether the datasets are originally imported or result from prior tasks (via ``result`` property). (`2 <https://github.com/tillbiskup/aspecd/issues/2>`_)
* :meth:`aspecd.tasks.Recipe.get_datasets` preserves order of datasets, regardless whether the datasets are originally imported or result from prior tasks (via ``result`` property).
* :meth:`aspecd.tasks.Chef.cook` closes open figures.

* Plotting

* :class:`CompositePlotter` does not add additional drawings any more to the plotters used. (`5 <https://github.com/tillbiskup/aspecd/issues/5>`_)

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

Released 2024-07-22


Fixes
-----

* Correct method for area normalization: take number of points into account.
* Adjust stacking in ``SinglePlotter2DStacked`` for data with larger minima than maxima.
* Templates for LaTeX dataset report: escape ``_`` and ` in dataset label.
* Axis labels can be removed by setting one or both of ``xlabel`` and ``ylabel`` to ``None`` (or ``null`` in YAML/recipe).

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

Released 2024-03-24


Fixes
-----

* Revert changes in :class:`aspecd.utils.ToDictMixin` from version 0.9.1, as it caused problems with Matplotlib.
* Updates on contour plots to work with Matplotlib 3.8
* Updates to prevent deprecation warning for NumPy 1.25
* :class:`aspecd.processing.RangeExtraction` extracts correct range for axis values.