rf-funcitons-py 0.1.1__tar.gz → 0.1.3__tar.gz

{rf_funcitons_py-0.1.1 → rf_funcitons_py-0.1.3}/PKG-INFO

@@ -1,10 +1,13 @@
 Metadata-Version: 2.4
 Name: rf_funcitons_py
-Version: 0.1.1
+Version: 0.1.3
 Summary: First package from a notebook
 Author-email: Avery Books <abooks104@gmail.com>
 Requires-Python: >3.8
 Description-Content-Type: text/markdown
+Requires-Dist: numpy
+Requires-Dist: matplotlib
+Requires-Dist: scipy
 
 #My First Package
 This package contains my alias source signal identification function

{rf_funcitons_py-0.1.1 → rf_funcitons_py-0.1.3}/pyproject.toml

@@ -4,12 +4,16 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "rf_funcitons_py"
-version = "0.1.1"
+version = "0.1.3"
 description = "First package from a notebook"
 readme = "README.md"
 authors = [{name = "Avery Books", email = "abooks104@gmail.com"}]
 requires-python = ">3.8"
-dependencies = []
+dependencies = [
+    "numpy",
+    "matplotlib",
+    "scipy",
+]
 
 [tool.setuptools]
 packages = ["rafpy"]

rf_funcitons_py-0.1.3/rafpy/__init__.py

@@ -0,0 +1,3 @@
+from .logic import id_signal_candidates
+from .rf_filter import RF_filter
+from .bpf_filter import create_bpf_kernel

rf_funcitons_py-0.1.3/rafpy/bpf_kernal.py

@@ -0,0 +1,3 @@
+def create_bpf_kernel(low_kb, high_kb, fs, num_taps=101):
+    """Utility to generate a Band-Pass Filter kernel."""
+    return sp_signal.firwin(num_taps, [low_kb, high_kb], fs=fs, pass_zero=False)

{rf_funcitons_py-0.1.1 → rf_funcitons_py-0.1.3}/rafpy/logic.py

