Skip to main content

KeyDetector

Struct KeyDetector 

Source
pub struct KeyDetector;
Expand description

Key detector using Krumhansl-Schmuckler profiles.

§Examples

use resonant_analysis::key::KeyDetector;
use resonant_analysis::chroma::ChromaVector;

// All-A chroma (strong A, C#, E — A major triad)
let mut cv = ChromaVector { bins: [0.0; 12] };
cv.bins[9]  = 1.0; // A
cv.bins[1]  = 0.8; // C#
cv.bins[4]  = 0.6; // E

let result = KeyDetector::new().detect(&[cv]);
assert!(result.is_some());

Implementations§

Source§

impl KeyDetector

Source

pub fn new() -> Self

Creates a new detector.

Source

pub fn detect(&self, chroma_frames: &[ChromaVector]) -> Option<KeyEstimate>

Classifies a sequence of chroma frames and returns the best-matching key.

Returns None if chroma_frames is empty.

Trait Implementations§

Source§

impl Default for KeyDetector

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.