genindex.html

<!DOCTYPE html>


<html >

  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>Index &#8212; PyFlowBAT 0.0.1 documentation</title>
  
  
  
  <script data-cfasync="false">
    document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
    document.documentElement.dataset.theme = localStorage.getItem("theme") || "light";
  </script>
  
  <!-- Loaded before other Sphinx assets -->
  <link href="_static/styles/theme.css?digest=e353d410970836974a52" rel="stylesheet" />
<link href="_static/styles/bootstrap.css?digest=e353d410970836974a52" rel="stylesheet" />
<link href="_static/styles/pydata-sphinx-theme.css?digest=e353d410970836974a52" rel="stylesheet" />

  
  <link href="_static/vendor/fontawesome/6.1.2/css/all.min.css?digest=e353d410970836974a52" rel="stylesheet" />
  <link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.1.2/webfonts/fa-solid-900.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.1.2/webfonts/fa-brands-400.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.1.2/webfonts/fa-regular-400.woff2" />

    <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
  
  <!-- Pre-loaded scripts that we'll load fully later -->
  <link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=e353d410970836974a52" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=e353d410970836974a52" />

    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
    <script src="_static/jquery.js"></script>
    <script src="_static/underscore.js"></script>
    <script src="_static/doctools.js"></script>
    <script>DOCUMENTATION_OPTIONS.pagename = 'genindex';</script>
    <link rel="index" title="Index" href="#" />
    <link rel="search" title="Search" href="search.html" />
  <meta name="viewport" content="width=device-width, initial-scale=1"/>
  <meta name="docsearch:language" content="None"/>
  </head>
  
  
  <body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="">

  
  
  <a class="skip-link" href="#main-content">Skip to main content</a>
  
  <input type="checkbox"
          class="sidebar-toggle"
          name="__primary"
          id="__primary"/>
  <label class="overlay overlay-primary" for="__primary"></label>
  
  <input type="checkbox"
          class="sidebar-toggle"
          name="__secondary"
          id="__secondary"/>
  <label class="overlay overlay-secondary" for="__secondary"></label>
  
  <div class="search-button__wrapper">
    <div class="search-button__overlay"></div>
    <div class="search-button__search-container">
<form class="bd-search d-flex align-items-center"
      action="search.html"
      method="get">
  <i class="fa-solid fa-magnifying-glass"></i>
  <input type="search"
         class="form-control"
         name="q"
         id="search-input"
         placeholder="Search the docs ..."
         aria-label="Search the docs ..."
         autocomplete="off"
         autocorrect="off"
         autocapitalize="off"
         spellcheck="false"/>
  <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form></div>
  </div>
  
    <nav class="bd-header navbar navbar-expand-lg bd-navbar">
<div class="bd-header__inner bd-page-width">
  <label class="sidebar-toggle primary-toggle" for="__primary">
    <span class="fa-solid fa-bars"></span>
  </label>
  
  <div class="navbar-header-items__start">
    
      <div class="navbar-item">
  

<a class="navbar-brand logo" href="index.html">
  
  
  
  
    
    
      
    
    
    <img src="https://raw.githubusercontent.com/ellifteria/pyflowbat/main/pyflowbat/resources/pyflowbat-logo.png" class="logo__image only-light" alt="PyFlowBAT"/>
    <script>document.write(`<img src="https://raw.githubusercontent.com/ellifteria/pyflowbat/main/pyflowbat/resources/pyflowbat-logo.png" class="logo__image only-dark" alt="PyFlowBAT"/>`);</script>
  
  
</a></div>
    
  </div>
  
  
  <div class="col-lg-9 navbar-header-items">
    
    <div class="me-auto navbar-header-items__center">
      
        <div class="navbar-item"><nav class="navbar-nav">
  <p class="sidebar-header-items__title"
     role="heading"
     aria-level="1"
     aria-label="Site Navigation">
    Site Navigation
  </p>
  <ul class="bd-navbar-elements navbar-nav">
    
                    <li class="nav-item">
                      <a class="nav-link nav-internal" href="modules.html">
                        pyflowbat
                      </a>
                    </li>
                
  </ul>
