Capability.Analyze Method

Definition

Namespace: Numerics.NET.Statistics.ProcessControl
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 10.4.0

Overload List

Analyze(Matrix<Double>, SpecificationLimits, SigmaEstimator, Double) Performs capability and performance analysis on a subgroup matrix and computes confidence intervals at the requested level.
Analyze(ReadOnlySpan<Double>, SpecificationLimits, SigmaEstimator, Double) Performs capability and performance analysis on a span of individuals observations and computes confidence intervals at the requested level.
Analyze(ReadOnlySpan<Double>, ReadOnlySpan<Int32>, SpecificationLimits, SigmaEstimator) Performs capability and performance analysis on flat observations with integer subgroup IDs.
Analyze(Vector<Double>, IGrouping, SpecificationLimits, SigmaEstimator) Performs capability and performance analysis on grouped observations using a Numerics.NET grouping abstraction.
Analyze(Vector<Double>, SpecificationLimits, SigmaEstimator, Double) Performs capability and performance analysis on an individuals series and computes confidence intervals at the requested level.
Analyze(ReadOnlySpan<Double>, ReadOnlySpan<Int32>, SpecificationLimits, SigmaEstimator, Double) Performs capability and performance analysis on flat observations with integer subgroup IDs and computes confidence intervals at the requested level.
Analyze(Vector<Double>, IGrouping, SpecificationLimits, SigmaEstimator, Double) Performs capability and performance analysis on grouped observations using a Numerics.NET grouping abstraction and computes confidence intervals at the requested level.
Analyze(ControlChart, SpecificationLimits, Nullable<Double>, Nullable<TestOfNormality>, ControlRuleSet, Double) Performs capability and performance analysis from a fitted or deployed variable control chart, using the chart's established baseline parameters.
Analyze(Matrix<Double>, SpecificationLimits, SigmaEstimator, Nullable<TestOfNormality>, ControlRuleSet, Double) Performs capability and performance analysis on a subgroup matrix.
Analyze(ReadOnlySpan<Double>, SpecificationLimits, SigmaEstimator, Nullable<TestOfNormality>, ControlRuleSet, Double) Performs capability and performance analysis on a span of individuals observations.
Analyze(Vector<Double>, SpecificationLimits, SigmaEstimator, Nullable<TestOfNormality>, ControlRuleSet, Double) Performs capability and performance analysis on an individuals series.

Analyze(Matrix<Double>, SpecificationLimits, SigmaEstimator, Double)

Performs capability and performance analysis on a subgroup matrix and computes confidence intervals at the requested level.
C#
public static CapabilityAnalysisResult Analyze(
	Matrix<double> subgroups,
	SpecificationLimits specifications,
	SigmaEstimator withinSigma,
	double confidenceLevel
)

Parameters

subgroups  Matrix<Double>
A matrix whose rows are ordered subgroups and whose columns are measurements within each subgroup.
specifications  SpecificationLimits
The specification limits for the process.
withinSigma  SigmaEstimator
The estimator used to compute within-process sigma.
confidenceLevel  Double
The confidence level for the intervals, expressed as a probability in (0, 1). For example, 0.95 requests 95% confidence intervals.

Return Value

CapabilityAnalysisResult
A CapabilityAnalysisResult with capability and performance metrics and populated confidence intervals.

Exceptions

ArgumentNullExceptionsubgroups or specifications is null.
ArgumentOutOfRangeExceptionconfidenceLevel is not in the open interval (0, 1).
ArgumentException The input is empty, contains non-finite values, or the requested estimator is incompatible with the supplied data shape.

Analyze(ReadOnlySpan<Double>, SpecificationLimits, SigmaEstimator, Double)

Performs capability and performance analysis on a span of individuals observations and computes confidence intervals at the requested level.
C#
public static CapabilityAnalysisResult Analyze(
	ReadOnlySpan<double> observations,
	SpecificationLimits specifications,
	SigmaEstimator withinSigma,
	double confidenceLevel
)

Parameters

observations  ReadOnlySpan<Double>
The ordered sequence of individual observations.
specifications  SpecificationLimits
The specification limits for the process.
withinSigma  SigmaEstimator
The estimator used to compute within-process sigma.
confidenceLevel  Double
The confidence level for the intervals, expressed as a probability in (0, 1). For example, 0.95 requests 95% confidence intervals.

Return Value

CapabilityAnalysisResult
A CapabilityAnalysisResult with capability and performance metrics and populated confidence intervals.

Exceptions

