From 521b0469b13f728ae454cd92e1a7270bc5c782bd Mon Sep 17 00:00:00 2001 From: Eric Ratliff Date: Sat, 14 Sep 2024 12:26:25 -0500 Subject: [PATCH] Update package and class references, improve documentation, and remove outdated test - Renamed package from com.waveletsolutions.robot to com.waveletsolutions.filtering - Updated the main class reference in pom.xml to ensure the application runs correctly - Improved class documentation to reflect the educational and professional use of signal processing techniques - Removed outdated AppTest.java file, which was no longer relevant --- pom.xml | 4 ++-- src/main/java/com/waveletsolutions/filtering/App.java | 7 +++++-- .../com/waveletsolutions/{robot => filtering}/AppTest.java | 2 +- 3 files changed, 8 insertions(+), 5 deletions(-) rename src/test/java/com/waveletsolutions/{robot => filtering}/AppTest.java (93%) diff --git a/pom.xml b/pom.xml index de29d47..496208a 100644 --- a/pom.xml +++ b/pom.xml @@ -2,7 +2,7 @@ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> 4.0.0 - com.waveletsolutions.robot + com.waveletsolutions.filtering filter-view jar 1.0-SNAPSHOT @@ -70,7 +70,7 @@ - com.waveletsolutions.robot.App + com.waveletsolutions.filtering.App diff --git a/src/main/java/com/waveletsolutions/filtering/App.java b/src/main/java/com/waveletsolutions/filtering/App.java index ceaef6e..473e4e3 100644 --- a/src/main/java/com/waveletsolutions/filtering/App.java +++ b/src/main/java/com/waveletsolutions/filtering/App.java @@ -41,8 +41,11 @@ import org.apache.commons.math3.transform.TransformType; *
  • Real-time plots of both time-domain and frequency-domain (FFT) data.
  • * * - * This class is intended as an educational tool for students learning about signal processing - * in the context of controlling a robot motor. + * This class is intended as an educational tool for students and professional engineers + * learning about signal processing techniques, such as filtering, in the context of real-time + * signal control and visualization. + * It demonstrates the application of raised cosine and low-pass filters to signal data, + * as well as the spectral analysis of filtered and non-filtered signals using FFT. * *

    Usage:

    *
      diff --git a/src/test/java/com/waveletsolutions/robot/AppTest.java b/src/test/java/com/waveletsolutions/filtering/AppTest.java similarity index 93% rename from src/test/java/com/waveletsolutions/robot/AppTest.java rename to src/test/java/com/waveletsolutions/filtering/AppTest.java index 5dba93c..d60854c 100644 --- a/src/test/java/com/waveletsolutions/robot/AppTest.java +++ b/src/test/java/com/waveletsolutions/filtering/AppTest.java @@ -1,4 +1,4 @@ -package com.waveletsolutions.robot; +package com.waveletsolutions.filtering; import junit.framework.Test; import junit.framework.TestCase;