deploy: 7ab380d

analogdevicesinc · Oct 26, 2023 · fb99b95 · fb99b95
1 parent ad0a7f8
commit fb99b95
Show file tree

Hide file tree

Showing 23 changed files with 624 additions and 355 deletions.
diff --git a/master/.doctrees/environment.pickle b/master/.doctrees/environment.pickle
diff --git a/master/.doctrees/reference.doctree b/master/.doctrees/reference.doctree
diff --git a/master/01_introduction.html b/master/01_introduction.html
@@ -1,13 +1,13 @@
 <!doctype html>
-<html class="no-js" lang="en">
+<html class="no-js" lang="en" data-content_root="./">
   <head><meta charset="utf-8"/>
     <meta name="viewport" content="width=device-width,initial-scale=1"/>
     <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Installation" href="setup.html" /><link rel="prev" title="genalyzer: Data Converter Library" href="index.html" />
 
-    <!-- Generated with Sphinx 7.1.0 and Furo 2023.07.26 -->
+    <!-- Generated with Sphinx 7.2.6 and Furo 2023.09.10 -->
         <title>Introduction - Genalyzer v0.0.1 documentation</title>
-      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=362ab14a" />
+      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=135e06be" />
     <link rel="stylesheet" type="text/css" href="_static/tabs.css?v=4c969af8" />
     <link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=eafc0fe6" />
@@ -200,7 +200,7 @@
         </div>
         <article role="main">
           <section id="introduction">
-<h1>Introduction<a class="headerlink" href="#introduction" title="Permalink to this heading">#</a></h1>
+<h1>Introduction<a class="headerlink" href="#introduction" title="Link to this heading">#</a></h1>
 <p>Genalyzer is a C++ library that facilitates the computation of commonly used data-converter RF performance metrics in a standards-complaint manner. Genalyzer supports generation of waveforms for characterizing data-converters as well as the computation of performance metrics given the time- or frequency-domain response of data-converters to such waveforms. In other words, users not only have the option of selecting whether or not to opt for waveform generation to characterize data-convereters, but are also able to utilize time-series data or FFT of samples captured from a data-convereter to directly compute the desired performance metrics.</p>
 <p>Thus, Genalyzer can support a simulation-only scenario or a data-capture scenario. In the first case, the response of a data-converter is simulated given its specifications, in order to compute the expected performance metrics. In the second case, the response of a data-converter is available for Genalyzer to process in the form of a text or binary file. Genalyzer facilitates the computation of common data converter performance metrics in a standards-complaint manner. The terminology and definitions for various common performance metrics are adopted from the IEEE Standard for Terminology and Test Methods for Analog-to-Digital Converters (IEEE 1241-2010) and the IEEE Standard for Terminology and Test Methods of Digital-to-Analog Converter Devices (IEEE 1658-2011) both published by Instrumentation and Measurement/Waveform Generation, Measurement, and Analysis - Technical Committee 10 (IM/WM&amp;A - TC10).</p>
 </section>
@@ -254,9 +254,9 @@ <h1>Introduction<a class="headerlink" href="#introduction" title="Permalink to t
 
     </aside>
   </div>
-</div><script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=57cfd03c"></script>
+</div><script src="_static/documentation_options.js?v=2fea6348"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
-    <script src="_static/sphinx_highlight.js?v=4825356b"></script>
+    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/scripts/furo.js?v=32e29ea5"></script>
     <script src="_static/tabs.js?v=3ee01567"></script>
     </body>

diff --git a/master/02_using_genalyzer.html b/master/02_using_genalyzer.html
@@ -1,13 +1,13 @@
 <!doctype html>
-<html class="no-js" lang="en">
+<html class="no-js" lang="en" data-content_root="./">
   <head><meta charset="utf-8"/>
     <meta name="viewport" content="width=device-width,initial-scale=1"/>
     <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" />
 
-    <!-- Generated with Sphinx 7.1.0 and Furo 2023.07.26 -->
+    <!-- Generated with Sphinx 7.2.6 and Furo 2023.09.10 -->
         <title>Using Genalyzer - Genalyzer v0.0.1 documentation</title>
-      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=362ab14a" />
+      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=135e06be" />
     <link rel="stylesheet" type="text/css" href="_static/tabs.css?v=4c969af8" />
     <link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=eafc0fe6" />
@@ -200,7 +200,7 @@
         </div>
         <article role="main">
           <section id="using-genalyzer">
