PitchEvent Class Reference
Provides information about a tone detected from the microphone(s). More...
#include <PitchEvent.h>
Detailed Description
Provides information about a tone detected from the microphone(s).
Definition at line 8 of file PitchEvent.h.
Public Member Functions | |
| PitchEvent () | |
| default constructor, sets generator ID, but nothing else | |
| PitchEvent (size_t sid, EventTypeID_t type, const float freq_, const char *name_, const float amplitude_, const unsigned int duration_, const float confidence_) | |
| constructor | |
| PitchEvent (const PitchEvent &p) | |
| copy constructor (does what you'd expect, explicit to satisify compiler warning) | |
| PitchEvent & | operator= (const PitchEvent &p) |
| assignment operator (does what you'd expect, explicit to satisify compiler warning) | |
| virtual EventBase * | clone () const |
| allows a copy to be made of an event, supporting polymorphism | |
| virtual std::string | getDescription (bool showTypeSpecific=true, unsigned int verbosity=0) const |
| generates a description of the event with variable verbosity | |
| virtual unsigned int | getBinSize () const |
| should return the minimum size needed if using binary format (i.e. not XML) | |
| virtual unsigned int | loadBinaryBuffer (const char buf[], unsigned int len) |
| load from binary format | |
| virtual unsigned int | saveBinaryBuffer (char buf[], unsigned int len) const |
| save to binary format | |
| virtual void | loadXML (xmlNode *node) |
| load from XML format | |
| virtual void | saveXML (xmlNode *node) const |
| save to XML format | |
| float | getFreq (void) const |
| returns freq | |
| float | getAmplitude (void) const |
| returns amplitude | |
| float | getConfidence (void) const |
| returns confidence | |
| virtual classTypeID_t | getClassTypeID () const |
| All subclasses should override this and return a unique ID for their class. | |
Protected Attributes | |
| float | freq |
| the frequency (Hz) being detected | |
| float | amplitude |
| indicates how loud the signal is -- can be both loud and noisy, loud doesn't necessarily mean "strong" | |
| float | confidence |
| indicates how much variance is being detected | |
Static Protected Attributes | |
| static const EventBase::classTypeID_t | autoRegisterPitchEvent = getTypeRegistry().registerType<PitchEvent>(makeClassTypeID("PITC")) |
| causes class type id to automatically be regsitered with EventBase's FamilyFactory (getTypeRegistry()) | |
Constructor & Destructor Documentation
| PitchEvent::PitchEvent | ( | ) |
default constructor, sets generator ID, but nothing else
Definition at line 11 of file PitchEvent.h.
Referenced by clone().
| PitchEvent::PitchEvent | ( | size_t | sid, | |
| EventTypeID_t | type, | |||
| const float | freq_, | |||
| const char * | name_, | |||
| const float | amplitude_, | |||
| const unsigned int | duration_, | |||
| const float | confidence_ | |||
| ) |
constructor
Definition at line 14 of file PitchEvent.h.
| PitchEvent::PitchEvent | ( | const PitchEvent & | p | ) |
copy constructor (does what you'd expect, explicit to satisify compiler warning)
Definition at line 19 of file PitchEvent.h.
Member Function Documentation
| virtual EventBase* PitchEvent::clone | ( | ) | const [virtual] |
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.
| float PitchEvent::getAmplitude | ( | void | ) | const |
returns amplitude
Definition at line 40 of file PitchEvent.h.
| unsigned int PitchEvent::getBinSize | ( | ) | const [virtual] |
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.
| virtual classTypeID_t PitchEvent::getClassTypeID | ( | ) | const [virtual] |
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.
| float PitchEvent::getConfidence | ( | void | ) | const |
returns confidence
Definition at line 41 of file PitchEvent.h.
| std::string PitchEvent::getDescription | ( | bool | showTypeSpecific = true, |
|
| unsigned int | verbosity = 0 | |||
| ) | const [virtual] |
generates a description of the event with variable verbosity
- Parameters:
-
showTypeSpecific should be read by subclasses to add additional information verbosity can be one of the following values: - 0 - Basic: event_name \t generator_id \t source_id \t type_id
- 1 - Numerics: event_name \t generator_id \t source_id \t type_id
- 2 - Timing: event_name \t generator_id \t source_id \t type_id \t duration \t timestamp
- 3 and above - Full: event_name \t generator_id \t source_id \t type_id \t duration \t timestamp \t magnitude if showTypeSpecific, additional fields will be added after the common fields listed above.
Reimplemented from EventBase.
Definition at line 10 of file PitchEvent.cc.
| float PitchEvent::getFreq | ( | void | ) | const |
returns freq
Definition at line 39 of file PitchEvent.h.
| unsigned int PitchEvent::loadBinaryBuffer | ( | const char | buf[], | |
| unsigned int | len | |||
| ) | [virtual] |
| void PitchEvent::loadXML | ( | xmlNode * | node | ) | [virtual] |
| PitchEvent& PitchEvent::operator= | ( | const PitchEvent & | p | ) |
assignment operator (does what you'd expect, explicit to satisify compiler warning)
Definition at line 24 of file PitchEvent.h.
| unsigned int PitchEvent::saveBinaryBuffer | ( | char | buf[], | |
| unsigned int | len | |||
| ) | const [virtual] |
| void PitchEvent::saveXML | ( | xmlNode * | node | ) | const [virtual] |
Member Data Documentation
float PitchEvent::amplitude [protected] |
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().
const EventBase::classTypeID_t PitchEvent::autoRegisterPitchEvent = getTypeRegistry().registerType<PitchEvent>(makeClassTypeID("PITC")) [static, protected] |
causes class type id to automatically be regsitered with EventBase's FamilyFactory (getTypeRegistry())
Definition at line 51 of file PitchEvent.h.
Referenced by getClassTypeID().
float PitchEvent::confidence [protected] |
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().
float PitchEvent::freq [protected] |
the frequency (Hz) being detected
Definition at line 46 of file PitchEvent.h.
Referenced by getBinSize(), getDescription(), getFreq(), loadBinaryBuffer(), loadXML(), operator=(), saveBinaryBuffer(), and saveXML().
The documentation for this class was generated from the following files:
