CLAM::Segmentator Class Reference
#include <Segmentator.hxx>
Detailed Description
Definition at line 71 of file Segmentator.hxx.
Public Member Functions | |
| Segmentator () | |
| Segmentator (const SegmentatorConfig &c) | |
| virtual | ~Segmentator () |
| const char * | GetClassName () const |
| Override it in every subclass and retur the name of that class. | |
| const ProcessingConfig & | GetConfig () const |
| Configuration getter. | |
| bool | Do () |
| Supervised mode execution method (using ports). | |
| bool | Do (Segment &originalSegment, SegmentDescriptors &descriptors) |
Protected Member Functions | |
| virtual void | UnwrapDescriptors (const Segment &originalSegment, SegmentDescriptors &descriptors, Matrix &descriptorsValues) |
Protected Attributes | |
| SegmentatorConfig | mConfig |
Constructor & Destructor Documentation
| Segmentator::Segmentator | ( | ) |
| Segmentator::Segmentator | ( | const SegmentatorConfig & | c | ) |
| Segmentator::~Segmentator | ( | ) | [virtual] |
Definition at line 195 of file Segmentator.cxx.
Member Function Documentation
| const char* CLAM::Segmentator::GetClassName | ( | ) | const [inline, virtual] |
Override it in every subclass and retur the name of that class.
Implements CLAM::Processing.
Definition at line 77 of file Segmentator.hxx.
| const ProcessingConfig& CLAM::Segmentator::GetConfig | ( | ) | const [inline, virtual] |
Configuration getter.
Gets the configuration parameters used to create the object.
- Returns:
- Const reference to the configuration object. The usual way to perform a configuration change in the processing object is to take a copy of this reference, to change it and to send it with the Configure method. If not overriden, it returns a NullProcessingConfig.
Reimplemented from CLAM::Processing.
Definition at line 78 of file Segmentator.hxx.
References mConfig.
| bool Segmentator::Do | ( | ) | [virtual] |
Supervised mode execution method (using ports).
- Returns:
- A boolean telling whether it has been output
Implements CLAM::Processing.
Definition at line 205 of file Segmentator.cxx.
References CLAM_ASSERT, CLAM_DEBUG_ASSERT, and CLAM::Processing::IsRunning().
| bool Segmentator::Do | ( | Segment & | originalSegment, | |
| SegmentDescriptors & | descriptors | |||
| ) |
Definition at line 215 of file Segmentator.cxx.
References CLAM::Segment::GetnFrames(), mConfig, and UnwrapDescriptors().
| void Segmentator::UnwrapDescriptors | ( | const Segment & | originalSegment, | |
| SegmentDescriptors & | descriptors, | |||
| Matrix & | descriptorsValues | |||
| ) | [protected, virtual] |
Definition at line 225 of file Segmentator.cxx.
References CLAM::AudioCentroidId, CLAM::AudioEnergyId, CLAM::AudioVarianceId, CLAM::AudioZeroCrossingRateId, CLAM::FundamentalId, CLAM::Segment::GetFrame(), CLAM::SegmentDescriptors::GetFrameD(), CLAM::Segment::GetnFrames(), mConfig, CLAM::MatrixTmpl< T >::SetAt(), CLAM::SpectralCentroidId, CLAM::SpectralEnergyId, CLAM::SpectralFlatnessId, CLAM::SpectralGeometricMeanId, CLAM::SpectralKurtosisId, CLAM::SpectralMeanId, CLAM::SpectralMoment2Id, CLAM::SpectralMoment3Id, CLAM::SpectralMoment4Id, CLAM::SpectralMoment5Id, and CLAM::SpectralMoment6Id.
Referenced by Do().
Member Data Documentation
SegmentatorConfig CLAM::Segmentator::mConfig [protected] |
Definition at line 83 of file Segmentator.hxx.
Referenced by Do(), GetConfig(), and UnwrapDescriptors().
The documentation for this class was generated from the following files:
