Skip to contents

Harmonicity

Source: R/harmonicity.R
Harmonicity.Rd

A Harmonicity object represents the degree of acoustic periodicity, the Harmonics-to-Noise Ratio (HNR), in a sound over time, measured in decibels.

Arguments

.xptr

Not for direct use. External pointer to the underlying C++ Harmonicity object; set internally when a method returns a new Harmonicity.

Value

A Harmonicity object with methods for harmonics-to-noise ratio (HNR) analysis.

Details

Created from a Sound via cross-correlation (CC) or glottal-to-noise excitation (GNE) analysis. Higher values indicate more periodic (voiced) speech.

Information methods

  • get_start_time(), get_end_time() - time range (s)

  • get_sampling_period() - time step between frames (s)

  • get_number_of_frames() - number of analysis frames

  • get_time_from_frame(frame) - time for a frame index

  • get_frame_from_time(time) - frame index for a time

Point query methods

  • get_value_at_time(time, interpolation) - HNR at a time point (dB)

  • get_values_at_times(times, interpolation) - HNR at a vector of times (batch)

  • get_values_vector() - raw HNR values for all frames

  • get_times_vector() - frame time points

Statistics methods (over a time range)

  • get_mean(from_time, to_time) - mean HNR (dB)

  • get_minimum(from_time, to_time, interpolation) - minimum HNR

  • get_maximum(from_time, to_time, interpolation) - maximum HNR

  • get_standard_deviation(from_time, to_time) - standard deviation

  • get_time_of_minimum(...), get_time_of_maximum(...) - time of extremum

Batch methods

  • get_statistics_batch(from_times, to_times) - statistics for multiple intervals in a single C++ call

Export methods

  • as_data_frame(), as_matrix() - export as a data.frame or matrix

See also

Sound, Pitch, PointProcess

Examples

sound <- Sound$create_tone(duration = 1.0, frequency = 200, sampling_rate =
 44100)
hnr <- sound$to_harmonicity_cc(time_step = 0.01, min_pitch = 75)
mean_hnr <- hnr$get_mean()
hnr_at_05 <- hnr$get_value_at_time(0.5)

# The same analysis on a recording read from disk
sound <- Sound(system.file("extdata", "test.wav", package = "pladdrr"))
hnr <- sound$to_harmonicity_ac(time_step = 0.01, min_pitch = 75)
df <- hnr$as_data_frame()