Merge branch 'dev' of github.com:fronzbot/python-adc-eval into add-adcs

Author: fronzbot

adc_eval/eval/spectrum.py

@@ -27,7 +27,8 @@ def sndr_sfdr(spectrum, freq, fs, nfft, leak, full_scale=0):
     """Get SNDR and SFDR."""
 
     # Zero the DC bin
-    spectrum[0] = 0
+    for i in range(0, leak + 1):
+        spectrum[i] = 0
     bin_sig = np.argmax(spectrum)
     psig = sum(spectrum[i] for i in range(bin_sig - leak, bin_sig + leak + 1))
     spectrum_n = spectrum
@@ -80,7 +81,7 @@ def sndr_sfdr(spectrum, freq, fs, nfft, leak, full_scale=0):
     return stats
 
 
-def find_harmonics(spectrum, freq, nfft, bin_sig, psig, harms=5, leak=20):
+def find_harmonics(spectrum, freq, nfft, bin_sig, psig, harms=5, leak=20, fscale=1e6):
     """Get the harmonic contents of the data."""
     harm_stats = {"harm": {}}
     harm_index = 2
@@ -110,7 +111,7 @@ def find_harmonics(spectrum, freq, nfft, bin_sig, psig, harms=5, leak=20):
 
         harm_stats["harm"][harm_index]["bin"] = bin_harm_max
         harm_stats["harm"][harm_index]["power"] = pwr_max
-        harm_stats["harm"][harm_index]["freq"] = round(freq[bin_harm] / 1e6, 1)
+        harm_stats["harm"][harm_index]["freq"] = round(freq[bin_harm] / fscale, 1)
         harm_stats["harm"][harm_index]["dBc"] = dBW(pwr_max / psig)
         harm_stats["harm"][harm_index]["dB"] = dBW(pwr_max)
 
@@ -161,6 +162,7 @@ def plot_spectrum(
     no_plot=False,
     yaxis="power",
     single_sided=True,
+    fscale="MHz",
 ):
     """Plot Power Spectrum for input signal."""
     wsize = data.size
@@ -169,10 +171,21 @@ def plot_spectrum(
         "hanning": np.hanning(wsize),
     }
 
+    fscalar = {
+        "Hz": 1,
+        "kHz": 1e3,
+        "MHz": 1e6,
+        "GHz": 1e9,
+    }
+
     if window not in windows:
         print(f"WARNING: {window} not implemented. Defaulting to 'rectangular'.")
         window = "rectangular"
 
