PitchExtractionOptions Struct Reference

#include <pitch-functions.h>

Collaboration diagram for PitchExtractionOptions:

Public Member Functions
	PitchExtractionOptions ()
void	Register (OptionsItf *opts)
int32	NccfWindowSize () const
	Returns the window-size in samples, after resampling. More...
int32	NccfWindowShift () const
	Returns the window-shift in samples, after resampling. More...

Public Attributes
BaseFloat	samp_freq
BaseFloat	frame_shift_ms
BaseFloat	frame_length_ms
BaseFloat	preemph_coeff
BaseFloat	min_f0
BaseFloat	max_f0
BaseFloat	soft_min_f0
BaseFloat	penalty_factor
BaseFloat	lowpass_cutoff
BaseFloat	resample_freq
BaseFloat	delta_pitch
BaseFloat	nccf_ballast
int32	lowpass_filter_width
int32	upsample_filter_width
int32	max_frames_latency
int32	frames_per_chunk
bool	simulate_first_pass_online
int32	recompute_frame
bool	nccf_ballast_online
bool	snip_edges

Detailed Description

Definition at line 42 of file pitch-functions.h.

Constructor & Destructor Documentation

PitchExtractionOptions()

PitchExtractionOptions ( )

inline

Definition at line 113 of file pitch-functions.h.

                          :
      samp_freq(16000),
      frame_shift_ms(10.0),
      frame_length_ms(25.0),
      preemph_coeff(0.0),
      min_f0(50),
      max_f0(400),
      soft_min_f0(10.0),
      penalty_factor(0.1),
      lowpass_cutoff(1000),
      resample_freq(4000),
      delta_pitch(0.005),
      nccf_ballast(7000),
      lowpass_filter_width(1),
      upsample_filter_width(5),
      max_frames_latency(0),
      frames_per_chunk(0),
      simulate_first_pass_online(false),
      recompute_frame(500),
      nccf_ballast_online(false),
      snip_edges(true) { }

Member Function Documentation

NccfWindowShift()

int32 NccfWindowShift ( ) const

inline

Returns the window-shift in samples, after resampling.

Definition at line 207 of file pitch-functions.h.

Referenced by OnlinePitchFeatureImpl::AcceptWaveform(), OnlinePitchFeatureImpl::NumFramesAvailable(), and OnlinePitchFeatureImpl::UpdateRemainder().

                                {
    return static_cast<int32>(resample_freq * frame_shift_ms / 1000.0);
  }

NccfWindowSize()

int32 NccfWindowSize ( ) const

inline

Returns the window-size in samples, after resampling.

This is the "basic window size", not the full window size after extending by max-lag.

Definition at line 203 of file pitch-functions.h.

Referenced by OnlinePitchFeatureImpl::AcceptWaveform(), OnlinePitchFeatureImpl::NumFramesAvailable(), OnlinePitchFeatureImpl::RecomputeBacktraces(), and OnlinePitchFeatureImpl::UpdateRemainder().

                               {
    return static_cast<int32>(resample_freq * frame_length_ms / 1000.0);
  }

Register()

void Register ( OptionsItf *  opts )

inline

Definition at line 135 of file pitch-functions.h.

References OptionsItf::Register().

