pitch-garden documentation

pitch-garden provides a unified interface to various pitch (F0) trackers and integrates their outputs by voting. See the README for the installation and the usage.

• API Reference
  • pitch_garden
    • Tracking
      • Tracker
        • Tracker.__call__()
        • Tracker.f0_range
        • Tracker.load()
        • Tracker.parallel_safe
        • Tracker.replace()
        • Tracker.supports_f0_range
        • Tracker.two_pass_policy
      • Pipeline
        • Pipeline.__call__()
        • Pipeline.close()
        • Pipeline.estimate_f0_range()
        • Pipeline.first_pass()
        • Pipeline.second_pass()
        • Pipeline.track()
      • PipelineResult
      • TwoPass
        • TwoPass.check_trackers()
      • TwoPassPolicy
    • Data
      • Audio
        • Audio.duration
        • Audio.length
      • Pitch
        • Pitch.length
        • Pitch.to()
        • Pitch.to_grid()
        • Pitch.tofile()
        • Pitch.voiced
        • Pitch.with_f0()
        • Pitch.with_threshold()
    • Input
      • load_audio()
      • RawFormat
        • RawFormat.is_raw()
  • pitch_garden.algorithms
    • AlgorithmConfig
    • crepe
      • CrepeAlgorithm
      • CrepeConfig
    • dio
      • DioAlgorithm
      • DioConfig
    • fcn-f0
      • FcnF0Algorithm
      • FcnF0Config
    • fcpe
      • FcpeAlgorithm
      • FcpeConfig
    • harmof0
      • HarmoF0Algorithm
      • HarmoF0Config
    • harvest
      • HarvestAlgorithm
      • HarvestConfig
    • pesto
      • PestoAlgorithm
      • PestoConfig
    • pienet
      • PiENetAlgorithm
      • PiENetConfig
    • pyin
      • PyinAlgorithm
      • PyinConfig
    • rapt
      • RaptAlgorithm
      • RaptConfig
    • reaper
      • ReaperAlgorithm
      • ReaperConfig
    • rmvpe
      • RmvpeAlgorithm
      • RmvpeConfig
    • straight
      • StraightAlgorithm
      • StraightConfig
    • swift-f0
      • SwiftF0Algorithm
      • SwiftF0Config
    • swipe
      • SwipeAlgorithm
      • SwipeConfig
    • yaapt
      • YaaptAlgorithm
      • YaaptConfig
    • yin
      • YinAlgorithm
      • YinConfig
  • pitch_garden.voters
    • MedianVoter
      • MedianVoter.vote()
    • AlignedVoter
      • AlignedVoter.align()
      • AlignedVoter.check_trackers()
      • AlignedVoter.vote()
    • BaseVoter
      • BaseVoter.check_trackers()
      • BaseVoter.fit()
      • BaseVoter.load_state_dict()
      • BaseVoter.state_dict()
      • BaseVoter.vote()
  • pitch_garden.ranges
    • LogNormalRangeEstimator
      • LogNormalRangeEstimator.estimate()
    • F0Range
      • F0Range.to_dict()
    • BaseRangeEstimator
      • BaseRangeEstimator.estimate()
  • pitch_garden.metrics
    • evaluate()
    • vde()
    • voicing_scores()
    • gpe()
    • fpe()
    • rpa()
    • rca()
    • oa()
    • f1_score()

Indices

• Index