-<h1>Using Genalyzer<a class="headerlink" href="#using-genalyzer" title="Permalink to this heading">#</a></h1>
+<h1>Using Genalyzer<a class="headerlink" href="#using-genalyzer" title="Link to this heading">#</a></h1>
 <p>As mentioned previously, Genalyzer is a C++ library designed to support computation of RF performance metrics using either simulation data or data captured from a physical instrument. Bindings are provided to enable users to write C- or Python-based scripts to compute the desired performance metrics. In both cases, the overall structure of a C-example script that links to genalyzer library is similar, as shown in the next section. The overall structure in a simulation-only scenario consists of three stages:</p>
 <ul class="simple">
 <li><p>Test Configuration</p></li>
@@ -255,9 +255,9 @@ <h1>Using Genalyzer<a class="headerlink" href="#using-genalyzer" title="Permalin
 </pre></div>
 </div>
 <section id="test-configuration">
-<h2>Test Configuration<a class="headerlink" href="#test-configuration" title="Permalink to this heading">#</a></h2>
+<h2>Test Configuration<a class="headerlink" href="#test-configuration" title="Link to this heading">#</a></h2>
 <section id="tone-based-test-configuration">
-<h3>Tone-based Test Configuration<a class="headerlink" href="#tone-based-test-configuration" title="Permalink to this heading">#</a></h3>
+<h3>Tone-based Test Configuration<a class="headerlink" href="#tone-based-test-configuration" title="Link to this heading">#</a></h3>
 <p>In tone-based test configuration, <code class="docutils literal notranslate"><span class="pre">config_tone_meas()</span></code> allows users to indicate test settings such as, number of tones, their frequencies, phases, scales, whether real sinusoidal or complex-exponential waveforms are to be generated, the sample-rate, full-scale range of the converter, its resolution etc. Similarly, users can indicate whether the data that will be loaded in the second stage is time-series data or interleaved FFT samples. Moreover, in data-capture scenario i.e., when FFT data is provided to Genalyzer in the second step, the tone frequency, scale and phase information is not required. This test configuration is used for measurements such as SFDR, THD, TIL etc.</p>
 <p>An example of the <code class="docutils literal notranslate"><span class="pre">config_tone_meas()</span></code> function call is shown by the following example.</p>
 <div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="w">  </span><span class="c1">// configuration</span>
@@ -281,7 +281,7 @@ <h3>Tone-based Test Configuration<a class="headerlink" href="#tone-based-test-co
 </div>
 </section>
 <section id="ramp-based-test-configuration">
-<h3>Ramp-based Test Configuration<a class="headerlink" href="#ramp-based-test-configuration" title="Permalink to this heading">#</a></h3>
+<h3>Ramp-based Test Configuration<a class="headerlink" href="#ramp-based-test-configuration" title="Link to this heading">#</a></h3>
 <p>In ramp-based test configuration, <code class="docutils literal notranslate"><span class="pre">config_ramp_meas()</span></code> allows users to indicate test settings such as, the starting and ending values of the ramp waveform in addition to the full-scale range and the resolution of the data converter under test. This test configuration is primarily used in non-linearity based measurements.</p>
 <p>An example of the <code class="docutils literal notranslate"><span class="pre">config_ramp_meas()</span></code> function call is shown by the following example.</p>
 <div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="w">  </span><span class="c1">// configuration</span>
@@ -298,7 +298,7 @@ <h3>Ramp-based Test Configuration<a class="headerlink" href="#ramp-based-test-co
 </div>
 </section>
 <section id="noise-based-test-configuration">
-<h3>Noise-based Test Configuration<a class="headerlink" href="#noise-based-test-configuration" title="Permalink to this heading">#</a></h3>
+<h3>Noise-based Test Configuration<a class="headerlink" href="#noise-based-test-configuration" title="Link to this heading">#</a></h3>
 <p>In noise-based test configuration, <code class="docutils literal notranslate"><span class="pre">config_noise_meas()</span></code> allows users to indicate test settings such as, the noise power level in addition to the full-scale range and the resolution of the data converter under test. This test configuration is primarily used for computing noise spectral density.</p>
 <p>An example of the <code class="docutils literal notranslate"><span class="pre">config_noise_meas()</span></code> function call is shown by the following example.</p>
 <div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="w">  </span><span class="c1">// configuration</span>
@@ -318,7 +318,7 @@ <h3>Noise-based Test Configuration<a class="headerlink" href="#noise-based-test-
 </section>
 </section>
 <section id="waveform-generation">
-<h2>Waveform Generation<a class="headerlink" href="#waveform-generation" title="Permalink to this heading">#</a></h2>
+<h2>Waveform Generation<a class="headerlink" href="#waveform-generation" title="Link to this heading">#</a></h2>
 <p>The second step, as shown previously, involves either generating the waveform and quantizing it or loading the waveform from a file. The following options are currently supported.</p>
 <ul class="simple">
 <li><p>cosine/sine and complex exponential waveforms of arbitrary frequency and sample rate</p></li>
@@ -352,7 +352,7 @@ <h2>Waveform Generation<a class="headerlink" href="#waveform-generation" title="
 </div>
 </section>
 <section id="performance-metric-computation">
-<h2>Performance Metric Computation<a class="headerlink" href="#performance-metric-computation" title="Permalink to this heading">#</a></h2>
+<h2>Performance Metric Computation<a class="headerlink" href="#performance-metric-computation" title="Link to this heading">#</a></h2>
 <p>The final stage involves simply computing the desired performance metric. Metric computation is done by a call to <code class="docutils literal notranslate"><span class="pre">metric()</span></code> where, the last argument is one of:</p>
 <table class="hlist"><tr><td><ul class="simple">
 <li><p><code class="docutils literal notranslate"><span class="pre">&quot;FSNR&quot;</span></code></p></li>
@@ -434,9 +434,9 @@ <h2>Performance Metric Computation<a class="headerlink" href="#performance-metri
 
     </aside>
   </div>
-</div><script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=57cfd03c"></script>
+</div><script src="_static/documentation_options.js?v=2fea6348"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
-    <script src="_static/sphinx_highlight.js?v=4825356b"></script>
+    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/scripts/furo.js?v=32e29ea5"></script>
     <script src="_static/tabs.js?v=3ee01567"></script>
     </body>

diff --git a/master/02a_test_configuration.html b/master/02a_test_configuration.html
@@ -1,13 +1,13 @@
 <!doctype html>
-<html class="no-js" lang="en">
+<html class="no-js" lang="en" data-content_root="./">
   <head><meta charset="utf-8"/>
     <meta name="viewport" content="width=device-width,initial-scale=1"/>
     <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" />
 
-    <!-- Generated with Sphinx 7.1.0 and Furo 2023.07.26 -->
+    <!-- Generated with Sphinx 7.2.6 and Furo 2023.09.10 -->
         <title>Test Configuration - Genalyzer v0.0.1 documentation</title>
-      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=362ab14a" />
+      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=135e06be" />
     <link rel="stylesheet" type="text/css" href="_static/tabs.css?v=4c969af8" />
     <link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=eafc0fe6" />
@@ -200,9 +200,9 @@
         </div>
         <article role="main">
           <section id="test-configuration">
-<h1>Test Configuration<a class="headerlink" href="#test-configuration" title="Permalink to this heading">#</a></h1>
+<h1>Test Configuration<a class="headerlink" href="#test-configuration" title="Link to this heading">#</a></h1>
 <section id="tone-based-test-configuration">
-<h2>Tone-based Test Configuration<a class="headerlink" href="#tone-based-test-configuration" title="Permalink to this heading">#</a></h2>
+<h2>Tone-based Test Configuration<a class="headerlink" href="#tone-based-test-configuration" title="Link to this heading">#</a></h2>
 <p>In tone-based test configuration, <code class="docutils literal notranslate"><span class="pre">config_tone_meas()</span></code> allows users to indicate test settings such as, number of tones, their frequencies, phases, scales, whether real sinusoidal or complex-exponential waveforms are to be generated, the sample-rate, full-scale range of the converter, its resolution etc. Similarly, users can indicate whether the data that will be loaded in the second stage is time-series data or interleaved FFT samples. Moreover, in data-capture scenario i.e., when FFT data is provided to Genalyzer in the second step, the tone frequency, scale and phase information is not required. This test configuration is used for measurements such as SFDR, THD, TIL etc.</p>
 <p>An example of the <code class="docutils literal notranslate"><span class="pre">config_tone_meas()</span></code> function call is shown by the following example.</p>
 <div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="w">  </span><span class="c1">// configuration</span>
