Skip to content

Commit

Permalink
Refactor: References
Browse files Browse the repository at this point in the history
  • Loading branch information
CSSFrancis committed Jun 5, 2024
1 parent a7933ff commit a7c8864
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 1 deletion.
9 changes: 9 additions & 0 deletions doc/bibliography.bib
Original file line number Diff line number Diff line change
Expand Up @@ -90,4 +90,13 @@ @article{Viladot:13
volume = {252},
journal = {Journal of microscopy},
doi = {10.1111/jmi.12065}
}
@article{pyxemorientationmapping2022,
title={Free, flexible and fast: Orientation mapping using the multi-core and GPU-accelerated template matching capabilities in the python-based open source 4D-STEM analysis toolbox Pyxem},
author={Cautaerts, Niels and Crout, Phillip and {\AA}nes, H{\aa}kon Wiik and Prestat, Eric and Jeong, Jiwon and Dehm, Gerhard and Liebscher, Christian H},
journal={Ultramicroscopy},
pages={113517},
year={2022},
publisher={Elsevier},
doi={10.1016/j.ultramic.2022.113517}
}
2 changes: 2 additions & 0 deletions examples/orientation_mapping/mulit_phase_orientation.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
You can also calculate the orientation of the grains for multiple phases using the
:meth:`pyxem.signals.PolarSignal2D.get_orientation` method. This requires that you
simulate the entire S2 space for the phase and then compare to the simulated diffraction.
For more information on the orientation mapping process see :cite:`pyxemorientationmapping2022`
"""

import pyxem as pxm
Expand Down
2 changes: 2 additions & 0 deletions examples/orientation_mapping/on_zone_orientation.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
Sometimes you have a tilt boundary and you might want to know the orientation of the
grains on each side of the boundary. This can be done using the
:meth:`pyxem.signals.PolarSignal2D.get_orientation` method.
For more information on the orientation mapping process see :cite:`pyxemorientationmapping2022`
"""

from pyxem.data import si_tilt, si_phase
Expand Down
2 changes: 2 additions & 0 deletions examples/orientation_mapping/single_phase_orientation.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
You can also calculate the orientation of the grains in a single phase sample using the
:meth:`pyxem.signals.PolarSignal2D.get_orientation` method. This requires that you
simulate the entire S2 space for the phase and then compare to the simulated diffraction.
For more information on the orientation mapping process see :cite:`pyxemorientationmapping2022`
"""

from pyxem.data import si_phase, si_grains
Expand Down
7 changes: 6 additions & 1 deletion pyxem/signals/polar_diffraction2d.py
Original file line number Diff line number Diff line change
Expand Up @@ -342,13 +342,18 @@ def get_orientation(
The gamma correction applied to the diffraction patterns. The default
value is 0.5 which takes the square root of the diffraction patterns to
increase the intensity of the low intensity reflections and decrease the
intensity of the high intensity reflections.
intensity of the high intensity reflections. In most cases gamma<1 is a
good starting point. See :cite:`pyxemorientationmapping2022` for more information.
kwargs : dict
Any additional options for the :meth:`~hyperspy.signal.BaseSignal.map` function.
Returns
-------
orientation : BaseSignal
A signal with the orientation at each navigation position.
References
----------
.. bibliography::
"""
if gamma != 1:
self.data = self.data**gamma
Expand Down

0 comments on commit a7c8864

Please sign in to comment.