Module: PulseAnalysis

Defined in:
lib/pulse-analysis.rb,
lib/pulse-analysis/file.rb,
lib/pulse-analysis/sound.rb,
lib/pulse-analysis/report.rb,
lib/pulse-analysis/console.rb,
lib/pulse-analysis/analysis.rb,
lib/pulse-analysis/audio_data.rb,
lib/pulse-analysis/conversion.rb,
lib/pulse-analysis/console/table.rb

Defined Under Namespace

Modules: Console, Conversion Classes: Analysis, AudioData, File, Report, Sound

Constant Summary collapse

VERSION = 
"0.0.2"

Class Method Summary collapse

Class Method Details

.report(file_or_path, options = {}) ⇒ PulseAnalysis::Report

Analyze the given audio file with the given options and generate a report

Parameters:

  • file_or_path (::File, String) —

    File or path to audio file to run analysis on

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :amplitude_threshold (Float) —

    Pulses above this amplitude will be analyzed

  • :length_threshold (Integer) —

    Pulse periods longer than this value will be analyzed

Returns:



33
34
35
36
37
 
# 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