KernelDensityOptions.Automatic Method

Creates options that select a bandwidth from the observations.

Definition

Namespace: Numerics.NET.Statistics.KernelDensityEstimation
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 10.9.0

public static KernelDensityOptions Automatic(
	KernelDensityBandwidthEstimator bandwidthEstimator = KernelDensityBandwidthEstimator.NormalReference,
	Kernel? kernel = null,
	double bandwidthAdjustment = 1
)

Visual Basic

Public Shared Function Automatic ( 
	Optional bandwidthEstimator As KernelDensityBandwidthEstimator = KernelDensityBandwidthEstimator.NormalReference,
	Optional kernel As Kernel = Nothing,
	Optional bandwidthAdjustment As Double = 1
) As KernelDensityOptions

C++/CLI

public:
static KernelDensityOptions^ Automatic(
	KernelDensityBandwidthEstimator bandwidthEstimator = KernelDensityBandwidthEstimator::NormalReference, 
	Kernel^ kernel = nullptr, 
	double bandwidthAdjustment = 1
)

static member Automatic : 
        ?bandwidthEstimator : KernelDensityBandwidthEstimator * 
        ?kernel : Kernel * 
        ?bandwidthAdjustment : float 
(* Defaults:
        let _bandwidthEstimator = defaultArg bandwidthEstimator KernelDensityBandwidthEstimator.NormalReference
        let _kernel = defaultArg kernel null
        let _bandwidthAdjustment = defaultArg bandwidthAdjustment 1
*)
-> KernelDensityOptions

Parameters

bandwidthEstimator KernelDensityBandwidthEstimator (Optional): The selection rule. The default is normal reference.
kernel Kernel (Optional): The kernel, or null to use the Gaussian kernel.
bandwidthAdjustment Double (Optional): A finite positive multiplier for the selected bandwidth. The default is 1.

Return Value

KernelDensityOptions
Immutable automatic bandwidth options.

Remarks

The Gaussian plug-in, Sheather-Jones and cross-validation rules require the built-in Gaussian kernel and use quadratic work per pair-sum evaluation. Default cross-validation bounds are 1/16 to 16 times the normal-reference width. Fit metadata reports resolved bounds and boundary hits. Use CrossValidated(Double, Double, Double) for explicit cross-validation bounds. Sheather-Jones expands its default root bracket when needed; use SheatherJones(Double, Double, Double) to supply a fixed root bracket.

Exceptions

NotSupportedException	An advanced Gaussian selector is requested with another kernel.
ArgumentOutOfRangeException	The rule is not an automatic selection rule, or the adjustment is not finite and positive.