kikuchipy 0.5.4

kikuchipy is an open-source Python library for processing and analysis of electron backscatter diffraction (EBSD) patterns.

See the changelog or below for all updates from the previous release.

Contributors

• Håkon Wiik Ånes

Added

• Optional parameters rechunk and chunk_kwargs to EBSD refinement methods to better control possible rechunking of pattern array before refinement. (#470)

Changed

• When EBSD refinement methods don't immediately compute, they return a dask array instead of a list of delayed instances. (#470)

Fixed

• Memory issue in EBSD refinement due to naive use of dask.delayed. Uses map_blocks() instead. (#470)

kikuchipy 0.5.3

kikuchipy is an open-source Python library for processing and analysis of electron backscatter diffraction (EBSD) patterns.

See below or the changelog for all updates from the previous release.

Contributors

• Håkon Wiik Ånes
• Zhou Xu

Added

• Printing of speed (patterns per second) of dictionary indexing and refinement. (#461)
• Restricted newest version of hyperspy>=1.6.5 due to incompatibility with h5py>=3.5. (#461)

Fixed

• Handling of projection centers (PCs): Correct conversion from/to EMsoft's convention requires binning factor and detector pixel size. Conversion between TSL/Oxford and Bruker conventions correctly uses detector aspect ratio. (#455)

kikuchipy 0.5.2

kikuchipy is an open-source Python library for processing and analysis of electron backscatter diffraction (EBSD) patterns.

This patch release was made so that cubochoric orientation sampling is used in the user guide. This is an improvement compared to the orientation sampling previously used. Cubochoric sampling was just made available in orix v0.7.

See the changelog for all updates from the previous release.

Contributors

• Håkon Wiik Ånes

Changed

• Add gnomonic circles as patches in axes returned from EBSDDetector.plot(). (#445)
• Restrict lowest supported version of orix to >= 0.7. (#444)

kikuchipy 0.5.1

kikuchipy is an open-source Python library for processing and analysis of electron backscatter diffraction (EBSD) patterns.

See the changelog for all updates from the previous release.

Contributors

• Håkon Wiik Ånes

Added

• Automatic creation of a release using GitHub Actions, which will simplify and lead to more frequent patch releases. (#433)

kikuchipy 0.5.1rc1

kikuchipy is an open-source Python library for processing and analysis of electron backscatter diffraction (EBSD) patterns.

See the changelog for all updates from the previous release.

kikuchipy 0.5.0

kikuchipy 0.5.0 is a minor release of kikuchipy, an open-source Python library for processing and analysis of electron backscatter diffraction (EBSD) patterns.

The most notable addition to this release is the possibility to refine EBSD orientations and/or projection/pattern center (PC) coordinates using SciPy's optimization algorithms. Also, the time to generate a dictionary of simulated EBSD patterns from a master pattern has been reduced substantially. A signal/detector mask can be used with dictionary indexing, and memory usage can be controlled somewhat by setting some parameters.

Some previously deprecated functionality has been removed, and some existing functionality has been deprecated to be removed in the future. Note that some functionality has also been changed in this release without a previous warning.

All updates from the previous release are listed below.

Contributors

• Eric Prestat
• Håkon Wiik Ånes
• Lars Andreas Hastad Lervik

Added

• Possibility to specify whether to rechunk experimental and simulated data sets and which data type to use for dictionary indexing. (#419)
• How to use the new orientation and/or projection center refinements to the pattern matching notebook. (#405)
• Notebooks to the documentation as shorter or longer "Examples" that don't fit in the user guide. (#403)
• Refinement module for EBSD refinement. Allows for the refinement of orientations and/or projection center estimates. (#387)

Changed

• If a custom metric is to be used for dictionary indexing, it must now be a class inheriting from an abstract SimilarityMetric class. This replaces the previous SimilarityMetric class and the make_similarity_metric() function. (#419)
• Dictionary indexing parameter n_slices to n_per_iteration. (#419)
• merge_crystal_maps parameter metric to greater_is_better. (#419)
• orientation_similarity_map parameter normalized is by default False. (#419)
• Dependency versions for dask >= 2021.8.1, fixing some memory issues encountered after 2021.3.1, and HyperSpy >= 1.6.4. Remove importlib_metadata from package dependencies. (#418)
• Performance improvements to EBSD dictionary generation, giving a substantial speed-up. (#405)
• Rename projection methods from project()/iproject() to vector2xy()/xy2vector(). (#405)
• URLs of user guide topics have an extra "/user_guide/" added to them. (#403)

Deprecated

• Custom EBSD metadata, meaning the Acquisition_instrument.SEM.EBSD.Detector and Sample.Phases nodes, as well as the EBSD set_experimental_parameters() and set_phase_parameters() methods. This will be removed in v0.6 The static_background metadata array will become available as an EBSD property. (#428)

Removed

• make_similarity_metric() function is replaced by the need to create a class inheriting from a new abstract SimilarityMetric class, which provides more freedom over preparations of arrays before dictionary indexing. (#419)
• EBSD.match_patterns() is removed, use EBSD.dictionary_indexing() instead. (#419)
• kikuchipy.pattern.correlate module. (#419)

Fixed

• Allow static background in EBSD metadata to be a Dask array. (#413)
• Set newest supported version of Sphinx to 4.0.2 so that nbsphinx works. (#403)

kikuchipy 0.4.0

kikuchipy 0.4.0 is a minor release of kikuchipy, an open-source Python library for processing and analysis of electron backscatter diffraction (EBSD) patterns.

The most notable addition is the reading of uncompressed EBSD patterns from Oxford Instruments' binary .ebsp file format, making users of their detectors able to visualize and analyze their patterns in kikuchipy! Projection/pattern center calibration via the moving screen technique is also added. All updates from the previous release are listed below.

Contributors

• Håkon Wiik Ånes

Added

• Sample tilt about RD can be passed as part of an EBSDDetector. This can be used when projecting parts of master patterns onto a detector. (#381)
• Reader for uncompressed EBSD patterns stored in Oxford Instrument's binary .ebsp file format. (#371, #391)
• Unit testing of docstring examples. (#350)
• Support for Python 3.9. (#348)
• Projection/pattern center calibration via the moving screen technique in a kikuchipy.detectors.calibration module. (#322)
• Three single crystal Si EBSD patterns, from the same sample position but with varying detector distances, to the data module (via external repo). (#320)
• Reading of NORDIF calibration patterns specified in a setting file into an EBSD signal. (#317)

Changed

• Only return figure from kikuchipy.filters.Window.plot() if desired, also add a colorbar only if desired. (#375)

Deprecated

• The kikuchipy.pattern.correlate module will be removed in v0.5. Use kikuchipy.indexing.similarity_metrics instead. (#377)
• Rename the EBSD.match_patterns() method to EBSD.dictionary_indexing(). match_patterns() will be removed in v0.5. (#376)

Fixed

• Set minimal requirement of importlib_metadata to v3.6 so Binder can run user guide notebooks with HyperSpy 1.6.3. (#395)
• Row (y) coordinate array returned with the crystal map from dictionary indexing is correctly sorted. (#392)
• Deep copying EBSD and EBSDMasterPattern signals carry over, respectively, xmap and detector, and phase, hemisphere and projection properties. (#356)
• Scaling of region of interest coordinates used in virtual backscatter electron imaging to physical coordinates. (#349)

kikuchipy 0.3.4

kikuchipy 0.3.4 is a patch release of kikuchipy, an open-source Python library for processing and analysis of electron backscatter diffraction (EBSD) patterns.

The release ensures a clean install of kikuchipy will install compatible versions of some dependencies.

See other changes in the 0.3.x minor release cycle in the changelog.

Contributors

• Håkon Wiik Ånes

Added

• Restrict newest version of dask<=2021.03.1 and pin version of orix==0.6.0. (#360)

kikuchipy 0.3.3

kikuchipy 0.3.3 is a patch release of kikuchipy, an open-source Python library for processing and analysis of electron backscatter diffraction (EBSD) patterns.

The release fixes bugs related to merging of crystal maps, getting markers from a geometrical EBSD simulation, removing the static background in an EBSD signal with non-square patterns, and reading of EBSD patterns from Bruker h5ebsd (HDF5) datasets created with a region of interest.

See other changes in the 0.3.x minor release cycle in the changelog.

Contributors

• Håkon Wiik Ånes
• Ole Natlandsmyr

Fixed

• Reading of EBSD patterns from Bruker h5ebsd with a region of interest (#339)
• Merging of (typically refined) crystal maps, where either a simulation indices array is not present or the array contains more indices per point than scores. (#335)
• Bugs in getting plot markers from geometrical EBSD simulation. (#334)
• Passing a static background pattern to EBSD.remove_static_background() for a non-square detector dataset works. (#331)

kikuchipy 0.3.2

kikuchipy 0.3.2 is a patch release of kikuchipy, an open-source Python library for processing and analysis of electron backscatter diffraction (EBSD) patterns.

The release fixes a bug in the creation of the returned CrystalMap(s) after pattern matching with the EBSD.match_patterns() method.

See other changes in the 0.3.x minor release cycle in the changelog.

Contributors

• Håkon Wiik Ånes

Fixed

• Deletion of temporary files saved to temporary directories in user guide (#312)
• Pattern matching sometimes failing to generate a crystal map due to incorrect creation of spatial arrays (#307)