Calculates the RMS source-referred noise or detector-referred noise, or the contribution of a specific noise source or a collection of sources to it. :param noiseResult: Results of the execution of an instruction with data type 'noise'. :type noiseResult
(noiseResult, noise, fmin, fmax, source=None, CDS=False, tau=None,
method="auto", points=0, wf=1)
| 1738 | return var |
| 1739 | |
| 1740 | def rmsNoise(noiseResult, noise, fmin, fmax, source=None, CDS=False, tau=None, |
| 1741 | method="auto", points=0, wf=1): |
| 1742 | """ |
| 1743 | Calculates the RMS source-referred noise or detector-referred noise, |
| 1744 | or the contribution of a specific noise source or a collection of sources |
| 1745 | to it. |
| 1746 | |
| 1747 | :param noiseResult: Results of the execution of an instruction with data |
| 1748 | type 'noise'. |
| 1749 | :type noiseResult: SLiCAPinstruction.instruction |
| 1750 | |
| 1751 | :param noise: 'inoise' or 'onoise' for source-referred noise or detector- |
| 1752 | referred noise, respectively. |
| 1753 | :type noise': str |
| 1754 | |
| 1755 | :param fmin: Lower limit of the frequency range in Hz. |
| 1756 | :type fmin: str, int, float, sp.Symbol |
| 1757 | |
| 1758 | :param fmax: Upper limit of the frequency range in Hz. |
| 1759 | :type fmax: str, int, float, sp.Symbol |
| 1760 | |
| 1761 | :param source: refDes (ID) or list with IDs of noise sources |
| 1762 | of which the contribution to the RMS noise needs to be |
| 1763 | evaluated. Only IDs of current of voltage sources with a |
| 1764 | nonzero value for their 'noise' parameter are accepted. |
| 1765 | :type source: str, list |
| 1766 | |
| 1767 | :param CDS: True if correlated double sampling is required, defaults to False |
| 1768 | If True parameter 'tau' must be given a nonzero finite value |
| 1769 | (can be symbolic). |
| 1770 | If method=="log" a logarithmic frequency seep will be used from |
| 1771 | the lowest frequency until the frequency of the first notch: |
| 1772 | f=1/tau. Linear sweeping will be used for all other frequency |
| 1773 | segments. |
| 1774 | The number of points per segment will be set to points. |
| 1775 | If type(points) == list, the method will be set to 'scipy'. |
| 1776 | :type CDS: Bool |
| 1777 | |
| 1778 | :param tau: CDS delay time |
| 1779 | :type tau: str, int, float, sp.Symbol |
| 1780 | |
| 1781 | :param method: Integration method, implemented methods are: |
| 1782 | |
| 1783 | - "auto": automatic selection of integration method |
| 1784 | - "symbolic": forces symbolic integration |
| 1785 | - "scipy": numeric integration using scipy.integrate.quad. |
| 1786 | CDS will use integration per section f=1/tau |
| 1787 | - "log": numeric integration using numpy.trapezoid with a |
| 1788 | logarithmic frequency sweep from f_min to f_max |
| 1789 | and the number of points (CDS: per section f=1/tau) set by points |
| 1790 | - "lin": numeric integration using numpy.trapezoid with a |
| 1791 | linear frequency sweep from fmin to fmax |
| 1792 | and the number of points (CDS: per section f=1/tau) set by points |
| 1793 | - "list": numeric integration using numpy.trapezoid with frequency |
| 1794 | points taken from points (CDS: switches method to 'scipy'). |
| 1795 | |
| 1796 | Defaults to 'auto' |
| 1797 |
nothing calls this directly
no test coverage detected