class_docstr: Compute pitch features of every frame in speech, return a float tensor
  with size (num_frames, 3).
docstr: Set params.
  :param config: contains nineteen optional parameters:
        --sample_rate               : Waveform data sample frequency (must match the waveform
                                      file, if specified there). (float, default = 16000)
        --delta-pitch               : Smallest relative change in pitch that our algorithm
                                      measures (float, default = 0.005)
        --window_length             : Frame length in seconds (float, default = 0.025)
        --frame_length              : Frame shift in seconds (float, default = 0.010)
        --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) (int, default = 0)
        --lowpass-cutoff            : cutoff frequency for LowPass filter (Hz).
                                      (float, default = 1000)
        --lowpass-filter-width      : Integer that determines filter width of lowpass filter,
                                      more gives sharper filter (int, default = 1)
        --max-f0                    : max. F0 to search for (Hz) (float, default = 400)
        --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 (int, default = 0)
        --min-f0                    : min. F0 to search for (Hz) (float, default = 50)
        --nccf-ballast              : Increasing this factor reduces NCCF for quiet frames.
                                      (float, default = 7000)
        --nccf-ballast-online       : This is useful mainly for debug; it affects how the NCCF
                                      ballast is computed. (bool, default = false)
        --penalty-factor            : cost factor for FO change. (float, default = 0.1)
        --preemphasis-coefficient   : Coefficient for use in signal preemphasis (deprecated).
                                      (float, default = 0)
        --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. (int, default = 500)
        --resample-frequency        : Frequency that we down-sample the signal to.  Must be
                                      more than twice lowpass-cutoff (float, default = 4000)
        --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 (bool, default = false)
        --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. (bool, default = true)
        --soft-min-f0               : Minimum f0, applied in soft way, must not exceed min-f0.
                                      (float, default = 10)
        --upsample-filter-width     : Integer that determines filter width when upsampling
                                      NCCF. (int, default = 5)
        --add-delta-pitch           : If true, time derivative of log-pitch is added to
                                      output features. (bool, default = true)
        --add-pov-feature           : If true, the warped NCCF is added to output features.
                                      (bool, default = true)
        --add-raw-log-pitch         : If true, log(pitch) is added to output features.
                                      (bool, default = false)
        --delay                     : Number of frames by which the pitch information is
                                      delayed. (int, default = 0)
        --delta-pitch-noise-stddev  : Standard deviation for noise we add to the delta
                                      log-pitch (before scaling); should be about the same as
                                      delta-pitch option to pitch creation.  The purpose is
                                      to get rid of peaks in the delta-pitch caused by
                                      discretization of pitch values. (float, default = 0.005)
        --delta-pitch-scale         : Term to scale the final delta log-pitch feature.
                                      (float, default = 10)
        --delta-window              : Number of frames on each side of central frame,
                                      to use for delta window. (int, default = 2)
        --normalization-left-context : Left-context (in frames) for moving window
                                      normalization. (int, default = 75)
        --normalization-right-context : Right-context (in frames) for moving window
                                      normalization. (int, default = 75)
        --pitch-scale               : Scaling factor for the final normalized log-pitch
                                      value. (float, default = 2)
        --pov-offset                : This can be used to add an offset to the POV feature.
                                      Intended for use in online decoding as a substitute
                                      for  CMN. (float, default = 0)
        --pov-scale                 : Scaling factor for final POV (probability of voicing)
                                      feature. (float, default = 2)
  :return: An object of class HParams, which is a set of hyperparameters as name-value pairs.