@@ -3,7 +3,7 @@ def id_signal_candidates(fig_num, observed, current_fs, filter_range=None, show_
     #filter_range: tuple (f_min, f_max)
     
     candidates =[]
-    f_nyquist = fs /2 
+    f_nyquist = current_fs /2 
 
     #logic for finding frequency within filter range
     match = None
@@ -56,12 +56,6 @@ def id_signal_candidates(fig_num, observed, current_fs, filter_range=None, show_
         ax.set_title(f"Fig {fig_num}. Signal Identification (Observed: {observed} Hz | $f_s$: {current_fs} Hz | Bandpass {np.min(filter_range)}-{np.max(filter_range)} Hz)", fontweight='bold')
         ax.set_xlabel("Frequency (Hz)", fontweight='bold')
         ax.set_ylim(0, 1.6)
-        desc = (
-        f"""Fig {fig_num}. You saw a signal at {observed} Hz with a sampling rate of {current_fs} Hz. If you used a bandpass filter then the highlighted frequency is the original frequency considering any aliasing observed and which Nyquist zone it resides in. If you did not use a bandpass filter, then this lists the possible frequencies associated with the sampled signal, which can be filtered manually using known physics of your source."""
-        )
-        wrapped_desc = textwrap.fill(desc, width=90)
-        plt.figtext(0.5, 0.05, wrapped_desc, ha='center', fontsize=10,
-                    bbox=dict(boxstyle="round,pad=0.3", fc="#f0f0f0", ec="black", alpha=0.5))
         plt.legend(loc='upper right')
         print("-" * 30)
         print(f"ANALYSIS FOR {observed} Hz (Fs = {current_fs} Hz)")

rf_funcitons_py-0.1.3/rafpy/rf_filter.py

@@ -0,0 +1,38 @@
+def RF_filter(signal_array, filter_kernel, caption_text1, caption_text2, sampling_rate=1.0, show_graph=True):
+    normalized_kernel = filter_kernel / np.sum(filter_kernel)
+    filtered_signal = signal.fftconvolve(signal_array, normalized_kernel, mode='same')
+    if show_graph:
+        N = len(signal_array)
+        t = np.arange(N) / sampling_rate
+        M = len(filter_kernel)
+        t_kernel = np.arange(M) / sampling_rate
+        fig, (ax1, ax2) = plt.subplots(2, 1, figsize=(10, 10))
+        plt.subplots_adjust(bottom=0.1, hspace=0.6)
+        ax1.set_title("Fig 1. Input 1: Signal & Filter Kernel", fontweight='bold')
+        ax1.plot(t, signal_array, color='steelblue', alpha=0.6, label='Input Signal (Left Axis)')
+        ax1.tick_params(axis='y', labelcolor='steelblue')
+        ax1_twin = ax1.twinx()
+        ax1_twin.plot(t_kernel, normalized_kernel, color='#D62728', linewidth=2, label='Filter Kernal (Right Axis)')
+        ax1_twin.fill_between(t_kernel, 0, normalized_kernel, color='#D62728', alpha=0.3)
+        ax1_twin.tick_params(axis='y', labelcolor='#D62728')
+        ax1_twin.set_ylim(bottom=0)
+        ax1_twin.set_ylabel("Normalized Amplitude", color='#D62728')
+        lines_1, labels_1 = ax1.get_legend_handles_labels()
+        lines_2, labels_2 = ax1_twin.get_legend_handles_labels()
+        ax1.legend(lines_1 + lines_2, labels_1 + labels_2, loc='upper right')
+        ax1.set_xlabel(f"Time (s)if Fs={sampling_rate} Hz")
+        ax1.set_ylabel("Amplitude", color = 'steelblue')
+        desc_1 = caption_text1 
+        desc_2 = caption_text2
+        ax1.text(0.5, -0.25, textwrap.fill(desc_1, width = 100), transform=ax1.transAxes, ha='center', va='top', fontsize=10, color='darkred', bbox=dict(boxstyle="round,pad=0.3", fc="white", ec="gray", alpha=0.5))
+        ax2.set_title("Fig 2. Output: Convolved Result", fontweight='bold')
+        ax2.plot(t, signal_array, color='gray', alpha=0.3, label='(Original Input)')
+        ax2.plot(t, filtered_signal, color='green', linewidth=2, label='Filtered Output')
+        ax2.set_xlabel(f"Time (seconds) if Fs={sampling_rate}Hz")
+        ax2.set_ylabel("Amplitude")
+        ax2.legend(loc='upper right')
+        ax2.grid(True, alpha=0.3)
+        ax2.text(0.5, -0.3, textwrap.fill(desc_2, width = 100), transform=ax2.transAxes, ha='center', va='top', fontsize=10, color='darkgreen', bbox=dict(boxstyle="round,pad=0.3", fc="white", ec="gray", alpha=0.5))
+       
+        plt.show()
+    return filtered_signal

{rf_funcitons_py-0.1.1 → rf_funcitons_py-0.1.3}/rf_funcitons_py.egg-info/PKG-INFO

@@ -1,10 +1,13 @@
 Metadata-Version: 2.4
 Name: rf_funcitons_py
-Version: 0.1.1
+Version: 0.1.3
 Summary: First package from a notebook
 Author-email: Avery Books <abooks104@gmail.com>
 Requires-Python: >3.8
 Description-Content-Type: text/markdown
+Requires-Dist: numpy
+Requires-Dist: matplotlib
+Requires-Dist: scipy
 
 #My First Package
 This package contains my alias source signal identification function

{rf_funcitons_py-0.1.1 → rf_funcitons_py-0.1.3}/rf_funcitons_py.egg-info/SOURCES.txt

@@ -1,8 +1,11 @@
 README.md
 pyproject.toml
 rafpy/__init__.py
+rafpy/bpf_kernal.py
 rafpy/logic.py
+rafpy/rf_filter.py
 rf_funcitons_py.egg-info/PKG-INFO
 rf_funcitons_py.egg-info/SOURCES.txt
 rf_funcitons_py.egg-info/dependency_links.txt
+rf_funcitons_py.egg-info/requires.txt
 rf_funcitons_py.egg-info/top_level.txt

rf_funcitons_py-0.1.3/rf_funcitons_py.egg-info/requires.txt

@@ -0,0 +1,3 @@
+numpy
+matplotlib
+scipy

rf_funcitons_py-0.1.1/rafpy/__init__.py

@@ -1 +0,0 @@
-from .logic import id_signal_candidates