API Reference

Complete API documentation for harmonic analysis of biosignals.

Core Objects

Main classes for single and batch time series analysis.

• Biotuner object
  • compute_biotuner
  • fit_biotuner()
• BiotunerGroup (BETA)
  • BiotunerGroup
  • Overview
  • Quick Start
  • Main Methods
  • See Also

Signal Processing Functions

Methods for spectral peak detection and extension (neuroscience/signal processing).

• Peaks Extraction
  • EMD_eeg()
  • SSA_EEG()
  • extract_welch_peaks()
  • compute_FOOOF()
  • HilbertHuang1D()
  • cepstrum()
  • cepstral_peaks()
  • pac_frequencies()
  • polycoherence()
  • polyspectrum_frequencies()
  • harmonic_recurrence()
  • endogenous_intermodulations()
  • compute_sidebands()
  • UnivariateTransformerMixin
  • SingularSpectrumAnalysis
• Peaks Extension
  • EEG_harmonics_mult()
  • EEG_harmonics_div()
  • harmonic_fit()
  • multi_consonance()

Musical Analysis Functions

Music theory and harmonic metrics computation.

• Harmonicity Metrics
  • compute_consonance()
  • euler()
  • tenneyHeight()
  • integral_tenneyHeight()
  • metric_denom()
  • dyad_similarity()
  • peaks_to_harmsim()
  • sum_p_q()
  • sum_distinct_intervals()
  • metric_3()
  • sum_p_q_for_all_intervals()
  • sum_q_for_all_intervals()
  • ratios2harmsim()
  • tuning_cons_matrix()
  • tuning_to_metrics()
  • timepoint_consonance()
  • compute_subharmonics()
  • compute_subharmonic_tension()
  • compute_subharmonics_2lists()
  • consonant_ratios()
  • consonance_peaks()
  • spectral_flatness()
  • spectral_entropy()
  • spectral_spread()
  • higuchi_fd()
• Scale construction
  • oct_subdiv()
  • compare_oct_div()
  • multi_oct_subdiv()
  • harmonic_tuning()
  • euler_fokker_scale()
  • convergents()
  • dissmeasure()
  • diss_curve()
  • compute_harmonic_entropy_domain_integral()
  • compute_harmonic_entropy_simple_weights()
  • harmonic_entropy()
  • tuning_reduction()
  • create_mode()
  • pac_mode()
  • tuning_range_to_MOS()
  • stern_brocot_to_generator_interval()
  • gen_interval_to_stern_brocot()
  • horogram_tree_steps()
  • horogram_tree()
  • phi_convergent_point()
  • Stern_Brocot()
  • generator_interval_tuning()
  • interval_exponents()
  • interval_to_radian()
  • tuning_to_radians()
  • tuning_MOS_info()
  • find_MOS()
  • MOS_metric_harmonic_mean()
  • generator_to_stern_brocot_fractions()
  • measure_symmetry()
• Rhythm construction
  • scale2euclid()
  • invert_ratio()
  • binome2euclid()
  • consonant_euclid()
  • interval_vector()
  • bjorklund()
  • interval_vec_to_string()
  • euclid_string_to_referent()
  • euclid_long_to_short()
  • find_optimal_offsets()

Extended Analysis Objects

Advanced objects building on biotuner_object for multi-dimensional analysis.

• harmonic_spectrum - Analysis across frequencies

• harmonic_connectivity - Analysis across space/sensors

• transitional_harmony - Analysis across time

• Harmonic spectrum
  • compute_global_harmonicity()
  • compute_phase_values()
  • harmonicity_matrices()
  • PLV_comod()
  • compute_harmonic_power()
  • compute_phase_spectrum()
  • compute_resonance_values()
  • find_spectral_peaks()
  • harmonic_entropy()
  • harmonic_spectrum_plot_trial_corr()
  • harmonic_spectrum_plot_freq_corr()
  • harmonic_spectrum_plot_avg_corr()
• Harmonic connectivity
• Transitional Harmony
  • transitional_harmony

Utilities

• Biotuner utilities