mirror of
https://github.com/fjosw/pyerrors.git
synced 2025-03-16 15:20:24 +01:00
Documentation updated
This commit is contained in:
fjosw
parent
8d54b89cbf
commit
1829ad4dc9
2 changed files with 11 additions and 27 deletions
|
|
@ -219,7 +219,7 @@
|
|||
<span class="bp">self</span><span class="o">.</span><span class="n">mom_out</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="s1">'mom_out'</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
|
||||
|
||||
|
||||
<span class="k">def</span> <span class="nf">read_ExternalLeg_hd5</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">filestem</span><span class="p">,</span> <span class="n">ens_id</span><span class="p">,</span> <span class="n">order</span><span class="o">=</span><span class="s1">'F'</span><span class="p">,</span> <span class="n">idl</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
||||
<span class="k">def</span> <span class="nf">read_ExternalLeg_hd5</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">filestem</span><span class="p">,</span> <span class="n">ens_id</span><span class="p">,</span> <span class="n">idl</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
||||
<span class="sd">"""Read hadrons ExternalLeg hdf5 file and output an array of CObs</span>
|
||||
|
||||
<span class="sd"> Parameters</span>
|
||||
|
|
@ -227,9 +227,6 @@
|
|||
<span class="sd"> path -- path to the files to read</span>
|
||||
<span class="sd"> filestem -- namestem of the files to read</span>
|
||||
<span class="sd"> ens_id -- name of the ensemble, required for internal bookkeeping</span>
|
||||
<span class="sd"> order -- order in which the array is to be reshaped,</span>
|
||||
<span class="sd"> 'F' for the first index changing fastest (9 4x4 matrices) default.</span>
|
||||
<span class="sd"> 'C' for the last index changing fastest (16 3x3 matrices),</span>
|
||||
<span class="sd"> idl : range</span>
|
||||
<span class="sd"> If specified only conifgurations in the given range are read in.</span>
|
||||
<span class="sd"> """</span>
|
||||
|
|
@ -256,10 +253,10 @@
|
|||
<span class="n">imag</span> <span class="o">=</span> <span class="n">Obs</span><span class="p">([</span><span class="n">rolled_array</span><span class="p">[</span><span class="n">si</span><span class="p">,</span> <span class="n">sj</span><span class="p">,</span> <span class="n">ci</span><span class="p">,</span> <span class="n">cj</span><span class="p">]</span><span class="o">.</span><span class="n">imag</span><span class="p">],</span> <span class="p">[</span><span class="n">ens_id</span><span class="p">],</span> <span class="n">idl</span><span class="o">=</span><span class="p">[</span><span class="n">idx</span><span class="p">])</span>
|
||||
<span class="n">matrix</span><span class="p">[</span><span class="n">si</span><span class="p">,</span> <span class="n">sj</span><span class="p">,</span> <span class="n">ci</span><span class="p">,</span> <span class="n">cj</span><span class="p">]</span> <span class="o">=</span> <span class="n">CObs</span><span class="p">(</span><span class="n">real</span><span class="p">,</span> <span class="n">imag</span><span class="p">)</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">Npr_matrix</span><span class="p">(</span><span class="n">matrix</span><span class="o">.</span><span class="n">swapaxes</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span><span class="o">.</span><span class="n">reshape</span><span class="p">((</span><span class="mi">12</span><span class="p">,</span> <span class="mi">12</span><span class="p">),</span> <span class="n">order</span><span class="o">=</span><span class="n">order</span><span class="p">),</span> <span class="n">mom_in</span><span class="o">=</span><span class="n">mom</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">Npr_matrix</span><span class="p">(</span><span class="n">matrix</span><span class="o">.</span><span class="n">swapaxes</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span><span class="o">.</span><span class="n">reshape</span><span class="p">((</span><span class="mi">12</span><span class="p">,</span> <span class="mi">12</span><span class="p">),</span> <span class="n">order</span><span class="o">=</span><span class="s1">'F'</span><span class="p">),</span> <span class="n">mom_in</span><span class="o">=</span><span class="n">mom</span><span class="p">)</span>
|
||||
|
||||
|
||||
<span class="k">def</span> <span class="nf">read_Bilinear_hd5</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">filestem</span><span class="p">,</span> <span class="n">ens_id</span><span class="p">,</span> <span class="n">order</span><span class="o">=</span><span class="s1">'F'</span><span class="p">,</span> <span class="n">idl</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
||||
<span class="k">def</span> <span class="nf">read_Bilinear_hd5</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">filestem</span><span class="p">,</span> <span class="n">ens_id</span><span class="p">,</span> <span class="n">idl</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
||||
<span class="sd">"""Read hadrons Bilinear hdf5 file and output an array of CObs</span>
|
||||
|
||||
<span class="sd"> Parameters</span>
|
||||
|
|
@ -267,9 +264,6 @@
|
|||
<span class="sd"> path -- path to the files to read</span>
|
||||
<span class="sd"> filestem -- namestem of the files to read</span>
|
||||
<span class="sd"> ens_id -- name of the ensemble, required for internal bookkeeping</span>
|
||||
<span class="sd"> order -- order in which the array is to be reshaped,</span>
|
||||
<span class="sd"> 'F' for the first index changing fastest (9 4x4 matrices) default.</span>
|
||||
<span class="sd"> 'C' for the last index changing fastest (16 3x3 matrices),</span>
|
||||
<span class="sd"> idl : range</span>
|
||||
<span class="sd"> If specified only conifgurations in the given range are read in.</span>
|
||||
<span class="sd"> """</span>
|
||||
|
|
@ -308,7 +302,7 @@
|
|||
<span class="n">imag</span> <span class="o">=</span> <span class="n">Obs</span><span class="p">([</span><span class="n">rolled_array</span><span class="p">[</span><span class="n">si</span><span class="p">,</span> <span class="n">sj</span><span class="p">,</span> <span class="n">ci</span><span class="p">,</span> <span class="n">cj</span><span class="p">]</span><span class="o">.</span><span class="n">imag</span><span class="p">],</span> <span class="p">[</span><span class="n">ens_id</span><span class="p">],</span> <span class="n">idl</span><span class="o">=</span><span class="p">[</span><span class="n">idx</span><span class="p">])</span>
|
||||
<span class="n">matrix</span><span class="p">[</span><span class="n">si</span><span class="p">,</span> <span class="n">sj</span><span class="p">,</span> <span class="n">ci</span><span class="p">,</span> <span class="n">cj</span><span class="p">]</span> <span class="o">=</span> <span class="n">CObs</span><span class="p">(</span><span class="n">real</span><span class="p">,</span> <span class="n">imag</span><span class="p">)</span>
|
||||
|
||||
<span class="n">result_dict</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">Npr_matrix</span><span class="p">(</span><span class="n">matrix</span><span class="o">.</span><span class="n">swapaxes</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span><span class="o">.</span><span class="n">reshape</span><span class="p">((</span><span class="mi">12</span><span class="p">,</span> <span class="mi">12</span><span class="p">),</span> <span class="n">order</span><span class="o">=</span><span class="n">order</span><span class="p">),</span> <span class="n">mom_in</span><span class="o">=</span><span class="n">mom_in</span><span class="p">,</span> <span class="n">mom_out</span><span class="o">=</span><span class="n">mom_out</span><span class="p">)</span>
|
||||
<span class="n">result_dict</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">Npr_matrix</span><span class="p">(</span><span class="n">matrix</span><span class="o">.</span><span class="n">swapaxes</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span><span class="o">.</span><span class="n">reshape</span><span class="p">((</span><span class="mi">12</span><span class="p">,</span> <span class="mi">12</span><span class="p">),</span> <span class="n">order</span><span class="o">=</span><span class="s1">'F'</span><span class="p">),</span> <span class="n">mom_in</span><span class="o">=</span><span class="n">mom_in</span><span class="p">,</span> <span class="n">mom_out</span><span class="o">=</span><span class="n">mom_out</span><span class="p">)</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">result_dict</span>
|
||||
</pre></div>
|
||||
|
|
@ -690,12 +684,12 @@ in and out momenta of the propagator are exchanged.</p>
|
|||
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">read_ExternalLeg_hd5</span><span class="signature">(path, filestem, ens_id, order='F', idl=None)</span>:
|
||||
<span class="name">read_ExternalLeg_hd5</span><span class="signature">(path, filestem, ens_id, idl=None)</span>:
|
||||
</div>
|
||||
|
||||
<details>
|
||||
<summary>View Source</summary>
|
||||
<div class="codehilite"><pre><span></span><span class="k">def</span> <span class="nf">read_ExternalLeg_hd5</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">filestem</span><span class="p">,</span> <span class="n">ens_id</span><span class="p">,</span> <span class="n">order</span><span class="o">=</span><span class="s1">'F'</span><span class="p">,</span> <span class="n">idl</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
||||
<div class="codehilite"><pre><span></span><span class="k">def</span> <span class="nf">read_ExternalLeg_hd5</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">filestem</span><span class="p">,</span> <span class="n">ens_id</span><span class="p">,</span> <span class="n">idl</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
||||
<span class="sd">"""Read hadrons ExternalLeg hdf5 file and output an array of CObs</span>
|
||||
|
||||
<span class="sd"> Parameters</span>
|
||||
|
|
@ -703,9 +697,6 @@ in and out momenta of the propagator are exchanged.</p>
|
|||
<span class="sd"> path -- path to the files to read</span>
|
||||
<span class="sd"> filestem -- namestem of the files to read</span>
|
||||
<span class="sd"> ens_id -- name of the ensemble, required for internal bookkeeping</span>
|
||||
<span class="sd"> order -- order in which the array is to be reshaped,</span>
|
||||
<span class="sd"> 'F' for the first index changing fastest (9 4x4 matrices) default.</span>
|
||||
<span class="sd"> 'C' for the last index changing fastest (16 3x3 matrices),</span>
|
||||
<span class="sd"> idl : range</span>
|
||||
<span class="sd"> If specified only conifgurations in the given range are read in.</span>
|
||||
<span class="sd"> """</span>
|
||||
|
|
@ -732,7 +723,7 @@ in and out momenta of the propagator are exchanged.</p>
|
|||
<span class="n">imag</span> <span class="o">=</span> <span class="n">Obs</span><span class="p">([</span><span class="n">rolled_array</span><span class="p">[</span><span class="n">si</span><span class="p">,</span> <span class="n">sj</span><span class="p">,</span> <span class="n">ci</span><span class="p">,</span> <span class="n">cj</span><span class="p">]</span><span class="o">.</span><span class="n">imag</span><span class="p">],</span> <span class="p">[</span><span class="n">ens_id</span><span class="p">],</span> <span class="n">idl</span><span class="o">=</span><span class="p">[</span><span class="n">idx</span><span class="p">])</span>
|
||||
<span class="n">matrix</span><span class="p">[</span><span class="n">si</span><span class="p">,</span> <span class="n">sj</span><span class="p">,</span> <span class="n">ci</span><span class="p">,</span> <span class="n">cj</span><span class="p">]</span> <span class="o">=</span> <span class="n">CObs</span><span class="p">(</span><span class="n">real</span><span class="p">,</span> <span class="n">imag</span><span class="p">)</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">Npr_matrix</span><span class="p">(</span><span class="n">matrix</span><span class="o">.</span><span class="n">swapaxes</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span><span class="o">.</span><span class="n">reshape</span><span class="p">((</span><span class="mi">12</span><span class="p">,</span> <span class="mi">12</span><span class="p">),</span> <span class="n">order</span><span class="o">=</span><span class="n">order</span><span class="p">),</span> <span class="n">mom_in</span><span class="o">=</span><span class="n">mom</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">Npr_matrix</span><span class="p">(</span><span class="n">matrix</span><span class="o">.</span><span class="n">swapaxes</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span><span class="o">.</span><span class="n">reshape</span><span class="p">((</span><span class="mi">12</span><span class="p">,</span> <span class="mi">12</span><span class="p">),</span> <span class="n">order</span><span class="o">=</span><span class="s1">'F'</span><span class="p">),</span> <span class="n">mom_in</span><span class="o">=</span><span class="n">mom</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
|
||||
</details>
|
||||
|
|
@ -745,8 +736,6 @@ in and out momenta of the propagator are exchanged.</p>
|
|||
<li><strong>path -- path to the files to read</strong></li>
|
||||
<li><strong>filestem -- namestem of the files to read</strong></li>
|
||||
<li><strong>ens_id -- name of the ensemble, required for internal bookkeeping</strong></li>
|
||||
<li><strong>order -- order in which the array is to be reshaped,</strong>: 'F' for the first index changing fastest (9 4x4 matrices) default.
|
||||
'C' for the last index changing fastest (16 3x3 matrices),</li>
|
||||
<li><strong>idl</strong> (range):
|
||||
If specified only conifgurations in the given range are read in.</li>
|
||||
</ul>
|
||||
|
|
@ -759,12 +748,12 @@ If specified only conifgurations in the given range are read in.</li>
|
|||
|
||||
|
||||
<span class="def">def</span>
|
||||
<span class="name">read_Bilinear_hd5</span><span class="signature">(path, filestem, ens_id, order='F', idl=None)</span>:
|
||||
<span class="name">read_Bilinear_hd5</span><span class="signature">(path, filestem, ens_id, idl=None)</span>:
|
||||
</div>
|
||||
|
||||
<details>
|
||||
<summary>View Source</summary>
|
||||
<div class="codehilite"><pre><span></span><span class="k">def</span> <span class="nf">read_Bilinear_hd5</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">filestem</span><span class="p">,</span> <span class="n">ens_id</span><span class="p">,</span> <span class="n">order</span><span class="o">=</span><span class="s1">'F'</span><span class="p">,</span> <span class="n">idl</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
||||
<div class="codehilite"><pre><span></span><span class="k">def</span> <span class="nf">read_Bilinear_hd5</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">filestem</span><span class="p">,</span> <span class="n">ens_id</span><span class="p">,</span> <span class="n">idl</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
||||
<span class="sd">"""Read hadrons Bilinear hdf5 file and output an array of CObs</span>
|
||||
|
||||
<span class="sd"> Parameters</span>
|
||||
|
|
@ -772,9 +761,6 @@ If specified only conifgurations in the given range are read in.</li>
|
|||
<span class="sd"> path -- path to the files to read</span>
|
||||
<span class="sd"> filestem -- namestem of the files to read</span>
|
||||
<span class="sd"> ens_id -- name of the ensemble, required for internal bookkeeping</span>
|
||||
<span class="sd"> order -- order in which the array is to be reshaped,</span>
|
||||
<span class="sd"> 'F' for the first index changing fastest (9 4x4 matrices) default.</span>
|
||||
<span class="sd"> 'C' for the last index changing fastest (16 3x3 matrices),</span>
|
||||
<span class="sd"> idl : range</span>
|
||||
<span class="sd"> If specified only conifgurations in the given range are read in.</span>
|
||||
<span class="sd"> """</span>
|
||||
|
|
@ -813,7 +799,7 @@ If specified only conifgurations in the given range are read in.</li>
|
|||
<span class="n">imag</span> <span class="o">=</span> <span class="n">Obs</span><span class="p">([</span><span class="n">rolled_array</span><span class="p">[</span><span class="n">si</span><span class="p">,</span> <span class="n">sj</span><span class="p">,</span> <span class="n">ci</span><span class="p">,</span> <span class="n">cj</span><span class="p">]</span><span class="o">.</span><span class="n">imag</span><span class="p">],</span> <span class="p">[</span><span class="n">ens_id</span><span class="p">],</span> <span class="n">idl</span><span class="o">=</span><span class="p">[</span><span class="n">idx</span><span class="p">])</span>
|
||||
<span class="n">matrix</span><span class="p">[</span><span class="n">si</span><span class="p">,</span> <span class="n">sj</span><span class="p">,</span> <span class="n">ci</span><span class="p">,</span> <span class="n">cj</span><span class="p">]</span> <span class="o">=</span> <span class="n">CObs</span><span class="p">(</span><span class="n">real</span><span class="p">,</span> <span class="n">imag</span><span class="p">)</span>
|
||||
|
||||
<span class="n">result_dict</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">Npr_matrix</span><span class="p">(</span><span class="n">matrix</span><span class="o">.</span><span class="n">swapaxes</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span><span class="o">.</span><span class="n">reshape</span><span class="p">((</span><span class="mi">12</span><span class="p">,</span> <span class="mi">12</span><span class="p">),</span> <span class="n">order</span><span class="o">=</span><span class="n">order</span><span class="p">),</span> <span class="n">mom_in</span><span class="o">=</span><span class="n">mom_in</span><span class="p">,</span> <span class="n">mom_out</span><span class="o">=</span><span class="n">mom_out</span><span class="p">)</span>
|
||||
<span class="n">result_dict</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">Npr_matrix</span><span class="p">(</span><span class="n">matrix</span><span class="o">.</span><span class="n">swapaxes</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span><span class="o">.</span><span class="n">reshape</span><span class="p">((</span><span class="mi">12</span><span class="p">,</span> <span class="mi">12</span><span class="p">),</span> <span class="n">order</span><span class="o">=</span><span class="s1">'F'</span><span class="p">),</span> <span class="n">mom_in</span><span class="o">=</span><span class="n">mom_in</span><span class="p">,</span> <span class="n">mom_out</span><span class="o">=</span><span class="n">mom_out</span><span class="p">)</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">result_dict</span>
|
||||
</pre></div>
|
||||
|
|
@ -828,8 +814,6 @@ If specified only conifgurations in the given range are read in.</li>
|
|||
<li><strong>path -- path to the files to read</strong></li>
|
||||
<li><strong>filestem -- namestem of the files to read</strong></li>
|
||||
<li><strong>ens_id -- name of the ensemble, required for internal bookkeeping</strong></li>
|
||||
<li><strong>order -- order in which the array is to be reshaped,</strong>: 'F' for the first index changing fastest (9 4x4 matrices) default.
|
||||
'C' for the last index changing fastest (16 3x3 matrices),</li>
|
||||
<li><strong>idl</strong> (range):
|
||||
If specified only conifgurations in the given range are read in.</li>
|
||||
</ul>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
Loading…
Add table
Reference in a new issue