mirror of
https://github.com/fjosw/pyerrors.git
synced 2025-03-16 15:20:24 +01:00
Documentation updated
This commit is contained in:
parent
6f74786b1d
commit
7fb12bd546
2 changed files with 85 additions and 1 deletions
|
@ -92,6 +92,9 @@
|
|||
<li>
|
||||
<a class="function" href="#Corr.reverse">reverse</a>
|
||||
</li>
|
||||
<li>
|
||||
<a class="function" href="#Corr.thin">thin</a>
|
||||
</li>
|
||||
<li>
|
||||
<a class="function" href="#Corr.correlate">correlate</a>
|
||||
</li>
|
||||
|
@ -582,6 +585,24 @@
|
|||
<span class="sd">"""Reverse the time ordering of the Corr"""</span>
|
||||
<span class="k">return</span> <span class="n">Corr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">content</span><span class="p">[::</span> <span class="o">-</span><span class="mi">1</span><span class="p">])</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">thin</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">spacing</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">offset</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>
|
||||
<span class="sd">"""Thin out a correlator to suppress correlations</span>
|
||||
|
||||
<span class="sd"> Parameters</span>
|
||||
<span class="sd"> ----------</span>
|
||||
<span class="sd"> spacing : int</span>
|
||||
<span class="sd"> Keep only every 'spacing'th entry of the correlator</span>
|
||||
<span class="sd"> offset : int</span>
|
||||
<span class="sd"> Offset the equal spacing</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">new_content</span> <span class="o">=</span> <span class="p">[]</span>
|
||||
<span class="k">for</span> <span class="n">t</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">T</span><span class="p">):</span>
|
||||
<span class="k">if</span> <span class="p">(</span><span class="n">offset</span> <span class="o">+</span> <span class="n">t</span><span class="p">)</span> <span class="o">%</span> <span class="n">spacing</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span>
|
||||
<span class="n">new_content</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="kc">None</span><span class="p">)</span>
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="n">new_content</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">content</span><span class="p">[</span><span class="n">t</span><span class="p">])</span>
|
||||
<span class="k">return</span> <span class="n">Corr</span><span class="p">(</span><span class="n">new_content</span><span class="p">)</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">correlate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">partner</span><span class="p">):</span>
|
||||
<span class="sd">"""Correlate the correlator with another correlator or Obs</span>
|
||||
|
||||
|
@ -1655,6 +1676,24 @@
|
|||
<span class="sd">"""Reverse the time ordering of the Corr"""</span>
|
||||
<span class="k">return</span> <span class="n">Corr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">content</span><span class="p">[::</span> <span class="o">-</span><span class="mi">1</span><span class="p">])</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">thin</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">spacing</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">offset</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>
|
||||
<span class="sd">"""Thin out a correlator to suppress correlations</span>
|
||||
|
||||
<span class="sd"> Parameters</span>
|
||||
<span class="sd"> ----------</span>
|
||||
<span class="sd"> spacing : int</span>
|
||||
<span class="sd"> Keep only every 'spacing'th entry of the correlator</span>
|
||||
<span class="sd"> offset : int</span>
|
||||
<span class="sd"> Offset the equal spacing</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">new_content</span> <span class="o">=</span> <span class="p">[]</span>
|
||||
<span class="k">for</span> <span class="n">t</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">T</span><span class="p">):</span>
|
||||
<span class="k">if</span> <span class="p">(</span><span class="n">offset</span> <span class="o">+</span> <span class="n">t</span><span class="p">)</span> <span class="o">%</span> <span class="n">spacing</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span>
|
||||
<span class="n">new_content</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="kc">None</span><span class="p">)</span>
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="n">new_content</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">content</span><span class="p">[</span><span class="n">t</span><span class="p">])</span>
|
||||
<span class="k">return</span> <span class="n">Corr</span><span class="p">(</span><span class="n">new_content</span><span class="p">)</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">correlate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">partner</span><span class="p">):</span>
|
||||
<span class="sd">"""Correlate the correlator with another correlator or Obs</span>
|
||||
|
||||
|
@ -2956,6 +2995,51 @@ number of timeslices</li>
|
|||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
<div id="Corr.thin" class="classattr">
|
||||
<div class="attr function"><a class="headerlink" href="#Corr.thin">#  </a>
|
||||
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">thin</span><span class="signature">(self, spacing=2, offset=0)</span>:
|
||||
</div>
|
||||
|
||||
<details>
|
||||
<summary>View Source</summary>
|
||||
<div class="codehilite"><pre><span></span> <span class="k">def</span> <span class="nf">thin</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">spacing</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">offset</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>
|
||||
<span class="sd">"""Thin out a correlator to suppress correlations</span>
|
||||
|
||||
<span class="sd"> Parameters</span>
|
||||
<span class="sd"> ----------</span>
|
||||
<span class="sd"> spacing : int</span>
|
||||
<span class="sd"> Keep only every 'spacing'th entry of the correlator</span>
|
||||
<span class="sd"> offset : int</span>
|
||||
<span class="sd"> Offset the equal spacing</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">new_content</span> <span class="o">=</span> <span class="p">[]</span>
|
||||
<span class="k">for</span> <span class="n">t</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">T</span><span class="p">):</span>
|
||||
<span class="k">if</span> <span class="p">(</span><span class="n">offset</span> <span class="o">+</span> <span class="n">t</span><span class="p">)</span> <span class="o">%</span> <span class="n">spacing</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span>
|
||||
<span class="n">new_content</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="kc">None</span><span class="p">)</span>
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="n">new_content</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">content</span><span class="p">[</span><span class="n">t</span><span class="p">])</span>
|
||||
<span class="k">return</span> <span class="n">Corr</span><span class="p">(</span><span class="n">new_content</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
|
||||
</details>
|
||||
|
||||
<div class="docstring"><p>Thin out a correlator to suppress correlations</p>
|
||||
|
||||
<h6 id="parameters">Parameters</h6>
|
||||
|
||||
<ul>
|
||||
<li><strong>spacing</strong> (int):
|
||||
Keep only every 'spacing'th entry of the correlator</li>
|
||||
<li><strong>offset</strong> (int):
|
||||
Offset the equal spacing</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
<div id="Corr.correlate" class="classattr">
|
||||
<div class="attr function"><a class="headerlink" href="#Corr.correlate">#  </a>
|
||||
|
|
File diff suppressed because one or more lines are too long
Loading…
Add table
Reference in a new issue