OpenChemistry/stempy: stempy 2.0.0

This release contains breaking changes that may require code updates.

• For consistency and ease of use, the ElectronCountedData namedtuple has been replaced by the SparseArray class. The SparseArray has similar attributes as the ElectronCountedData, but scan_dimensions is now scan_shape[::-1], and frame_dimensions is now frame_shape.

  Here are the functions that are effected:

  • stempy.image.electron_count() now returns a SparseArray instead of the namedtuple
  • stempy.io.load_electron_counts() now also returns a SparseArray
  • stempy.io.save_electron_counts() now requires a SparseArray argument instead of the namedtuple

• SparseArray now also supports attaching metadata. This metadata will be included in any of the HDF5 files written from a SparseArray instance. The various electron counting parameters used in stempy.image.electron_count() are now also automatically added to the metadata of the SparseArray instance.
• When performing electron counting on a dataset that contains multiple frames at each scan position, the electron events are now stored in separate arrays for each frame, rather than being append to a single array.

Full Changelog: https://github.com/OpenChemistry/stempy/compare/1.1.1...2.0.0