Hiyve Components - v1.0.0
    Preparing search index...

    Interface EstimatePitchesOptions

    Options for estimatePitches and verifyPitches.

    interface EstimatePitchesOptions {
        attributionShare?: number;
        competitorMargin?: number;
        consistentExtraThreshold?: number;
        consistentPartials?: number;
        dominantFundamental?: number;
        extraThreshold?: number;
        maxMidi?: number;
        maxNotes?: number;
        minMidi?: number;
        minSupportedPartials?: number;
        octavePreference?: number;
        partials?: number;
        partialSnrFloor?: number;
        presentThreshold?: number;
        ringCents?: number;
        supportFloor?: number;
        toleranceCents?: number;
        tuningCents?: number;
        weakPresentThreshold?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    attributionShare? competitorMargin? consistentExtraThreshold? consistentPartials? dominantFundamental? extraThreshold? maxMidi? maxNotes? minMidi? minSupportedPartials? octavePreference? partials? partialSnrFloor? presentThreshold? ringCents? supportFloor? toleranceCents? tuningCents? weakPresentThreshold?

    Properties

    attributionShare?: number

    When an accepted note is subtracted, this share of each partial's measured level is removed (at least the idealised 1/k amount), so a louder-than-ideal partial is not re-claimed as a note of its own (default: 0.75)

    competitorMargin?: number

    An expected note is rejected when a semitone neighbour has more than this many times its support — a different note was played (default: 1.25)

    consistentExtraThreshold?: number

    An unexpected note is also accepted below extraThreshold when all of its first four partials are consistent and its relative evidence reaches this (default: 0.1)

    consistentPartials?: number

    Partials that must be consistent for the weak-presence rule (default: 3)

    dominantFundamental?: number

    A note whose fundamental alone is at least this fraction of the loudest bin counts as a note even with no other partials — a near-pure tone (default: 0.5)

    extraThreshold?: number

    Relative evidence an unexpected note needs to count as extra (default: 0.2)

    maxMidi?: number

    Highest note searched (default: 108, C8)

    maxNotes?: number

    Most notes reported for one moment (default: 10)

    minMidi?: number

    Lowest note searched (default: 21, A0)

    minSupportedPartials?: number

    Of the first three partials, how many an unexpected note must show (default: 2)

    octavePreference?: number

    When searching without a score, a candidate yields to the note an octave below if that note's fundamental is visible and its support is at least this fraction of the candidate's (default: 0.6)

    partials?: number

    Partials examined per note (default: 6)

    partialSnrFloor?: number

    A partial counts as consistent when its peak is at least this many times its local floor (default: 10)

    presentThreshold?: number

    Relative evidence an expected note needs to count as present (default: 0.1)

    ringCents?: number

    Half-width of the ring around each partial whose median is its local noise floor, in cents (default: 250)

    supportFloor?: number

    A partial counts as supporting the note when its peak is at least this fraction of the loudest bin (default: 0.05)

    toleranceCents?: number

    Half-width of the window around each partial, in cents (default: 50)

    tuningCents?: number

    Tuning offset of the instrument from A4 = 440 Hz, in cents (default: 0)

    weakPresentThreshold?: number

    An expected note too quiet to reach presentThreshold still counts as present when at least consistentPartials of its first four partials stand clearly above their local floors and its relative evidence reaches this (default: 0.01) — a quiet chord tone next to loud ones

    Settings

    Member Visibility

    On This Page

    Properties