</nav></div>
      
    </div>
    
    
    <div class="navbar-header-items__end">
      
        <div class="navbar-item navbar-persistent--container">
          
<script>
document.write(`
  <button class="btn btn-sm navbar-btn search-button search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
    <i class="fa-solid fa-magnifying-glass"></i>
  </button>
`);
</script>
        </div>
      
      
        <div class="navbar-item">
<script>
document.write(`
  <button class="theme-switch-button btn btn-sm btn-outline-primary navbar-btn rounded-circle" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
    <span class="theme-switch" data-mode="light"><i class="fa-solid fa-sun"></i></span>
    <span class="theme-switch" data-mode="dark"><i class="fa-solid fa-moon"></i></span>
    <span class="theme-switch" data-mode="auto"><i class="fa-solid fa-circle-half-stroke"></i></span>
  </button>
`);
</script></div>
      
    </div>
    
  </div>
  
  
    <div class="navbar-persistent--mobile">
<script>
document.write(`
  <button class="btn btn-sm navbar-btn search-button search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
    <i class="fa-solid fa-magnifying-glass"></i>
  </button>
`);
</script>
    </div>
  

  
</div>

    </nav>
  
  <div class="bd-container">
    <div class="bd-container__inner bd-page-width">
      
      <div class="bd-sidebar-primary bd-sidebar hide-on-wide">
        

  
  <div class="sidebar-header-items sidebar-primary__section">
    
    
      <div class="sidebar-header-items__center">
        
          <div class="navbar-item"><nav class="navbar-nav">
  <p class="sidebar-header-items__title"
     role="heading"
     aria-level="1"
     aria-label="Site Navigation">
    Site Navigation
  </p>
  <ul class="bd-navbar-elements navbar-nav">
    
                    <li class="nav-item">
                      <a class="nav-link nav-internal" href="modules.html">
                        pyflowbat
                      </a>
                    </li>
                
  </ul>
</nav></div>
        
      </div>
    
    
    
      <div class="sidebar-header-items__end">
        
          <div class="navbar-item">
<script>
document.write(`
  <button class="theme-switch-button btn btn-sm btn-outline-primary navbar-btn rounded-circle" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
    <span class="theme-switch" data-mode="light"><i class="fa-solid fa-sun"></i></span>
    <span class="theme-switch" data-mode="dark"><i class="fa-solid fa-moon"></i></span>
    <span class="theme-switch" data-mode="auto"><i class="fa-solid fa-circle-half-stroke"></i></span>
  </button>
`);
</script></div>
        
      </div>
    
  </div>
  
  
  <div class="sidebar-primary-items__end sidebar-primary__section">
  </div>
  
  <div id="rtd-footer-container"></div>


      </div>
      
      <main id="main-content" class="bd-main">
        
        
          <div class="bd-content">
            <div class="bd-article-container">
              
              <div class="bd-header-article"></div>
              
              
              
                
<div id="searchbox"></div>
                <article class="bd-article" role="main">
                  

<h1 id="index">Index</h1>

<div class="genindex-jumpbox">
 <a href="#A"><strong>A</strong></a>
 | <a href="#C"><strong>C</strong></a>
 | <a href="#E"><strong>E</strong></a>
 | <a href="#F"><strong>F</strong></a>
 | <a href="#G"><strong>G</strong></a>
 | <a href="#I"><strong>I</strong></a>
 | <a href="#L"><strong>L</strong></a>
 | <a href="#M"><strong>M</strong></a>
 | <a href="#N"><strong>N</strong></a>
 | <a href="#P"><strong>P</strong></a>
 | <a href="#S"><strong>S</strong></a>
 | <a href="#T"><strong>T</strong></a>
 | <a href="#V"><strong>V</strong></a>
 | <a href="#W"><strong>W</strong></a>
 
