Skip to content

Commit ffc4c9e

Browse files
authored
Update digital_dark_field.py
Adding to introductory docstring to give the publication reference
1 parent 04e2b6b commit ffc4c9e

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

py4DSTEM/process/diffraction/digital_dark_field.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
A general note on all these functions is that they are designed for use with rotation calibration into the pointslist.
33
However, they have to date only been used with the Qx and Qy in pixels and not calibrated into reciprocal units.
44
There is no reason why this should not work, but the default tolerance would need adjustment.
5+
6+
These majority of these functions have been used and described in https://doi.org/10.1093/mam/ozae104,
7+
with the exception of the ones written in polar co-ordinates (which are still to be used in published work).
58
"""
69

710
import numpy as np

0 commit comments

Comments
 (0)