FrameExtractionOptions Struct Reference

#include <feature-window.h>

Collaboration diagram for FrameExtractionOptions:

Public Member Functions
	FrameExtractionOptions ()
void	Register (OptionsItf *opts)
int32	WindowShift () const
int32	WindowSize () const
int32	PaddedWindowSize () const

Public Attributes
BaseFloat	samp_freq
BaseFloat	frame_shift_ms
BaseFloat	frame_length_ms
BaseFloat	dither
BaseFloat	preemph_coeff
bool	remove_dc_offset
std::string	window_type
bool	round_to_power_of_two
BaseFloat	blackman_coeff
bool	snip_edges
bool	allow_downsample
bool	allow_upsample
int	max_feature_vectors

Detailed Description

Definition at line 35 of file feature-window.h.

Constructor & Destructor Documentation

FrameExtractionOptions()

FrameExtractionOptions ( )

inline

Definition at line 53 of file feature-window.h.

                          :
      samp_freq(16000),
      frame_shift_ms(10.0),
      frame_length_ms(25.0),
      dither(1.0),
      preemph_coeff(0.97),
      remove_dc_offset(true),
      window_type("povey"),
      round_to_power_of_two(true),
      blackman_coeff(0.42),
      snip_edges(true),
      allow_downsample(false),
      allow_upsample(false),
      max_feature_vectors(-1)
      { }

Member Function Documentation

PaddedWindowSize()

int32 PaddedWindowSize ( ) const

inline

Definition at line 112 of file feature-window.h.

References kaldi::RoundUpToNearestPowerOfTwo(), and FrameExtractionOptions::WindowSize().

Referenced by SpectrogramComputer::Compute(), MfccComputer::Compute(), FbankComputer::Compute(), PlpComputer::Compute(), kaldi::ExtractWindow(), FbankComputer::FbankComputer(), MelBanks::MelBanks(), MfccComputer::MfccComputer(), PlpComputer::PlpComputer(), and SpectrogramComputer::SpectrogramComputer().

                                 {
    return (round_to_power_of_two ? RoundUpToNearestPowerOfTwo(WindowSize()) :
                                    WindowSize());
  }

Register()

void Register ( OptionsItf *  opts )

inline

Definition at line 69 of file feature-window.h.

References OptionsItf::Register().

Referenced by SpectrogramOptions::Register(), MfccOptions::Register(), FbankOptions::Register(), and PlpOptions::Register().

                                  {
    opts->Register("sample-frequency", &samp_freq,
                   "Waveform data sample frequency (must match the waveform file, "
                   "if specified there)");
    opts->Register("frame-length", &frame_length_ms, "Frame length in milliseconds");
    opts->Register("frame-shift", &frame_shift_ms, "Frame shift in milliseconds");
    opts->Register("preemphasis-coefficient", &preemph_coeff,
                   "Coefficient for use in signal preemphasis");
    opts->Register("remove-dc-offset", &remove_dc_offset,
                   "Subtract mean from waveform on each frame");
    opts->Register("dither", &dither, "Dithering constant (0.0 means no dither). "
                   "If you turn this off, you should set the --energy-floor "
                   "option, e.g. to 1.0 or 0.1");
    opts->Register("window-type", &window_type, "Type of window "
                   "(\"hamming\"|\"hanning\"|\"povey\"|\"rectangular\""
                   "|\"sine\"|\"blackmann\")");
    opts->Register("blackman-coeff", &blackman_coeff,
                   "Constant coefficient for generalized Blackman window.");
    opts->Register("round-to-power-of-two", &round_to_power_of_two,
                   "If true, round window size to power of two by zero-padding "
                   "input to FFT.");
    opts->Register("snip-edges", &snip_edges,
                   "If true, end effects will be handled by outputting only frames that "
                   "completely fit in the file, and the number of frames depends on the "
                   "frame-length.  If false, the number of frames depends only on the "
                   "frame-shift, and we reflect the data at the ends.");
    opts->Register("allow-downsample", &allow_downsample,
                   "If true, allow the input waveform to have a higher frequency than "
                   "the specified --sample-frequency (and we'll downsample).");
    opts->Register("max-feature-vectors", &max_feature_vectors,
                   "Memory optimization. If larger than 0, periodically remove feature "
                   "vectors so that only this number of the latest feature vectors is "
                   "retained.");
    opts->Register("allow-upsample", &allow_upsample,
                   "If true, allow the input waveform to have a lower frequency than "
                   "the specified --sample-frequency (and we'll upsample).");
  }

WindowShift()

