Table of Contents

Struct KeyCorrelation

Namespace
Celeritas.Core.Analysis
Assembly
Celeritas.dll

Correlation of input with a specific key profile.

public readonly record struct KeyCorrelation : IEquatable<KeyCorrelation>
Implements
Inherited Members

Constructors

KeyCorrelation(KeySignature, float)

Correlation of input with a specific key profile.

public KeyCorrelation(KeySignature Key, float Correlation)

Parameters

Key KeySignature

The key whose profile was correlated.

Correlation float

The correlation score for that key.

Properties

Correlation

The correlation score for that key.

public float Correlation { get; init; }

Property Value

float

Key

The key whose profile was correlated.

public KeySignature Key { get; init; }

Property Value

KeySignature

Methods

ToString()

Returns the key name and correlation score (e.g. "C Major: 0.812").

public override string ToString()

Returns

string