@@ -226,7 +226,7 @@ <h2>Tone-based Test Configuration<a class="headerlink" href="#tone-based-test-co
 </div>
 </section>
 <section id="ramp-based-test-configuration">
-<h2>Ramp-based Test Configuration<a class="headerlink" href="#ramp-based-test-configuration" title="Permalink to this heading">#</a></h2>
+<h2>Ramp-based Test Configuration<a class="headerlink" href="#ramp-based-test-configuration" title="Link to this heading">#</a></h2>
 <p>In ramp-based test configuration, <code class="docutils literal notranslate"><span class="pre">config_ramp_meas()</span></code> allows users to indicate test settings such as, the starting and ending values of the ramp waveform in addition to the full-scale range and the resolution of the data converter under test. This test configuration is primarily used in non-linearity based measurements.</p>
 <p>An example of the <code class="docutils literal notranslate"><span class="pre">config_ramp_meas()</span></code> function call is shown by the following example.</p>
 <div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="w">  </span><span class="c1">// configuration</span>
@@ -243,7 +243,7 @@ <h2>Ramp-based Test Configuration<a class="headerlink" href="#ramp-based-test-co
 </div>
 </section>
 <section id="noise-based-test-configuration">
-<h2>Noise-based Test Configuration<a class="headerlink" href="#noise-based-test-configuration" title="Permalink to this heading">#</a></h2>
+<h2>Noise-based Test Configuration<a class="headerlink" href="#noise-based-test-configuration" title="Link to this heading">#</a></h2>
 <p>In noise-based test configuration, <code class="docutils literal notranslate"><span class="pre">config_noise_meas()</span></code> allows users to indicate test settings such as, the noise power level in addition to the full-scale range and the resolution of the data converter under test. This test configuration is primarily used for computing noise spectral density.</p>
 <p>An example of the <code class="docutils literal notranslate"><span class="pre">config_noise_meas()</span></code> function call is shown by the following example.</p>
 <div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="w">  </span><span class="c1">// configuration</span>
@@ -315,9 +315,9 @@ <h2>Noise-based Test Configuration<a class="headerlink" href="#noise-based-test-
 
     </aside>
   </div>
-</div><script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=57cfd03c"></script>
+</div><script src="_static/documentation_options.js?v=2fea6348"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
-    <script src="_static/sphinx_highlight.js?v=4825356b"></script>
+    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/scripts/furo.js?v=32e29ea5"></script>
     <script src="_static/tabs.js?v=3ee01567"></script>
     </body>

diff --git a/master/02b_waveform_generation.html b/master/02b_waveform_generation.html
@@ -1,13 +1,13 @@
 <!doctype html>
-<html class="no-js" lang="en">
+<html class="no-js" lang="en" data-content_root="./">
   <head><meta charset="utf-8"/>
     <meta name="viewport" content="width=device-width,initial-scale=1"/>
     <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" />
 
-    <!-- Generated with Sphinx 7.1.0 and Furo 2023.07.26 -->
+    <!-- Generated with Sphinx 7.2.6 and Furo 2023.09.10 -->
         <title>Waveform Generation - Genalyzer v0.0.1 documentation</title>
-      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=362ab14a" />
+      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=135e06be" />
     <link rel="stylesheet" type="text/css" href="_static/tabs.css?v=4c969af8" />
     <link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=eafc0fe6" />
@@ -200,7 +200,7 @@
         </div>
         <article role="main">
           <section id="waveform-generation">
-<h1>Waveform Generation<a class="headerlink" href="#waveform-generation" title="Permalink to this heading">#</a></h1>
+<h1>Waveform Generation<a class="headerlink" href="#waveform-generation" title="Link to this heading">#</a></h1>
 <p>The second step, as shown previously, involves either generating the waveform and quantizing it or loading the waveform from a file. The following options are currently supported.</p>
 <ul class="simple">
 <li><p>cosine/sine and complex exponential waveforms of arbitrary frequency and sample rate</p></li>
@@ -265,9 +265,9 @@ <h1>Waveform Generation<a class="headerlink" href="#waveform-generation" title="
 
     </aside>
   </div>
-</div><script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=57cfd03c"></script>
+</div><script src="_static/documentation_options.js?v=2fea6348"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
-    <script src="_static/sphinx_highlight.js?v=4825356b"></script>
+    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/scripts/furo.js?v=32e29ea5"></script>
     <script src="_static/tabs.js?v=3ee01567"></script>
     </body>