conflux.bsg.Functions
=====================

.. py:module:: conflux.bsg.Functions


Functions
---------

.. autoapisummary::

   conflux.bsg.Functions.stableA
   conflux.bsg.Functions.getEltonNuclearRadius
   conflux.bsg.Functions.getDJpi
   conflux.bsg.Functions.determineForbiddenness
   conflux.bsg.Functions.rebin
   conflux.bsg.Functions.downsample


Module Contents
---------------

.. py:function:: stableA(Z)

   Get estimate for stable mass number as a function of Z


.. py:function:: getEltonNuclearRadius(A, natUnits=False)

   Return nuclear charge radius in fm according to Elton formula

   :param A: mass number
   :param natUnits: return result in units where m_e=hbar=c=1 (Default value = False)



.. py:function:: getDJpi(Jpi)

   Turn string of possible spin-parities into
   (double of spin, parity)

   :param Jpi: string, spin-parities



.. py:function:: determineForbiddenness(mJpi, dJpi)

   Determine degree of forbiddenness and uniqueness
   returns (deltaJ[int], forbiddenness[int], unique[bool])

   :param mJpi: string, mother spin and parity
   :param dJpi: string, daughter spin and parity



.. py:function:: rebin(x1, x2, y2)

   Rough rebinning to downsample y2 to grid of x1

   :param x1: array, x values to rebin to
   :param x2: array, initial x values
   :param y2: array, initial y values



.. py:function:: downsample(x1, x2, y2, method='linear', fillValue=0.0, axis=0)

   Downsample (x2, y2) to (x1, new y)

   :param x1: array, target x range
   :param x2: array, initial x range
   :param y2: array, initial y range
   :param method: interpolation method (Default value = 'linear')
   :param fillValue: default value outside of range (Default value = 0.)