Tekkotsu Homepage | Demos | Overview | Downloads | Dev. Resources | Reference | Credits |
PitchEvent Class Reference#include <PitchEvent.h>
Inheritance diagram for PitchEvent:
![]() Detailed DescriptionProvides information about a tone detected from the microphone(s).Definition at line 8 of file PitchEvent.h.
Constructor & Destructor Documentation
default constructor, sets generator ID, but nothing else
Definition at line 11 of file PitchEvent.h. Referenced by clone().
copy constructor (does what you'd expect, explicit to satisify compiler warning)
Definition at line 19 of file PitchEvent.h.
Member Function Documentation
assignment operator (does what you'd expect, explicit to satisify compiler warning)
Definition at line 24 of file PitchEvent.h.
allows a copy to be made of an event, supporting polymorphism Must be overridden by all subclasses to allow this to happen I would like to switch this over to the cloneable interface once the compiler gets updated out of the 3.3 branch... see Cloneable::clone() for a discussion of the issue and implementation notes. Reimplemented from EventBase. Definition at line 29 of file PitchEvent.h.
generates a description of the event with variable verbosity
Reimplemented from EventBase. Definition at line 10 of file PitchEvent.cc.
should return the minimum size needed if using binary format (i.e. not XML)
Reimplemented from EventBase. Definition at line 19 of file PitchEvent.cc.
All subclasses should override this and return a unique ID for their class. All IDs corresponding to all-capital letters are reserved for future framework expansion. (Thus, user subclasses should contain at least one lower-case letter.) This code can be used when serializing to allow quick identification of the class type by the receiver. Reimplemented from EventBase. Definition at line 43 of file PitchEvent.h.
Member Data Documentation
the frequency (Hz) being detected
Definition at line 46 of file PitchEvent.h. Referenced by getBinSize(), getDescription(), getFreq(), loadBinaryBuffer(), loadXML(), operator=(), saveBinaryBuffer(), and saveXML().
indicates how loud the signal is -- can be both loud and noisy, loud doesn't necessarily mean "strong"
Definition at line 47 of file PitchEvent.h. Referenced by getAmplitude(), getBinSize(), getDescription(), loadBinaryBuffer(), loadXML(), operator=(), saveBinaryBuffer(), and saveXML().
indicates how much variance is being detected
Definition at line 48 of file PitchEvent.h. Referenced by getBinSize(), getConfidence(), getDescription(), loadBinaryBuffer(), loadXML(), operator=(), saveBinaryBuffer(), and saveXML().
causes class type id to automatically be regsitered with EventBase's FamilyFactory (getTypeRegistry())
Definition at line 51 of file PitchEvent.h. Referenced by getClassTypeID().
The documentation for this class was generated from the following files: |
Tekkotsu v4.0 |
Generated Thu Nov 22 00:58:36 2007 by Doxygen 1.5.4 |