+    if fscale not in fscalar:
+        print(f"WARNING: {fscale} not implemented. Defaulting to 'MHz'.")
+        fscale = "MHz"
+
     wscale = {
         "rectangular": 1.0,
         "hanning": 1.633,
@@ -193,6 +206,7 @@ def plot_spectrum(
     lut_key = yaxis.lower()
     scalar = yaxis_lut[lut_key][0]
     yunits = yaxis_lut[lut_key][1]
+    xscale = fscalar[fscale]
 
     psd_out = 10 * np.log10(pwr) - scalar
     if lut_key in ["magnitude"]:
@@ -207,6 +221,7 @@ def plot_spectrum(
         )
 
     sndr_stats = sndr_sfdr(psd_ss, f_ss, fs, nfft, leak=leak, full_scale=full_scale)
+
     harm_stats = find_harmonics(
         psd_ss,
         f_ss,
@@ -215,20 +230,21 @@ def plot_spectrum(
         sndr_stats["sig"]["power"],
         harms=harmonics,
         leak=leak,
+        fscale=xscale,
     )
 
     stats = {**sndr_stats, **harm_stats}
 
     xmin = 0 if single_sided else -fs / 2e6
 
     if not no_plot:
-        plt_str = get_plot_string(stats, full_scale, fs, nfft, window)
+        plt_str = get_plot_string(stats, full_scale, fs, nfft, window, xscale, fscale)
         fig, ax = plt.subplots(figsize=(15, 8))
-        ax.plot(freq / 1e6, psd_out)
+        ax.plot(freq / xscale, psd_out)
         ax.set_ylabel(f"Power Spectrum ({yunits})", fontsize=18)
-        ax.set_xlabel("Frequency (MHz)", fontsize=16)
+        ax.set_xlabel(f"Frequency ({fscale})", fontsize=16)
         ax.set_title("Output Power Spectrum", fontsize=16)
-        ax.set_xlim([xmin, fs / 2e6])
+        ax.set_xlim([xmin, fs / (2 * xscale)])
         ax.set_ylim([1.1 * min(psd_out), 1])
 
         ax.annotate(
@@ -291,7 +307,7 @@ def plot_spectrum(
     return (freq, psd_out, stats)
 
 
-def get_plot_string(stats, full_scale, fs, nfft, window):
+def get_plot_string(stats, full_scale, fs, nfft, window, xscale=1e6, fscale="MHz"):
     """Generate plot string from stats dict."""
 
     plt_str = "==== FFT ====\n"
@@ -302,22 +318,22 @@ def get_plot_string(stats, full_scale, fs, nfft, window):
     plt_str += "==== Signal ====\n"
     plt_str += f"FullScale = {full_scale} dB\n"
     plt_str += f"Psig = {stats['sig']['dBFS']} dBFS ({stats['sig']['dB']} dB)\n"
-    plt_str += f"fsig = {round(stats['sig']['freq']/1e6, 2)} MHz\n"
-    plt_str += f"fsamp = {round(fs/1e6, 2)} MHz\n"
+    plt_str += f"fsig = {round(stats['sig']['freq']/xscale, 2)} {fscale}\n"
+    plt_str += f"fsamp = {round(fs/xscale, 2)} {fscale}\n"
     plt_str += "\n"
     plt_str += "====  SNDR/SFDR  ====\n"
     plt_str += f"ENOB = {stats['enob']['bits']} bits\n"
     plt_str += f"SNDR = {stats['sndr']['dBFS']} dBFS ({stats['sndr']['dBc']} dBc)\n"
     plt_str += f"SFDR = {stats['sfdr']['dBFS']} dBFS ({stats['sfdr']['dBc']} dBc)\n"
     plt_str += f"Pspur = {stats['spur']['dBFS']} dBFS\n"
-    plt_str += f"fspur = {round(stats['spur']['freq']/1e6, 2)} MHz\n"
+    plt_str += f"fspur = {round(stats['spur']['freq']/xscale, 2)} {fscale}\n"
     plt_str += f"Noise Floor = {stats['noise']['dBHz']} dBFS\n"
     plt_str += f"NSD = {stats['noise']['NSD']} dBFS\n"
     plt_str += "\n"
     plt_str += "==== Harmonics ====\n"
 
     for hindex, hdata in stats["harm"].items():
-        plt_str += f"HD{hindex} = {round(hdata['dB'] - full_scale, 1)} dBFS @ {hdata['freq']} MHz\n"
+        plt_str += f"HD{hindex} = {round(hdata['dB'] - full_scale, 1)} dBFS @ {hdata['freq']} {fscale}\n"
 
     plt_str += "\n"
 
@@ -335,6 +351,7 @@ def analyze(
     no_plot=False,
     yaxis="fullscale",
     single_sided=True,
+    fscale="MHz",
 ):
     """Perform spectral analysis on input waveform."""
     (freq, spectrum, stats) = plot_spectrum(
@@ -348,6 +365,7 @@ def analyze(
         no_plot=no_plot,
         yaxis=yaxis,
         single_sided=single_sided,
+        fscale=fscale,
     )
 
     return (freq, spectrum, stats)

pyproject.toml

@@ -21,7 +21,7 @@ classifiers = [
 ]
 requires-python = ">=3.9.0"
 dependencies = [
-    "matplotlib==3.9.1",
+    "matplotlib==3.9.2",
 ]
 
 [project.urls]

requirements.txt

@@ -1,3 +1,3 @@
-matplotlib==3.9.1
+matplotlib==3.9.2
 tqdm==4.67.1
 scipy==1.15.2

requirements_test.txt

@@ -1,11 +1,11 @@
-black==24.4.2
-coverage==7.6.0
-pylint==3.2.5
-pytest==8.2.2
+black==24.8.0
+coverage==7.6.1
+pylint==3.2.7
+pytest==8.3.2
 pytest-cov==5.0.0
 pytest-sugar==1.0.0
 pytest-timeout==2.3.1
-ruff==0.5.2
-tox==4.16.0
+ruff==0.6.3
+tox==4.18.0
 restructuredtext-lint==1.4.0
 pygments==2.18.0