super_auto_comb.calc
====================

.. py:module:: super_auto_comb.calc


Functions
---------

.. autoapisummary::

   super_auto_comb.calc.beat2y


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

.. py:function:: beat2y(f_beat, nominal, N, f_rep, f0, f_beat_sign=1, k_scale=1, f0_scale=1, f_offset=0.0)

   Calculate the fractional frequency y from beatnote values, using arbitrary precision numbers where appropriate.

   :param f_beat: Input frequency beat, unsigned
   :type f_beat: ndarray of floats
   :param nominal: Nominal frequency in Hz as string.
   :type nominal: str
   :param N: Comb tooth number
   :type N: int
   :param f_rep: Comb repetition rate in Hz
   :type f_rep: float
   :param f0: Comb offset frequency in Hz
   :type f0: float
   :param f_beat_sign: Sign of f_beat, by default 1
   :type f_beat_sign: int, optional
   :param k_scale: Frequency scaling (typically 1, 2 in case of SHG), by default 1
   :type k_scale: int, optional
   :param f0_scale: Frequency scaling of f0 (typically 1, 2 for measurements with visible branch), by default 1
   :type f0_scale: int, optional
   :param f_offset: Offset frequency in Hz from the counted beatnote, by default 0.0
   :type f_offset: float, optional

   :returns: Fractional frequency y
   :rtype: ndarray