From d78e2f3505d02699db4ac82862efecbb7696221c Mon Sep 17 00:00:00 2001
From: "github-actions[bot]" <github-actions[bot]@users.noreply.github.com>
Date: Mon, 1 Apr 2024 22:09:49 +0000
Subject: [PATCH] Update docs build

---
 changes.html   | 6 +++---
 searchindex.js | 2 +-
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/changes.html b/changes.html
index 4ae5bef..8628f2c 100644
--- a/changes.html
+++ b/changes.html
@@ -415,8 +415,8 @@
 <h1>Release Notes<a class="headerlink" href="#release-notes" title="Link to this heading">#</a></h1>
 <p>Changelog entries for the development version are available at
 <a class="reference external" href="https://holospy.readthedocs.io/en/latest/changes.html">https://holospy.readthedocs.io/en/latest/changes.html</a></p>
-<section id="release-unreleased-2024-03-31">
-<h2> [UNRELEASED] (2024-03-31)<a class="headerlink" href="#release-unreleased-2024-03-31" title="Link to this heading">#</a></h2>
+<section id="release-unreleased-2024-04-01">
+<h2> [UNRELEASED] (2024-04-01)<a class="headerlink" href="#release-unreleased-2024-04-01" title="Link to this heading">#</a></h2>
 <section id="improved-documentation">
 <h3>Improved Documentation<a class="headerlink" href="#improved-documentation" title="Link to this heading">#</a></h3>
 <ul class="simple">
@@ -510,7 +510,7 @@ <h2>Initiation (2023-07-23)<a class="headerlink" href="#initiation-2023-07-23" t
   </div>
   <nav class="bd-toc-nav page-toc" aria-labelledby="pst-page-navigation-heading-2">
     <ul class="visible nav section-nav flex-column">
-<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#release-unreleased-2024-03-31"> [UNRELEASED] (2024-03-31)</a><ul class="nav section-nav flex-column">
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#release-unreleased-2024-04-01"> [UNRELEASED] (2024-04-01)</a><ul class="nav section-nav flex-column">
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#improved-documentation">Improved Documentation</a></li>
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#maintenance">Maintenance</a></li>
 </ul>
