Documentation: Added the scaling factor 1e5 to the quasi resistance s…

…pace transformation
bcobo · Feb 2, 2021 · ff1e9f3 · ff1e9f3
1 parent fa8f449
commit ff1e9f3
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 20 deletions.
diff --git a/doc/SIRENA.rst b/doc/SIRENA.rst
@@ -1,6 +1,5 @@
 .. _SIRENA:
 
-
 .. role:: pageblue
 .. role:: red
 
@@ -649,15 +648,15 @@ The SIRENA input parameter that controls the reconstruction method applied is :o
 
         .. math::
 
-            \frac{R}{R0} = \mathit{1} - \left(\frac{abs(\Delta I)/\mathit{I0\_START}}{1 + abs(\Delta I)/\mathit{I0\_START}}\right)
+            \frac{R}{R0} = {\mathit{1} - \left(\frac{abs(\Delta I)/\mathit{I0\_START}}{1 + abs(\Delta I)/\mathit{I0\_START}}\right)}·10^5
         
 * **I2RFITTED** transformation
 
     Looking for a simple transformation that would produce also a linear gain scale, a new transformation *I2RFITTED* has been proposed in :cite:`Peille2016`.
 
 	.. math::
 	
-		\frac{R}{V0} = -\frac{1}{(I_{fit} + ADC)}
+		\frac{R}{V0} = -10^5\frac{1}{(I_{fit} + ADC)}
 		
     .. If the *Group 1* info is available in the input FITS file:
     
@@ -669,6 +668,8 @@ The SIRENA input parameter that controls the reconstruction method applied is :o
                                         
     .. These values for :math:`I_{fit}` are a first approach, although it should be confirmed after the instrument calibration.
     The :math:`I_{fit}` value is tunable for the moment as an input parameter. 
+
+The :math:`10^5` scaling factor has been included in the quasi resistance space (both **I2R** and **I2RFITTED** transformations) to avoid rounding errors when working with very small numbers.
 
 
 

diff --git a/doc/SIRENAfunctions.rst b/doc/SIRENAfunctions.rst
@@ -872,13 +872,11 @@ Search functions by name at :ref:`genindex`.
 
         - Conversion according to :option:`EnergyMethod` = **I2R**:
 
-            :math:`DeltaI = I`    :math:`R/R0 = 1 - (abs(DeltaI)/I\_BIAS)/(1+abs(DeltaI)/I\_BIAS)`
+            :math:`DeltaI = I`    :math:`R/R0 = [1 - (abs(DeltaI)/I\_BIAS)/(1+abs(DeltaI)/I\_BIAS)]\cdot10^5`
 
         - Conversion according to :option:`EnergyMethod` = **I2RFITTED**:
 
-        ..    :math:`R/V0 = -1/(I_{fit}+ADC)` being :math:`I_{fit}` = ``ADU_BIAS``
-        
-            :math:`R/V0 = -1/(I_{fit}+ADC)` being :math:`I_{fit}` value an input parameter
+            :math:`R/V0 = -10^5/(I_{fit}+ADC)` being :math:`I_{fit}` value an input parameter
 
 
     If the ``ADU_CNV`` keyword is NOT in the input FITS file and :cpp:member:`invector` contains the **ADC** column data from the input FITS file:
@@ -889,13 +887,13 @@ Search functions by name at :ref:`genindex`.
 
         - Conversion according to :option:`EnergyMethod` = **I2R**:
 
-            :math:`DeltaI = I`    :math:`R/R0 = 1 - (abs(DeltaI)/I0\_START)/(1+abs(DeltaI)/I0\_START)`
+            :math:`DeltaI = I`    :math:`R/R0 = {1 - (abs(DeltaI)/I0\_START)/(1+abs(DeltaI)/I0\_START)}\cdot10^5`
 
         - Conversion according to :option:`EnergyMethod` = **I2RFITTED**  
-
-            .. :math:`R/V0 = -1/(I_{fit}+ADC)` being :math:`I_{fit}=I0\_START(adu)=I0\_START(A)/aducnv(A/adu)`
 
-            :math:`R/V0 = -1/(I_{fit}+ADC)` being :math:`I_{fit}` value an input parameter
+            :math:`R/V0 = -10^5/(I_{fit}+ADC)` being :math:`I_{fit}` value an input parameter
+
+    The :math:`10^5` scaling factor has been included in the quasi resistance space (both **I2R** and **I2RFITTED** transformations) to avoid rounding errors when working with very small numbers.
 
     **Members/Variables**
 

