From ffc4c9e1c1b1c70756435abb27d4f3fa5e37540e Mon Sep 17 00:00:00 2001 From: maclariz Date: Tue, 8 Apr 2025 09:42:40 +0100 Subject: [PATCH 1/2] Update digital_dark_field.py Adding to introductory docstring to give the publication reference --- py4DSTEM/process/diffraction/digital_dark_field.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/py4DSTEM/process/diffraction/digital_dark_field.py b/py4DSTEM/process/diffraction/digital_dark_field.py index cbf2778f4..de52aa0c3 100644 --- a/py4DSTEM/process/diffraction/digital_dark_field.py +++ b/py4DSTEM/process/diffraction/digital_dark_field.py @@ -2,6 +2,9 @@ A general note on all these functions is that they are designed for use with rotation calibration into the pointslist. However, they have to date only been used with the Qx and Qy in pixels and not calibrated into reciprocal units. There is no reason why this should not work, but the default tolerance would need adjustment. + +These majority of these functions have been used and described in https://doi.org/10.1093/mam/ozae104, +with the exception of the ones written in polar co-ordinates (which are still to be used in published work). """ import numpy as np From 31baf1bdfde7744de80e8fae416e71ed2f65c429 Mon Sep 17 00:00:00 2001 From: Steven Zeltmann Date: Tue, 8 Apr 2025 07:47:46 -0400 Subject: [PATCH 2/2] format with black --- py4DSTEM/process/diffraction/digital_dark_field.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/py4DSTEM/process/diffraction/digital_dark_field.py b/py4DSTEM/process/diffraction/digital_dark_field.py index de52aa0c3..8e60c7a8e 100644 --- a/py4DSTEM/process/diffraction/digital_dark_field.py +++ b/py4DSTEM/process/diffraction/digital_dark_field.py @@ -3,7 +3,7 @@ However, they have to date only been used with the Qx and Qy in pixels and not calibrated into reciprocal units. There is no reason why this should not work, but the default tolerance would need adjustment. -These majority of these functions have been used and described in https://doi.org/10.1093/mam/ozae104, +These majority of these functions have been used and described in https://doi.org/10.1093/mam/ozae104, with the exception of the ones written in polar co-ordinates (which are still to be used in published work). """