Referenced by main().

                                  {
    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 (deprecated)");
    opts->Register("min-f0", &min_f0,
                   "min. F0 to search for (Hz)");
    opts->Register("max-f0", &max_f0,
                   "max. F0 to search for (Hz)");
    opts->Register("soft-min-f0", &soft_min_f0,
                   "Minimum f0, applied in soft way, must not exceed min-f0");
    opts->Register("penalty-factor", &penalty_factor,
                   "cost factor for FO change.");
    opts->Register("lowpass-cutoff", &lowpass_cutoff,
                   "cutoff frequency for LowPass filter (Hz) ");
    opts->Register("resample-frequency", &resample_freq,
                   "Frequency that we down-sample the signal to.  Must be "
                   "more than twice lowpass-cutoff");
    opts->Register("delta-pitch", &delta_pitch,
                   "Smallest relative change in pitch that our algorithm "
                   "measures");
    opts->Register("nccf-ballast", &nccf_ballast,
                   "Increasing this factor reduces NCCF for quiet frames");
    opts->Register("nccf-ballast-online", &nccf_ballast_online,
                   "This is useful mainly for debug; it affects how the NCCF "
                   "ballast is computed.");
    opts->Register("lowpass-filter-width", &lowpass_filter_width,
                   "Integer that determines filter width of "
                   "lowpass filter, more gives sharper filter");
    opts->Register("upsample-filter-width", &upsample_filter_width,
                   "Integer that determines filter width when upsampling NCCF");
    opts->Register("frames-per-chunk", &frames_per_chunk, "Only relevant for "
                   "offline pitch extraction (e.g. compute-kaldi-pitch-feats), "
                   "you can set it to a small nonzero value, such as 10, for "
                   "better feature compatibility with online decoding (affects "
                   "energy normalization in the algorithm)");
    opts->Register("simulate-first-pass-online", &simulate_first_pass_online,
                   "If true, compute-kaldi-pitch-feats will output features "
                   "that correspond to what an online decoder would see in the "
                   "first pass of decoding-- not the final version of the "
                   "features, which is the default.  Relevant if "
                   "--frames-per-chunk > 0");
    opts->Register("recompute-frame", &recompute_frame, "Only relevant for "
                   "online pitch extraction, or for compatibility with online "
                   "pitch extraction.  A non-critical parameter; the frame at "
                   "which we recompute some of the forward pointers, after "
                   "revising our estimate of the signal energy.  Relevant if"
                   "--frames-per-chunk > 0");
    opts->Register("max-frames-latency", &max_frames_latency, "Maximum number "
                   "of frames of latency that we allow pitch tracking to "
                   "introduce into the feature processing (affects output only "
                   "if --frames-per-chunk > 0 and "
                   "--simulate-first-pass-online=true");
    opts->Register("snip-edges", &snip_edges, "If this is set to false, the "
                   "incomplete frames near the ending edge won't be snipped, "
                   "so that the number of frames is the file size divided by "
                   "the frame-shift. This makes different types of features "
                   "give the same number of frames.");
  }

Member Data Documentation

delta_pitch

BaseFloat delta_pitch

Definition at line 56 of file pitch-functions.h.

Referenced by PitchFrameInfo::ComputeBacktraces(), and kaldi::SelectLags().

frame_length_ms

BaseFloat frame_length_ms

Definition at line 46 of file pitch-functions.h.

Referenced by kaldi::UnitTestSnipEdges().

frame_shift_ms

BaseFloat frame_shift_ms

Definition at line 45 of file pitch-functions.h.

Referenced by kaldi::ComputeAndProcessKaldiPitch(), kaldi::ComputeKaldiPitch(), kaldi::ComputeKaldiPitchFirstPass(), OnlinePitchFeatureImpl::FrameShiftInSeconds(), and kaldi::UnitTestSnipEdges().

frames_per_chunk

int32 frames_per_chunk

Definition at line 83 of file pitch-functions.h.

Referenced by kaldi::ComputeAndProcessKaldiPitch(), kaldi::ComputeKaldiPitch(), and kaldi::ComputeKaldiPitchFirstPass().

lowpass_cutoff

BaseFloat lowpass_cutoff

Definition at line 53 of file pitch-functions.h.

Referenced by OnlinePitchFeatureImpl::OnlinePitchFeatureImpl(), kaldi::UnitTestDiffSampleRate(), kaldi::UnitTestPitchExtractionSpeed(), and kaldi::UnitTestProcess().

lowpass_filter_width

int32 lowpass_filter_width

Definition at line 60 of file pitch-functions.h.

Referenced by OnlinePitchFeatureImpl::OnlinePitchFeatureImpl().

max_f0

