| <!DOCTYPE html> |
|
|
| <html lang="en" data-content_root="./"> |
| <head> |
| <meta charset="utf-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" /> |
|
|
| <title>ARLTheoretical — AIM-CU 1.0.0 documentation</title> |
| <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" /> |
| <link rel="stylesheet" type="text/css" href="_static/basic.css?v=d35aba6c" /> |
| <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=0ca6144b" /> |
| <script src="_static/documentation_options.js?v=8d563738"></script> |
| <script src="_static/doctools.js?v=9bcbadda"></script> |
| <script src="_static/sphinx_highlight.js?v=dc90522c"></script> |
| <link rel="index" title="Index" href="genindex.html" /> |
| <link rel="search" title="Search" href="search.html" /> |
| <link rel="next" title="Utils" href="ref_utils.html" /> |
| <link rel="prev" title="CUSUM" href="ref_cusum.html" /> |
| |
| <link rel="stylesheet" href="_static/custom.css" type="text/css" /> |
| |
|
|
| |
| |
|
|
| </head><body> |
| |
|
|
| <div class="document"> |
| <div class="documentwrapper"> |
| <div class="bodywrapper"> |
| |
|
|
| <div class="body" role="main"> |
| |
| <section id="module-package.ARLTheoretical"> |
| <span id="arltheoretical"></span><h1>ARLTheoretical<a class="headerlink" href="#module-package.ARLTheoretical" title="Link to this heading">¶</a></h1> |
| <p>ARLTheoretical</p> |
| <p>@author: smriti.prathapan</p> |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="package.ARLTheoretical.get_ARL_1"> |
| <span class="sig-prename descclassname"><span class="pre">package.ARLTheoretical.</span></span><span class="sig-name descname"><span class="pre">get_ARL_1</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">h</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shift_in_mean</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dict_ARL0_k</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">OrderedDict</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">DataFrame</span></span></span><a class="headerlink" href="#package.ARLTheoretical.get_ARL_1" title="Link to this definition">¶</a></dt> |
| <dd><p>Get the ARL1 along with k values.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>h</strong> (<em>float</em>) – Normalized threshold.</p></li> |
| <li><p><strong>shift_in_mean</strong> (<em>list</em><em>[</em><em>float</em><em>]</em>) – List of the values of shift in mean.</p></li> |
| <li><p><strong>dict_ARL0_k</strong> (<em>OrderedDict</em>) – Data dictionary of ARL0 and k</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>Table for ARL1 and k values.</p> |
| </dd> |
| <dt class="field-odd">Return type<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>pd.DataFrame</p> |
| </dd> |
| </dl> |
| </dd></dl> |
|
|
| <dl class="py function"> |
| <dt class="sig sig-object py" id="package.ARLTheoretical.get_ARL_1_h_mu1_k"> |
| <span class="sig-prename descclassname"><span class="pre">package.ARLTheoretical.</span></span><span class="sig-name descname"><span class="pre">get_ARL_1_h_mu1_k</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">h</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">k</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mu1</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#package.ARLTheoretical.get_ARL_1_h_mu1_k" title="Link to this definition">¶</a></dt> |
| <dd><p>Calculate ARL_1 with given Shift in Mean (mu1) and k.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>h</strong> (<em>float</em>) – Normalized threshold.</p></li> |
| <li><p><strong>k</strong> (<em>float</em>) – Normalized reference value.</p></li> |
| <li><p><strong>mu1</strong> (<em>float</em>) – Intended shift in mean.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>Detection delay (ARL1).</p> |
| </dd> |
| <dt class="field-odd">Return type<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>float</p> |
| </dd> |
| </dl> |
| </dd></dl> |
|
|
| <dl class="py function"> |
| <dt class="sig sig-object py" id="package.ARLTheoretical.get_ref_value"> |
| <span class="sig-prename descclassname"><span class="pre">package.ARLTheoretical.</span></span><span class="sig-name descname"><span class="pre">get_ref_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">h</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">list_ARL_0</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">DataFrame</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">OrderedDict</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#package.ARLTheoretical.get_ref_value" title="Link to this definition">¶</a></dt> |
| <dd><p>provides normalized reference values k for provided list of ARL0, given the value of normalized threshold h.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>h</strong> (<em>float</em>) – Normalized threshold.</p></li> |
| <li><p><strong>list_ARL_0</strong> (<em>list</em>) – List of ARL0 values.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>Dataframe of ARL0 and k, Data dictionary of ARL0 and k; where k is normalized reference value.</p> |
| </dd> |
| <dt class="field-odd">Return type<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>tuple[pd.Dataframe, OrderedDict]</p> |
| </dd> |
| </dl> |
| </dd></dl> |
|
|
| <dl class="py function"> |
| <dt class="sig sig-object py" id="package.ARLTheoretical.get_ref_value_k"> |
| <span class="sig-prename descclassname"><span class="pre">package.ARLTheoretical.</span></span><span class="sig-name descname"><span class="pre">get_ref_value_k</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">h</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ARL_0</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#package.ARLTheoretical.get_ref_value_k" title="Link to this definition">¶</a></dt> |
| <dd><p>Calculation for the reference value for given h and ARL_0.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>h</strong> (<em>float</em>) – Normalized threshold.</p></li> |
| <li><p><strong>ARL_0</strong> (<em>float</em>) – ARL0 value.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>Normalized reference value k.</p> |
| </dd> |
| <dt class="field-odd">Return type<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>float</p> |
| </dd> |
| </dl> |
| </dd></dl> |
|
|
| </section> |
|
|
|
|
| </div> |
| |
| </div> |
| </div> |
| <div class="sphinxsidebar" role="navigation" aria-label="Main"> |
| <div class="sphinxsidebarwrapper"> |
| <h1 class="logo"><a href="index.html">AIM-CU</a></h1> |
|
|
|
|
|
|
|
|
|
|
|
|
| <p> |
| <iframe src="https://ghbtns.com/github-btn.html?user=DIDSR&repo=AIM-CU&type=watch&count=true&size=large&v=2" |
| allowtransparency="true" frameborder="0" scrolling="0" width="200px" height="35px"></iframe> |
| </p> |
|
|
|
|
|
|
|
|
|
|
|
|
| <search id="searchbox" style="display: none" role="search"> |
| <div class="searchformwrapper"> |
| <form class="search" action="search.html" method="get"> |
| <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/> |
| <input type="submit" value="Go" /> |
| </form> |
| </div> |
| </search> |
| <script>document.getElementById('searchbox').style.display = "block"</script><h3>Navigation</h3> |
| <p class="caption" role="heading"><span class="caption-text">Contents:</span></p> |
| <ul class="current"> |
| <li class="toctree-l1"><a class="reference internal" href="ref_method.html">Methods</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="ref_cusum.html">CUSUM</a></li> |
| <li class="toctree-l1 current"><a class="current reference internal" href="#">ARLTheoretical</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="#package.ARLTheoretical.get_ARL_1"><code class="docutils literal notranslate"><span class="pre">get_ARL_1()</span></code></a></li> |
| <li class="toctree-l2"><a class="reference internal" href="#package.ARLTheoretical.get_ARL_1_h_mu1_k"><code class="docutils literal notranslate"><span class="pre">get_ARL_1_h_mu1_k()</span></code></a></li> |
| <li class="toctree-l2"><a class="reference internal" href="#package.ARLTheoretical.get_ref_value"><code class="docutils literal notranslate"><span class="pre">get_ref_value()</span></code></a></li> |
| <li class="toctree-l2"><a class="reference internal" href="#package.ARLTheoretical.get_ref_value_k"><code class="docutils literal notranslate"><span class="pre">get_ref_value_k()</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="ref_utils.html">Utils</a></li> |
| </ul> |
|
|
| <div class="relations"> |
| <h3>Related Topics</h3> |
| <ul> |
| <li><a href="index.html">Documentation overview</a><ul> |
| <li>Previous: <a href="ref_cusum.html" title="previous chapter">CUSUM</a></li> |
| <li>Next: <a href="ref_utils.html" title="next chapter">Utils</a></li> |
| </ul></li> |
| </ul> |
| </div> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| </div> |
| </div> |
| <div class="clearer"></div> |
| </div> |
| <div class="footer"> |
| |
| |
| |
| Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.1.3</a> |
| & <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a> |
| |
| | |
| <a href="_sources/ref_theoretical.rst.txt" |
| rel="nofollow">Page source</a> |
| </div> |
|
|
| |
|
|
| |
| </body> |
| </html> |
