CLAM::EnvelopeExtractor Class Reference

#include <EnvelopeExtractor.hxx>

List of all members.

Public Member Functions

 EnvelopeExtractor (const EnvExtractorConfig &c=EnvExtractorConfig())
const char * GetClassName () const
 Override it in every subclass and retur the name of that class.
const ProcessingConfigGetConfig () const
 Configuration getter.
void Attach (Audio &inp, Envelope &env)
bool Do ()
 Supervised mode execution method (using ports).
bool Do (const Audio &inp, Envelope &env)
int NPoints () const
TData NormalLevel () const
TData SilenceLevel () const
TTime InterpolationPeriod () const
TTime IntegrationLength () const
TData NormalLevelControl () const
TData SilenceLevelControl () const
TTime InterpolationPeriodControl () const
TTime IntegrationLengthControl () const

Public Attributes

FloatInControl cInterpolationPeriod
FloatInControl cIntegrationLength
FloatInControl cNormalLevel
FloatInControl cSilenceLevel
InPort< AudioInput
OutPort< EnvelopeOutput

Detailed Description

Definition at line 161 of file EnvelopeExtractor.hxx.


Constructor & Destructor Documentation

CLAM::EnvelopeExtractor::EnvelopeExtractor ( const EnvExtractorConfig c = EnvExtractorConfig()  ) 

Definition at line 119 of file EnvelopeExtractor.cxx.

References CLAM::Processing::Configure().


Member Function Documentation

void CLAM::EnvelopeExtractor::Attach ( Audio inp,
Envelope env 
)
bool CLAM::EnvelopeExtractor::Do ( const Audio inp,
Envelope env 
)

Definition at line 424 of file EnvelopeExtractor.cxx.

bool CLAM::EnvelopeExtractor::Do (  )  [virtual]

Supervised mode execution method (using ports).

Returns:
A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 416 of file EnvelopeExtractor.cxx.

const char* CLAM::EnvelopeExtractor::GetClassName (  )  const [inline, virtual]

Override it in every subclass and retur the name of that class.

Implements CLAM::Processing.

Definition at line 180 of file EnvelopeExtractor.hxx.

const ProcessingConfig& CLAM::EnvelopeExtractor::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 182 of file EnvelopeExtractor.hxx.

TTime CLAM::EnvelopeExtractor::IntegrationLength (  )  const [inline]

Definition at line 200 of file EnvelopeExtractor.hxx.

TTime CLAM::EnvelopeExtractor::IntegrationLengthControl (  )  const [inline]

Definition at line 208 of file EnvelopeExtractor.hxx.

TTime CLAM::EnvelopeExtractor::InterpolationPeriod (  )  const [inline]

Definition at line 198 of file EnvelopeExtractor.hxx.

TTime CLAM::EnvelopeExtractor::InterpolationPeriodControl (  )  const [inline]

Definition at line 206 of file EnvelopeExtractor.hxx.

TData CLAM::EnvelopeExtractor::NormalLevel (  )  const [inline]

Definition at line 194 of file EnvelopeExtractor.hxx.

TData CLAM::EnvelopeExtractor::NormalLevelControl (  )  const [inline]

Definition at line 202 of file EnvelopeExtractor.hxx.

int CLAM::EnvelopeExtractor::NPoints (  )  const [inline]

Definition at line 192 of file EnvelopeExtractor.hxx.

TData CLAM::EnvelopeExtractor::SilenceLevel (  )  const [inline]

Definition at line 196 of file EnvelopeExtractor.hxx.

TData CLAM::EnvelopeExtractor::SilenceLevelControl (  )  const [inline]

Definition at line 204 of file EnvelopeExtractor.hxx.


Member Data Documentation

Definition at line 171 of file EnvelopeExtractor.hxx.

Definition at line 170 of file EnvelopeExtractor.hxx.

Definition at line 172 of file EnvelopeExtractor.hxx.

Definition at line 173 of file EnvelopeExtractor.hxx.

Definition at line 175 of file EnvelopeExtractor.hxx.

Definition at line 176 of file EnvelopeExtractor.hxx.


The documentation for this class was generated from the following files:
Generated by  doxygen 1.6.3