KernelParams¶
ferreus_bbfmm.KernelParams(kernel_type, spheroidal_order, base_range, total_sill)
¶
Defines the KernelType to use, along with parameter values for Spheroidal kernels.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
kernel_type
|
FmmKernelType
|
FmmKernelType enum variant to use. |
required |
spheroidal_order
|
Optional[SpheroidalOrder]
|
SpheroidalOrder enum variant to use. Only applicable when using the spheroidal kernel. If spheroidal kernel is used and an order isn't provided then the default is SpheroidalOrder.Three. |
required |
base_range
|
Optional[float]
|
Controls how quickly the interpolant decays with distance from each point. Smaller values restrict influence to a local neighborhood, while larger values produce smoother, broader effects. Typically chosen based on the spacing of your data. Only used in spheroidal kernels. |
required |
total_sill
|
Optional[float]
|
Sets the overall strength of influence each point exerts. Higher values give points more weight and stronger local effects. Lower values yield smoother, less pronounced variation. Works in combination with base_range and the kernel degree. Only used in spheroidal kernels. |
required |