Diff: Phase_Finder.h

Revision:

9:d86d73964999

Parent:

8:aaf5cde0aa0a

Child:

10:cd3f7010da48

diff -r aaf5cde0aa0a -r d86d73964999 Phase_Finder.h
--- a/Phase_Finder.h	Wed Apr 27 20:12:55 2016 +0000
+++ b/Phase_Finder.h	Thu Apr 28 06:15:54 2016 +0000
@@ -3,12 +3,22 @@
 const int SAMPLE_LENGTH = 251;
 const int PEAKS = 4;
 
-/** A
-*      }
+/** AoA_Est.h
+*   Computes the angle of arrival of an audio signal
+*   EXAMPLE:
+    @code
+    //Find the angle of arrival of a 900Hz audio signal using 3 MBEDS equipped with microphones. 
+    //Requires an array of phases, found using Phase_Finder and communication between MBEDs. 
+    //This code begins after phases have been found and communicated to master MBED
+    //Sensors are located at (0,0), (150,0), and (150,90). Maximum sensors is 10 including master. Can be changed with parameter MAX_SENSORS
+    float angle = 0;
+    int x[2] = {150, 150); //Distances from master MBED microphone in milimeters. All distances must be for microphones, not MBED units
+    int y[2] = {0, 90);  //Do not include master MBED, its microphone is assumed to be 0,0.
+    AoA_Est AoA(3, x, y, 900);
+    angle = AoA.estimate(phases, phases);
 * }
 * @endcode
 */
-
 class Phase_Finder {
 
 public: