Diff: AoA_Est.h

Revision:

15:29805fab7655

Parent:

14:8865ec38bdc8

--- a/AoA_Est.h	Thu Apr 28 17:20:41 2016 +0000
+++ b/AoA_Est.h	Thu Apr 28 17:25:34 2016 +0000
@@ -37,10 +37,10 @@
     AoA_Est(int numOfSensors, int xPassed[], int yPassed[], float freq);
     /** Estimate the angle to the sound source
          *
-         * @param phases[] Array of phases, first phase is the master. Must correspond to order of X and Y coordinates. 
+         * @param phases[] Array of phases, first phase is the master. Must correspond to order of X and Y coordinates. All sensors must be within 1/2 wavelength of eachother. Will not work otherwise. 
          * @param amp[] Amplitudes. Not currently used. Repeat the phase array here to prevent errors.
          * @param yPassed[] Y coordinates of every sensor EXCEPT the master
-         * @return angle relative to X axis
+         * @return Angle relative to X axis
          */
     float estimate(float phases[], float amp[]);
     /** Not Used
@@ -48,7 +48,7 @@
     bool calibrate();
     /** Confidence level of the output
     *
-    * @return number corresponding to the number of angle determinations used in the average
+    * @return Float corresponding to the number of angle determinations used in the average
     */
     int confidence;