Skip to content

Commit

Permalink
Added Comments for Syllable class
Browse files Browse the repository at this point in the history
  • Loading branch information
arjo129 committed Jan 24, 2014
1 parent b448c60 commit 7b0fe0d
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions uspeech.h
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@
#define F_DETECTION 3
#define F_CONSTANT 350

/**
* The main recognizer class
*/
class signal{
public:
int arr[32]; /*!< This is the audio buffer*/
Expand All @@ -35,7 +38,7 @@ class signal{
int amplificationFactor; /*!<Amplification factor: Adjust as you need*/
int micPowerThreshold; /*!< Ignore anything with micPower below this */
int scale;
char phoneme; /*!< the phoneme detected when f was returned */
char phoneme; /*!< The phoneme detected when f was returned */
signal(int port);
int micPower;
void sample();
Expand All @@ -54,16 +57,18 @@ class signal{
unsigned int complexity(int power);
};

/**
* Simple Accumulator Vector. Stores simple syllables. Useful for basic word recognition.
*/
class syllable{
public:
int f,e,o,s,h,v;
syllable();
void classify(char c);
int* tointptr();
#if ARDUINO_ENVIRONMENT > 0
void debugPrint();
int f,e,o,s,h,v; /*!< Accumulators for the stated characters */
syllable(); /*!< Constructor for the class*/
void classify(char c); /*!< Classifies the character into a vector so as to create a fingerprint for the uttered syllable*/
int* tointptr(); /*!< Returns the vector from the accumulators as an integer pointer */
#if ARDUINO_ENVIRONMENT > 0
void debugPrint(); /*!< Outputs the datain the accumulator vector. Only enabled for arduino.*/
#endif

};

#endif

0 comments on commit 7b0fe0d

Please sign in to comment.