NcmMSetTransKernCat

NcmMSetTransKernCat — Catalog sampler

Functions

NcmMSetTransKernCat * ncm_mset_trans_kern_cat_new ()
void ncm_mset_trans_kern_cat_set_sampling ()
NcmMSetTransKernCatSampling ncm_mset_trans_kern_cat_get_sampling ()
void ncm_mset_trans_kern_cat_reset ()

Properties

NcmMSetCatalog * catalog Read / Write / Construct Only
gboolean choose-cut Read / Write / Construct
double choose-percentile Read / Write / Construct
double m2lnL-reltol Read / Write / Construct
NcmMSetTransKernCatSampling sampling-type Read / Write / Construct
NcmStatsDist * stats-dist Read / Write / Construct Only

Types and Values

#define NCM_TYPE_MSET_TRANS_KERN_CAT
enum NcmMSetTransKernCatSampling
  NcmMSetTransKernCat

Object Hierarchy

    GEnum
    ╰── NcmMSetTransKernCatSampling
    GObject
    ╰── NcmMSetTransKern
        ╰── NcmMSetTransKernCat

Description

This object subclasses NcmMSetTransKern and implements a catalog sampler.

Implementation of a catalog sampler class, capable of drawing samples from a catalog of points. Users can select the desired sampling method as described in NcmMSetTransKernCatSampling.

**Key Functionality:**

This class is designed for scenarios where sampling from a pre-existing catalog is useful, providing flexibility through the selection of various sampling methods described in NcmMSetTransKernCatSampling.

Functions

ncm_mset_trans_kern_cat_new ()

NcmMSetTransKernCat *
ncm_mset_trans_kern_cat_new (NcmMSetCatalog *mcat,
                             NcmStatsDist *sd);

New NcmMSetTransKernCat from mcat catalog with the interpolation object sd .

Parameters

mcat

a NcmMSetCatalog

  

sd

a NcmStatsDist.

[allow-none]

Returns

a new NcmMSetTransKernCat.

[transfer full]

ncm_mset_trans_kern_cat_set_sampling ()

void
ncm_mset_trans_kern_cat_set_sampling (NcmMSetTransKernCat *tcat,
                                      NcmMSetTransKernCatSampling sampling);

Sets the sampling type to sampling .

Parameters

tcat

a NcmMSetTransKernCat

  

sampling

a NcmMSetTransKernCatSampling

  

ncm_mset_trans_kern_cat_get_sampling ()

NcmMSetTransKernCatSampling
ncm_mset_trans_kern_cat_get_sampling (NcmMSetTransKernCat *tcat);

Gets the sampling type.

Parameters

tcat

a NcmMSetTransKernCat

  

Returns

the current sampling type NcmMSetTransKernCat.

ncm_mset_trans_kern_cat_reset ()

void
ncm_mset_trans_kern_cat_reset (NcmMSetTransKernCat *tcat);

Types and Values

NCM_TYPE_MSET_TRANS_KERN_CAT

#define NCM_TYPE_MSET_TRANS_KERN_CAT (ncm_mset_trans_kern_cat_get_type ())

enum NcmMSetTransKernCatSampling

Sampling methods.

Members

NCM_MSET_TRANS_KERN_CAT_SAMPLING_CHOOSE

sampling by choosing radomly points from the catalog

  

NCM_MSET_TRANS_KERN_CAT_SAMPLING_RBF_INTERP

sampling from the RBF interpolation built using the last ensemble from the catalog

  

NCM_MSET_TRANS_KERN_CAT_SAMPLING_KDE

sampling from the KDE estimate built using the last ensemble from the catalog

  

NcmMSetTransKernCat

typedef struct _NcmMSetTransKernCat NcmMSetTransKernCat;

Property Details

The “catalog” property

  “catalog”                  NcmMSetCatalog *

catalog.

Owner: NcmMSetTransKernCat

Flags: Read / Write / Construct Only

The “choose-cut” property

  “choose-cut”               gboolean

Whether to cut the catalog at the choose-percentile before choosing.

Owner: NcmMSetTransKernCat

Flags: Read / Write / Construct

Default value: FALSE

The “choose-percentile” property

  “choose-percentile”        double

Max percentile to choose from.

Owner: NcmMSetTransKernCat

Flags: Read / Write / Construct

Allowed values: [0.01,1]

Default value: 0.9

The “m2lnL-reltol” property

  “m2lnL-reltol”             double

Relative tolerance for m2lnL.

Owner: NcmMSetTransKernCat

Flags: Read / Write / Construct

Allowed values: [2.22045e-16,0.001]

Default value: 1e-07

The “sampling-type” property

  “sampling-type”            NcmMSetTransKernCatSampling

Sampling method to use.

Owner: NcmMSetTransKernCat

Flags: Read / Write / Construct

Default value: NCM_MSET_TRANS_KERN_CAT_SAMPLING_RBF_INTERP

The “stats-dist” property

  “stats-dist”               NcmStatsDist *

NcmStatsDist object.

Owner: NcmMSetTransKernCat

Flags: Read / Write / Construct Only

Generated by GTK-Doc V1.33.1