ArgumentNullExceptionspecifications is null.
ArgumentOutOfRangeExceptionconfidenceLevel is not in the open interval (0, 1).
ArgumentException The input is empty, contains non-finite values, or the requested estimator is incompatible with individuals data.

Analyze(ReadOnlySpan<Double>, ReadOnlySpan<Int32>, SpecificationLimits, SigmaEstimator)

Performs capability and performance analysis on flat observations with integer subgroup IDs.
C#
public static CapabilityAnalysisResult Analyze(
	ReadOnlySpan<double> observations,
	ReadOnlySpan<int> subgroupIds,
	SpecificationLimits specifications,
	SigmaEstimator withinSigma = SigmaEstimator.WithinRange
)

Parameters

observations  ReadOnlySpan<Double>
The flat sequence of observations.
subgroupIds  ReadOnlySpan<Int32>
Subgroup identifiers, one per observation. Subgroup order in the result follows first-appearance order.
specifications  SpecificationLimits
The specification limits for the process.
withinSigma  SigmaEstimator  (Optional)
The estimator used to compute within-process sigma. Defaults to WithinRange.

Return Value

CapabilityAnalysisResult
A CapabilityAnalysisResult containing the computed capability and performance metrics.

Exceptions

ArgumentNullExceptionspecifications is null.
ArgumentException The inputs are empty, have mismatched lengths, contain non-finite values, or the requested estimator is incompatible with the supplied data shape.

Analyze(Vector<Double>, IGrouping, SpecificationLimits, SigmaEstimator)

Performs capability and performance analysis on grouped observations using a Numerics.NET grouping abstraction.
C#
public static CapabilityAnalysisResult Analyze(
	Vector<double> observations,
	IGrouping grouping,
	SpecificationLimits specifications,
	SigmaEstimator withinSigma = SigmaEstimator.WithinRange
)

Parameters

observations  Vector<Double>
The observations to analyze.
grouping  IGrouping
The grouping that defines subgroup membership.
specifications  SpecificationLimits
The specification limits for the process.
withinSigma  SigmaEstimator  (Optional)
The estimator used to compute within-process sigma. Defaults to WithinRange.

Return Value

CapabilityAnalysisResult
A CapabilityAnalysisResult containing the computed capability and performance metrics.

Exceptions

ArgumentNullExceptionobservations, grouping, or specifications is null.
ArgumentException The input is empty, contains non-finite values, or the requested estimator is incompatible with the supplied data shape.

Analyze(Vector<Double>, SpecificationLimits, SigmaEstimator, Double)

Performs capability and performance analysis on an individuals series and computes confidence intervals at the requested level.
C#
public static CapabilityAnalysisResult Analyze(
	Vector<double> observations,
	SpecificationLimits specifications,
	SigmaEstimator withinSigma,
	double confidenceLevel
)

Parameters

observations  Vector<Double>
The ordered sequence of individual observations.
specifications  SpecificationLimits
The specification limits for the process.
withinSigma  SigmaEstimator
The estimator used to compute within-process sigma.
confidenceLevel  Double
The confidence level for the intervals, expressed as a probability in (0, 1). For example, 0.95 requests 95% confidence intervals.

Return Value

CapabilityAnalysisResult
A CapabilityAnalysisResult with capability and performance metrics and populated confidence intervals.

Exceptions

ArgumentNullExceptionobservations or specifications is null.
ArgumentOutOfRangeExceptionconfidenceLevel is not in the open interval (0, 1).
ArgumentException The input is empty, contains non-finite values, or the requested estimator is incompatible with individuals data.

Analyze(ReadOnlySpan<Double>, ReadOnlySpan<Int32>, SpecificationLimits, SigmaEstimator, Double)

Performs capability and performance analysis on flat observations with integer subgroup IDs and computes confidence intervals at the requested level.
C#
public static CapabilityAnalysisResult Analyze(
	ReadOnlySpan<double> observations,
	ReadOnlySpan<int> subgroupIds,
	SpecificationLimits specifications,
	SigmaEstimator withinSigma,
	double confidenceLevel
)

Parameters

observations  ReadOnlySpan<Double>
The flat sequence of observations.
subgroupIds  ReadOnlySpan<Int32>
Subgroup identifiers, one per observation. Subgroup order in the result follows first-appearance order.
specifications  SpecificationLimits
The specification limits for the process.
withinSigma  SigmaEstimator
The estimator used to compute within-process sigma.
confidenceLevel  Double
The confidence level for the intervals, expressed as a probability in (0, 1). For example, 0.95 requests 95% confidence intervals.