int32 WindowShift ( ) const

inline

Definition at line 106 of file feature-window.h.

References FrameExtractionOptions::frame_shift_ms.

Referenced by kaldi::FirstSampleOfFrame(), and kaldi::NumFrames().

                            {
    return static_cast<int32>(samp_freq * 0.001 * frame_shift_ms);
  }

WindowSize()

int32 WindowSize ( ) const

inline

Definition at line 109 of file feature-window.h.

References FrameExtractionOptions::frame_length_ms.

Referenced by kaldi::ExtractWindow(), FeatureWindowFunction::FeatureWindowFunction(), kaldi::FirstSampleOfFrame(), kaldi::NumFrames(), FrameExtractionOptions::PaddedWindowSize(), and kaldi::ProcessWindow().

                           {
    return static_cast<int32>(samp_freq * 0.001 * frame_length_ms);
  }

Member Data Documentation

allow_downsample

bool allow_downsample

Definition at line 50 of file feature-window.h.

allow_upsample

bool allow_upsample

Definition at line 51 of file feature-window.h.

blackman_coeff

BaseFloat blackman_coeff

Definition at line 48 of file feature-window.h.

Referenced by FeatureWindowFunction::FeatureWindowFunction().

dither

BaseFloat dither

Definition at line 39 of file feature-window.h.

Referenced by main(), kaldi::ProcessWindow(), kaldi::TestOnlineAppendFeature(), kaldi::TestOnlineMfcc(), kaldi::TestOnlinePlp(), kaldi::TestOnlineTransform(), UnitTestHTKCompare1(), UnitTestHTKCompare2(), UnitTestHTKCompare3(), UnitTestHTKCompare4(), UnitTestHTKCompare5(), UnitTestHTKCompare6(), and UnitTestSimple().

frame_length_ms

BaseFloat frame_length_ms

Definition at line 38 of file feature-window.h.

Referenced by main(), OnlineFeInput< E >::OnlineFeInput(), and FrameExtractionOptions::WindowSize().

frame_shift_ms

BaseFloat frame_shift_ms

Definition at line 37 of file feature-window.h.

Referenced by main(), OnlineFeInput< E >::OnlineFeInput(), and FrameExtractionOptions::WindowShift().

max_feature_vectors

int max_feature_vectors

Definition at line 52 of file feature-window.h.

preemph_coeff

BaseFloat preemph_coeff

Definition at line 40 of file feature-window.h.

Referenced by kaldi::ProcessWindow(), kaldi::TestOnlineAppendFeature(), UnitTestHTKCompare1(), UnitTestHTKCompare2(), UnitTestHTKCompare3(), UnitTestHTKCompare4(), UnitTestHTKCompare6(), and UnitTestSimple().

remove_dc_offset

bool remove_dc_offset

Definition at line 41 of file feature-window.h.

Referenced by kaldi::ProcessWindow(), kaldi::TestOnlineAppendFeature(), UnitTestHTKCompare1(), UnitTestHTKCompare2(), UnitTestHTKCompare3(), UnitTestHTKCompare4(), UnitTestHTKCompare5(), UnitTestHTKCompare6(), and UnitTestSimple().

round_to_power_of_two

bool round_to_power_of_two

Definition at line 47 of file feature-window.h.

Referenced by kaldi::TestOnlineAppendFeature(), UnitTestHTKCompare1(), UnitTestHTKCompare2(), UnitTestHTKCompare3(), UnitTestHTKCompare4(), UnitTestHTKCompare5(), UnitTestHTKCompare6(), and UnitTestSimple().

samp_freq

BaseFloat samp_freq

Definition at line 36 of file feature-window.h.

Referenced by MelBanks::MelBanks(), OnlineFeInput< E >::OnlineFeInput(), and kaldi::TestOnlineAppendFeature().

snip_edges

bool snip_edges

Definition at line 49 of file feature-window.h.

Referenced by kaldi::ExtractWindow(), kaldi::FirstSampleOfFrame(), kaldi::NumFrames(), and OnlineFeInput< E >::OnlineFeInput().

window_type

std::string window_type

Definition at line 42 of file feature-window.h.

Referenced by FeatureWindowFunction::FeatureWindowFunction(), kaldi::TestOnlineAppendFeature(), UnitTestHTKCompare1(), UnitTestHTKCompare2(), UnitTestHTKCompare3(), UnitTestHTKCompare4(), UnitTestHTKCompare5(), UnitTestHTKCompare6(), and UnitTestSimple().

---

The documentation for this struct was generated from the following file:

• feat/feature-window.h