Class
NumCosmoMathStatsDistVKDE
Description [src]
class NumCosmoMath.StatsDistVKDE : NumCosmoMath.StatsDistKDE
{
/* No available fields */
}
Base class for implementing N-dimensional probability distributions with a variable density estimator kernel.
Abstract object to reconstruct an arbitrary N-dimensional probability distribution.
This object provides the complementary tools to perform a radial basis interpolation
in a multidimensional function using the NcmStatsDist class.
This object sets the kernel $\phi$ to be used in the radial basis interpolation. This
object also implements some calculations needed in the NcmStatsDist class, such as
the covariance matrices of the whole sample points and its Cholesky decompositions,
the preparation of the interpolation matrix $IM$, the kernel normalization factors,
and given a sample vector $\vec{x}$, the distribution evaluated in these points. Some
of these calculations are explained below.
The NcmStatsDistVKDE uses a different covariance matrix for each sample point. This
feature is computed in the ncm_stats_dist_prepare_kernel() function. In this
algorithm, one should define the local_frac parameter, that is, the fraction of
nearest sample points that will be used to compute each covariance matrix of each
sample point. This is done by calling the function
ncm_stats_dist_vkde_set_local_frac(). The rest of the calculation follows the same
procedure as the NcmStatsDist and NcmStatsDistKDE objects, using now a different
covariance matrix and normalization factor for each kernel. For more information
about how the NcmStatsDist class works, check NcmStatsDist and NcmStatsDistKDE
objects.
The user must provide input the values: sdk, CV_type - ncm_stats_dist_vkde_new(),
y - ncm_stats_dist_add_obs(), split_frac - ncm_stats_dist_set_split_frac(),
over_smooth - ncm_stats_dist_set_over_smooth(), local_Frac -
ncm_stats_dist_vkde_set_local_frac(), $v(x)$ - ncm_stats_dist_prepare_interp(). To
see an example of how to use this object and the main functions that are called
within each function, check the flowchart at the end of this documentation, where the
order of the functions that should be called by the user and some of the functions
that the algorithm calls.
.
Constructors
ncm_stats_dist_vkde_new
Creates a new NcmStatsDistVKDE object using sdk as
kernel and CV_type as cross-validation method.
Functions
ncm_stats_dist_vkde_clear
Decreases the reference count of sdvkde and sets the pointer sdvkde to NULL.
Instance methods
ncm_stats_dist_vkde_set_local_frac
Sets local kernel fraction to local_frac. This fraction
defines the amount of closest points from each sample point
that will be used to compute the covariance matrix of each point.
Methods inherited from NcmStatsDistKDE (8)
ncm_stats_dist_kde_free
Decreases the reference count of sdkde.
ncm_stats_dist_kde_get_cov_type
ncm_stats_dist_kde_get_nearPD_maxiter
ncm_stats_dist_kde_peek_cov_fixed
Gets the currently used fixed covariance matrix.
ncm_stats_dist_kde_ref
Increases the reference count of sdkde.
ncm_stats_dist_kde_set_cov_fixed
Sets the covariance matrix to be used when NcmStatsDistKDECovType is
set to #NCM_STATS_DIST_KDE_COV_TYPE_FIXED. A copy of the matrix
cov_fixed is made and saved into the object.
ncm_stats_dist_kde_set_cov_type
Sets the covariance type to use in kernel interpolation.
ncm_stats_dist_kde_set_nearPD_maxiter
Sets the maximum number of iterations when finding the
nearest positive definite covariance matrix to maxiter. This function is implemented
as a property and is called in the _cholesky_decomp and in the ncm_stats_dist_kde_prepare_kernel function.
Methods inherited from NcmStatsDist (38)
Please see NcmStatsDist for a full list of methods.
Properties
Properties inherited from NcmStatsDistKDE (3)
NumCosmoMath.StatsDistKDE:cov-fixed
NumCosmoMath.StatsDistKDE:cov-type
NumCosmoMath.StatsDistKDE:nearPD-maxiter
Properties inherited from NcmStatsDist (8)
NumCosmoMath.StatsDist:CV-type
NumCosmoMath.StatsDist:N
NumCosmoMath.StatsDist:kernel
NumCosmoMath.StatsDist:over-smooth
NumCosmoMath.StatsDist:print-fit
NumCosmoMath.StatsDist:shrink
NumCosmoMath.StatsDist:split-frac
NumCosmoMath.StatsDist:use-threads
Signals
Signals inherited from GObject (1)
GObject::notify
The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.