From 3aa6b488969581575e05584833bd5fc1986ba97f Mon Sep 17 00:00:00 2001 From: maclariz Date: Tue, 18 Nov 2025 11:49:09 +0000 Subject: [PATCH] DDF Tutorial 01 update Minor corrections to Markdown at top --- .../digital_dark_field_01_two_phase_titanium.ipynb | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/notebooks/digital_dark_field_01_two_phase_titanium.ipynb b/notebooks/digital_dark_field_01_two_phase_titanium.ipynb index d68441e..be7bd77 100644 --- a/notebooks/digital_dark_field_01_two_phase_titanium.ipynb +++ b/notebooks/digital_dark_field_01_two_phase_titanium.ipynb @@ -7,9 +7,11 @@ "tags": [] }, "source": [ - "# Virtual Dark Field Imaging - Ti550\n", + "# Digital Dark Field Imaging Tutorial 01 - two-phase titanium\n", "\n", - "This notebook performs virtual dark field (VDF) mapping of a SPED dataset of a Ti550 specimen taken by Dr Ian MacLaren Dr Enrique Frutos-Myro.\n", + "This notebook demonstrates digital dark field (VDF) mapping of a SPED dataset of a Ti550 specimen taken by Dr Ian MacLaren and Dr Enrique Frutos-Myro. Specifically, it demonstrates DDF imaging using\n", + "1. Diffraction peak positions from one position in the dataset to form the aperture array\n", + "2. Aperture arrays made from two basis vectors determined using the *strain* module\n", "\n", "## Data\n", "This is a real SPED dataset from a sample provided by Timet\n", @@ -18,13 +20,19 @@ "The notebook uses the bragg_peaks in the file at:\n", "https://drive.google.com/file/d/12AO5SKkH84Q6oGxTMN1vE8gpd2PGYMsS/view\n", "\n", + "The data shown in this was originally published at https://doi.org/10.1111/jmi.13275\n", + "\n", "## Acknowlegements\n", "\n", "This notebook was made Ian MacLaren. Contact ian.maclaren@glasgow.ac.uk with any questions.\n", "\n", "### Versioning\n", "\n", - "Last updated on 2025-11-13 with the current dev version of py4DSTEM v.0.14.19. It is essential that you upgrade to the dev version from this date or any subsequent version for this to run. Otherwise, digital_dark_field is missing one function definition for filter_by_position." + "Last updated on 2025-11-18 with the current dev version of py4DSTEM v.0.14.19. It is essential that you upgrade to the dev version from this 2025-11-13 onwards or any subsequent numbered release for this to run. \n", + "\n", + "(e.g. pip install git+https://github.com/py4dstem/py4DSTEM.git#dev --upgrade)\n", + "\n", + "Otherwise, digital_dark_field is missing one function definition for filter_by_position." ] }, {