PageRenderTime 50ms CodeModel.GetById 24ms RepoModel.GetById 1ms app.codeStats 0ms

/v1.6/api/hyperspy.signals.html

https://github.com/hyperspy/hyperspy-doc
HTML | 242 lines | 219 code | 20 blank | 3 comment | 0 complexity | e720fab875bbff79e577327bca5c0087 MD5 | raw file
    

  1. <!DOCTYPE html>
    2. 

  2. <html class="writer-html5" lang="en" >
    3. 

  3. <head>
    4. 

  4.   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
    5. 

  5. 

  6.   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    7. 

  7.   <title>hyperspy.signals module &mdash; HyperSpy 1.6.5 documentation</title>
    8. 

  8.       <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    9. 

  9.       <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    10. 

  10.       <link rel="stylesheet" href="../_static/graphviz.css" type="text/css" />
    11. 

  11.     <link rel="shortcut icon" href="../_static/hyperspy.ico"/>
    12. 

  12.   <!--[if lt IE 9]>
    13. 

  13.     <script src="../_static/js/html5shiv.min.js"></script>
    14. 

  14.   <![endif]-->
    15. 

  15.   
    16. 

  16.         <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
    17. 

  17.         <script src="../_static/jquery.js"></script>
    18. 

  18.         <script src="../_static/underscore.js"></script>
    19. 

  19.         <script src="../_static/doctools.js"></script>
    20. 

  20.         <script src="../_static/toggleprompt.js"></script>
    21. 

  21.     <script src="../_static/js/theme.js"></script>
    22. 

  22.     <link rel="index" title="Index" href="../genindex.html" />
    23. 

  23.     <link rel="search" title="Search" href="../search.html" />
    24. 

  24.     <link rel="next" title="hyperspy.ui_registry module" href="hyperspy.ui_registry.html" />
    25. 

  25.     <link rel="prev" title="hyperspy.signal_tools module" href="hyperspy.signal_tools.html" />
    26. 

  26.  
    27. 

  27. <script type="text/javascript">
    28. 

  28. 

  29.   var _gaq = _gaq || [];
    30. 

  30.   _gaq.push(['_setAccount', 'UA-25260850-1']);
    31. 

  31.   _gaq.push(['_trackPageview']);
    32. 

  32. 

  33.   (function() {
    34. 

  34.     var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
    35. 

  35.     ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
    36. 

  36.     var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
    37. 

  37.   })();
    38. 

  38. 

  39. </script>
    40. 

  40. 

  41. </head>
    42. 

  42. 

  43. <body class="wy-body-for-nav"> 
    44. 

  44.   <div class="wy-grid-for-nav">
    45. 

  45.     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
    46. 

  46.       <div class="wy-side-scroll">
    47. 

  47.         <div class="wy-side-nav-search" >
    48. 

  48.             <a href="../index.html" class="icon icon-home"> HyperSpy
    49. 

  49.             <img src="../_static/hyperspy_logo.png" class="logo" alt="Logo"/>
    50. 

  50.           </a>
    51. 

  51.               <div class="version">
    52. 

  52.                 1.6.5
    53. 

  53.               </div>
    54. 

  54. <div role="search">
    55. 

  55.   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
    56. 

  56.     <input type="text" name="q" placeholder="Search docs" />
    57. 

  57.     <input type="hidden" name="check_keywords" value="yes" />
    58. 

  58.     <input type="hidden" name="area" value="default" />
    59. 

  59.   </form>
    60. 

  60. </div>
    61. 

  61.         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
    62. 

  62.               <p class="caption" role="heading"><span class="caption-text">User Guide</span></p>
    63. 

  63. <ul>
    64. 

  64. <li class="toctree-l1"><a class="reference internal" href="../user_guide/intro.html">Introduction</a></li>
    65. 

  65. <li class="toctree-l1"><a class="reference internal" href="../user_guide/changes.html">Changelog</a></li>
    66. 

  66. <li class="toctree-l1"><a class="reference internal" href="../user_guide/install.html">Installing HyperSpy</a></li>
    67. 

  67. <li class="toctree-l1"><a class="reference internal" href="../user_guide/getting_started.html">Getting started</a></li>
    68. 

  68. <li class="toctree-l1"><a class="reference internal" href="../user_guide/signal.html">The Signal class</a></li>
    69. 

  69. <li class="toctree-l1"><a class="reference internal" href="../user_guide/interactive_operations_ROIs.html">Interactive Operations and Region of Interest (ROI)</a></li>
    70. 

  70. <li class="toctree-l1"><a class="reference internal" href="../user_guide/signal1d.html">Signal1D Tools</a></li>
    71. 

  71. <li class="toctree-l1"><a class="reference internal" href="../user_guide/signal2d.html">Signal2D Tools</a></li>
    72. 

  72. <li class="toctree-l1"><a class="reference internal" href="../user_guide/visualisation.html">Data visualization</a></li>
    73. 

  73. <li class="toctree-l1"><a class="reference internal" href="../user_guide/mva.html">Machine learning</a></li>
    74. 

  74. <li class="toctree-l1"><a class="reference internal" href="../user_guide/model.html">Model fitting</a></li>
    75. 

  75. <li class="toctree-l1"><a class="reference internal" href="../user_guide/eels.html">Electron Energy Loss Spectroscopy</a></li>
    76. 

  76. <li class="toctree-l1"><a class="reference internal" href="../user_guide/eds.html">Energy-Dispersive X-ray Spectrometry (EDS)</a></li>
    77. 

  77. <li class="toctree-l1"><a class="reference internal" href="../user_guide/dielectric_function.html">Dielectric function tools</a></li>
    78. 

  78. <li class="toctree-l1"><a class="reference internal" href="../user_guide/electron_holography.html">Electron Holography</a></li>
    79. 

  79. <li class="toctree-l1"><a class="reference internal" href="../user_guide/io.html">Loading and saving data</a></li>
    80. 

  80. <li class="toctree-l1"><a class="reference internal" href="../user_guide/events.html">Events</a></li>
    81. 

  81. <li class="toctree-l1"><a class="reference internal" href="../user_guide/big_data.html">Working with big data</a></li>
    82. 

  82. <li class="toctree-l1"><a class="reference internal" href="../user_guide/metadata_structure.html">Metadata structure</a></li>
    83. 

  83. <li class="toctree-l1"><a class="reference internal" href="../user_guide/bibliography.html">Bibliography</a></li>
    84. 

  84. </ul>
    85. 

  85. <p class="caption" role="heading"><span class="caption-text">Developer Guide</span></p>
    86. 

  86. <ul>
    87. 

  87. <li class="toctree-l1"><a class="reference internal" href="../dev_guide/intro.html">Introduction</a></li>
    88. 

  88. <li class="toctree-l1"><a class="reference internal" href="../dev_guide/git.html">Using Git and GitHub</a></li>
    89. 

  89. <li class="toctree-l1"><a class="reference internal" href="../dev_guide/testing.html">Running and writing tests</a></li>
    90. 

  90. <li class="toctree-l1"><a class="reference internal" href="../dev_guide/writing_docs.html">Writing documentation</a></li>
    91. 

  91. <li class="toctree-l1"><a class="reference internal" href="../dev_guide/coding_style.html">Coding style</a></li>
    92. 

  92. <li class="toctree-l1"><a class="reference internal" href="../dev_guide/lazy_computations.html">Tips for writing methods that work on lazy signals</a></li>
    93. 

  93. <li class="toctree-l1"><a class="reference internal" href="../dev_guide/speeding_up_code.html">Speeding up code</a></li>
    94. 

  94. <li class="toctree-l1"><a class="reference internal" href="../dev_guide/writing_extensions.html">Writing packages that extend HyperSpy</a></li>
    95. 

  95. <li class="toctree-l1"><a class="reference internal" href="../dev_guide/useful_information.html">Useful information</a></li>
    96. 

  96. </ul>
    97. 

  97. <p class="caption" role="heading"><span class="caption-text">API References</span></p>
    98. 

  98. <ul class="current">
    99. 

  99. <li class="toctree-l1 current"><a class="reference internal" href="modules.html">hyperspy</a><ul class="current">
    100. 

  100. <li class="toctree-l2 current"><a class="reference internal" href="hyperspy.html">hyperspy package</a><ul class="current">
    101. 

  101. <li class="toctree-l3"><a class="reference internal" href="hyperspy.html#subpackages">Subpackages</a></li>
    102. 

  102. <li class="toctree-l3 current"><a class="reference internal" href="hyperspy.html#submodules">Submodules</a><ul class="current">
    103. 

  103. <li class="toctree-l4"><a class="reference internal" href="hyperspy.Release.html">hyperspy.Release module</a></li>
    104. 

  104. <li class="toctree-l4"><a class="reference internal" href="hyperspy._lazy_signals.html">hyperspy._lazy_signals module</a></li>
    105. 

  105. <li class="toctree-l4"><a class="reference internal" href="hyperspy.api.html">hyperspy.api module</a></li>
    106. 

  106. <li class="toctree-l4"><a class="reference internal" href="hyperspy.api_nogui.html">hyperspy.api_nogui module</a></li>
    107. 

  107. <li class="toctree-l4"><a class="reference internal" href="hyperspy.axes.html">hyperspy.axes module</a></li>
    108. 

  108. <li class="toctree-l4"><a class="reference internal" href="hyperspy.component.html">hyperspy.component module</a></li>
    109. 

  109. <li class="toctree-l4"><a class="reference internal" href="hyperspy.components1d.html">hyperspy.components1d module</a></li>
    110. 

  110. <li class="toctree-l4"><a class="reference internal" href="hyperspy.components2d.html">hyperspy.components2d module</a></li>
    111. 

  111. <li class="toctree-l4"><a class="reference internal" href="hyperspy.conftest.html">hyperspy.conftest module</a></li>
    112. 

  112. <li class="toctree-l4"><a class="reference internal" href="hyperspy.decorators.html">hyperspy.decorators module</a></li>
    113. 

  113. <li class="toctree-l4"><a class="reference internal" href="hyperspy.defaults_parser.html">hyperspy.defaults_parser module</a></li>
    114. 

  114. <li class="toctree-l4"><a class="reference internal" href="hyperspy.events.html">hyperspy.events module</a></li>
    115. 

  115. <li class="toctree-l4"><a class="reference internal" href="hyperspy.exceptions.html">hyperspy.exceptions module</a></li>
    116. 

  116. <li class="toctree-l4"><a class="reference internal" href="hyperspy.extensions.html">hyperspy.extensions module</a></li>
    117. 

  117. <li class="toctree-l4"><a class="reference internal" href="hyperspy.interactive.html">hyperspy.interactive module</a></li>
    118. 

  118. <li class="toctree-l4"><a class="reference internal" href="hyperspy.io.html">hyperspy.io module</a></li>
    119. 

  119. <li class="toctree-l4"><a class="reference internal" href="hyperspy.logger.html">hyperspy.logger module</a></li>
    120. 

  120. <li class="toctree-l4"><a class="reference internal" href="hyperspy.model.html">hyperspy.model module</a></li>
    121. 

  121. <li class="toctree-l4"><a class="reference internal" href="hyperspy.roi.html">hyperspy.roi module</a></li>
    122. 

  122. <li class="toctree-l4"><a class="reference internal" href="hyperspy.samfire.html">hyperspy.samfire module</a></li>
    123. 

  123. <li class="toctree-l4"><a class="reference internal" href="hyperspy.signal.html">hyperspy.signal module</a></li>
    124. 

  124. <li class="toctree-l4"><a class="reference internal" href="hyperspy.signal_tools.html">hyperspy.signal_tools module</a></li>
    125. 

  125. <li class="toctree-l4 current"><a class="current reference internal" href="#">hyperspy.signals module</a></li>
    126. 

  126. <li class="toctree-l4"><a class="reference internal" href="hyperspy.ui_registry.html">hyperspy.ui_registry module</a></li>
    127. 

  127. </ul>
    128. 

  128. </li>
    129. 

  129. <li class="toctree-l3"><a class="reference internal" href="hyperspy.html#module-hyperspy">Module contents</a></li>
    130. 

  130. </ul>
    131. 

  131. </li>
    132. 

  132. </ul>
    133. 

  133. </li>
    134. 

  134. </ul>
    135. 

  135. <p class="caption" role="heading"><span class="caption-text">Credits and citation</span></p>
    136. 

  136. <ul>
    137. 

  137. <li class="toctree-l1"><a class="reference internal" href="../credits.html">Credits</a></li>
    138. 

  138. <li class="toctree-l1"><a class="reference internal" href="../citing.html">Citing HyperSpy</a></li>
    139. 

  139. </ul>
    140. 

  140. 

  141.         </div>
    142. 

  142.       </div>
    143. 

  143.     </nav>
    144. 

  144. 

  145.     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
    146. 

  146.           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
    147. 

  147.           <a href="../index.html">HyperSpy</a>
    148. 

  148.       </nav>
    149. 

  149. 

  150.       <div class="wy-nav-content">
    151. 

  151.         <div class="rst-content">
    152. 

  152.           <div role="navigation" aria-label="Page navigation">
    153. 

  153.   <ul class="wy-breadcrumbs">
    154. 

  154.       <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
    155. 

  155.           <li><a href="modules.html">hyperspy</a> &raquo;</li>
    156. 

  156.           <li><a href="hyperspy.html">hyperspy package</a> &raquo;</li>
    157. 

  157.       <li>hyperspy.signals module</li>
    158. 

  158.       <li class="wy-breadcrumbs-aside">
    159. 

  159.             <a href="../_sources/api/hyperspy.signals.rst.txt" rel="nofollow"> View page source</a>
    160. 

  160.       </li>
    161. 

  161.   </ul>
    162. 

  162.   <hr/>
    163. 

  163. </div>
    164. 

  164.           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
    165. 

  165.            <div itemprop="articleBody">
    166. 

  166.              
    167. 

  167.   <section id="module-hyperspy.signals">
    168. 

  168. <span id="hyperspy-signals-module"></span><h1>hyperspy.signals module<a class="headerlink" href="#module-hyperspy.signals" title="Permalink to this headline"></a></h1>
    169. 

  169. <p>The Signal class and its specialized subclasses:</p>
    170. 

  170. <blockquote>
    171. 

  171. <div><dl class="simple">
    172. 

  172. <dt>BaseSignal</dt><dd><p>For generic data with arbitrary signal_dimension. All other signal
    173. 

  173. classes inherit from this one. It should only be used with none of
    174. 

  174. the others is appropriated.</p>
    175. 

  175. </dd>
    176. 

  176. <dt>Signal1D</dt><dd><p>For generic data with signal_dimension equal 1, i.e. spectral data of
    177. 

  177. n-dimensions. The signal is unbinned by default.</p>
    178. 

  178. </dd>
    179. 

  179. <dt>Signal2D</dt><dd><p>For generic data with signal_dimension equal 2, i.e. image data of
    180. 

  180. n-dimensions. The signal is unbinned by default.</p>
    181. 

  181. </dd>
    182. 

  182. <dt>ComplexSignal</dt><dd><p>For generic complex data with arbitrary signal_dimension.</p>
    183. 

  183. </dd>
    184. 

  184. <dt>ComplexSignal1D</dt><dd><p>For generic complex data with signal_dimension equal 1, i.e. spectral
    185. 

  185. data of n-dimensions. The signal is unbinned by default.</p>
    186. 

  186. </dd>
    187. 

  187. <dt>ComplexSignal2D</dt><dd><p>For generic complex data with signal_dimension equal 2, i.e. image
    188. 

  188. data of n-dimensions. The signal is unbinned by default.</p>
    189. 

  189. </dd>
    190. 

  190. <dt>EELSSpectrum</dt><dd><p>For electron energy-loss data with signal_dimension equal 1, i.e.
    191. 

  191. spectral data of n-dimensions. The signal is binned by default.</p>
    192. 

  192. </dd>
    193. 

  193. <dt>EDSTEMSpectrum</dt><dd><p>For electron energy-dispersive X-rays data acquired in a transmission
    194. 

  194. electron microscopy with signal_dimension equal 1, i.e.
    195. 

  195. spectral data of n-dimensions. The signal is binned by default.</p>
    196. 

  196. </dd>
    197. 

  197. <dt>EDSSEMSpectrum</dt><dd><p>For electron energy-dispersive X-rays data acquired in a scanning
    198. 

  198. electron microscopy with signal_dimension equal 1, i.e.
    199. 

  199. spectral data of n-dimensions. The signal is binned by default.</p>
    200. 

  200. </dd>
    201. 

  201. <dt>DielectricFunction</dt><dd><p>For dielectric function data with signal_dimension equal 1. The signal
    202. 

  202. is unbinned by default.</p>
    203. 

  203. </dd>
    204. 

  204. <dt>HolographyImage</dt><dd><p>For 2D-images taken via electron holography. Electron wave as
    205. 

  205. ComplexSignal2D can be reconstructed from them.</p>
    206. 

  206. </dd>
    207. 

  207. </dl>
    208. 

  208. </div></blockquote>
    209. 

  209. </section>
    210. 

  210. 

  211. 

  212.            </div>
    213. 

  213.           </div>
    214. 

  214.           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
    215. 

  215.         <a href="hyperspy.signal_tools.html" class="btn btn-neutral float-left" title="hyperspy.signal_tools module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
    216. 

  216.         <a href="hyperspy.ui_registry.html" class="btn btn-neutral float-right" title="hyperspy.ui_registry module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    217. 

  217.     </div>
    218. 

  218. 

  219.   <hr/>
    220. 

  220. 

  221.   <div role="contentinfo">
    222. 

  222.     <p>&#169; Copyright 2011-2021, The HyperSpy development team.</p>
    223. 

  223.   </div>
    224. 

  224. 

  225.   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    226. 

  226.     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    227. 

  227.     provided by <a href="https://readthedocs.org">Read the Docs</a>.
    228. 

  228.    
    229. 

  229. 

  230. </footer>
    231. 

  231.         </div>
    232. 

  232.       </div>
    233. 

  233.     </section>
    234. 

  234.   </div>
    235. 

  235.   <script>
    236. 

  236.       jQuery(function () {
    237. 

  237.           SphinxRtdTheme.Navigation.enable(true);
    238. 

  238.       });
    239. 

  239.   </script> 
    240. 

  240. 

  241. </body>
    242. 

  242. </html>
    243.