module PulseAnalysis
Constants
- VERSION
Public Class Methods
report(file_or_path, options = {})
click to toggle source
Analyze the given audio file with the given options and generate a report @param [::File, String] file_or_path File
or path to audio file to run analysis on @param [Hash] options @option options [Float] :amplitude_threshold Pulses above this amplitude will be analyzed @option options [Integer] :length_threshold Pulse periods longer than this value will be analyzed @return [PulseAnalysis::Report]
# File lib/pulse-analysis.rb, line 33 def self.report(file_or_path, options = {}) analysis = Analysis.new(file_or_path, options) analysis.run Report.new(analysis) end