microcalorimetry.math.unc_models
================================

.. py:module:: microcalorimetry.math.unc_models

.. autoapi-nested-parse::

   This module contains functions that define uncertainty models for operating calorimeters.

   These models can be used as part of the calculate eta function to apply uncertainty models
   post correction.

   Typically these uncertainty models are inherited from uncertiainties called out in
   tech notes, papers, and internal memos.

   ..
       !! processed by numpydoc !!


Functions
---------

.. autoapisummary::

   microcalorimetry.math.unc_models.uA_24mm
   microcalorimetry.math.unc_models.uA_CN
   microcalorimetry.math.unc_models.uB_CN


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

.. py:function:: uA_24mm(f)

   
   Historical repeatability of NIST's 2.4 mm Type A uncertainty.

   Accepts frequency in GHz.

   Taken from the calorimeter matlab code "effcalc.m" on March 2026

   :Parameters:

       **f** : array
           Frequency in GHz.



   :Returns:

       **unc** : array
           Type A uncertainty same shape as f.











   ..
       !! processed by numpydoc !!

.. py:function:: uA_CN(frequencies, RLead: float = 0, RThermistor: float = 200)

   
   Get the uncertainties associated with the Type N calorimeter.

   This function is envoked by the underlying models.

   This function taken from pat of the effcalc.m matlab function
   on March 2026.

   :Parameters:

       **frequencies** : array
           Array of frequencies

       **RLead** : float, optional
           Lead resistance of the sensor. The default is 0.

       **RThermistor :float , optional**
           Resistance of the thermistor. The default is 200.



   :Returns:

       **uA** : np.array
           Type A uncertainty.

       **uB** : np.array
           Type B uncertainty.

       **Utot** : np.array
           k = 2 total uncertainty.











   ..
       !! processed by numpydoc !!

.. py:function:: uB_CN(frequencies, RLead: float = 0, RThermistor: float = 200)

   
   Get the uncertainties associated with the Type N calorimeter.

   This function is envoked by the underlying models.

   This function taken from pat of the effcalc.m matlab function
   on March 2026.

   :Parameters:

       **frequencies** : array
           Array of frequencies

       **RLead** : float, optional
           Lead resistance of the sensor. The default is 0.

       **RThermistor :float , optional**
           Resistance of the thermistor. The default is 200.



   :Returns:

       **uA** : np.array
           Type A uncertainty.

       **uB** : np.array
           Type B uncertainty.

       **Utot** : np.array
           k = 2 total uncertainty.











   ..
       !! processed by numpydoc !!