diff --git a/doc/_build/html/SIRENA.html b/doc/_build/html/SIRENA.html
@@ -574,7 +574,7 @@ <h2>Files<a class="headerlink" href="#files" title="Permalink to this headline">
 <p><img class="math" src="_images/math/afd60a99c7f643fa1b80c04c025d2cdc811ebede.png" alt="I = ADC * aducnv"/> + <code class="docutils literal notranslate"><span class="pre">IMIN</span></code></p>
 <p><img class="math" src="_images/math/703f80b0165258f418d07ab0c95ff789172a633f.png" alt="\Delta I= \mathit{I}"/> - <code class="docutils literal notranslate"><span class="pre">I0_START</span></code></p>
 <div class="math">
-<p><img src="_images/math/1149326f852e41709678fd177678ce8d86dc4d33.png" alt="\frac{R}{R0} = \mathit{1} - \left(\frac{abs(\Delta I)/\mathit{I0\_START}}{1 + abs(\Delta I)/\mathit{I0\_START}}\right)"/></p>
+<p><img src="_images/math/3822f13b5e326ff1f2bfb8436e8c2fc1f6f12cc5.png" alt="\frac{R}{R0} = {\mathit{1} - \left(\frac{abs(\Delta I)/\mathit{I0\_START}}{1 + abs(\Delta I)/\mathit{I0\_START}}\right)}·10^5"/></p>
 </div></div></blockquote>
 </div></blockquote>
 </li>
@@ -583,9 +583,13 @@ <h2>Files<a class="headerlink" href="#files" title="Permalink to this headline">
 <div><p>Looking for a simple transformation that would produce also a linear gain scale, a new transformation <em>I2RFITTED</em> has been proposed in <a class="bibtex reference internal" href="zreferences.html#peille2016" id="id26">[Peille+16]</a>.</p>
 <blockquote>
 <div><div class="math">
-<p><img src="_images/math/3942fff594f4b566cad850c037d7ec72d0829708.png" alt="\frac{R}{V0} = -\frac{1}{(I_{fit} + ADC)}"/></p>
+<p><img src="_images/math/d6455a97dd29a4780fd62eccb0a1ed946027444a.png" alt="\frac{R}{V0} = -10^5\frac{1}{(I_{fit} + ADC)}"/></p>
 </div></div></blockquote>
 <p>The <img class="math" src="_images/math/fd0179dc927022f51d9a8abdb0acfd9f4e91f5ba.png" alt="I_{fit}"/> value is tunable for the moment as an input parameter.</p>
+</div></blockquote>
+</li>
+</ul>
+<p>The <img class="math" src="_images/math/1005d5cba0257915abbd43381cee3bfa5eda67e3.png" alt="10^5"/> scaling factor has been included in the quasi resistance space (both <strong>I2R</strong> and <strong>I2RFITTED</strong> transformations) to avoid rounding errors when working with very small numbers.</p>
 <blockquote>
 <div><blockquote>
 <div><blockquote>
@@ -594,9 +598,6 @@ <h2>Files<a class="headerlink" href="#files" title="Permalink to this headline">
 </div></blockquote>
 </div></blockquote>
 </div></blockquote>
-</div></blockquote>
-</li>
-</ul>
 </div>
 <div class="section" id="two-experimental-approaches-adding-a-prebuffer-or-0-padding">
 <span id="prebuffer-or-0-padding"></span><h4><span class="pageblue">Two experimental approaches: adding a preBuffer or 0-padding</span><a class="headerlink" href="#two-experimental-approaches-adding-a-prebuffer-or-0-padding" title="Permalink to this headline">¶</a></h4>

diff --git a/doc/_build/html/SIRENAfunctions.html b/doc/_build/html/SIRENAfunctions.html
@@ -653,10 +653,14 @@ <h1>SIRENA functions<a class="headerlink" href="#sirena-functions" title="Permal
 <ul>
 <li><p>Conversion according to <a class="reference internal" href="SIRENAcommandline.html#cmdoption-arg-5"><code class="xref std std-option docutils literal notranslate"><span class="pre">EnergyMethod</span></code></a> = <strong>I2R</strong>:</p>
 <blockquote>
