1 2<!DOCTYPE html> 3 4 5<html lang="en" data-content_root="./" > 6 7 <head> 8 <meta charset="utf-8" /> 9 <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" /> 10 <link href="_static/hyperspy.ico" rel="icon" type="image/x-icon"> 11 <title>What is HyperSpy — HyperSpy 2.4.0 documentation</title> 12 13 14 15
15<script data-cfasync="false"> 16 document.documentElement.dataset.mode = localStorage.getItem("mode") || ""; 17 document.documentElement.dataset.theme = localStorage.getItem("theme") || ""; 18 </script>
18 19 <!-- 20 this give us a css class that will be invisible only if js is disabled 21 --> 22 <noscript> 23 <style> 24 .pst-js-only { display: none !important; } 25 26 </style> 27 </noscript> 28 29 <!-- Loaded before other Sphinx assets --> 30 <link href="_static/styles/theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" /> 31<link href="_static/styles/pydata-sphinx-theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" /> 32 33 <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" /> 34 <link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=4ae1632d" /> 35 <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" /> 36 <link rel="stylesheet" type="text/css" href="_static/custom-styles.css?v=eff58afb" /> 37 <link rel="stylesheet" type="text/css" href="_static/sg_gallery.css?v=d2d258e8" /> 38 <link rel="stylesheet" type="text/css" href="_static/sg_gallery-binder.css?v=f4aeca0c" /> 39 <link rel="stylesheet" type="text/css" href="_static/sg_gallery-dataframe.css?v=2082cf3c" /> 40 <link rel="stylesheet" type="text/css" href="_static/sg_gallery-rendered-html.css?v=1277b6f3" /> 41 <link rel="stylesheet" type="text/css" href="_static/sphinx-design.min.css?v=95c83b7e" /> 42 43 <!-- So that users can add custom icons --> 44
44<script src="_static/scripts/fontawesome.js?digest=8878045cc6db502f8baf"></script>
44 45 <!-- Pre-loaded scripts that we'll load fully later --> 46 <link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" /> 47<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" /> 48 49
49<script src="_static/documentation_options.js?v=4d935f96"></script>
49 50
50<script src="_static/doctools.js?v=fd6eb6e6"></script>
50 51
51<script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
51 52
52<script src="_static/clipboard.min.js?v=a7894cd8"></script>
52 53
53<script src="_static/copybutton.js?v=ccdb6887"></script>
53 54
54<script src="_static/design-tabs.js?v=f930bc37"></script>
vendor: 76 bytes, lines 54-55
54 55 <script async="async" src="https://www.googletagmanager.com/gtag/js?id=
55G-B0XD0GTW1M
vendor: 16 bytes, lines 55-56
55"></script> 56
56<script> 57
vendor: 177 bytes, lines 57-60
57window.dataLayer = window.dataLayer || []; 58 function gtag(){ dataLayer.push(arguments); } 59 gtag('js', new Date()); 60 gtag('config', '
60G-B0XD0GTW1M
vendor: 16 bytes, lines 60-61
60'); 61
61</script>
61 62
62<script>DOCUMENTATION_OPTIONS.pagename = 'index';</script>
62 63
63<script> 64 DOCUMENTATION_OPTIONS.theme_version = '0.16.1'; 65 DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://hyperspy.org/hyperspy-doc/dev/_static/switcher.json'; 66 DOCUMENTATION_OPTIONS.theme_switcher_version_match = '2.4.0'; 67 DOCUMENTATION_OPTIONS.show_version_warning_banner = 68 true; 69 </script>
69 70 <link rel="index" title="Index" href="genindex.html" /> 71 <link rel="search" title="Search" href="search.html" /> 72 <link rel="next" title="User guide" href="user_guide/index.html" /> 73 74 <meta name="viewport" content="width=device-width, initial-scale=1"/> 75 <meta name="docsearch:language" content="en"/> 76 <meta name="docsearch:version" content="2.4" />
77<script type="text/javascript"> 78 79 var _gaq = _gaq || []; 80 _gaq.push(['_setAccount', 'UA-25260850-1']); 81 _gaq.push(['_trackPageview']); 82 83 (function() { 84 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; 85 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; 86 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); 87 })(); 88 89</script>
89 90 91 </head> 92 93 94 <body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode=""> 95 96 97 98 <div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div> 99 100 <div id="pst-scroll-pixel-helper"></div> 101 102 <button type="button" class="btn rounded-pill" id="pst-back-to-top"> 103 <i class="fa-solid fa-arrow-up"></i>Back to top</button> 104 105 106 <dialog id="pst-search-dialog"> 107 108<form class="bd-search d-flex align-items-center" 109 action="search.html" 110 method="get"> 111 <i class="fa-solid fa-magnifying-glass"></i> 112 <input type="search" 113 class="form-control" 114 name="q" 115 placeholder="Search the docs ..." 116 aria-label="Search the docs ..." 117 autocomplete="off" 118 autocorrect="off" 119 autocapitalize="off" 120 spellcheck="false"/> 121 <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span> 122</form> 123 </dialog> 124 125 <div class="pst-async-banner-revealer d-none"> 126 <aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside> 127</div> 128 129 130 <header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none"> 131<div class="bd-header__inner bd-page-width"> 132 <button class="pst-navbar-icon sidebar-toggle primary-toggle" aria-label="Site navigation"> 133 <span class="fa-solid fa-bars"></span> 134 </button> 135 136 137 <div class="col-lg-3 navbar-header-items__start"> 138 139 <div class="navbar-item"> 140 141 142 143 144 145<a class="navbar-brand logo" href="#"> 146 147 148 149 150 151 152 153 154 155 156 <img src="_static/hyperspy_logo.png" class="logo__image only-light" alt=""/> 157 <img src="_static/hyperspy_logo.png" class="logo__image only-dark pst-js-only" alt=""/> 158 159 160 <p class="title logo__title">HyperSpy</p> 161 162</a></div> 163 164 <div class="navbar-item"> 165<div class="version-switcher__container dropdown pst-js-only"> 166 <button id="pst-version-switcher-button-2" 167 type="button" 168 class="version-switcher__button btn btn-sm dropdown-toggle" 169 data-bs-toggle="dropdown" 170 aria-haspopup="listbox" 171 aria-controls="pst-version-switcher-list-2" 172 aria-label="Version switcher list" 173 > 174 Choose version <!-- this text may get changed later by javascript --> 175 <span class="caret"></span> 176 </button> 177 <div id="pst-version-switcher-list-2" 178 class="version-switcher__menu dropdown-menu list-group-flush py-0" 179 role="listbox" aria-labelledby="pst-version-switcher-button-2"> 180 <!-- dropdown will be populated by javascript on page load --> 181 </div> 182</div></div> 183 184 </div> 185 186 <div class="col-lg-9 navbar-header-items"> 187 188 <div class="me-auto navbar-header-items__center"> 189 190 <div class="navbar-item"> 191<nav> 192 <ul class="bd-navbar-elements navbar-nav"> 193 194<li class="nav-item "> 195 <a class="nav-link nav-internal" href="user_guide/index.html"> 196 User Guide 197 </a> 198</li> 199 200 201<li class="nav-item "> 202 <a class="nav-link nav-internal" href="auto_examples/index.html"> 203 Examples 204 </a> 205</li> 206 207 208<li class="nav-item "> 209 <a class="nav-link nav-internal" href="reference/index.html"> 210 Reference 211 </a> 212</li> 213 214 215<li class="nav-item "> 216 <a class="nav-link nav-internal" href="help.html"> 217 Get Help 218 </a> 219</li> 220 221 222<li class="nav-item "> 223 <a class="nav-link nav-internal" href="changes.html"> 224 Release Notes 225 </a> 226</li> 227 228 229<li class="nav-item "> 230 <a class="nav-link nav-internal" href="dev_guide/index.html"> 231 Contribute 232 </a> 233</li> 234 235 236<li class="nav-item "> 237 <a class="nav-link nav-external" href="https://github.com/hyperspy/hyperspy-demos"> 238 Tutorial 239 </a> 240</li> 241 242 </ul> 243</nav></div> 244 245 </div> 246 247 248 <div class="navbar-header-items__end"> 249 250 <div class="navbar-item navbar-persistent--container"> 251 252 253<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip"> 254 <i class="fa-solid fa-magnifying-glass"></i> 255 <span class="search-button__default-text">Search</span> 256 <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span> 257</button> 258 </div> 259 260 261 <div class="navbar-item"> 262 263<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip"> 264 <i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i> 265 <i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i> 266 <i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i> 267</button></div> 268 269 <div class="navbar-item"><ul class="navbar-icon-links" 270 aria-label="Icon Links"> 271 <li class="nav-item"> 272 273 274 275 276 277 278 279 280 <a href="https://github.com/hyperspy/hyperspy" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i>
281 <span class="sr-only">GitHub</span></a> 282 </li> 283 <li class="nav-item"> 284 285 286 287 288 289 290 291 292 <a href="https://gitter.im/hyperspy/hyperspy" title="Gitter" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fab fa-gitter fa-lg" aria-hidden="true"></i> 293 <span class="sr-only">Gitter</span></a> 294 </li> 295 <li class="nav-item"> 296 297 298 299 300 301 302 303 304 <a href="https://hyperspy.org" title="HyperSpy" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><img src="_static/hyperspy.ico" class="icon-link-image" alt="HyperSpy"/></a> 305 </li> 306</ul></div> 307 308 </div> 309 310 </div> 311 312 313 <div class="navbar-persistent--mobile"> 314 315<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip"> 316 <i class="fa-solid fa-magnifying-glass"></i> 317 <span class="search-button__default-text">Search</span> 318 <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span> 319</button> 320 </div> 321 322 323 324 <button class="pst-navbar-icon sidebar-toggle secondary-toggle" aria-label="On this page"> 325 <span class="fa-solid fa-outdent"></span> 326 </button> 327 328</div> 329 330 </header> 331 332 333 <div class="bd-container"> 334 <div class="bd-container__inner bd-page-width"> 335 336 337 338 339 340 <dialog id="pst-primary-sidebar-modal"></dialog> 341 <div id="pst-primary-sidebar" class="bd-sidebar-primary bd-sidebar hide-on-wide"> 342 343 344 345 <div class="sidebar-header-items sidebar-primary__section"> 346 347 348 <div class="sidebar-header-items__center"> 349 350 351 352 <div class="navbar-item"> 353<nav> 354 <ul class="bd-navbar-elements navbar-nav"> 355 356<li class="nav-item "> 357 <a class="nav-link nav-internal" href="user_guide/index.html"> 358 User Guide 359 </a> 360</li> 361 362 363<li class="nav-item "> 364 <a class="nav-link nav-internal" href="auto_examples/index.html"> 365 Examples 366 </a> 367</li> 368 369 370<li class="nav-item "> 371 <a class="nav-link nav-internal" href="reference/index.html"> 372 Reference 373 </a> 374</li> 375 376 377<li class="nav-item "> 378 <a class="nav-link nav-internal" href="help.html"> 379 Get Help 380 </a> 381</li> 382 383 384<li class="nav-item "> 385 <a class="nav-link nav-internal" href="changes.html"> 386 Release Notes 387 </a> 388</li> 389 390 391<li class="nav-item "> 392 <a class="nav-link nav-internal" href="dev_guide/index.html"> 393 Contribute 394 </a> 395</li> 396 397 398<li class="nav-item "> 399 <a class="nav-link nav-external" href="https://github.com/hyperspy/hyperspy-demos"> 400 Tutorial 401 </a> 402</li> 403 404 </ul> 405</nav></div> 406 407 408 </div> 409 410 411 412 <div class="sidebar-header-items__end"> 413 414 <div class="navbar-item"> 415 416<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip"> 417 <i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i> 418 <i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i> 419 <i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i> 420</button></div> 421 422 <div class="navbar-item"><ul class="navbar-icon-links" 423 aria-label="Icon Links"> 424 <li class="nav-item"> 425 426 427 428 429 430 431 432 433 <a href="https://github.com/hyperspy/hyperspy" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i>
434 <span class="sr-only">GitHub</span></a> 435 </li> 436 <li class="nav-item"> 437 438 439 440 441 442 443 444 445 <a href="https://gitter.im/hyperspy/hyperspy" title="Gitter" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fab fa-gitter fa-lg" aria-hidden="true"></i> 446 <span class="sr-only">Gitter</span></a> 447 </li> 448 <li class="nav-item"> 449 450 451 452 453 454 455 456 457 <a href="https://hyperspy.org" title="HyperSpy" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><img src="_static/hyperspy.ico" class="icon-link-image" alt="HyperSpy"/></a> 458 </li> 459</ul></div> 460 461 </div> 462 463 </div> 464 465 466 <div class="sidebar-primary-items__end sidebar-primary__section"> 467 <div class="sidebar-primary-item"> 468<div id="ethical-ad-placement" 469 class="flat" 470 data-ea-publisher="readthedocs" 471 data-ea-type="readthedocs-sidebar" 472 data-ea-manual="true"> 473</div></div> 474 </div> 475 476 477 </div> 478 479 <main id="main-content" class="bd-main" role="main"> 480 481 482 <div class="bd-content"> 483 <div class="bd-article-container"> 484 485 <div class="bd-header-article d-print-none"></div> 486 487 488 489 490<div id="searchbox"></div> 491 <article class="bd-article"> 492 493 <div class="toctree-wrapper compound"> 494</div> 495<section id="what-is-hyperspy"> 496<h1>What is HyperSpy<a class="headerlink" href="#what-is-hyperspy" title="Link to this heading">#</a></h1> 497<p>HyperSpy is an open source Python library which provides tools to facilitate 498the interactive data analysis of multidimensional datasets that can be 499described as multidimensional arrays of a given signal (e.g. a 2D array of 500spectra a.k.a spectrum image).</p> 501<p>HyperSpy aims at making it easy and natural to apply analytical procedures 502that operate on an individual signal to multidimensional datasets of any 503size, as well as providing easy access to analytical tools that exploit their 504multidimensionality.</p> 505<div class="versionadded"> 506<p><span class="versionmodified added">Added in version 1.5: </span>External packages can extend HyperSpy by registering signals, 507components and widgets.</p> 508</div> 509<p>The functionality of HyperSpy can be extended by external packages, e.g. to 510implement features for analyzing a particular sort of data (usually related to a 511specific set of experimental methods). A <a class="reference external" href="https://github.com/hyperspy/hyperspy-extensions-list">list of packages that extend HyperSpy</a> is curated in a 512dedicated repository. For details on how to register extensions see 513<a class="reference internal" href="dev_guide/writing_extensions.html#writing-extensions-label"><span class="std std-ref">Writing packages that extend HyperSpy</span></a>.</p> 514<div class="versionchanged"> 515<p><span class="versionmodified changed">Changed in version 2.0: </span>HyperSpy was split into a core package (HyperSpy) that provides the common 516infrastructure for multidimensional datasets and the dedicated IO package 517<a class="reference external" href="https://hyperspy.org/rosettasciio/index.html" title="(in RosettaSciIO)"><span class="xref std std-doc">RosettaSciIO</span></a>. Signal classes focused on 518specific types of data previously included in HyperSpy (EELS, EDS, Holography) 519were moved to specialized <a class="reference external" href="https://github.com/hyperspy/hyperspy-extensions-list">HyperSpy extensions</a>.</p> 520</div> 521</section> 522<section id="hyperspy-s-character"> 523<h1>HyperSpyâs character<a class="headerlink" href="#hyperspy-s-character" title="Link to this heading">#</a></h1> 524<p>HyperSpy has been written by a subset of the people who use it, a particularity 525that sets its character:</p> 526<ul class="simple"> 527<li><p>To us, this program is a research tool, much like a screwdriver or a Greenâs 528function. We believe that the better our tools are, the better our research 529will be. We also think that it is beneficial for the advancement of knowledge 530to share our research tools and to forge them in a collaborative way. This is 531because by collaborating we advance faster, mainly by avoiding reinventing the 532wheel. Idealistic as it may sound, many other people think like this and it is 533thanks to them that this project exists.</p></li> 534<li><p>Not surprisingly, we care about making it easy for others to contribute to 535HyperSpy. In other words,
536we aim at minimising the âuser becomes developerâ threshold. 537Do you want to contribute already? No problem, see the <a class="reference internal" href="dev_guide/intro.html#dev-guide"><span class="std std-ref">Introduction</span></a> 538for details.</p></li> 539<li><p>The main way of interacting with the program is through scripting. 540This is because <a class="reference external" href="https://jupyter.org/">Jupyter</a> exists, making your 541interactive data analysis productive, scalable, reproducible and, 542most importantly, fun. That said, widgets to interact with HyperSpy 543elements are provided where there 544is a clear productivity advantage in doing so. See the 545<a class="reference external" href="https://github.com/hyperspy/hyperspy_gui_ipywidgets">hyperspy-gui-ipywidgets</a> 546and 547<a class="reference external" href="https://github.com/hyperspy/hyperspy_gui_traitsui">hyperspy-gui-traitsui</a> 548packages for details. Not enough? If you 549need a full, standalone GUI, <a class="reference external" href="https://hyperspy.org/hyperspyUI/">HyperSpyUI</a> 550is for you.</p></li> 551</ul> 552</section> 553<section id="learning-resources"> 554<h1>Learning resources<a class="headerlink" href="#learning-resources" title="Link to this heading">#</a></h1> 555<div class="sd-container-fluid sd-sphinx-override sd-mb-4 docutils"> 556<div class="sd-row sd-row-cols-2 sd-row-cols-xs-2 sd-row-cols-sm-3 sd-row-cols-md-3 sd-row-cols-lg-3 sd-g-2 sd-g-xs-2 sd-g-sm-2 sd-g-md-2 sd-g-lg-2 docutils"> 557<div class="sd-col sd-d-flex-row docutils"> 558<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils"> 559<div class="sd-card-header docutils"> 560<p class="sd-card-text"><svg version="1.1" width="2.0em" height="2.0em" class="sd-octicon sd-octicon-rocket sd-text-info" viewBox="0 0 24 24" aria-hidden="true"><path d="M20.322.75h1.176a1.75 1.75 0 0 1 1.75 1.749v1.177a10.75 10.75 0 0 1-2.925 7.374l-1.228 1.304a23.699 23.699 0 0 1-1.596 1.542v5.038c0 .615-.323 1.184-.85 1.5l-4.514 2.709a.75.75 0 0 1-1.12-.488l-.963-4.572a1.305 1.305 0 0 1-.14-.129L8.04 15.96l-1.994-1.873a1.305 1.305 0 0 1-.129-.14l-4.571-.963a.75.75 0 0 1-.49-1.12l2.71-4.514c.316-.527.885-.85 1.5-.85h5.037a23.668 23.668 0 0 1 1.542-1.594l1.304-1.23A10.753 10.753 0 0 1 20.321.75Zm-6.344 4.018v-.001l-1.304 1.23a22.275 22.275 0 0 0-3.255 3.851l-2.193 3.29 1.859 1.744a.545.545 0 0 1 .034.034l1.743 1.858 3.288-2.192a22.263 22.263 0 0 0 3.854-3.257l1.228-1.303a9.251 9.251 0 0 0 2.517-6.346V2.5a.25.25 0 0 0-.25-.25h-1.177a9.252 9.252 0 0 0-6.344 2.518ZM6.5 21c-1.209 1.209-3.901 1.445-4.743 1.49a.236.236 0 0 1-.18-.067.236.236 0 0 1-.067-.18c.045-.842.281-3.534 1.49-4.743.9-.9 2.6-.9 3.5 0 .9.9.9 2.6 0 3.5Zm-.592-8.588L8.17 9.017c.23-.346.47-.685.717-1.017H5.066a.25.25 0 0 0-.214.121l-2.167 3.612ZM16 15.112c-.333.248-.672.487-1.018.718l-3.393 2.262.678 3.223 3.612-2.167a.25.25 0 0 0 .121-.214ZM17.5 8a1.5 1.5 0 1 1-3.001-.001A1.5 1.5 0 0 1 17.5 8Z"></path></svg> Getting Started</p> 561</div> 562<div class="sd-card-body docutils"> 563<p class="sd-card-text">New to HyperSpy or Python? The getting started guide provides an 564introduction on basic usage of HyperSpy and how to install it.</p> 565</div> 566<a class="sd-stretched-link sd-hide-link-text reference internal" href="user_guide/install.html"><span class="doc">Installing HyperSpy</span></a></div> 567</div> 568<div class="sd-col sd-d-flex-row docutils"> 569<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils"> 570<div class="sd-card-header docutils"> 571<p class="sd-card-text"><svg version="1.1" width="2.0em" height="2.0em" class="sd-octicon sd-octicon-book sd-text-info" viewBox="0 0 24 24" aria-hidden="true"><path d="M0 3.75A.75.75 0 0 1 .75 3h7.497c1.566 0 2.945.8 3.751 2.014A4.495 4.495 0 0 1 15.75 3h7.5a.75.75 0 0 1 .75.75v15.063a.752.752 0 0 1-.755.75l-7.682-.052a3 3 0 0 0-2.142.878l-.89.891a.75.75 0 0 1-1.061 0l-.902-.901a2.996 2.996 0 0 0-2.121-.879H.75a.75.75 0 0 1-.75-.75Zm12.75 15.232a4.503 4.503 0 0 1 2.823-.971l6.927.047V4.5h-6.75a3 3 0 0 0-3 3ZM11.247 7.497a3 3 0 0 0-3-2.997H1.5V18h6.947c1.018 0 2.006.346 2.803.98Z"></path></svg> User Guide</p> 572</div> 573<div class="sd-card-body docutils"> 574<p class="sd-card-text">The user guide provides in-depth information on key concepts of HyperSpy 575and how to use it along with background information and explanations.</p> 576</div> 577<a class="sd-stretched-link sd-hide-link-text reference internal" href="user_guide/index.html"><span class="doc">User guide</span></a></div> 578</div> 579<div class="sd-col sd-d-flex-row docutils"> 580<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docut
580ils"> 581<div class="sd-card-header docutils"> 582<p class="sd-card-text"><svg version="1.1" width="2.0em" height="2.0em" class="sd-octicon sd-octicon-code-square sd-text-info" viewBox="0 0 24 24" aria-hidden="true"><path d="M10.3 8.24a.75.75 0 0 1-.04 1.06L7.352 12l2.908 2.7a.75.75 0 1 1-1.02 1.1l-3.5-3.25a.75.75 0 0 1 0-1.1l3.5-3.25a.75.75 0 0 1 1.06.04Zm3.44 1.06a.75.75 0 1 1 1.02-1.1l3.5 3.25a.75.75 0 0 1 0 1.1l-3.5 3.25a.75.75 0 1 1-1.02-1.1l2.908-2.7-2.908-2.7Z"></path><path d="M2 3.75C2 2.784 2.784 2 3.75 2h16.5c.966 0 1.75.784 1.75 1.75v16.5A1.75 1.75 0 0 1 20.25 22H3.75A1.75 1.75 0 0 1 2 20.25Zm1.75-.25a.25.25 0 0 0-.25.25v16.5c0 .138.112.25.25.25h16.5a.25.25 0 0 0 .25-.25V3.75a.25.25 0 0 0-.25-.25Z"></path></svg> Reference</p> 583</div> 584<div class="sd-card-body docutils"> 585<p class="sd-card-text">Documentation of the metadata specification and of the Application Progamming Interface (API), 586which describe how HyperSpy functions work and which parameters can be used.</p> 587</div> 588<a class="sd-stretched-link sd-hide-link-text reference internal" href="reference/index.html"><span class="doc">Reference</span></a></div> 589</div> 590<div class="sd-col sd-d-flex-row docutils"> 591<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils"> 592<div class="sd-card-header docutils"> 593<p class="sd-card-text"><svg version="1.1" width="2.0em" height="2.0em" class="sd-octicon sd-octicon-zap sd-text-info" viewBox="0 0 24 24" aria-hidden="true"><path d="M15.716 1.329a1.341 1.341 0 0 1 2.109 1.55L15.147 9h4.161c1.623 0 2.372 2.016 1.143 3.075L8.102 22.721a1.148 1.148 0 0 1-1.81-1.317L8.996 15H4.674c-1.619 0-2.37-2.008-1.148-3.07l12.19-10.6Zm.452 1.595L4.51 13.061a.25.25 0 0 0 .164.439h5.45a.749.749 0 0 1 .692 1.041l-2.559 6.066 11.215-9.668a.25.25 0 0 0-.164-.439H14a.75.75 0 0 1-.687-1.05Z"></path></svg> Examples</p> 594</div> 595<div class="sd-card-body docutils"> 596<p class="sd-card-text">Gallery of short examples illustrating simple tasks that can be performed with HyperSpy.</p> 597</div> 598<a class="sd-stretched-link sd-hide-link-text reference internal" href="auto_examples/index.html"><span class="doc">Gallery of Examples</span></a></div> 599</div> 600<div class="sd-col sd-d-flex-row docutils"> 601<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils"> 602<div class="sd-card-header docutils"> 603<p class="sd-card-text"><svg version="1.1" width="2.0em" height="2.0em" class="sd-octicon sd-octicon-workflow sd-text-info" viewBox="0 0 24 24" aria-hidden="true"><path d="M1 3a2 2 0 0 1 2-2h6.5a2 2 0 0 1 2 2v6.5a2 2 0 0 1-2 2H7v4.063C7 16.355 7.644 17 8.438 17H12.5v-2.5a2 2 0 0 1 2-2H21a2 2 0 0 1 2 2V21a2 2 0 0 1-2 2h-6.5a2 2 0 0 1-2-2v-2.5H8.437A2.939 2.939 0 0 1 5.5 15.562V11.5H3a2 2 0 0 1-2-2Zm2-.5a.5.5 0 0 0-.5.5v6.5a.5.5 0 0 0 .5.5h6.5a.5.5 0 0 0 .5-.5V3a.5.5 0 0 0-.5-.5ZM14.5 14a.5.5 0 0 0-.5.5V21a.5.5 0 0 0 .5.5H21a.5.5 0 0 0 .5-.5v-6.5a.5.5 0 0 0-.5-.5Z"></path></svg> Tutorials</p> 604</div> 605<div class="sd-card-body docutils"> 606<p class="sd-card-text">Tutorials in form of Jupyter Notebooks to learn how to 607process multi-dimensional data using HyperSpy.</p> 608</div> 609<a class="sd-stretched-link sd-hide-link-text reference external" href="https://github.com/hyperspy/hyperspy-demos"><span>https://github.com/hyperspy/hyperspy-demos</span></a></div> 610</div> 611<div class="sd-col sd-d-flex-row docutils"> 612<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils"> 613<div class="sd-card-header docutils"> 614<p class="sd-card-text"><svg version="1.1" width="2.0em" height="2.0em" class="sd-octicon sd-octicon-people sd-text-info" viewBox="0 0 24 24" aria-hidden="true"><path d="M3.5 8a5.5 5.5 0 1 1 8.596 4.547 9.005 9.005 0 0 1 5.9 8.18.751.751 0 0 1-1.5.045 7.5 7.5 0 0 0-14.993 0 .75.75 0 0 1-1.499-.044 9.005 9.005 0 0 1 5.9-8.181A5.496 5.496 0 0 1 3.5 8ZM9 4a4 4 0 1 0 0 8 4 4 0 0 0 0-8Zm8.29 4c-.148 0-.292.01-.434.03a.75.75 0 1 1-.212-1.484 4.53 4.53 0 0 1 3.38 8.097 6.69 6.69 0 0 1 3.956 6.107.75.75 0 0 1-1.5 0 5.193 5.193 0 0 0-3.696-4.972l-.534-.16v-1.676l.41-.209A3.03 3.03 0 0 0 17.29 8Z"></path></svg> Contributing</p> 615</div> 616<div class="sd-card-body docutils"> 617<p class="sd-card-text">HyperSpy is a community project maintained for and by its users. 618There are many ways you can help!</p> 619</div> 620<a class="sd-stretched-link sd-hide-link-text reference internal" href="dev_guide/index.html"><span class="doc">
620Contribute</span></a></div> 621</div> 622</div> 623</div> 624</section> 625<section id="citing-hyperspy"> 626<h1>Citing HyperSpy<a class="headerlink" href="#citing-hyperspy" title="Link to this heading">#</a></h1> 627<p>If HyperSpy has been significant to a project that leads to an academic 628publication, please acknowledge that fact by citing it. The DOI in the 629badge below is the <a class="reference external" href="https://support.zenodo.org/help/en-gb/1-upload-deposit/97-what-is-doi-versioning">Concept DOI</a> of 630HyperSpy. It can be used to cite the project without referring to a specific 631version. If you are citing HyperSpy because you have used it to process data, 632please use the DOI of the specific version that you have employed. You can 633find iy by clicking on the DOI badge below.</p> 634<a class="reference external image-reference" href="https://doi.org/10.5281/zenodo.592838"><img alt="https://zenodo.org/badge/doi/10.5281/zenodo.592838.svg" src="https://zenodo.org/badge/doi/10.5281/zenodo.592838.svg" /> 635</a> 636<section id="hyperspy-s-citation-in-the-scientific-literature"> 637<h2>HyperSpyâs citation in the scientific literature<a class="headerlink" href="#hyperspy-s-citation-in-the-scientific-literature" title="Link to this heading">#</a></h2> 638<p>Given the increasing number of articles that cite HyperSpy we do not maintain a list of 639articles citing HyperSpy. For an up to date list search for 640HyperSpy in a scientific database e.g. <a class="reference external" href="https://scholar.google.co.uk/scholar?q=hyperspy">Google Scholar</a>.</p> 641<div class="admonition note"> 642<p class="admonition-title">Note</p> 643<p>Articles published before 2012 may mention the HyperSpy project under 644its old name, <cite>EELSLab</cite>.</p> 645</div> 646</section> 647</section> 648<section id="credits"> 649<h1>Credits<a class="headerlink" href="#credits" title="Link to this heading">#</a></h1> 650<p>HyperSpy is maintained by <a class="reference external" href="https://github.com/hyperspy/hyperspy/contributors">an active community of developers</a>.</p> 651<p>The HyperSpy logo was created by Stefano Mazzucco. It is a modified version of <a class="reference external" href="http://en.wikipedia.org/wiki/File:Hypercube.svg">this figure</a> and the same GFDL license applies.</p> 652</section> 653 654 655 </article> 656 657 658 659 660 661 <footer class="prev-next-footer d-print-none"> 662 663<div class="prev-next-area"> 664 <a class="right-next" 665 href="user_guide/index.html" 666 title="next page"> 667 <div class="prev-next-info"> 668 <p class="prev-next-subtitle">next</p> 669 <p class="prev-next-title">User guide</p> 670 </div> 671 <i class="fa-solid fa-angle-right"></i> 672 </a> 673</div> 674 </footer> 675 676 </div> 677 678 679 680 <dialog id="pst-secondary-sidebar-modal"></dialog> 681 <div id="pst-secondary-sidebar" class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner"> 682 683 684 <div class="sidebar-secondary-item"> 685<div 686 id="pst-page-navigation-heading-2" 687 class="page-toc tocsection onthispage"> 688 <i class="fa-solid fa-list"></i> On this page 689 </div> 690 <nav class="bd-toc-nav page-toc" aria-labelledby="pst-page-navigation-heading-2"> 691 <ul class="visible nav section-nav flex-column"> 692<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#">What is HyperSpy</a></li> 693<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#hyperspy-s-character">HyperSpyâs character</a></li> 694<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#learning-resources">Learning resources</a></li> 695<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#citing-hyperspy">Citing HyperSpy</a><ul class="visible nav section-nav flex-column"> 696<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#hyperspy-s-citation-in-the-scientific-literature">HyperSpyâs citation in the scientific literature</a></li> 697</ul> 698</li> 699<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#credits">Credits</a></li> 700</ul> 701 702 </nav></div> 703 704 <div class="sidebar-secondary-item"> 705 <div role="note" aria-label="source link"> 706 <h3>This Page</h3> 707 <ul class="this-page-menu"> 708 <li><a href="_sources/index.rst.txt" 709 rel="nofollow">Show Source</a></li> 710 </ul> 711 </div></div> 712 713</div></div> 714 715 716 </div> 717 <footer class="bd-footer-content"> 718 719 </footer> 720 721 </main> 722 </div> 723 </div> 724 725 <!-- Scripts loaded after <body> so the DOM is not blocked --> 726
726<script defer src="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf"></script>
vendor: 1 bytes, line 726
726
727<script defer src="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf"></script>
727 728 729 <footer class="bd-footer"> 730<div class="bd-footer__inner bd-page-width"> 731 732 <div class="footer-items__start"> 733 734 <div class="footer-item"> 735 736 <p class="copyright"> 737 738 © Copyright 2011-2026, The HyperSpy development team. 739 <br/> 740 741 </p> 742</div> 743 744 <div class="footer-item"> 745 746 <p class="sphinx-version"> 747 Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.1.0. 748 <br/> 749 </p> 750</div> 751 752 </div> 753 754 755 756 <div class="footer-items__end"> 757 758 <div class="footer-item"> 759<p class="theme-version"> 760 <!-- # L10n: Setting the PST URL as an argument as this does not need to be localized --> 761 Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.16.1. 762</p></div> 763 764 </div> 765 766</div> 767 768 </footer> 769 </body> 770</html>
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.