Class ModalProgressions.ModalProgressionAnalysisResult

Namespace

Celeritas.Core.Analysis

Assembly

Celeritas.dll

Result of modal progression analysis.

public sealed class ModalProgressions.ModalProgressionAnalysisResult

Inheritance

object

ModalProgressions.ModalProgressionAnalysisResult

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

BorrowedChords

Chords containing pitch classes outside the detected mode's scale (modal mixture).

public required IReadOnlyList<ModalProgressions.ModalMixtureChord> BorrowedChords { get; init; }

Property Value

IReadOnlyList<ModalProgressions.ModalMixtureChord>

Degrees

Scale degree (1-7) of each chord's root in the detected mode; 0 for chords outside the scale or unparsable.

public required IReadOnlyList<int> Degrees { get; init; }

Property Value

IReadOnlyList<int>

DetectedKey

The detected modal key (root and mode).

public required ModalKey DetectedKey { get; init; }

Property Value

ModalKey

HasModalMixture

Whether any borrowed (out-of-scale) chords were found.

public bool HasModalMixture { get; }

Property Value

bool

MatchedProgression

Best-matching characteristic progression for the detected mode, or null if none matched.

public required ModalProgression? MatchedProgression { get; init; }

Property Value

ModalProgression?

ModeConfidence

Margin between the best-fitting mode and the runner-up on the detected root (a modest value, not a probability).

public required float ModeConfidence { get; init; }

Property Value

float

ProgressionConfidence

Fraction of the matched progression's degrees that line up, in 0-1.

public required float ProgressionConfidence { get; init; }

Property Value

float