Merge pull request #19 from KalebKE/v1.2

V1.2

Author: KalebKE

fsensor/src/main/java/com/kircherelectronics/fsensor/BaseFilter.java

@@ -0,0 +1,9 @@
+package com.kircherelectronics.fsensor;
+
+/**
+ * Created by kaleb on 4/1/18.
+ */
+
+public abstract class BaseFilter {
+    public abstract float[] getOutput();
+}

fsensor/src/main/java/com/kircherelectronics/fsensor/filter/BaseFilter.java

@@ -1,7 +1,5 @@
 package com.kircherelectronics.fsensor.filter.averaging;
 
-import com.kircherelectronics.fsensor.filter.BaseFilter;
-
 /*
  * Copyright 2017, Kircher Electronics, LLC
  *
@@ -18,13 +16,15 @@
  * limitations under the License.
  */
 
+import com.kircherelectronics.fsensor.BaseFilter;
+
 /**
- * A base implementation of an averaging filter.
+ * A base implementation of an averaging fusedOrientation.
  *
  * Created by kaleb on 7/6/17.
  */
 
-public abstract class AveragingFilter implements BaseFilter {
+public abstract class AveragingFilter extends BaseFilter {
     public static float DEFAULT_TIME_CONSTANT = 0.18f;
 
     protected float timeConstant;

fsensor/src/main/java/com/kircherelectronics/fsensor/filter/averaging/AveragingFilter.java

@@ -17,12 +17,12 @@
  */
 
 /**
- * An implementation of the Android Developer low-pass filter. The Android
+ * An implementation of the Android Developer low-pass fusedOrientation. The Android
  * Developer LowPassFilter, is an IIR single-pole implementation. The coefficient, a
  * (alpha), can be adjusted based on the sample period of the sensor to produce
- * the desired time constant that the filter will act on. It takes a simple form of y[0] = alpha * y[0] + (1
+ * the desired time constant that the fusedOrientation will act on. It takes a simple form of y[0] = alpha * y[0] + (1
  * - alpha) * x[0]. Alpha is defined as alpha = timeConstant / (timeConstant +
- * dt) where the time constant is the length of signals the filter should act on
+ * dt) where the time constant is the length of signals the fusedOrientation should act on
  * and dt is the sample period (1/frequency) of the sensor.
  *
  * http://developer.android.com/reference/android/hardware/SensorEvent.html
@@ -33,7 +33,7 @@ public class LowPassFilter extends AveragingFilter
     private static final String tag = LowPassFilter.class.getSimpleName();
 
     // Gravity and linear accelerations components for the
-    // Wikipedia low-pass filter
+    // Wikipedia low-pass fusedOrientation
     private float[] output;
 
     public LowPassFilter() {
@@ -51,7 +51,7 @@ public LowPassFilter(float timeConstant) {
      * @param values
      *            The acceleration data. A 1x3 matrix containing the data from the X, Y and Z axis of the sensor
      *            noting that order is arbitrary.
-     * @return Returns the output of the filter.
+     * @return Returns the output of the fusedOrientation.
      */
     public float[] filter(float[] values)
     {

fsensor/src/main/java/com/kircherelectronics/fsensor/filter/averaging/LowPassFilter.java

@@ -20,16 +20,16 @@
  */
 
 /**
- * Implements a mean filter designed to smooth the data points based on a mean. The mean filter will take the mean
+ * Implements a mean fusedOrientation designed to smooth the data points based on a mean. The mean fusedOrientation will take the mean
  * of the samples that occur over a period defined by the time constant... the number
- * of samples that are considered is known as the filter window. The approach
- * allows the filter window to be defined over a period of time, instead of a
+ * of samples that are considered is known as the fusedOrientation window. The approach
+ * allows the fusedOrientation window to be defined over a period of time, instead of a
  * fixed number of samples. This is important on devices that are
  * equipped with different hardware sensors that output samples at different
  * frequencies and also allow the developer to generally specify the output
- * frequency. Defining the filter window in terms of the time constant allows
- * the mean filter to applied to all sensor outputs with the same relative
- * filter window, regardless of sensor frequency.
+ * frequency. Defining the fusedOrientation window in terms of the time constant allows
+ * the mean fusedOrientation to applied to all sensor outputs with the same relative
+ * fusedOrientation window, regardless of sensor frequency.
  *
  * @author Kaleb
  */

fsensor/src/main/java/com/kircherelectronics/fsensor/filter/averaging/MeanFilter.java

@@ -22,17 +22,17 @@
  */
 
 /**
- * Implements a median filter designed to smooth the data points based on a time
- * constant in units of seconds. The median filter will take the median of the
+ * Implements a median fusedOrientation designed to smooth the data points based on a time
+ * constant in units of seconds. The median fusedOrientation will take the median of the
  * samples that occur over a period defined by the time constant... the number
- * of samples that are considered is known as the filter window. The approach
- * allows the filter window to be defined over a period of time, instead of a
+ * of samples that are considered is known as the fusedOrientation window. The approach
+ * allows the fusedOrientation window to be defined over a period of time, instead of a
  * fixed number of samples. This is important on devices that are
  * equipped with different hardware sensors that output samples at different
  * frequencies and also allow the developer to generally specify the output
- * frequency. Defining the filter window in terms of the time constant allows
- * the mean filter to applied to all sensor outputs with the same relative
- * filter window, regardless of sensor frequency.
+ * frequency. Defining the fusedOrientation window in terms of the time constant allows
+ * the mean fusedOrientation to applied to all sensor outputs with the same relative
+ * fusedOrientation window, regardless of sensor frequency.
  *
  * @author Kaleb
  * @version %I%, %G%