BaseFloat max_f0

Definition at line 49 of file pitch-functions.h.

Referenced by OnlinePitchFeatureImpl::OnlinePitchFeatureImpl(), kaldi::SelectLags(), and kaldi::UnitTestDiffSampleRate().

max_frames_latency

int32 max_frames_latency

Definition at line 74 of file pitch-functions.h.

Referenced by OnlinePitchFeatureImpl::AcceptWaveform(), and OnlinePitchFeatureImpl::RecomputeBacktraces().

min_f0

BaseFloat min_f0

Definition at line 48 of file pitch-functions.h.

Referenced by OnlinePitchFeatureImpl::OnlinePitchFeatureImpl(), and kaldi::SelectLags().

nccf_ballast

BaseFloat nccf_ballast

Definition at line 57 of file pitch-functions.h.

Referenced by OnlinePitchFeatureImpl::AcceptWaveform(), OnlinePitchFeatureImpl::RecomputeBacktraces(), kaldi::UnitTestKeele(), kaldi::UnitTestKeeleNccfBallast(), kaldi::UnitTestPitchExtractionSpeed(), and kaldi::UnitTestPitchExtractorCompareKeele().

nccf_ballast_online

bool nccf_ballast_online

Definition at line 111 of file pitch-functions.h.

Referenced by OnlinePitchFeatureImpl::AcceptWaveform(), OnlinePitchFeatureImpl::InputFinished(), OnlinePitchFeatureImpl::RecomputeBacktraces(), kaldi::UnitTestDelay(), kaldi::UnitTestPieces(), and kaldi::UnitTestSearch().

penalty_factor

BaseFloat penalty_factor

Definition at line 52 of file pitch-functions.h.

Referenced by PitchFrameInfo::ComputeBacktraces(), and kaldi::UnitTestPenaltyFactor().

preemph_coeff

BaseFloat preemph_coeff

Definition at line 47 of file pitch-functions.h.

Referenced by OnlinePitchFeatureImpl::ExtractFrame().

recompute_frame

int32 recompute_frame

Definition at line 104 of file pitch-functions.h.

Referenced by OnlinePitchFeatureImpl::AcceptWaveform(), OnlinePitchFeatureImpl::InputFinished(), and OnlinePitchFeatureImpl::RecomputeBacktraces().

resample_freq

BaseFloat resample_freq

Definition at line 54 of file pitch-functions.h.

Referenced by OnlinePitchFeatureImpl::OnlinePitchFeatureImpl().

samp_freq

BaseFloat samp_freq

Definition at line 44 of file pitch-functions.h.

Referenced by kaldi::ComputeAndProcessKaldiPitch(), kaldi::ComputeKaldiPitch(), kaldi::ComputeKaldiPitchFirstPass(), OnlinePitchFeatureImpl::InputFinished(), main(), OnlinePitchFeatureImpl::OnlinePitchFeatureImpl(), kaldi::UnitTestDelay(), kaldi::UnitTestDiffSampleRate(), kaldi::UnitTestPieces(), and kaldi::UnitTestSearch().

simulate_first_pass_online

bool simulate_first_pass_online

Definition at line 92 of file pitch-functions.h.

Referenced by kaldi::ComputeAndProcessKaldiPitch(), and kaldi::ComputeKaldiPitch().

snip_edges

bool snip_edges

Definition at line 112 of file pitch-functions.h.

Referenced by OnlinePitchFeatureImpl::AcceptWaveform(), OnlinePitchFeatureImpl::ExtractFrame(), and kaldi::UnitTestSnipEdges().

soft_min_f0

BaseFloat soft_min_f0

Definition at line 50 of file pitch-functions.h.

Referenced by kaldi::ComputeLocalCost().

upsample_filter_width

int32 upsample_filter_width

Definition at line 62 of file pitch-functions.h.

Referenced by OnlinePitchFeatureImpl::OnlinePitchFeatureImpl().

---

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

• feat/pitch-functions.h