Return Value

CapabilityAnalysisResult
A CapabilityAnalysisResult with capability and performance metrics and populated confidence intervals.

Exceptions

ArgumentNullExceptionspecifications is null.
ArgumentOutOfRangeExceptionconfidenceLevel is not in the open interval (0, 1).
ArgumentException The inputs are empty, have mismatched lengths, contain non-finite values, or the requested estimator is incompatible with the supplied data shape.

Analyze(Vector<Double>, IGrouping, SpecificationLimits, SigmaEstimator, Double)

Performs capability and performance analysis on grouped observations using a Numerics.NET grouping abstraction and computes confidence intervals at the requested level.
C#
public static CapabilityAnalysisResult Analyze(
	Vector<double> observations,
	IGrouping grouping,
	SpecificationLimits specifications,
	SigmaEstimator withinSigma,
	double confidenceLevel
)

Parameters

observations  Vector<Double>
The observations to analyze.
grouping  IGrouping
The grouping that defines subgroup membership.
specifications  SpecificationLimits
The specification limits for the process.
withinSigma  SigmaEstimator
The estimator used to compute within-process sigma.
confidenceLevel  Double
The confidence level for the intervals, expressed as a probability in (0, 1). For example, 0.95 requests 95% confidence intervals.

Return Value

CapabilityAnalysisResult
A CapabilityAnalysisResult with capability and performance metrics and populated confidence intervals.

Exceptions

ArgumentNullExceptionobservations, grouping, or specifications is null.
ArgumentOutOfRangeExceptionconfidenceLevel is not in the open interval (0, 1).
ArgumentException The input is empty, contains non-finite values, or the requested estimator is incompatible with the supplied data shape.

Analyze(ControlChart, SpecificationLimits, Nullable<Double>, Nullable<TestOfNormality>, ControlRuleSet, Double)

Performs capability and performance analysis from a fitted or deployed variable control chart, using the chart's established baseline parameters.
C#
public static CapabilityAnalysisResult Analyze(
	ControlChart chart,
	SpecificationLimits specifications,
	double? confidenceLevel = null,
	TestOfNormality? normalityTest = null,
	ControlRuleSet? ruleSet = null,
	double significanceLevel = 0.05
)

Parameters

chart  ControlChart
A fitted or deployed variable control chart (IndividualsMovingRangeChartSet, XBarRChartSet, or XBarSChartSet).
specifications  SpecificationLimits
The specification limits for the process.
confidenceLevel  Nullable<Double>  (Optional)
An optional confidence level for computing confidence intervals on the capability indices, expressed as a probability in (0, 1). For example, 0.95 requests 95% confidence intervals. When null, no confidence intervals are computed. Confidence intervals require a Fitted chart (raw data must be available).
normalityTest  Nullable<TestOfNormality>  (Optional)
Optional normality test to include in the assumption diagnostics. Pass null to skip normality testing.
ruleSet  ControlRuleSet  (Optional)
Optional control rule set used to check for out-of-control signals in the assumption diagnostics. Pass null to skip rule evaluation.
significanceLevel  Double  (Optional)
Significance level for the normality test when normalityTest is supplied. Defaults to 0.05.

Return Value

CapabilityAnalysisResult
A CapabilityAnalysisResult containing capability and performance metrics derived from the chart's fitted parameters.

Remarks

The chart's fitted sigma estimate is used as the within-subgroup sigma for capability indices. For an IndividualsMovingRangeChartSet, this is MR̄/d₂. For an XBarRChartSet, this is R̄/d₂. For an XBarSChartSet, this is S̄/c₄.

For a Fitted IndividualsMovingRangeChartSet, the result matches calling Capability.Analyze(observations, specifications, sigmaEstimator) directly with the same data.

For Deployed charts, the chart's stored baseline parameters are used for both within-sigma and overall-sigma. Confidence intervals are not supported in Deployed state.

Exceptions

ArgumentNullExceptionchart or specifications is null.
InvalidOperationException The chart is in the Unfitted state. Analyze() must be called before performing capability analysis. Also thrown when confidenceLevel is non-null but the chart is in the Deployed state.
ArgumentOutOfRangeExceptionconfidenceLevel is not in the open interval (0, 1).
NotSupportedException The chart type does not support normal-distribution capability analysis. Attribute charts (PChart, NpChart, CChart, UChart) and time-weighted charts (EwmaChart, CusumChart) are not supported.

Analyze(Matrix<Double>, SpecificationLimits, SigmaEstimator, Nullable<TestOfNormality>, ControlRuleSet, Double)

