Struct ModalTurnEvent

Namespace

Celeritas.Core.Analysis

Assembly

Celeritas.dll

A detected segment where a different mode explains the pitch material better than the base key mode.

public readonly record struct ModalTurnEvent : IEquatable<ModalTurnEvent>

Implements

IEquatable<ModalTurnEvent>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

ModalTurnEvent(int, int, Mode, double, int)

A detected segment where a different mode explains the pitch material better than the base key mode.

public ModalTurnEvent(int StartChordIndex, int EndChordIndex, Mode Mode, double Confidence, int OutOfKeyPitchClassMask)

Parameters

StartChordIndex int

Index of the first chord in the segment.

EndChordIndex int

Index of the last chord in the segment.

Mode Mode

The mode that best explains the segment.

Confidence double

Coverage improvement over the base mode.

OutOfKeyPitchClassMask int

12-bit pitch-class mask (bit n = pitch class n) of pitch classes used that lie outside the base key. A mask (not an array) keeps this record struct's value equality meaningful.

Properties

Confidence

Coverage improvement over the base mode.

public double Confidence { get; init; }

Property Value

double

EndChordIndex

Index of the last chord in the segment.

public int EndChordIndex { get; init; }

Property Value

int

Mode

The mode that best explains the segment.

public Mode Mode { get; init; }

Property Value

Mode

OutOfKeyPitchClassMask

12-bit pitch-class mask (bit n = pitch class n) of pitch classes used that lie outside the base key. A mask (not an array) keeps this record struct's value equality meaningful.

public int OutOfKeyPitchClassMask { get; init; }

Property Value

int

StartChordIndex

Index of the first chord in the segment.

public int StartChordIndex { get; init; }

Property Value

int