docstr_tok: ["Set","params",".",":","param","config",":","contains","nineteen","optional","parameters",":","--","sample_rate",":","Waveform","data","sample","frequency","(","must","match","the","waveform","file",",","if","specified","there",")",".","(","float",",","default","=","16000",")","--","delta-pitch",":","Smallest","relative","change","in","pitch","that","our","algorithm","measures","(","float",",","default","=","0.005",")","--","window_length",":","Frame","length","in","seconds","(","float",",","default","=","0.025",")","--","frame_length",":","Frame","shift","in","seconds","(","float",",","default","=","0.010",")","--","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",")","(","int",",","default","=","0",")","--","lowpass-cutoff",":","cutoff","frequency","for","LowPass","filter","(","Hz",")",".","(","float",",","default","=","1000",")","--","lowpass-filter-width",":","Integer","that","determines","filter","width","of","lowpass","filter",",","more","gives","sharper","filter","(","int",",","default","=","1",")","--","max-f0",":","max",".","F0","to","search","for","(","Hz",")","(","float",",","default","=","400",")","--","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","(","int",",","default","=","0",")","--","min-f0",":","min",".","F0","to","search","for","(","Hz",")","(","float",",","default","=","50",")","--","nccf-ballast",":","Increasing","this","factor","reduces","NCCF","for","quiet","frames",".","(","float",",","default","=","7000",")","--","nccf-ballast-online",":","This","is","useful","mainly","for","debug",";","it","affects","how","the","NCCF","ballast","is","computed",".","(","bool",",","default","=","false",")","--","penalty-factor",":","cost","factor","for","FO","change",".","(","float",",","default","=","0.1",")","--","preemphasis-coefficient",":","Coefficient","for","use","in","signal","preemphasis","(","deprecated",")",".","(","float",",","default","=","0",")","--","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",".","(","int",",","default","=","500",")","--","resample-frequency",":","Frequency","that","we","down-sample","the","signal","to",".","Must","be","more","than","twice","lowpass-cutoff","(","float",",","default","=","4000",")","--","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","(","bool",",","default","=","false",")","--","snip-edges",":","If","this","is","set","to","false",",","the","incomplete","frames","near","the","ending","edge","wo","n'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",".","(","bool",",","default","=","true",")","--","soft-min-f0",":","Minimum","f0",",","applied","in","soft","way",",","must","not","exceed","min-f0",".","(","float",",","default","=","10",")","--","upsample-filter-width",":","Integer","that","determines","filter","width","when","upsampling","NCCF",".","(","int",",","default","=","5",")","--","add-delta-pitch",":","If","true",",","time","derivative","of","log-pitch","is","added","to","output","features",".","(","bool",",","default","=","true",")","--","add-pov-feature",":","If","true",",","the","warped","NCCF","is","added","to","output","features",".","(","bool",",","default","=","true",")","--","add-raw-log-pitch",":","If","true",",","log","(","pitch",")","is","added","to","output","features",".","(","bool",",","default","=","false",")","--","delay",":","Number","of","frames","by","which","the","pitch","information","is","delayed",".","(","int",",","default","=","0",")","--","delta-pitch-noise-stddev",":","Standard","deviation","for","noise","we","add","to","the","delta","log-pitch","(","before","scaling",")",";","should","be","about","the","same","as","delta-pitch","option","to","pitch","creation",".","The","purpose","is","to","get","rid","of","peaks","in","the","delta-pitch","caused","by","discretization","of","pitch","values",".","(","float",",","default","=","0.005",")","--","delta-pitch-scale",":","Term","to","scale","the","final","delta","log-pitch","feature",".","(","float",",","default","=","10",")","--","delta-window",":","Number","of","frames","on","each","side","of","central","frame",",","to","use","for","delta","window",".","(","int",",","default","=","2",")","--","normalization-left-context",":","Left-context","(","in","frames",")","for","moving","window","normalization",".","(","int",",","default","=","75",")","--","normalization-right-context",":","Right-context","(","in","frames",")","for","moving","window","normalization",".","(","int",",","default","=","75",")","--","pitch-scale",":","Scaling","factor","for","the","final","normalized","log-pitch","value",".","(","float",",","default","=","2",")","--","pov-offset",":","This","can","be","used","to","add","an","offset","to","the","POV","feature",".","Intended","for","use","in","online","decoding","as","a","substitute","for","CMN",".","(","float",",","default","=","0",")","--","pov-scale",":","Scaling","factor","for","final","POV","(","probability","of","voicing",")","feature",".","(","float",",","default","=","2",")",":","return",":","An","object","of","class","HParams",",","which","is","a","set","of","hyperparameters","as","name-value","pairs","."]
code: def params(cls, config=None):
      """
      Set params.
      :param config: contains nineteen optional parameters:
            --sample_rate               : Waveform data sample frequency (must match the waveform
                                          file, if specified there). (float, default = 16000)
            --delta-pitch               : Smallest relative change in pitch that our algorithm
                                          measures (float, default = 0.005)
            --window_length             : Frame length in seconds (float, default = 0.025)
            --frame_length              : Frame shift in seconds (float, default = 0.010)
            --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) (int, default = 0)
            --lowpass-cutoff            : cutoff frequency for LowPass filter (Hz).
                                          (float, default = 1000)
            --lowpass-filter-width      : Integer that determines filter width of lowpass filter,
                                          more gives sharper filter (int, default = 1)
            --max-f0                    : max. F0 to search for (Hz) (float, default = 400)
            --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 (int, default = 0)
            --min-f0                    : min. F0 to search for (Hz) (float, default = 50)
            --nccf-ballast              : Increasing this factor reduces NCCF for quiet frames.
                                          (float, default = 7000)
            --nccf-ballast-online       : This is useful mainly for debug; it affects how the NCCF
                                          ballast is computed. (bool, default = false)
            --penalty-factor            : cost factor for FO change. (float, default = 0.1)
            --preemphasis-coefficient   : Coefficient for use in signal preemphasis (deprecated).
                                          (float, default = 0)
            --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. (int, default = 500)
            --resample-frequency        : Frequency that we down-sample the signal to.  Must be
                                          more than twice lowpass-cutoff (float, default = 4000)
            --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 (bool, default = false)
            --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. (bool, default = true)
            --soft-min-f0               : Minimum f0, applied in soft way, must not exceed min-f0.
                                          (float, default = 10)
            --upsample-filter-width     : Integer that determines filter width when upsampling
                                          NCCF. (int, default = 5)
            --add-delta-pitch           : If true, time derivative of log-pitch is added to
                                          output features. (bool, default = true)
            --add-pov-feature           : If true, the warped NCCF is added to output features.
                                          (bool, default = true)
            --add-raw-log-pitch         : If true, log(pitch) is added to output features.
                                          (bool, default = false)
            --delay                     : Number of frames by which the pitch information is
                                          delayed. (int, default = 0)
            --delta-pitch-noise-stddev  : Standard deviation for noise we add to the delta
                                          log-pitch (before scaling); should be about the same as
                                          delta-pitch option to pitch creation.  The purpose is
                                          to get rid of peaks in the delta-pitch caused by
                                          discretization of pitch values. (float, default = 0.005)
            --delta-pitch-scale         : Term to scale the final delta log-pitch feature.
                                          (float, default = 10)
            --delta-window              : Number of frames on each side of central frame,
                                          to use for delta window. (int, default = 2)
            --normalization-left-context : Left-context (in frames) for moving window
                                          normalization. (int, default = 75)
            --normalization-right-context : Right-context (in frames) for moving window
                                          normalization. (int, default = 75)
            --pitch-scale               : Scaling factor for the final normalized log-pitch
                                          value. (float, default = 2)
            --pov-offset                : This can be used to add an offset to the POV feature.
                                          Intended for use in online decoding as a substitute
                                          for  CMN. (float, default = 0)
            --pov-scale                 : Scaling factor for final POV (probability of voicing)
                                          feature. (float, default = 2)
      :return: An object of class HParams, which is a set of hyperparameters as name-value pairs.
      """
  
      hparams = HParams(cls=cls)
      window_length = 0.025
      frame_length = 0.010
      sample_rate = 16000
      snip_edges = True
      preemph_coeff = 0.0
      min_f0 = 50.0
      max_f0 = 400.0
      soft_min_f0 = 10.0
      penalty_factor = 0.1
      lowpass_cutoff = 1000.0
      resample_freq = 4000.0
      delta_pitch = 0.005
      nccf_ballast = 7000.0
      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
  
      pitch_scale = 2.0
      pov_scale = 2.0
      pov_offset = 0.0
      delta_pitch_scale = 10.0
      delta_pitch_noise_stddev = 0.005
      normalization_left_context = 75
      normalization_right_context = 75
      delta_window = 2
      delay = 0
      add_pov_feature = True
      add_normalized_log_pitch = True
      add_delta_pitch = True
      add_raw_log_pitch = False
  
      hparams.add_hparam("window_length", window_length)
      hparams.add_hparam("frame_length", frame_length)
      hparams.add_hparam("sample_rate", sample_rate)
      hparams.add_hparam("snip_edges", snip_edges)
      hparams.add_hparam("preemph_coeff", preemph_coeff)
      hparams.add_hparam("min_f0", min_f0)
      hparams.add_hparam("max_f0", max_f0)
      hparams.add_hparam("soft_min_f0", soft_min_f0)
      hparams.add_hparam("penalty_factor", penalty_factor)
      hparams.add_hparam("lowpass_cutoff", lowpass_cutoff)
      hparams.add_hparam("resample_freq", resample_freq)
      hparams.add_hparam("delta_pitch", delta_pitch)
      hparams.add_hparam("nccf_ballast", nccf_ballast)
      hparams.add_hparam("lowpass_filter_width", lowpass_filter_width)
      hparams.add_hparam("upsample_filter_width", upsample_filter_width)
      hparams.add_hparam("max_frames_latency", max_frames_latency)
      hparams.add_hparam("frames_per_chunk", frames_per_chunk)
      hparams.add_hparam(
          "simulate_first_pass_online", simulate_first_pass_online
      )
      hparams.add_hparam("recompute_frame", recompute_frame)
      hparams.add_hparam("nccf_ballast_online", nccf_ballast_online)
  
      hparams.add_hparam("pitch_scale", pitch_scale)
      hparams.add_hparam("pov_offset", pov_offset)
      hparams.add_hparam("pov_scale", pov_scale)
      hparams.add_hparam("delta_pitch_scale", delta_pitch_scale)
      hparams.add_hparam(
          "delta_pitch_noise_stddev", delta_pitch_noise_stddev
      )
      hparams.add_hparam(
          "normalization_left_context", normalization_left_context
      )
      hparams.add_hparam(
          "normalization_right_context", normalization_right_context
      )
      hparams.add_hparam("delta_window", delta_window)
      hparams.add_hparam("delay", delay)
      hparams.add_hparam("add_pov_feature", add_pov_feature)
      hparams.add_hparam(
          "add_normalized_log_pitch", add_normalized_log_pitch
      )
      hparams.add_hparam("add_delta_pitch", add_delta_pitch)
      hparams.add_hparam("add_raw_log_pitch", add_raw_log_pitch)
  
      if config is not None:
          hparams.override_from_dict(config)
  
      return hparams
  
file_path: delta/delta/data/frontend/pitch.py
imports: import delta.compat
  from core.ops import py_x_ops
  from delta.utils.hparam import HParams
  from delta.data.frontend.base_frontend import BaseFrontend
label_desc: Use image node_id 2 for calling the Pitch obj's underlying member method code with example usage: obj.params(cls, config) and returns: hparams