Performs capability and performance analysis on a subgroup matrix.
C#
public static CapabilityAnalysisResult Analyze(
	Matrix<double> subgroups,
	SpecificationLimits specifications,
	SigmaEstimator withinSigma = SigmaEstimator.WithinRange,
	TestOfNormality? normalityTest = null,
	ControlRuleSet? ruleSet = null,
	double significanceLevel = 0.05
)

Parameters

subgroups  Matrix<Double>
A matrix whose rows are ordered subgroups and whose columns are measurements within each subgroup.
specifications  SpecificationLimits
The specification limits for the process.
withinSigma  SigmaEstimator  (Optional)
The estimator used to compute within-process sigma. Defaults to WithinRange.
normalityTest  Nullable<TestOfNormality>  (Optional)
Optional normality test to include in the assumption diagnostics. Pass null to skip normality testing.
ruleSet  ControlRuleSet  (Optional)
Optional control rule set used to check for out-of-control signals in the assumption diagnostics. Pass null to skip rule evaluation.
significanceLevel  Double  (Optional)
Significance level for the normality test when normalityTest is supplied. Defaults to 0.05.

Return Value

CapabilityAnalysisResult
A CapabilityAnalysisResult containing the computed capability and performance metrics.

Exceptions

ArgumentNullExceptionsubgroups or specifications is null.
ArgumentException The input is empty, contains non-finite values, or the requested estimator is incompatible with the supplied data shape.

Analyze(ReadOnlySpan<Double>, SpecificationLimits, SigmaEstimator, Nullable<TestOfNormality>, ControlRuleSet, Double)

Performs capability and performance analysis on a span of individuals observations.
C#
public static CapabilityAnalysisResult Analyze(
	ReadOnlySpan<double> observations,
	SpecificationLimits specifications,
	SigmaEstimator withinSigma = SigmaEstimator.MovingRange,
	TestOfNormality? normalityTest = null,
	ControlRuleSet? ruleSet = null,
	double significanceLevel = 0.05
)

Parameters

observations  ReadOnlySpan<Double>
The ordered sequence of individual observations.
specifications  SpecificationLimits
The specification limits for the process.
withinSigma  SigmaEstimator  (Optional)
The estimator used to compute within-process sigma. Defaults to MovingRange.
normalityTest  Nullable<TestOfNormality>  (Optional)
Optional normality test to include in the assumption diagnostics. Pass null to skip normality testing.
ruleSet  ControlRuleSet  (Optional)
Optional control rule set used to check for out-of-control signals in the assumption diagnostics. Pass null to skip rule evaluation.
significanceLevel  Double  (Optional)
Significance level for the normality test when normalityTest is supplied. Defaults to 0.05.

Return Value

CapabilityAnalysisResult
A CapabilityAnalysisResult containing the computed capability and performance metrics.

Exceptions

ArgumentNullExceptionspecifications is null.
ArgumentException The input is empty, contains non-finite values, or the requested estimator is incompatible with individuals data.

Analyze(Vector<Double>, SpecificationLimits, SigmaEstimator, Nullable<TestOfNormality>, ControlRuleSet, Double)

Performs capability and performance analysis on an individuals series.
C#
public static CapabilityAnalysisResult Analyze(
	Vector<double> observations,
	SpecificationLimits specifications,
	SigmaEstimator withinSigma = SigmaEstimator.MovingRange,
	TestOfNormality? normalityTest = null,
	ControlRuleSet? ruleSet = null,
	double significanceLevel = 0.05
)

Parameters

observations  Vector<Double>
The ordered sequence of individual observations.
specifications  SpecificationLimits
The specification limits for the process.
withinSigma  SigmaEstimator  (Optional)
The estimator used to compute within-process sigma. Defaults to MovingRange.
normalityTest  Nullable<TestOfNormality>  (Optional)
Optional normality test to include in the assumption diagnostics. Pass null to skip normality testing.
ruleSet  ControlRuleSet  (Optional)
Optional control rule set used to check for out-of-control signals in the assumption diagnostics. Pass null to skip rule evaluation.
significanceLevel  Double  (Optional)
Significance level for the normality test when normalityTest is supplied. Defaults to 0.05.

Return Value

CapabilityAnalysisResult
A CapabilityAnalysisResult containing the computed capability and performance metrics.

Exceptions

ArgumentNullExceptionobservations or specifications is null.
ArgumentException The input is empty, contains non-finite values, or the requested estimator is incompatible with individuals data.

See Also