|
5 | 5 | <head> |
6 | 6 | <meta charset="utf-8" /> |
7 | 7 | <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
8 | | - <title>diffpy.utils.diffraction_objects — diffpy.utils 3.6.1rc0 documentation</title> |
| 8 | + <title>diffpy.utils.diffraction_objects — diffpy.utils 3.6.1rc1 documentation</title> |
9 | 9 | <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=03e43079" /> |
10 | 10 | <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=e59714d7" /> |
11 | 11 | <link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css?v=76b2166b" /> |
12 | 12 |
|
13 | 13 |
|
14 | 14 | <script src="../../../_static/jquery.js?v=5d32c60e"></script> |
15 | 15 | <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> |
16 | | - <script src="../../../_static/documentation_options.js?v=4cdc70cc"></script> |
| 16 | + <script src="../../../_static/documentation_options.js?v=e59c04aa"></script> |
17 | 17 | <script src="../../../_static/doctools.js?v=9bcbadda"></script> |
18 | 18 | <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script> |
19 | 19 | <script src="../../../_static/clipboard.min.js?v=a7894cd8"></script> |
@@ -490,26 +490,29 @@ <h1>Source code for diffpy.utils.diffraction_objects</h1><div class="highlight"> |
490 | 490 |
|
491 | 491 | <div class="viewcode-block" id="DiffractionObject.get_array_index"> |
492 | 492 | <a class="viewcode-back" href="../../../api/diffpy.utils.html#diffpy.utils.diffraction_objects.DiffractionObject.get_array_index">[docs]</a> |
493 | | - <span class="k">def</span><span class="w"> </span><span class="nf">get_array_index</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">xtype</span><span class="p">,</span> <span class="n">xvalue</span><span class="p">):</span> |
494 | | -<span class="w"> </span><span class="sd">"""Return the index of the closest value in the array associated with</span> |
495 | | -<span class="sd"> the specified xtype and the value provided.</span> |
496 | | - |
497 | | -<span class="sd"> Parameters</span> |
498 | | -<span class="sd"> ----------</span> |
499 | | -<span class="sd"> xtype : str</span> |
500 | | -<span class="sd"> The type of the independent variable in `xarray`. Must be one</span> |
501 | | -<span class="sd"> of {*XQUANTITIES}.</span> |
502 | | -<span class="sd"> xvalue : float</span> |
503 | | -<span class="sd"> The value of the xtype to find the closest index for.</span> |
504 | | - |
505 | | -<span class="sd"> Returns</span> |
506 | | -<span class="sd"> -------</span> |
507 | | -<span class="sd"> index : int</span> |
508 | | -<span class="sd"> The index of the closest value in the array associated with the</span> |
509 | | -<span class="sd"> specified xtype and the value provided.</span> |
510 | | -<span class="sd"> """</span> |
511 | | - |
512 | | - <span class="n">xtype</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_input_xtype</span> |
| 493 | + <span class="k">def</span><span class="w"> </span><span class="nf">get_array_index</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">xvalue</span><span class="p">,</span> <span class="n">xtype</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| 494 | + <span class="sa">f</span><span class="s2">"""Return the index of the closest value in the array associated with</span> |
| 495 | +<span class="s2"> the specified xtype and the value provided.</span> |
| 496 | + |
| 497 | +<span class="s2"> Parameters</span> |
| 498 | +<span class="s2"> ----------</span> |
| 499 | +<span class="s2"> xvalue : float</span> |
| 500 | +<span class="s2"> The value of the xtype to find the closest index for.</span> |
| 501 | +<span class="s2"> xtype : str, optional</span> |
| 502 | +<span class="s2"> The type of the independent variable in `xarray`. Must be one</span> |
| 503 | +<span class="s2"> of </span><span class="si">{</span><span class="o">*</span><span class="n">XQUANTITIES</span><span class="p">,</span><span class="w"> </span><span class="si">}</span><span class="s2">. Default is </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">_input_xtype</span><span class="si">}</span> |
| 504 | + |
| 505 | +<span class="s2"> Returns</span> |
| 506 | +<span class="s2"> -------</span> |
| 507 | +<span class="s2"> index : int</span> |
| 508 | +<span class="s2"> The index of the closest value in the array associated with the</span> |
| 509 | +<span class="s2"> specified xtype and the value provided.</span> |
| 510 | +<span class="s2"> """</span> |
| 511 | + <span class="k">if</span> <span class="n">xtype</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| 512 | + <span class="n">xtype</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_input_xtype</span> |
| 513 | + <span class="k">else</span><span class="p">:</span> |
| 514 | + <span class="k">if</span> <span class="n">xtype</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">XQUANTITIES</span><span class="p">:</span> |
| 515 | + <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">_xtype_wmsg</span><span class="p">(</span><span class="n">xtype</span><span class="p">))</span> |
513 | 516 | <span class="n">xarray</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">on_xtype</span><span class="p">(</span><span class="n">xtype</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span> |
514 | 517 | <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">xarray</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
515 | 518 | <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span> |
|
0 commit comments