</div>
<h2 id="A">A</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="pyflowbat.html#pyflowbat.pyflowbat.Workspace.apply_compensation_matrix">apply_compensation_matrix() (pyflowbat.pyflowbat.Workspace method)</a>
</li>
      <li><a href="pyflowbat.html#pyflowbat.operations.apply_conversion_factor">apply_conversion_factor() (in module pyflowbat.operations)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="pyflowbat.html#pyflowbat.pyflowbat.Workspace.apply_gate">apply_gate() (pyflowbat.pyflowbat.Workspace method)</a>
</li>
      <li><a href="pyflowbat.html#pyflowbat.pyflowbat.Workspace.apply_operation">apply_operation() (pyflowbat.pyflowbat.Workspace method)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="C">C</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="pyflowbat.html#pyflowbat.pyflowbat.Workspace.calculate_beads_factors">calculate_beads_factors() (pyflowbat.pyflowbat.Workspace method)</a>
</li>
      <li><a href="pyflowbat.html#pyflowbat.pyflowbat.Workspace.calculate_compensation_matrix">calculate_compensation_matrix() (pyflowbat.pyflowbat.Workspace method)</a>
</li>
      <li><a href="pyflowbat.html#pyflowbat.operations.channel_mean">channel_mean() (in module pyflowbat.operations)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="pyflowbat.html#pyflowbat.r_gating.clust_2d_gate">clust_2d_gate() (in module pyflowbat.r_gating)</a>
</li>
      <li><a href="pyflowbat.html#pyflowbat.pyflowbat.Workspace.combine_replicates">combine_replicates() (pyflowbat.pyflowbat.Workspace method)</a>
</li>
      <li><a href="pyflowbat.html#pyflowbat.operations.compute_conversion_factor_stdErr">compute_conversion_factor_stdErr() (in module pyflowbat.operations)</a>
</li>
      <li><a href="pyflowbat.html#pyflowbat.pyflowbat.Workspace.create_statistic_extraction">create_statistic_extraction() (pyflowbat.pyflowbat.Workspace method)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="E">E</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="pyflowbat.html#pyflowbat.pyflowbat.Workspace.extract_statistic">extract_statistic() (pyflowbat.pyflowbat.Workspace method)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="F">F</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="pyflowbat.html#pyflowbat.gating.find_percentile">find_percentile() (in module pyflowbat.gating)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="G">G</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="pyflowbat.html#pyflowbat.gating.gate_heks">gate_heks() (in module pyflowbat.gating)</a>
</li>
      <li><a href="pyflowbat.html#pyflowbat.gating.gate_high_low">gate_high_low() (in module pyflowbat.gating)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="pyflowbat.html#pyflowbat.gating.gate_singlets">gate_singlets() (in module pyflowbat.gating)</a>
</li>
      <li><a href="pyflowbat.html#pyflowbat.r_gating_general.general_r_gate">general_r_gate() (in module pyflowbat.r_gating_general)</a>
</li>
      <li><a href="pyflowbat.html#pyflowbat.pyflowbat.Workspace.graph_statistics">graph_statistics() (pyflowbat.pyflowbat.Workspace method)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="I">I</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="pyflowbat.html#pyflowbat.pyflowbat.Workspace.init_r">init_r() (pyflowbat.pyflowbat.Workspace method)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="L">L</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="pyflowbat.html#pyflowbat.pyflowbat.Workspace.load_samples">load_samples() (pyflowbat.pyflowbat.Workspace method)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="M">M</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li>
    module

      <ul>
        <li><a href="pyflowbat.html#module-pyflowbat">pyflowbat</a>
</li>
        <li><a href="pyflowbat.html#module-pyflowbat.gating">pyflowbat.gating</a>
</li>
        <li><a href="pyflowbat.html#module-pyflowbat.operations">pyflowbat.operations</a>
</li>
        <li><a href="pyflowbat.html#module-pyflowbat.pyflowbat">pyflowbat.pyflowbat</a>
</li>
        <li><a href="pyflowbat.html#module-pyflowbat.r_gating">pyflowbat.r_gating</a>
