Class PELTPenaltySelectionResult

Namespace

SignalSharp.Detection.PELT

Assembly

SignalSharp.dll

Represents the result of an automatic penalty selection process for PELT.

public record PELTPenaltySelectionResult : IEquatable<PELTPenaltySelectionResult>

Inheritance

object

PELTPenaltySelectionResult

Implements

IEquatable<PELTPenaltySelectionResult>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Diagnostics

Optional diagnostic information about the selection process. Contains tuples of (Tested Penalty, Calculated Score, Number of Change Points). The interpretation of 'Score' depends on the SelectionMethod (e.g., BIC value, AIC value). May be null if diagnostics were not generated or requested.

public IReadOnlyList<(double Penalty, double Score, int ChangePoints)>? Diagnostics { get; init; }

Property Value

IReadOnlyList<(double Penalty, double Score, int ChangePoints)>

OptimalBreakpoints

The optimal change points detected using the SelectedPenalty.

public required int[] OptimalBreakpoints { get; init; }

Property Value

int[]

SelectedPenalty

The penalty value selected by the chosen method.

public required double SelectedPenalty { get; init; }

Property Value

double

SelectionMethod

The method used to select the penalty.

public required PELTPenaltySelectionMethod SelectionMethod { get; init; }

Property Value

PELTPenaltySelectionMethod