Version 0.12.0

Released 2024-12-22

Note: This version comes with a new version of the recipe format: 0.3. Existing recipes are updated automatically on import.

New features

• I/O

  • Importer logs warning if importing did not populate data array in dataset.

• Plotting

  • Attribute clim in :class:aspecd.plotting.SurfaceProperties
  • Parameter threshold for determining the levels of a contour plot in class :class:aspecd.plotting.SinglePlotter2D
  • Attributes number_of_colors and first_color in :class:aspecd.plotting.MultiPlot1DProperties: Fixed number of elements from colormap, to have same colour succession in plots with different number of curves if a colormap is specified, and potential offset in colormap if starting with white/a light colour.
  • Attributes norm and norm_parameters in :class:aspecd.plotting.SurfaceProperties.

• Plot annotations

  • Parameter units in :class:aspecd.annotation.Text, :class:aspecd.annotation.Marker, :class:aspecd.annotation.VerticalLine, :class:aspecd.annotation.HorizontalLine, :class:aspecd.annotation.VerticalSpan, and :class:aspecd.annotation.HorizontalSpan allowing to position using axes rather than data coordinates.

• Processing

  • :class:aspecd.processing.SliceRearrangement for rearranging slices of a dataset along one dimension.
  • :class:aspecd.processing.DatasetAlgebra operates on a list of datasets, allowing to add/subtract multiple datasets from a given dataset.
  • :class:aspecd.processing.Denoising1DSVD for denoising 1D datasets using singular value decomposition.

• Tasks

  • Functions add and multiply for properties of tasks in recipes.
  • New default setting number_of_colors on recipe level: Fixed number of elements from colormap, to have same colour succession in plots with different number of curves if a colormap is specified.
  • Tasks can be marked as to be skipped, using the skip keyword on the top level of the task definition in a recipe.

Changes

• Recipe structure changed slightly: The settings dictionary has a new sub-dictionary colors, and the default_colormap key moved there, together with the new keys number_of_colors and first_color.

  • New recipe format version: 0.3.
  • Existing recipes are updated automatically on import.

• Figure properties (see :class:aspecd.plotting.FigureProperties) are applied to the figure before the actual plotting is done, as some plotters need to know the (final) figure size or else.

• Axes properties (see :class:aspecd.plotting.AxesProperties) are applied to the axes before the actual plotting is done, as some plotters need to know the (final) axes limits or else.

Fixes

• Plotter with colorbar work with recipes (no longer recursion in to_dict())
• :class:aspecd.processing.SliceRemoval handles lists properly
• :class:aspecd.processing.SliceRemoval removes value(s) from corresponding axis
• :class:aspecd.processing.Averaging handles inverted axes (e.g., ppm scale) correctly regardless how ranges are given
• :class:aspecd.plotting.MultiPlot1DProperties handles explicit colours of individual drawings correctly.

Updated requirements

• bibrecord >= 0.2