</li>
        <li><a href="pyflowbat.html#module-pyflowbat.r_gating_general">pyflowbat.r_gating_general</a>
</li>
      </ul></li>
  </ul></td>
</tr></table>

<h2 id="N">N</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="pyflowbat.html#pyflowbat.operations.non_negative">non_negative() (in module pyflowbat.operations)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="P">P</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li>
    pyflowbat

      <ul>
        <li><a href="pyflowbat.html#module-pyflowbat">module</a>
</li>
      </ul></li>
      <li>
    pyflowbat.gating

      <ul>
        <li><a href="pyflowbat.html#module-pyflowbat.gating">module</a>
</li>
      </ul></li>
      <li>
    pyflowbat.operations

      <ul>
        <li><a href="pyflowbat.html#module-pyflowbat.operations">module</a>
</li>
      </ul></li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li>
    pyflowbat.pyflowbat

      <ul>
        <li><a href="pyflowbat.html#module-pyflowbat.pyflowbat">module</a>
</li>
      </ul></li>
      <li>
    pyflowbat.r_gating

      <ul>
        <li><a href="pyflowbat.html#module-pyflowbat.r_gating">module</a>
</li>
      </ul></li>
      <li>
    pyflowbat.r_gating_general

      <ul>
        <li><a href="pyflowbat.html#module-pyflowbat.r_gating_general">module</a>
</li>
      </ul></li>
  </ul></td>
</tr></table>

<h2 id="S">S</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="pyflowbat.html#pyflowbat.r_gating.singlet_gate">singlet_gate() (in module pyflowbat.r_gating)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="pyflowbat.html#pyflowbat.operations.split_sample_name">split_sample_name() (in module pyflowbat.operations)</a>
</li>
      <li><a href="pyflowbat.html#pyflowbat.pyflowbat.StatisticsExtraction">StatisticsExtraction (class in pyflowbat.pyflowbat)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="T">T</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="pyflowbat.html#pyflowbat.r_gating.transitional_gate">transitional_gate() (in module pyflowbat.r_gating)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="V">V</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="pyflowbat.html#pyflowbat.pyflowbat.Workspace.visualize_plot_change">visualize_plot_change() (pyflowbat.pyflowbat.Workspace method)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="pyflowbat.html#pyflowbat.pyflowbat.Workspace.visualize_plot_overlay">visualize_plot_overlay() (pyflowbat.pyflowbat.Workspace method)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="W">W</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="pyflowbat.html#pyflowbat.pyflowbat.Workspace">Workspace (class in pyflowbat.pyflowbat)</a>
</li>
  </ul></td>
</tr></table>



                </article>
              
              
              
                <footer class="bd-footer-article">
                  
<div class="footer-article-items footer-article__inner">
  
    <div class="footer-article-item"><!-- Previous / next buttons -->
<div class="prev-next-area">
</div></div>
  
</div>

                </footer>
              
            </div>
            
            
              
            
          </div>
          <footer class="bd-footer-content">
            
          </footer>
        
      </main>
    </div>
  </div>
  
  <!-- Scripts loaded after <body> so the DOM is not blocked -->
  <script src="_static/scripts/bootstrap.js?digest=e353d410970836974a52"></script>
<script src="_static/scripts/pydata-sphinx-theme.js?digest=e353d410970836974a52"></script>

  <footer class="bd-footer">
<div class="bd-footer__inner bd-page-width">
  
    <div class="footer-items__start">
      
        <div class="footer-item">
  <p class="copyright">
    
      © Copyright 2023, Elli Beres.
      <br/>
    
  </p>
</div>
      
        <div class="footer-item">
  <p class="sphinx-version">
    Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.5.0.
    <br/>
  </p>
</div>
      
    </div>
  
  
    <div class="footer-items__end">
      
        <div class="footer-item"><p class="theme-version">
  Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.13.3.
</p></div>
      
    </div>
  
</div>

  </footer>
  </body>
</html>