pyxem/kikuchipy: kikuchipy 0.7.0
Creators
- 1. Norwegian University of Science and Technology
- 2. Monash Centre for Electron Microscopy
Description
kikuchipy is an open-source Python library for processing and analysis of electron backscatter diffraction (EBSD) patterns.
This release adds readers for EBSD patterns in three file formats: Oxford Instrument's h5ebsd format (H5OINA), EDAX TSL's UP1/2 files and a dictionary of image files.
New readers for loading master patterns of transmission kikuchi diffraction and electron channeling patterns simulated with EMsoft are also added.
Finally, EBSD refinement is improved by applying the signal mask to experimental patterns as well, in addition to some internal improvements which combined can improve speeds by a factor of about 2.
See below, the changelog or the GitHub changelog for all updates from the previous release.
Added
- Signal mask passed to EBSD orientation and projection center refinement methods is now applied to the experimental pattern as well. (#573)
- Dependency
imageio
needed for reading EBSD patterns in image files. (#570) - Reader of an
EBSD
signal from all images in a directory assuming they are of the same shape and data type. (#570) - Reader of an
EBSD
signal from EDAX TSL\'s binary UP1/UP2 file formats. (#569) - Ability to project simulated patterns from a master pattern using varying projection centers (PCs) in
EBSDMasterPattern.get_patterns()
. An example is added to the method to show this. (#567) - Allow not setting
energy
parameter inEBSDMasterPattern.get_patterns()
, upon which the highest energy available is used. (#567) - Improved handling of custom attributes
xmap
,detector
andstatic_background
inEBSD
andhemisphere
,phase
andprojection
in EBSD/ECP master pattern classes when calling inherited HyperSpySignal2D
methodsas_lazy()
,change_dtype()
,compute()
,deepcopy()
,set_signal_type()
andsqueeze()
. (#564) - Reader of an electron channelig pattern (ECP) master pattern from an EMsoft HDF5 file into an
ECPMasterPattern
signal. (#564) - Reader of a transmission kikuchi diffraction (TKD) master pattern from an EMsoft HDF5 file into an
EBSDMasterPattern
signal. (#564) ECPMasterPattern
class. (#564)- Some internal logging which can be controlled via
kikuchipy.set_log_level()
. (#564) - Reader of an
EBSD
signal from Oxford Instrument\'s h5ebsd format (H5OINA). (#562) - Figures of reference frames of other software added to the documentation. (#552)
- Whether to show progressbars from most signal methods (except indexing and refinement) can be controlled by passing
show_progressbar
or by setting HyperSpy\'shs.preferences.General.show_progressbar
(see their docs for details). (#550)
Changed
- Documentation theme from Furo to PyData, as the growing API reference is easier to navigate with the latter. (#574)
- Use Rodrigues-Frank vector components (Rx, Ry, Rz) instead of Euler angles in EBSD orientation and projection center refinement methods. This means that if refinement is not directly but a Dask array is returned from any of these methods, the data which previously contained Euler angles now contain these vector components. This change was done to speed up refinement. (#573)
- Most of the
EBSD
metadata structure is removed, in an effort to move all relevant data to the attributesxmap
,static_background
, anddetector
. (#562) - h5ebsd plugin split into one plugin for each h5ebsd format (kikuchipy, EDAX TSL, and Bruker Nano). (#562)
EBSDDetector.plot()
andPCCalibrationMovingScreen.plot()
parameterreturn_fig_ax
renamed toreturn_figure
. (#552)- Import modules lazily using the specification in PEP 562. (#551)
- Minimal version of HyperSpy increased to >= 1.7.1. (#550)
progressbar
parameter toshow_progressbar
inkikuchipy.data
functions which accepts aallow_download
parameter. If not given, the value is retreived from HyperSpy\'s preferences. (#550)
Deprecated
mask
parameter in EBSD orientation and projection center refinement is deprecated in favor ofsignal_mask
, and will be removed in version 0.8.0. (#573)projections.ebsd_projections
module. (#563)
Removed
EBSDSimulationGenerator
andGeometricalEBSDSimulation
(useKikuchiPatternSimulator
andGeometricalKikuchiPatternSimulation
instead) andsimulations.features
module. (#563)crystallography
module. (#563)- Options
"north"
and"south"
for propertyEBSDMasterPattern.hemisphere
and in the parameter"hemisphere"
inkikuchipy.data.nickel_ebsd_master_pattern_small()
; use"upper"
and"lower"
instead. (#563) - Functions
remove_static_background()
,remove_dynamic_background()
andget_image_quality()
fromchunk
module. (#563) - Parameter
relative
inEBSD.remove_static_background()
. (#563) - Functions
ebsd_metadata()
andmetadata_nodes()
which have been deprecated since v0.5. (#550, #562) - Print information emitted from
EBSD
methods likeremove_static_background()
is removed. (#550)
Fixed
detector
attribute ofEBSD
signal returned from the NORDIF calibration pattern reader is now anEBSDDetector
and not just a dictionary. (#569)- Silence dask warning about splitting large chunks in
EBSD.dictionary_indexing()
. Memory use can be controlled by rechunking the dictionary or setting therechunk
orn_per_iteration
parameters. (#567)
Files
pyxem/kikuchipy-v0.7.0.zip
Files
(9.9 MB)
Name | Size | Download all |
---|---|---|
md5:fc6d875ceb3d6a3d5c00bea7bba5eac6
|
9.9 MB | Preview Download |
Additional details
Related works
- Is supplement to
- https://github.com/pyxem/kikuchipy/tree/v0.7.0 (URL)