diff --git a/searchindex.js b/searchindex.js
index 8e72902..642062d 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["api/data", "api/index", "api/reconstruct", "api/signals", "api/tools", "changes", "contributing", "index", "intro", "user_guide/bibliography", "user_guide/electron_holography", "user_guide/index", "user_guide/installation", "user_guide/metadata_structure"], "filenames": ["api/data.rst", "api/index.rst", "api/reconstruct.rst", "api/signals.rst", "api/tools.rst", "changes.rst", "contributing.rst", "index.rst", "intro.rst", "user_guide/bibliography.rst", "user_guide/electron_holography.rst", "user_guide/index.rst", "user_guide/installation.rst", "user_guide/metadata_structure.rst"], "titles": ["<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">holospy.data</span></code>", "Reference", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">holospy.reconstruct</span></code>", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">holospy.signals.hologram_image</span></code>", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">holospy.tools</span></code>", "Release Notes", "Contributing", "Welcome to HoloSpy\u2019s documentation!", "Welcome to HoloSpy\u2019s documentation!", "Bibliography", "Electron Holography", "User Guide", "Installation", "HoloSpy metadata structure"], "terms": {"fe_needle_hologram": [0, 1, 3, 10], "load": [0, 12], "an": [0, 3, 7, 8, 10, 12, 13], "object": [0, 3, 10, 13], "hologram": [0, 2, 3, 4, 11, 13], "imag": [0, 2, 3, 9, 10], "note": [0, 7, 8, 10, 13], "sampl": [0, 2, 3, 10, 11], "fe": 0, "needl": 0, "yox": 0, "nanoparticl": 0, "inclus": 0, "see": [0, 3, 7, 8, 10, 13], "refer": [0, 2, 3, 4, 6, 7, 8, 10, 12, 13], "more": [0, 6, 7, 8, 12], "detail": [0, 3, 6, 7, 8, 10, 12, 13], "migunov": 0, "v": [0, 13], "et": 0, "al": 0, "model": 0, "independ": [0, 12], "measur": [0, 5, 13], "charg": 0, "densiti": 0, "distribut": [0, 7, 8, 12], "along": [0, 7, 8], "atom": 0, "probe": 0, "us": [0, 2, 3, 4, 5, 6, 7, 8, 10, 11, 13], "off": [0, 3, 7, 8, 10, 13], "axi": [0, 3, 7, 8, 10, 13], "electron": [0, 2, 3, 5, 7, 8, 9, 11, 13], "holographi": [0, 3, 5, 7, 8, 9, 11, 13], "without": [0, 3, 7, 8, 10], "mean": [0, 3, 10], "inner": 0, "potenti": 0, "effect": [0, 10], "j": 0, "appl": 0, "phy": 0, "117": 0, "134301": 0, "2015": 0, "http": [0, 5, 9], "doi": [0, 7, 8, 9], "org": [0, 9], "10": [0, 3, 5, 9], "1063": 0, "1": [0, 2, 3, 9, 10], "4916609": 0, "tem": [0, 3, 11], "fei": 0, "titan": 0, "g2": 0, "60": 0, "300": [0, 3], "holo": [0, 3, 10], "boothroyd": 0, "c": [0, 12], "journal": 0, "larg": 0, "scale": [0, 4], "research": 0, "facil": 0, "jlsrf": 0, "2": [0, 2, 3, 5, 7, 8, 9, 10], "44": 0, "2016": 0, "17815": 0, "70": 0, "signal": [0, 1, 10, 11], "i": [0, 2, 3, 4, 6, 7, 8, 10, 12, 13], "read": [0, 6, 7, 8, 13], "onli": [0, 3, 10, 12, 13], "ensur": [0, 6], "access": [0, 10, 13], "regardless": 0, "instal": [0, 7, 8, 11], "locat": [0, 2, 3], "fe_needle_reference_hologram": [0, 1, 3, 10], "holospi": [1, 5, 6, 10, 11, 12], "data": [1, 2, 3, 4, 7, 8, 10], "reconstruct": [1, 3, 11], "aperture_funct": [1, 2], "estimate_sideband_posit": [1, 2, 3, 10], "estimate_sideband_s": [1, 2, 3, 10], "freq_arrai": [1, 2], "hologram_imag": 1, "hologramimag": [1, 3, 10], "lazyhologramimag": [1, 3], "tool": [1, 10], "calculate_carrier_frequ": [1, 4], "estimate_fringe_contrast_fouri": [1, 4], "r": [2, 9], "apradiu": 2, "rsmooth": 2, "A": [2, 9, 10], "smooth": [2, 3, 10], "apertur": [2, 3, 13], "function": [2, 5, 6, 7, 8, 10], "decai": 2, "from": [2, 3, 5, 10, 12, 13], "paramet": [2, 3, 4, 7, 8, 10, 13], "ndarrai": [2, 3, 4], "arrai": [2, 3], "input": [2, 3], "e": [2, 3, 10, 13], "g": [2, 13], "frequenc": [2, 3, 4, 10], "float": [2, 3, 4, 13], "radiu": [2, 3, 10], "center": [2, 3, 10], "start": [2, 6, 7, 8], "halfwidth": 2, "caus": [2, 10], "0": [2, 3, 7, 8, 10], "over": 2, "pixel": [2, 3, 4, 10], "holo_data": [2, 4], "holo_sampl": 2, "central_band_mask_radiu": 2, "none": [2, 3, 4, 10], "sb": [2, 3, 10], "lower": [2, 3, 10], "high_cf": [2, 3], "true": [2, 3, 10], "find": [2, 7, 8, 10, 12], "posit": [2, 3, 4, 10, 13], "sideband": [2, 3, 4, 10], "return": [2, 3, 4, 10], "its": [2, 3, 7, 8, 10, 13], "The": [2, 3, 4, 5, 6, 7, 8, 10, 13], "tupl": [2, 3, 4], "rate": 2, "both": [2, 10], "direct": 2, "option": [2, 3, 7, 8, 10, 12], "mask": [2, 3], "out": [2, 3, 5, 6, 7, 8], "centerband": [2, 3], "str": [2, 3, 13], "choos": [2, 3], "which": [2, 3, 4, 7, 8, 10, 13], "taken": [2, 3], "upper": [2, 3, 10], "left": [2, 3], "right": [2, 3], "bool": [2, 3], "If": [2, 3, 6, 7, 8, 12], "fals": [2, 3, 10], "highest": [2, 3], "carrier": [2, 3, 4, 10], "allow": [2, 3], "equal": [2, 3], "half": [2, 3, 10], "nyquist": [2, 3], "default": [2, 3, 4, 10, 13], "type": [2, 3, 4, 6, 13], "y": [2, 3, 9, 10, 12], "x": [2, 3, 9, 10], "unshift": [2, 3], "fft": [2, 3, 4, 10], "sb_posit": [2, 3, 4, 10], "holo_shap": 2, "sb_size_ratio": 2, "5": [2, 10], "estim": [2, 3, 4, 10], "size": [2, 3, 10], "filter": [2, 10], "array_lik": 2, "holograph": 2, "non": [2, 3, 4], "shift": [2, 3, 4], "fraction": [2, 10], "distanc": [2, 3, 10], "central": [2, 3, 10], "band": [2, 3, 10], "sb_size": [2, 3, 10], "shape": [2, 3, 10], "make": [2, 6], "up": 2, "sb_smooth": [2, 3, 10], "output_shap": [2, 3, 10], "plot": [2, 3, 10], "core": 2, "new": [2, 3, 7, 8, 9], "output": [2, 3, 6, 10], "wav": 2, "wave": [2, 3, 11], "nparrai": [2, 10], "class": [3, 10, 13], "arg": 3, "kwarg": 3, "acquir": 3, "via": [3, 6], "ap_cb_radiu": [3, 10], "show_progressbar": 3, "num_work": [3, 5], "displai": [3, 10], "progress": 3, "bar": 3, "prefer": 3, "set": [3, 5, 10], "int": [3, 10], "number": [3, 6], "worker": 3, "dask": 3, "valu": [3, 6, 10], "signal1d": 3, "instanc": 3, "rais": 3, "notimplementederror": 3, "ax": [3, 4], "ar": [3, 5, 6, 7, 8, 10, 12, 13], "uniform": 3, "exampl": [3, 6, 10], "import": [3, 6, 10], "": [3, 4, 9, 10, 13], "124": 3, "452": 3, "basesign": 3, "68": 3, "87670143": 3, "reconstruct_phas": [3, 10], "sb_unit": [3, 10], "store_paramet": 3, "oper": [3, 12], "multidimension": 3, "hyperspi": [3, 5, 6, 7, 8, 10, 12, 13], "There": [3, 7, 8, 10], "sever": 3, "usag": [3, 7, 8, 10], "scheme": 3, "1d": 3, "nd": 3, "singl": [3, 10], "appli": [3, 4, 10, 13], "each": [3, 6, 10], "stack": [3, 10], "have": [3, 7, 8, 10, 12], "same": [3, 10, 13], "dimension": [3, 7, 8], "signal2d": [3, 10], "vacuum": [3, 10], "correspond": 3, "unit": [3, 10, 13], "3": [3, 5, 7, 8, 9, 10], "between": [3, 6, 10], "two": 3, "given": [3, 13], "nm": [3, 10], "mrad": [3, 10], "select": [3, 10, 13], "determin": 3, "automat": [3, 10, 12], "should": [3, 6, 10], "larger": 3, "than": [3, 10], "show": 3, "store": [3, 13], "metadata": [3, 5, 7, 8, 11], "By": [3, 10, 13], "divid": [3, 4], "complexsignal2d": [3, 10], "set_microscope_paramet": 3, "beam_energi": 3, "biprism_voltag": 3, "tilt_stag": 3, "microscop": [3, 9, 13], "argument": [3, 5], "interact": 3, "mode": 3, "fill": 3, "energi": 3, "beam": 3, "kev": 3, "In": [3, 6, 10], "volt": [3, 13], "degre": [3, 13], "print": 3, "now": [3, 12], "acquisition_instru": [3, 13], "statist": [3, 11], "fringe_contrast_algorithm": [3, 10], "apod": [3, 4, 10], "han": [3, 4, 10], "single_valu": [3, 10], "calcul": [3, 4, 10], "follow": [3, 6, 10, 12, 13], "fring": [3, 4, 10], "contrast": [3, 4, 10], "either": [3, 7, 8, 10], "definit": 3, "fourier": [3, 10], "space": [3, 4, 10], "approach": 3, "descript": [3, 10], "calibr": [3, 10], "4": [3, 5, 9], "radian": [3, 10], "px": 3, "It": [3, 7, 8, 10], "ha": [3, 7, 8, 13], "algorithm": [3, 10], "k_0": 3, "where": 3, "intens": [3, 10], "origin": [3, 4, 7, 8, 10], "thi": [3, 7, 8, 10, 13], "method": [3, 6, 10, 13], "deliv": 3, "also": [3, 6, 10, 12], "reason": [3, 10], "interfer": 3, "pattern": [3, 10], "do": [3, 12], "cover": [3, 10], "full": 3, "field": [3, 10, 13], "view": [3, 10], "standard": [3, 6, 10], "deviat": [3, 10], "real": [3, 4, 10], "reli": 3, "regularli": 3, "entir": [3, 10], "ham": [3, 4, 10], "window": [3, 4, 10], "befor": [3, 4, 6], "typic": [3, 4, 6, 10], "need": [3, 4, 6], "suppress": [3, 4], "strike": [3, 4], "due": [3, 4, 10], "sharp": [3, 4], "edg": [3, 4, 10], "often": [3, 4, 10], "result": [3, 4, 6], "underestim": [3, 4, 10], "first": [3, 10], "navig": [3, 10], "dictionari": [3, 10], "statistics_dict": 3, "4860442674236256": 3, "26383819985575441": 3, "56475154609203482": 3, "071298357213623778": 3, "7902017241882331": 3, "28685808994016415": 3, "lazi": 3, "comput": 3, "delai": 3, "until": 3, "explicitli": 3, "request": 3, "expect": 3, "instanti": 3, "directli": [3, 13], "instead": 3, "da": 3, "ones": [3, 13], "h": 3, "as_lazi": 3, "averag": 4, "amplitud": [4, 10], "maximum": [4, 10], "string": [4, 13], "changelog": 5, "entri": [5, 10], "develop": [5, 6, 7, 8, 12], "version": [5, 7, 8, 12], "avail": 5, "readthedoc": 5, "io": 5, "en": 5, "latest": 5, "chang": [5, 6, 7, 8, 10], "html": 5, "add": [5, 13], "logo": 5, "26": 5, "ruff": 5, "lint": 5, "format": 5, "check": [5, 7, 8, 12], "npy2011": 5, "28": 5, "numpi": [5, 6], "25": 5, "deprec": 5, "29": 5, "get": [5, 6, 7, 8, 11], "16": 5, "towncrier": 5, "manag": 5, "dev": 5, "17": 5, "pre": 5, "commit": 5, "configur": 5, "file": 5, "code": 5, "black": [5, 6], "workflow": [5, 6], "github": [5, 6, 12], "test": 5, "build": 5, "packag": [5, 6, 7, 8, 11], "renam": 5, "max_work": 5, "9": 5, "setup": 5, "codecov": 5, "coverag": 5, "badg": [5, 7, 8], "doc": [5, 6], "push": [5, 6], "13": 5, "consolid": 5, "pyproject": 5, "toml": 5, "14": [5, 9], "setuptools_scm": 5, "time": 5, "python": [5, 6, 7, 8, 12], "wa": 5, "split": [5, 7, 8], "repositori": [5, 6, 12], "juli": 5, "so": 5, "far": 5, "were": 5, "move": 5, "meant": 6, "commun": [6, 7, 8], "maintain": [6, 7, 8], "project": [6, 7, 8], "we": [6, 12], "welcom": 6, "form": [6, 7, 8], "bug": 6, "report": 6, "featur": [6, 7, 8], "some": [6, 10], "resourc": 6, "help": [6, 7, 8], "you": [6, 7, 8, 12], "tracker": 6, "can": [6, 7, 8, 10, 12, 13], "propos": 6, "when": [6, 13], "give": [6, 10], "minim": 6, "demonstr": 6, "copi": 6, "past": 6, "error": 6, "traceback": 6, "want": [6, 12], "sourc": [6, 7, 8], "send": 6, "u": 6, "small": 6, "fix": 6, "correct": 6, "user": [6, 7, 8, 10, 12], "guid": [6, 7, 8, 12], "good": 6, "point": 6, "But": 6, "don": 6, "t": [6, 9], "hesit": 6, "signific": [6, 7, 8], "ll": 6, "readi": 6, "common": 6, "pleas": [6, 7, 8, 10, 12], "order": 6, "guidelin": [6, 7, 8], "kikuchipi": 6, "contributor": 6, "anoth": 6, "extens": 6, "valuabl": 6, "provid": [6, 7, 8, 10], "As": 6, "qualiti": [6, 10], "assur": 6, "improv": 6, "gener": [6, 7, 8, 11], "thoroughli": 6, "least": 6, "one": [6, 10, 12], "other": [6, 7, 8, 10, 12], "member": 6, "team": 6, "being": 6, "merg": 6, "consist": 6, "three": 6, "element": 6, "docstr": 6, "individu": 6, "written": 6, "sphinx": 6, "host": 6, "part": [6, 7, 8, 10], "jupyt": [6, 7, 8, 12], "notebook": [6, 7, 8, 12], "demo": 6, "tutori": [6, 7, 8], "alwai": 6, "wai": [6, 7, 8, 10], "learn": 6, "through": 6, "respect": [6, 10, 13], "For": [6, 10], "numpydoc": 6, "structur": [6, 11], "block": 6, "blank": 6, "line": 6, "them": 6, "librari": [6, 7, 8, 12], "like": [6, 10], "o": 6, "third": 6, "parti": 6, "final": 6, "all": [6, 10, 12, 13], "pytest": 6, "framework": 6, "resid": 6, "directori": 6, "short": 6, "call": [6, 10], "compar": 6, "known": 6, "answer": 6, "further": [6, 7, 8, 11], "inform": [6, 7, 8, 10], "semant": 6, "therefor": [6, 10], "major": 6, "minor": 6, "patch": 6, "depend": [6, 10, 12], "accord": 6, "increas": 6, "incompat": 6, "api": [6, 7, 8, 10], "ad": [6, 10], "backward": 6, "compat": 6, "manner": 6, "process": [6, 7, 8, 11], "pypi": [6, 12], "conda": [6, 11], "forg": [6, 12], "extend": [7, 8, 13], "multi": [7, 8], "analysi": [7, 8], "aim": [7, 8], "domain": [7, 8], "specif": [7, 8, 13], "been": [7, 8], "dedic": [7, 8], "releas": [7, 8, 12], "section": [7, 8, 10, 12, 13], "includ": [7, 8, 10, 12], "how": [7, 8], "open": [7, 8, 12], "everyon": [7, 8], "contribut": [7, 8], "our": [7, 8], "ecosystem": [7, 8], "introduct": [7, 8], "basic": [7, 8], "depth": [7, 8], "kei": [7, 8], "concept": [7, 8], "background": [7, 8], "explan": [7, 8], "applic": [7, 8], "progam": [7, 8], "interfac": [7, 8], "describ": [7, 8, 10, 13], "work": [7, 8, 12], "whole": [7, 8], "mani": [7, 8, 10], "To": [7, 8, 10, 12], "about": [7, 8, 12, 13], "recent": [7, 8, 10], "lead": [7, 8, 10], "academ": [7, 8], "public": [7, 8], "acknowledg": [7, 8], "fact": [7, 8], "below": [7, 8], "becaus": [7, 8], "emploi": [7, 8], "click": [7, 8], "free": [7, 8], "softwar": [7, 8], "redistribut": [7, 8], "modifi": [7, 8], "under": [7, 8], "term": [7, 8], "gnu": [7, 8], "gpl": [7, 8], "publish": [7, 8], "foundat": [7, 8], "your": [7, 8], "ani": [7, 8, 10, 13], "later": [7, 8], "hope": [7, 8], "warranti": [7, 8], "even": [7, 8, 10], "impli": [7, 8], "merchant": [7, 8], "fit": [7, 8], "particular": [7, 8, 10], "purpos": [7, 8], "gabor1948": [9, 10], "d": 9, "gabor": 9, "principl": 9, "natur": 9, "161": 9, "1948": 9, "777": 9, "778": 9, "1038": 9, "161777a0": 9, "joy1993": [9, 10], "joi": 9, "zhang": 9, "hashimoto": 9, "bunn": 9, "l": 9, "allard": 9, "nolan": 9, "practic": 9, "aspect": 9, "ultramicroscopi": 9, "51": 9, "1993": 9, "1016": 9, "0304": 9, "3991": 9, "93": 9, "90130": 9, "p": 9, "mccartney2007": [9, 10], "m": 9, "mccartnei": 9, "smith": 9, "phase": [9, 11], "nanomet": [9, 10], "resolut": 9, "annu": 9, "rev": 9, "mater": 9, "re": 9, "37": 9, "2007": 9, "729": 9, "767": 9, "onlinelibrari": 9, "wilei": 9, "com": 9, "1146": 9, "annurev": 9, "matsci": 9, "052506": 9, "084219": 9, "tonomura1999": [9, 10], "tonomura": 9, "springer": 9, "berlin": 9, "heidelberg": 9, "1999": 9, "78": 9, "132": 9, "1007": 9, "978": 9, "540": 9, "37204": 9, "inherit": 10, "_signal": 10, "thu": 10, "explain": 10, "transform": 10, "subclass": 10, "im": 10, "set_signal_typ": 10, "found": [10, 13], "literatur": 10, "base": [10, 12], "side": 10, "isol": 10, "invers": 10, "perform": 10, "complex_signal2d": 10, "contain": [10, 13], "take": 10, "dataset": 10, "wave_imag": 10, "sb_radiu": 10, "search": [10, 13], "exclud": 10, "middl": 10, "area": [10, 13], "defin": 10, "commonli": 10, "strong": 10, "altern": [10, 12], "recalcul": 10, "weak": 10, "reference_hologram": 10, "unwrap": 10, "properti": 10, "complexsign": 10, "unwrapped_phas": 10, "addition": 10, "possibl": 10, "desir": 10, "rather": 10, "milliradian": 10, "30": 10, "05": 10, "preserv": 10, "though": 10, "oversampl": 10, "sinc": 10, "limit": 10, "avoid": 10, "diamet": 10, "out_siz": 10, "assign": 10, "howev": 10, "recommend": [10, 12], "experienc": 10, "onc": 10, "explor": 10, "argand": 10, "argand_diagram": 10, "display_rang": 10, "scalebar": 10, "diagram": [10, 13], "list": 10, "abov": [10, 12], "differ": 10, "well": 10, "divis": 10, "twice": 10, "centr": 10, "requir": [10, 12], "highli": 10, "sensit": 10, "artifact": 10, "dud": 10, "fresnel": 10, "etc": 10, "second": 10, "less": 10, "precis": 10, "sometim": 10, "mai": 10, "done": 10, "forc": 10, "otherwis": [10, 13], "prior": 10, "experiment": 10, "condit": 10, "especi": [10, 12], "extrem": 10, "variat": 10, "strongli": 10, "document": [10, 12, 13], "pip": 11, "updat": 11, "complex": 11, "acquisit": 11, "instrument": 11, "bibliographi": 11, "system": 12, "bundl": 12, "standalon": 12, "program": 12, "relev": 12, "anyth": 12, "els": 12, "appropri": 12, "replac": 12, "step": 12, "suggest": 12, "miniforg": 12, "alreadi": 12, "prompt": 12, "run": 12, "command": 12, "n": 12, "activ": 12, "complet": 12, "next": 12, "troubl": 12, "unfamiliar": 12, "enter": 12, "anaconda": 12, "scratch": 12, "jupyterlab": 12, "lab": 12, "index": 12, "upgrad": 12, "notifi": 12, "watch": 12, "account": 12, "convent": 13, "attribut": 13, "tree": 13, "node": 13, "label": 13, "capit": 13, "leav": 13, "leaf": 13, "quantiti": 13, "dimensionless": 13, "extra": 13, "_unit": 13, "suffix": 13, "besid": 13, "signal_typ": 13, "set_item": 13, "has_item": 13, "get_item": 13, "item": 13, "repres": 13, "parenthes": 13, "chapter": 13, "everi": 13, "azimuth_angl": 13, "\u00ba": 13, "voltag": 13, "current": 13, "addit": 13, "rotat": 13, "angl": 13, "column": 13, "plane": 13, "electrostat": 13, "exspi": 13}, "objects": {"holospy": [[0, 0, 0, "-", "data"], [2, 0, 0, "-", "reconstruct"], [4, 0, 0, "-", "tools"]], "holospy.data": [[0, 1, 1, "", "Fe_needle_hologram"], [0, 1, 1, "", "Fe_needle_reference_hologram"]], "holospy.reconstruct": [[2, 1, 1, "", "aperture_function"], [2, 1, 1, "", "estimate_sideband_position"], [2, 1, 1, "", "estimate_sideband_size"], [2, 1, 1, "", "freq_array"], [2, 1, 1, "", "reconstruct"]], "holospy.signals": [[3, 0, 0, "-", "hologram_image"]], "holospy.signals.hologram_image": [[3, 2, 1, "", "HologramImage"], [3, 2, 1, "", "LazyHologramImage"]], "holospy.signals.hologram_image.HologramImage": [[3, 3, 1, "", "estimate_sideband_position"], [3, 3, 1, "", "estimate_sideband_size"], [3, 3, 1, "", "reconstruct_phase"], [3, 3, 1, "", "set_microscope_parameters"], [3, 3, 1, "", "statistics"]], "holospy.tools": [[4, 1, 1, "", "calculate_carrier_frequency"], [4, 1, 1, "", "estimate_fringe_contrast_fourier"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:method"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "method", "Python method"]}, "titleterms": {"holospi": [0, 2, 3, 4, 7, 8, 13], "data": 0, "refer": 1, "api": 1, "reconstruct": [2, 10], "signal": [3, 13], "hologram_imag": 3, "tool": 4, "releas": [5, 6], "note": 5, "unreleas": 5, "2024": 5, "03": 5, "31": 5, "improv": 5, "document": [5, 6, 7, 8], "mainten": 5, "0": 5, "1": [5, 12], "2023": 5, "12": 5, "02": 5, "bug": 5, "fix": 5, "11": 5, "15": 5, "initi": 5, "07": 5, "23": 5, "contribut": 6, "issu": 6, "pull": 6, "request": 6, "review": 6, "code": 6, "style": 6, "write": 6, "test": 6, "new": [6, 12], "version": 6, "welcom": [7, 8], "": [7, 8], "learn": [7, 8], "resourc": [7, 8], "cite": [7, 8], "licens": [7, 8], "bibliographi": 9, "electron": 10, "holographi": 10, "hologram": 10, "further": 10, "process": 10, "complex": 10, "wave": 10, "phase": 10, "get": [10, 12], "statist": 10, "user": 11, "guid": 11, "instal": 12, "us": 12, "conda": 12, "creat": 12, "environ": 12, "2": 12, "packag": 12, "3": 12, "start": 12, "pip": 12, "updat": 12, "metadata": 13, "structur": 13, "gener": 13, "sampl": 13, "acquisit": 13, "instrument": 13, "tem": 13, "biprism": 13}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx": 60}, "alltitles": {"holospy.data": [[0, "module-holospy.data"]], "Reference": [[1, "reference"]], "API Reference": [[1, null]], "holospy.reconstruct": [[2, "module-holospy.reconstruct"]], "holospy.signals.hologram_image": [[3, "module-holospy.signals.hologram_image"]], "holospy.tools": [[4, "module-holospy.tools"]], "Release Notes": [[5, "release-notes"]], " [UNRELEASED] (2024-03-31)": [[5, "release-unreleased-2024-03-31"]], "Improved Documentation": [[5, "improved-documentation"]], "Maintenance": [[5, "maintenance"], [5, "id6"]], "0.1.1 (2023-12-02)": [[5, "id4"]], "Bug Fixes": [[5, "bug-fixes"]], "0.1 (2023-11-15)": [[5, "changes-0-1"]], "Initiation (2023-07-23)": [[5, "initiation-2023-07-23"]], "Contributing": [[6, "contributing"]], "Issues": [[6, "issues"]], "Pull Requests": [[6, "pull-requests"]], "Reviewing": [[6, "reviewing"]], "Documentation": [[6, "documentation"]], "Code style": [[6, "code-style"]], "Writing tests": [[6, "writing-tests"]], "Releasing a new version": [[6, "releasing-a-new-version"]], "Welcome to HoloSpy\u2019s documentation!": [[7, "welcome-to-holospy-s-documentation"], [8, "welcome-to-holospy-s-documentation"]], "Learning resources": [[7, "learning-resources"], [8, "learning-resources"]], "Citing HoloSpy": [[7, "citing-holospy"], [8, "citing-holospy"]], "License": [[7, "license"], [8, "license"]], "Bibliography": [[9, "bibliography"]], "Electron Holography": [[10, "electron-holography"]], "Reconstruction of holograms": [[10, "reconstruction-of-holograms"]], "Further processing of complex wave and phase": [[10, "further-processing-of-complex-wave-and-phase"]], "Getting hologram statistics": [[10, "getting-hologram-statistics"]], "User Guide": [[11, "user-guide"], [11, null]], "Installation": [[12, "installation"]], "Installation using conda": [[12, "installation-using-conda"]], "1. Creating a conda environment": [[12, "creating-a-conda-environment"]], "2. Installing the package in the new environment": [[12, "installing-the-package-in-the-new-environment"]], "3. Getting Started": [[12, "getting-started"]], "Installation using pip": [[12, "installation-using-pip"]], "Updating the package": [[12, "updating-the-package"]], "HoloSpy metadata structure": [[13, "holospy-metadata-structure"]], "General": [[13, "general"]], "Sample": [[13, "sample"]], "Signal": [[13, "signal"]], "Acquisition Instrument": [[13, "acquisition-instrument"]], "TEM": [[13, "tem"]], "Biprism": [[13, "biprism"]]}, "indexentries": {"fe_needle_hologram() (in module holospy.data)": [[0, "holospy.data.Fe_needle_hologram"]], "fe_needle_reference_hologram() (in module holospy.data)": [[0, "holospy.data.Fe_needle_reference_hologram"]], "holospy.data": [[0, "module-holospy.data"]], "module": [[0, "module-holospy.data"], [2, "module-holospy.reconstruct"], [3, "module-holospy.signals.hologram_image"], [4, "module-holospy.tools"]], "aperture_function() (in module holospy.reconstruct)": [[2, "holospy.reconstruct.aperture_function"]], "estimate_sideband_position() (in module holospy.reconstruct)": [[2, "holospy.reconstruct.estimate_sideband_position"]], "estimate_sideband_size() (in module holospy.reconstruct)": [[2, "holospy.reconstruct.estimate_sideband_size"]], "freq_array() (in module holospy.reconstruct)": [[2, "holospy.reconstruct.freq_array"]], "holospy.reconstruct": [[2, "module-holospy.reconstruct"]], "reconstruct() (in module holospy.reconstruct)": [[2, "holospy.reconstruct.reconstruct"]], "hologramimage (class in holospy.signals.hologram_image)": [[3, "holospy.signals.hologram_image.HologramImage"]], "lazyhologramimage (class in holospy.signals.hologram_image)": [[3, "holospy.signals.hologram_image.LazyHologramImage"]], "estimate_sideband_position() (holospy.signals.hologram_image.hologramimage method)": [[3, "holospy.signals.hologram_image.HologramImage.estimate_sideband_position"]], "estimate_sideband_size() (holospy.signals.hologram_image.hologramimage method)": [[3, "holospy.signals.hologram_image.HologramImage.estimate_sideband_size"]], "holospy.signals.hologram_image": [[3, "module-holospy.signals.hologram_image"]], "reconstruct_phase() (holospy.signals.hologram_image.hologramimage method)": [[3, "holospy.signals.hologram_image.HologramImage.reconstruct_phase"]], "set_microscope_parameters() (holospy.signals.hologram_image.hologramimage method)": [[3, "holospy.signals.hologram_image.HologramImage.set_microscope_parameters"]], "statistics() (holospy.signals.hologram_image.hologramimage method)": [[3, "holospy.signals.hologram_image.HologramImage.statistics"]], "calculate_carrier_frequency() (in module holospy.tools)": [[4, "holospy.tools.calculate_carrier_frequency"]], "estimate_fringe_contrast_fourier() (in module holospy.tools)": [[4, "holospy.tools.estimate_fringe_contrast_fourier"]], "holospy.tools": [[4, "module-holospy.tools"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["api/data", "api/index", "api/reconstruct", "api/signals", "api/tools", "changes", "contributing", "index", "intro", "user_guide/bibliography", "user_guide/electron_holography", "user_guide/index", "user_guide/installation", "user_guide/metadata_structure"], "filenames": ["api/data.rst", "api/index.rst", "api/reconstruct.rst", "api/signals.rst", "api/tools.rst", "changes.rst", "contributing.rst", "index.rst", "intro.rst", "user_guide/bibliography.rst", "user_guide/electron_holography.rst", "user_guide/index.rst", "user_guide/installation.rst", "user_guide/metadata_structure.rst"], "titles": ["<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">holospy.data</span></code>", "Reference", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">holospy.reconstruct</span></code>", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">holospy.signals.hologram_image</span></code>", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">holospy.tools</span></code>", "Release Notes", "Contributing", "Welcome to HoloSpy\u2019s documentation!", "Welcome to HoloSpy\u2019s documentation!", "Bibliography", "Electron Holography", "User Guide", "Installation", "HoloSpy metadata structure"], "terms": {"fe_needle_hologram": [0, 1, 3, 10], "load": [0, 12], "an": [0, 3, 7, 8, 10, 12, 13], "object": [0, 3, 10, 13], "hologram": [0, 2, 3, 4, 11, 13], "imag": [0, 2, 3, 9, 10], "note": [0, 7, 8, 10, 13], "sampl": [0, 2, 3, 10, 11], "fe": 0, "needl": 0, "yox": 0, "nanoparticl": 0, "inclus": 0, "see": [0, 3, 7, 8, 10, 13], "refer": [0, 2, 3, 4, 6, 7, 8, 10, 12, 13], "more": [0, 6, 7, 8, 12], "detail": [0, 3, 6, 7, 8, 10, 12, 13], "migunov": 0, "v": [0, 13], "et": 0, "al": 0, "model": 0, "independ": [0, 12], "measur": [0, 5, 13], "charg": 0, "densiti": 0, "distribut": [0, 7, 8, 12], "along": [0, 7, 8], "atom": 0, "probe": 0, "us": [0, 2, 3, 4, 5, 6, 7, 8, 10, 11, 13], "off": [0, 3, 7, 8, 10, 13], "axi": [0, 3, 7, 8, 10, 13], "electron": [0, 2, 3, 5, 7, 8, 9, 11, 13], "holographi": [0, 3, 5, 7, 8, 9, 11, 13], "without": [0, 3, 7, 8, 10], "mean": [0, 3, 10], "inner": 0, "potenti": 0, "effect": [0, 10], "j": 0, "appl": 0, "phy": 0, "117": 0, "134301": 0, "2015": 0, "http": [0, 5, 9], "doi": [0, 7, 8, 9], "org": [0, 9], "10": [0, 3, 5, 9], "1063": 0, "1": [0, 2, 3, 9, 10], "4916609": 0, "tem": [0, 3, 11], "fei": 0, "titan": 0, "g2": 0, "60": 0, "300": [0, 3], "holo": [0, 3, 10], "boothroyd": 0, "c": [0, 12], "journal": 0, "larg": 0, "scale": [0, 4], "research": 0, "facil": 0, "jlsrf": 0, "2": [0, 2, 3, 5, 7, 8, 9, 10], "44": 0, "2016": 0, "17815": 0, "70": 0, "signal": [0, 1, 10, 11], "i": [0, 2, 3, 4, 6, 7, 8, 10, 12, 13], "read": [0, 6, 7, 8, 13], "onli": [0, 3, 10, 12, 13], "ensur": [0, 6], "access": [0, 10, 13], "regardless": 0, "instal": [0, 7, 8, 11], "locat": [0, 2, 3], "fe_needle_reference_hologram": [0, 1, 3, 10], "holospi": [1, 5, 6, 10, 11, 12], "data": [1, 2, 3, 4, 7, 8, 10], "reconstruct": [1, 3, 11], "aperture_funct": [1, 2], "estimate_sideband_posit": [1, 2, 3, 10], "estimate_sideband_s": [1, 2, 3, 10], "freq_arrai": [1, 2], "hologram_imag": 1, "hologramimag": [1, 3, 10], "lazyhologramimag": [1, 3], "tool": [1, 10], "calculate_carrier_frequ": [1, 4], "estimate_fringe_contrast_fouri": [1, 4], "r": [2, 9], "apradiu": 2, "rsmooth": 2, "A": [2, 9, 10], "smooth": [2, 3, 10], "apertur": [2, 3, 13], "function": [2, 5, 6, 7, 8, 10], "decai": 2, "from": [2, 3, 5, 10, 12, 13], "paramet": [2, 3, 4, 7, 8, 10, 13], "ndarrai": [2, 3, 4], "arrai": [2, 3], "input": [2, 3], "e": [2, 3, 10, 13], "g": [2, 13], "frequenc": [2, 3, 4, 10], "float": [2, 3, 4, 13], "radiu": [2, 3, 10], "center": [2, 3, 10], "start": [2, 6, 7, 8], "halfwidth": 2, "caus": [2, 10], "0": [2, 3, 7, 8, 10], "over": 2, "pixel": [2, 3, 4, 10], "holo_data": [2, 4], "holo_sampl": 2, "central_band_mask_radiu": 2, "none": [2, 3, 4, 10], "sb": [2, 3, 10], "lower": [2, 3, 10], "high_cf": [2, 3], "true": [2, 3, 10], "find": [2, 7, 8, 10, 12], "posit": [2, 3, 4, 10, 13], "sideband": [2, 3, 4, 10], "return": [2, 3, 4, 10], "its": [2, 3, 7, 8, 10, 13], "The": [2, 3, 4, 5, 6, 7, 8, 10, 13], "tupl": [2, 3, 4], "rate": 2, "both": [2, 10], "direct": 2, "option": [2, 3, 7, 8, 10, 12], "mask": [2, 3], "out": [2, 3, 5, 6, 7, 8], "centerband": [2, 3], "str": [2, 3, 13], "choos": [2, 3], "which": [2, 3, 4, 7, 8, 10, 13], "taken": [2, 3], "upper": [2, 3, 10], "left": [2, 3], "right": [2, 3], "bool": [2, 3], "If": [2, 3, 6, 7, 8, 12], "fals": [2, 3, 10], "highest": [2, 3], "carrier": [2, 3, 4, 10], "allow": [2, 3], "equal": [2, 3], "half": [2, 3, 10], "nyquist": [2, 3], "default": [2, 3, 4, 10, 13], "type": [2, 3, 4, 6, 13], "y": [2, 3, 9, 10, 12], "x": [2, 3, 9, 10], "unshift": [2, 3], "fft": [2, 3, 4, 10], "sb_posit": [2, 3, 4, 10], "holo_shap": 2, "sb_size_ratio": 2, "5": [2, 10], "estim": [2, 3, 4, 10], "size": [2, 3, 10], "filter": [2, 10], "array_lik": 2, "holograph": 2, "non": [2, 3, 4], "shift": [2, 3, 4], "fraction": [2, 10], "distanc": [2, 3, 10], "central": [2, 3, 10], "band": [2, 3, 10], "sb_size": [2, 3, 10], "shape": [2, 3, 10], "make": [2, 6], "up": 2, "sb_smooth": [2, 3, 10], "output_shap": [2, 3, 10], "plot": [2, 3, 10], "core": 2, "new": [2, 3, 7, 8, 9], "output": [2, 3, 6, 10], "wav": 2, "wave": [2, 3, 11], "nparrai": [2, 10], "class": [3, 10, 13], "arg": 3, "kwarg": 3, "acquir": 3, "via": [3, 6], "ap_cb_radiu": [3, 10], "show_progressbar": 3, "num_work": [3, 5], "displai": [3, 10], "progress": 3, "bar": 3, "prefer": 3, "set": [3, 5, 10], "int": [3, 10], "number": [3, 6], "worker": 3, "dask": 3, "valu": [3, 6, 10], "signal1d": 3, "instanc": 3, "rais": 3, "notimplementederror": 3, "ax": [3, 4], "ar": [3, 5, 6, 7, 8, 10, 12, 13], "uniform": 3, "exampl": [3, 6, 10], "import": [3, 6, 10], "": [3, 4, 9, 10, 13], "124": 3, "452": 3, "basesign": 3, "68": 3, "87670143": 3, "reconstruct_phas": [3, 10], "sb_unit": [3, 10], "store_paramet": 3, "oper": [3, 12], "multidimension": 3, "hyperspi": [3, 5, 6, 7, 8, 10, 12, 13], "There": [3, 7, 8, 10], "sever": 3, "usag": [3, 7, 8, 10], "scheme": 3, "1d": 3, "nd": 3, "singl": [3, 10], "appli": [3, 4, 10, 13], "each": [3, 6, 10], "stack": [3, 10], "have": [3, 7, 8, 10, 12], "same": [3, 10, 13], "dimension": [3, 7, 8], "signal2d": [3, 10], "vacuum": [3, 10], "correspond": 3, "unit": [3, 10, 13], "3": [3, 5, 7, 8, 9, 10], "between": [3, 6, 10], "two": 3, "given": [3, 13], "nm": [3, 10], "mrad": [3, 10], "select": [3, 10, 13], "determin": 3, "automat": [3, 10, 12], "should": [3, 6, 10], "larger": 3, "than": [3, 10], "show": 3, "store": [3, 13], "metadata": [3, 5, 7, 8, 11], "By": [3, 10, 13], "divid": [3, 4], "complexsignal2d": [3, 10], "set_microscope_paramet": 3, "beam_energi": 3, "biprism_voltag": 3, "tilt_stag": 3, "microscop": [3, 9, 13], "argument": [3, 5], "interact": 3, "mode": 3, "fill": 3, "energi": 3, "beam": 3, "kev": 3, "In": [3, 6, 10], "volt": [3, 13], "degre": [3, 13], "print": 3, "now": [3, 12], "acquisition_instru": [3, 13], "statist": [3, 11], "fringe_contrast_algorithm": [3, 10], "apod": [3, 4, 10], "han": [3, 4, 10], "single_valu": [3, 10], "calcul": [3, 4, 10], "follow": [3, 6, 10, 12, 13], "fring": [3, 4, 10], "contrast": [3, 4, 10], "either": [3, 7, 8, 10], "definit": 3, "fourier": [3, 10], "space": [3, 4, 10], "approach": 3, "descript": [3, 10], "calibr": [3, 10], "4": [3, 5, 9], "radian": [3, 10], "px": 3, "It": [3, 7, 8, 10], "ha": [3, 7, 8, 13], "algorithm": [3, 10], "k_0": 3, "where": 3, "intens": [3, 10], "origin": [3, 4, 7, 8, 10], "thi": [3, 7, 8, 10, 13], "method": [3, 6, 10, 13], "deliv": 3, "also": [3, 6, 10, 12], "reason": [3, 10], "interfer": 3, "pattern": [3, 10], "do": [3, 12], "cover": [3, 10], "full": 3, "field": [3, 10, 13], "view": [3, 10], "standard": [3, 6, 10], "deviat": [3, 10], "real": [3, 4, 10], "reli": 3, "regularli": 3, "entir": [3, 10], "ham": [3, 4, 10], "window": [3, 4, 10], "befor": [3, 4, 6], "typic": [3, 4, 6, 10], "need": [3, 4, 6], "suppress": [3, 4], "strike": [3, 4], "due": [3, 4, 10], "sharp": [3, 4], "edg": [3, 4, 10], "often": [3, 4, 10], "result": [3, 4, 6], "underestim": [3, 4, 10], "first": [3, 10], "navig": [3, 10], "dictionari": [3, 10], "statistics_dict": 3, "4860442674236256": 3, "26383819985575441": 3, "56475154609203482": 3, "071298357213623778": 3, "7902017241882331": 3, "28685808994016415": 3, "lazi": 3, "comput": 3, "delai": 3, "until": 3, "explicitli": 3, "request": 3, "expect": 3, "instanti": 3, "directli": [3, 13], "instead": 3, "da": 3, "ones": [3, 13], "h": 3, "as_lazi": 3, "averag": 4, "amplitud": [4, 10], "maximum": [4, 10], "string": [4, 13], "changelog": 5, "entri": [5, 10], "develop": [5, 6, 7, 8, 12], "version": [5, 7, 8, 12], "avail": 5, "readthedoc": 5, "io": 5, "en": 5, "latest": 5, "chang": [5, 6, 7, 8, 10], "html": 5, "add": [5, 13], "logo": 5, "26": 5, "ruff": 5, "lint": 5, "format": 5, "check": [5, 7, 8, 12], "npy2011": 5, "28": 5, "numpi": [5, 6], "25": 5, "deprec": 5, "29": 5, "get": [5, 6, 7, 8, 11], "16": 5, "towncrier": 5, "manag": 5, "dev": 5, "17": 5, "pre": 5, "commit": 5, "configur": 5, "file": 5, "code": 5, "black": [5, 6], "workflow": [5, 6], "github": [5, 6, 12], "test": 5, "build": 5, "packag": [5, 6, 7, 8, 11], "renam": 5, "max_work": 5, "9": 5, "setup": 5, "codecov": 5, "coverag": 5, "badg": [5, 7, 8], "doc": [5, 6], "push": [5, 6], "13": 5, "consolid": 5, "pyproject": 5, "toml": 5, "14": [5, 9], "setuptools_scm": 5, "time": 5, "python": [5, 6, 7, 8, 12], "wa": 5, "split": [5, 7, 8], "repositori": [5, 6, 12], "juli": 5, "so": 5, "far": 5, "were": 5, "move": 5, "meant": 6, "commun": [6, 7, 8], "maintain": [6, 7, 8], "project": [6, 7, 8], "we": [6, 12], "welcom": 6, "form": [6, 7, 8], "bug": 6, "report": 6, "featur": [6, 7, 8], "some": [6, 10], "resourc": 6, "help": [6, 7, 8], "you": [6, 7, 8, 12], "tracker": 6, "can": [6, 7, 8, 10, 12, 13], "propos": 6, "when": [6, 13], "give": [6, 10], "minim": 6, "demonstr": 6, "copi": 6, "past": 6, "error": 6, "traceback": 6, "want": [6, 12], "sourc": [6, 7, 8], "send": 6, "u": 6, "small": 6, "fix": 6, "correct": 6, "user": [6, 7, 8, 10, 12], "guid": [6, 7, 8, 12], "good": 6, "point": 6, "But": 6, "don": 6, "t": [6, 9], "hesit": 6, "signific": [6, 7, 8], "ll": 6, "readi": 6, "common": 6, "pleas": [6, 7, 8, 10, 12], "order": 6, "guidelin": [6, 7, 8], "kikuchipi": 6, "contributor": 6, "anoth": 6, "extens": 6, "valuabl": 6, "provid": [6, 7, 8, 10], "As": 6, "qualiti": [6, 10], "assur": 6, "improv": 6, "gener": [6, 7, 8, 11], "thoroughli": 6, "least": 6, "one": [6, 10, 12], "other": [6, 7, 8, 10, 12], "member": 6, "team": 6, "being": 6, "merg": 6, "consist": 6, "three": 6, "element": 6, "docstr": 6, "individu": 6, "written": 6, "sphinx": 6, "host": 6, "part": [6, 7, 8, 10], "jupyt": [6, 7, 8, 12], "notebook": [6, 7, 8, 12], "demo": 6, "tutori": [6, 7, 8], "alwai": 6, "wai": [6, 7, 8, 10], "learn": 6, "through": 6, "respect": [6, 10, 13], "For": [6, 10], "numpydoc": 6, "structur": [6, 11], "block": 6, "blank": 6, "line": 6, "them": 6, "librari": [6, 7, 8, 12], "like": [6, 10], "o": 6, "third": 6, "parti": 6, "final": 6, "all": [6, 10, 12, 13], "pytest": 6, "framework": 6, "resid": 6, "directori": 6, "short": 6, "call": [6, 10], "compar": 6, "known": 6, "answer": 6, "further": [6, 7, 8, 11], "inform": [6, 7, 8, 10], "semant": 6, "therefor": [6, 10], "major": 6, "minor": 6, "patch": 6, "depend": [6, 10, 12], "accord": 6, "increas": 6, "incompat": 6, "api": [6, 7, 8, 10], "ad": [6, 10], "backward": 6, "compat": 6, "manner": 6, "process": [6, 7, 8, 11], "pypi": [6, 12], "conda": [6, 11], "forg": [6, 12], "extend": [7, 8, 13], "multi": [7, 8], "analysi": [7, 8], "aim": [7, 8], "domain": [7, 8], "specif": [7, 8, 13], "been": [7, 8], "dedic": [7, 8], "releas": [7, 8, 12], "section": [7, 8, 10, 12, 13], "includ": [7, 8, 10, 12], "how": [7, 8], "open": [7, 8, 12], "everyon": [7, 8], "contribut": [7, 8], "our": [7, 8], "ecosystem": [7, 8], "introduct": [7, 8], "basic": [7, 8], "depth": [7, 8], "kei": [7, 8], "concept": [7, 8], "background": [7, 8], "explan": [7, 8], "applic": [7, 8], "progam": [7, 8], "interfac": [7, 8], "describ": [7, 8, 10, 13], "work": [7, 8, 12], "whole": [7, 8], "mani": [7, 8, 10], "To": [7, 8, 10, 12], "about": [7, 8, 12, 13], "recent": [7, 8, 10], "lead": [7, 8, 10], "academ": [7, 8], "public": [7, 8], "acknowledg": [7, 8], "fact": [7, 8], "below": [7, 8], "becaus": [7, 8], "emploi": [7, 8], "click": [7, 8], "free": [7, 8], "softwar": [7, 8], "redistribut": [7, 8], "modifi": [7, 8], "under": [7, 8], "term": [7, 8], "gnu": [7, 8], "gpl": [7, 8], "publish": [7, 8], "foundat": [7, 8], "your": [7, 8], "ani": [7, 8, 10, 13], "later": [7, 8], "hope": [7, 8], "warranti": [7, 8], "even": [7, 8, 10], "impli": [7, 8], "merchant": [7, 8], "fit": [7, 8], "particular": [7, 8, 10], "purpos": [7, 8], "gabor1948": [9, 10], "d": 9, "gabor": 9, "principl": 9, "natur": 9, "161": 9, "1948": 9, "777": 9, "778": 9, "1038": 9, "161777a0": 9, "joy1993": [9, 10], "joi": 9, "zhang": 9, "hashimoto": 9, "bunn": 9, "l": 9, "allard": 9, "nolan": 9, "practic": 9, "aspect": 9, "ultramicroscopi": 9, "51": 9, "1993": 9, "1016": 9, "0304": 9, "3991": 9, "93": 9, "90130": 9, "p": 9, "mccartney2007": [9, 10], "m": 9, "mccartnei": 9, "smith": 9, "phase": [9, 11], "nanomet": [9, 10], "resolut": 9, "annu": 9, "rev": 9, "mater": 9, "re": 9, "37": 9, "2007": 9, "729": 9, "767": 9, "onlinelibrari": 9, "wilei": 9, "com": 9, "1146": 9, "annurev": 9, "matsci": 9, "052506": 9, "084219": 9, "tonomura1999": [9, 10], "tonomura": 9, "springer": 9, "berlin": 9, "heidelberg": 9, "1999": 9, "78": 9, "132": 9, "1007": 9, "978": 9, "540": 9, "37204": 9, "inherit": 10, "_signal": 10, "thu": 10, "explain": 10, "transform": 10, "subclass": 10, "im": 10, "set_signal_typ": 10, "found": [10, 13], "literatur": 10, "base": [10, 12], "side": 10, "isol": 10, "invers": 10, "perform": 10, "complex_signal2d": 10, "contain": [10, 13], "take": 10, "dataset": 10, "wave_imag": 10, "sb_radiu": 10, "search": [10, 13], "exclud": 10, "middl": 10, "area": [10, 13], "defin": 10, "commonli": 10, "strong": 10, "altern": [10, 12], "recalcul": 10, "weak": 10, "reference_hologram": 10, "unwrap": 10, "properti": 10, "complexsign": 10, "unwrapped_phas": 10, "addition": 10, "possibl": 10, "desir": 10, "rather": 10, "milliradian": 10, "30": 10, "05": 10, "preserv": 10, "though": 10, "oversampl": 10, "sinc": 10, "limit": 10, "avoid": 10, "diamet": 10, "out_siz": 10, "assign": 10, "howev": 10, "recommend": [10, 12], "experienc": 10, "onc": 10, "explor": 10, "argand": 10, "argand_diagram": 10, "display_rang": 10, "scalebar": 10, "diagram": [10, 13], "list": 10, "abov": [10, 12], "differ": 10, "well": 10, "divis": 10, "twice": 10, "centr": 10, "requir": [10, 12], "highli": 10, "sensit": 10, "artifact": 10, "dud": 10, "fresnel": 10, "etc": 10, "second": 10, "less": 10, "precis": 10, "sometim": 10, "mai": 10, "done": 10, "forc": 10, "otherwis": [10, 13], "prior": 10, "experiment": 10, "condit": 10, "especi": [10, 12], "extrem": 10, "variat": 10, "strongli": 10, "document": [10, 12, 13], "pip": 11, "updat": 11, "complex": 11, "acquisit": 11, "instrument": 11, "bibliographi": 11, "system": 12, "bundl": 12, "standalon": 12, "program": 12, "relev": 12, "anyth": 12, "els": 12, "appropri": 12, "replac": 12, "step": 12, "suggest": 12, "miniforg": 12, "alreadi": 12, "prompt": 12, "run": 12, "command": 12, "n": 12, "activ": 12, "complet": 12, "next": 12, "troubl": 12, "unfamiliar": 12, "enter": 12, "anaconda": 12, "scratch": 12, "jupyterlab": 12, "lab": 12, "index": 12, "upgrad": 12, "notifi": 12, "watch": 12, "account": 12, "convent": 13, "attribut": 13, "tree": 13, "node": 13, "label": 13, "capit": 13, "leav": 13, "leaf": 13, "quantiti": 13, "dimensionless": 13, "extra": 13, "_unit": 13, "suffix": 13, "besid": 13, "signal_typ": 13, "set_item": 13, "has_item": 13, "get_item": 13, "item": 13, "repres": 13, "parenthes": 13, "chapter": 13, "everi": 13, "azimuth_angl": 13, "\u00ba": 13, "voltag": 13, "current": 13, "addit": 13, "rotat": 13, "angl": 13, "column": 13, "plane": 13, "electrostat": 13, "exspi": 13}, "objects": {"holospy": [[0, 0, 0, "-", "data"], [2, 0, 0, "-", "reconstruct"], [4, 0, 0, "-", "tools"]], "holospy.data": [[0, 1, 1, "", "Fe_needle_hologram"], [0, 1, 1, "", "Fe_needle_reference_hologram"]], "holospy.reconstruct": [[2, 1, 1, "", "aperture_function"], [2, 1, 1, "", "estimate_sideband_position"], [2, 1, 1, "", "estimate_sideband_size"], [2, 1, 1, "", "freq_array"], [2, 1, 1, "", "reconstruct"]], "holospy.signals": [[3, 0, 0, "-", "hologram_image"]], "holospy.signals.hologram_image": [[3, 2, 1, "", "HologramImage"], [3, 2, 1, "", "LazyHologramImage"]], "holospy.signals.hologram_image.HologramImage": [[3, 3, 1, "", "estimate_sideband_position"], [3, 3, 1, "", "estimate_sideband_size"], [3, 3, 1, "", "reconstruct_phase"], [3, 3, 1, "", "set_microscope_parameters"], [3, 3, 1, "", "statistics"]], "holospy.tools": [[4, 1, 1, "", "calculate_carrier_frequency"], [4, 1, 1, "", "estimate_fringe_contrast_fourier"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:method"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "method", "Python method"]}, "titleterms": {"holospi": [0, 2, 3, 4, 7, 8, 13], "data": 0, "refer": 1, "api": 1, "reconstruct": [2, 10], "signal": [3, 13], "hologram_imag": 3, "tool": 4, "releas": [5, 6], "note": 5, "unreleas": 5, "2024": 5, "04": 5, "01": 5, "improv": 5, "document": [5, 6, 7, 8], "mainten": 5, "0": 5, "1": [5, 12], "2023": 5, "12": 5, "02": 5, "bug": 5, "fix": 5, "11": 5, "15": 5, "initi": 5, "07": 5, "23": 5, "contribut": 6, "issu": 6, "pull": 6, "request": 6, "review": 6, "code": 6, "style": 6, "write": 6, "test": 6, "new": [6, 12], "version": 6, "welcom": [7, 8], "": [7, 8], "learn": [7, 8], "resourc": [7, 8], "cite": [7, 8], "licens": [7, 8], "bibliographi": 9, "electron": 10, "holographi": 10, "hologram": 10, "further": 10, "process": 10, "complex": 10, "wave": 10, "phase": 10, "get": [10, 12], "statist": 10, "user": 11, "guid": 11, "instal": 12, "us": 12, "conda": 12, "creat": 12, "environ": 12, "2": 12, "packag": 12, "3": 12, "start": 12, "pip": 12, "updat": 12, "metadata": 13, "structur": 13, "gener": 13, "sampl": 13, "acquisit": 13, "instrument": 13, "tem": 13, "biprism": 13}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx": 60}, "alltitles": {"holospy.data": [[0, "module-holospy.data"]], "Reference": [[1, "reference"]], "API Reference": [[1, null]], "holospy.reconstruct": [[2, "module-holospy.reconstruct"]], "holospy.signals.hologram_image": [[3, "module-holospy.signals.hologram_image"]], "holospy.tools": [[4, "module-holospy.tools"]], "Release Notes": [[5, "release-notes"]], " [UNRELEASED] (2024-04-01)": [[5, "release-unreleased-2024-04-01"]], "Improved Documentation": [[5, "improved-documentation"]], "Maintenance": [[5, "maintenance"], [5, "id6"]], "0.1.1 (2023-12-02)": [[5, "id4"]], "Bug Fixes": [[5, "bug-fixes"]], "0.1 (2023-11-15)": [[5, "changes-0-1"]], "Initiation (2023-07-23)": [[5, "initiation-2023-07-23"]], "Contributing": [[6, "contributing"]], "Issues": [[6, "issues"]], "Pull Requests": [[6, "pull-requests"]], "Reviewing": [[6, "reviewing"]], "Documentation": [[6, "documentation"]], "Code style": [[6, "code-style"]], "Writing tests": [[6, "writing-tests"]], "Releasing a new version": [[6, "releasing-a-new-version"]], "Welcome to HoloSpy\u2019s documentation!": [[7, "welcome-to-holospy-s-documentation"], [8, "welcome-to-holospy-s-documentation"]], "Learning resources": [[7, "learning-resources"], [8, "learning-resources"]], "Citing HoloSpy": [[7, "citing-holospy"], [8, "citing-holospy"]], "License": [[7, "license"], [8, "license"]], "Bibliography": [[9, "bibliography"]], "Electron Holography": [[10, "electron-holography"]], "Reconstruction of holograms": [[10, "reconstruction-of-holograms"]], "Further processing of complex wave and phase": [[10, "further-processing-of-complex-wave-and-phase"]], "Getting hologram statistics": [[10, "getting-hologram-statistics"]], "User Guide": [[11, "user-guide"], [11, null]], "Installation": [[12, "installation"]], "Installation using conda": [[12, "installation-using-conda"]], "1. Creating a conda environment": [[12, "creating-a-conda-environment"]], "2. Installing the package in the new environment": [[12, "installing-the-package-in-the-new-environment"]], "3. Getting Started": [[12, "getting-started"]], "Installation using pip": [[12, "installation-using-pip"]], "Updating the package": [[12, "updating-the-package"]], "HoloSpy metadata structure": [[13, "holospy-metadata-structure"]], "General": [[13, "general"]], "Sample": [[13, "sample"]], "Signal": [[13, "signal"]], "Acquisition Instrument": [[13, "acquisition-instrument"]], "TEM": [[13, "tem"]], "Biprism": [[13, "biprism"]]}, "indexentries": {"fe_needle_hologram() (in module holospy.data)": [[0, "holospy.data.Fe_needle_hologram"]], "fe_needle_reference_hologram() (in module holospy.data)": [[0, "holospy.data.Fe_needle_reference_hologram"]], "holospy.data": [[0, "module-holospy.data"]], "module": [[0, "module-holospy.data"], [2, "module-holospy.reconstruct"], [3, "module-holospy.signals.hologram_image"], [4, "module-holospy.tools"]], "aperture_function() (in module holospy.reconstruct)": [[2, "holospy.reconstruct.aperture_function"]], "estimate_sideband_position() (in module holospy.reconstruct)": [[2, "holospy.reconstruct.estimate_sideband_position"]], "estimate_sideband_size() (in module holospy.reconstruct)": [[2, "holospy.reconstruct.estimate_sideband_size"]], "freq_array() (in module holospy.reconstruct)": [[2, "holospy.reconstruct.freq_array"]], "holospy.reconstruct": [[2, "module-holospy.reconstruct"]], "reconstruct() (in module holospy.reconstruct)": [[2, "holospy.reconstruct.reconstruct"]], "hologramimage (class in holospy.signals.hologram_image)": [[3, "holospy.signals.hologram_image.HologramImage"]], "lazyhologramimage (class in holospy.signals.hologram_image)": [[3, "holospy.signals.hologram_image.LazyHologramImage"]], "estimate_sideband_position() (holospy.signals.hologram_image.hologramimage method)": [[3, "holospy.signals.hologram_image.HologramImage.estimate_sideband_position"]], "estimate_sideband_size() (holospy.signals.hologram_image.hologramimage method)": [[3, "holospy.signals.hologram_image.HologramImage.estimate_sideband_size"]], "holospy.signals.hologram_image": [[3, "module-holospy.signals.hologram_image"]], "reconstruct_phase() (holospy.signals.hologram_image.hologramimage method)": [[3, "holospy.signals.hologram_image.HologramImage.reconstruct_phase"]], "set_microscope_parameters() (holospy.signals.hologram_image.hologramimage method)": [[3, "holospy.signals.hologram_image.HologramImage.set_microscope_parameters"]], "statistics() (holospy.signals.hologram_image.hologramimage method)": [[3, "holospy.signals.hologram_image.HologramImage.statistics"]], "calculate_carrier_frequency() (in module holospy.tools)": [[4, "holospy.tools.calculate_carrier_frequency"]], "estimate_fringe_contrast_fourier() (in module holospy.tools)": [[4, "holospy.tools.estimate_fringe_contrast_fourier"]], "holospy.tools": [[4, "module-holospy.tools"]]}})
\ No newline at end of file