-<div><p><img class="math" src="_images/math/e515bb519c3d970f7969d907715c9ff934b14f30.png" alt="DeltaI = I"/>    <img class="math" src="_images/math/74ef2c5cb718f28a5df594997d91fcefed187d4e.png" alt="R/R0 = 1 - (abs(DeltaI)/I\_BIAS)/(1+abs(DeltaI)/I\_BIAS)"/></p>
+<div><p><img class="math" src="_images/math/e515bb519c3d970f7969d907715c9ff934b14f30.png" alt="DeltaI = I"/>    <img class="math" src="_images/math/23e57ccecc638a557496cc94f9d5fc0effbe93f6.png" alt="R/R0 = [1 - (abs(DeltaI)/I\_BIAS)/(1+abs(DeltaI)/I\_BIAS)]\cdot10^5"/></p>
+</div></blockquote>
+</li>
+<li><p>Conversion according to <a class="reference internal" href="SIRENAcommandline.html#cmdoption-arg-5"><code class="xref std std-option docutils literal notranslate"><span class="pre">EnergyMethod</span></code></a> = <strong>I2RFITTED</strong>:</p>
+<blockquote>
+<div><p><img class="math" src="_images/math/2e891283e4e6eb35d9f250aa2e57ec642a5d06c9.png" alt="R/V0 = -10^5/(I_{fit}+ADC)"/> being <img class="math" src="_images/math/fd0179dc927022f51d9a8abdb0acfd9f4e91f5ba.png" alt="I_{fit}"/> value an input parameter</p>
 </div></blockquote>
 </li>
-<li><p>Conversion according to <a class="reference internal" href="SIRENAcommandline.html#cmdoption-arg-5"><code class="xref std std-option docutils literal notranslate"><span class="pre">EnergyMethod</span></code></a> = <strong>I2RFITTED</strong>:</p></li>
 </ul>
 </div></blockquote>
 <p>If the <code class="docutils literal notranslate"><span class="pre">ADU_CNV</span></code> keyword is NOT in the input FITS file and <a class="reference internal" href="#_CPPv410convertI2RPcddddddddPP10gsl_vector" title="convertI2R::invector"><code class="xref cpp cpp-member docutils literal notranslate"><span class="pre">invector</span></code></a> contains the <strong>ADC</strong> column data from the input FITS file:</p>
@@ -666,16 +670,17 @@ <h1>SIRENA functions<a class="headerlink" href="#sirena-functions" title="Permal
 <ul>
 <li><p>Conversion according to <a class="reference internal" href="SIRENAcommandline.html#cmdoption-arg-5"><code class="xref std std-option docutils literal notranslate"><span class="pre">EnergyMethod</span></code></a> = <strong>I2R</strong>:</p>
 <blockquote>
-<div><p><img class="math" src="_images/math/e515bb519c3d970f7969d907715c9ff934b14f30.png" alt="DeltaI = I"/>    <img class="math" src="_images/math/8dbf2e0eeba92c2bdd50f2c8629812c9f3f086ea.png" alt="R/R0 = 1 - (abs(DeltaI)/I0\_START)/(1+abs(DeltaI)/I0\_START)"/></p>
+<div><p><img class="math" src="_images/math/e515bb519c3d970f7969d907715c9ff934b14f30.png" alt="DeltaI = I"/>    <img class="math" src="_images/math/578ae88198ed227b42f810e14641db8562e1d7ee.png" alt="R/R0 = {1 - (abs(DeltaI)/I0\_START)/(1+abs(DeltaI)/I0\_START)}\cdot10^5"/></p>
 </div></blockquote>
 </li>
 <li><p>Conversion according to <a class="reference internal" href="SIRENAcommandline.html#cmdoption-arg-5"><code class="xref std std-option docutils literal notranslate"><span class="pre">EnergyMethod</span></code></a> = <strong>I2RFITTED</strong></p>
 <blockquote>
-<div><p><img class="math" src="_images/math/6ce13246d1bc4ada931b0e3b3206fe178815e0d7.png" alt="R/V0 = -1/(I_{fit}+ADC)"/> being <img class="math" src="_images/math/fd0179dc927022f51d9a8abdb0acfd9f4e91f5ba.png" alt="I_{fit}"/> value an input parameter</p>
+<div><p><img class="math" src="_images/math/2e891283e4e6eb35d9f250aa2e57ec642a5d06c9.png" alt="R/V0 = -10^5/(I_{fit}+ADC)"/> being <img class="math" src="_images/math/fd0179dc927022f51d9a8abdb0acfd9f4e91f5ba.png" alt="I_{fit}"/> value an input parameter</p>
 </div></blockquote>
 </li>
 </ul>
 </div></blockquote>
+<p>The <img class="math" src="_images/math/1005d5cba0257915abbd43381cee3bfa5eda67e3.png" alt="10^5"/> scaling factor has been included in the quasi resistance space (both <strong>I2R</strong> and <strong>I2RFITTED</strong> transformations) to avoid rounding errors when working with very small numbers.</p>
 <p><strong>Members/Variables</strong></p>
 <p>char* <strong>EnergyMethod</strong></p>
 <blockquote>