Specify off-axis holography

Co-authored-by: Jonas Lähnemann <[email protected]>
hyperspy · Aug 30, 2023 · 5d04ee4 · 5d04ee4
1 parent 0d4b4b8
commit 5d04ee4
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 
 HoloSpy is a Python package extending the functionality for multi-dimensional
 data analysis provided by the [HyperSpy](https://hyperspy.org) library. It is
-aimed at helping with the analysis of electron holography data.
+aimed at helping with the analysis of (off-axis) electron holography data.
 
 Go to the documentation for instructions on how to install HoloSpy and start an
 analysis: [Read the docs](https://holospy.readthedocs.io).

diff --git a/doc/index.rst b/doc/index.rst
@@ -2,7 +2,7 @@ Welcome to HoloSpy's documentation!
 ***********************************
 **HoloSpy** is a Python package extending the functionality for multi-dimensional
 data analysis provided by the `HyperSpy <https://hyperspy.org/>`_ library. It is
-aimed at helping with the analysis of electron holography data.
+aimed at helping with the analysis of (off-axis) electron holography data.
 
 Check out the :ref:`installation` section for further information, including
 how to start using this project.

diff --git a/doc/user_guide/electron_holography.rst b/doc/user_guide/electron_holography.rst
@@ -4,7 +4,7 @@ Electron Holography
 *******************
 
 HoloSpy provides the user with a signal class which can be used to process
-electron holography data:
+(off-axis) electron holography data:
 
 * :py:class:`~.signals.hologram_image.HologramImage`
 

diff --git a/doc/user_guide/metadata_structure.rst b/doc/user_guide/metadata_structure.rst
@@ -23,7 +23,7 @@ Besides directly accessing the metadata tree structure, e.g.
 can be used to add to, search for and read from items in the metadata tree,
 respectively.
 
-The holography specific metadata structure is represented in the following
+The holography-specific metadata structure is represented in the following
 tree diagram. The default units are given in parentheses. Details about the
 leaves can be found in the following sections of this chapter. Note that not
 all types of leaves will apply to every type of measurement.