Class
NumCosmoHaloCatalogGenerator
Description [src]
final class NumCosmo.HaloCatalogGenerator : GObject.Object
{
/* No available fields */
}
Samples a NcHaloCatalog from a cluster abundance model.
A reusable object that draws a Poisson realization of the cluster number
counts from a NcClusterAbundance and, for each drawn object, samples the
observed redshift and mass through the NcClusterRedshift and NcClusterMass
models found in the NcmMSet. The result is returned as a NcHaloCatalog of
kind NC_HALO_CATALOG_KIND_CLUSTER.
It assembles the existing sampling machinery rather than reimplementing it,
and is meant to be reused by the likelihood data objects (for example
NcDataClusterNCount) and by higher-level mock generators. Richer mocks
(sky positions, member galaxies) are expected to be built by composition,
holding extra collaborators that augment the generated catalog.
The generated catalog columns are, in order:
z_true,lnM_true: the true redshift and mass;z_obs_0..z_obs_{n-1}: the observed redshift block (n= redshift observable length);lnM_obs_0..lnM_obs_{m-1}: the observed mass block;z_obs_param_0.. andlnM_obs_param_0.. : the observable parameter blocks, when the models declare any;ra,dec: sky position (degrees), only when aNcmSkyFootprintis set (see nc_halo_catalog_generator_set_footprint());r_Delta: the spherical-overdensity radius (Mpc) of the true halo, only when radius output is enabled (see nc_halo_catalog_generator_set_with_radius()). It is computed from $M_\Delta = \frac{4\pi}{3}\,\Delta\,\rho_\mathrm{bg}\, r_\Delta^3$ using the mass definition ($\Delta$ and background density) carried by the multiplicity function used to draw the counts.
Constructors
nc_halo_catalog_generator_new
Creates a new NcHaloCatalogGenerator using cad to draw the number counts.
Functions
nc_halo_catalog_generator_clear
If gen is different from NULL, decreases its reference count and sets
gen to NULL.
Instance methods
nc_halo_catalog_generator_generate
Draws a Poisson realization of the cluster number counts and samples the
observed redshift and mass of each object, returning them as a
NcHaloCatalog of kind NC_HALO_CATALOG_KIND_CLUSTER. See the class
description for the column layout.
nc_halo_catalog_generator_get_with_radius
Gets whether the generated catalog includes the r_Delta radius column.
nc_halo_catalog_generator_peek_footprint
Gets the sky footprint used to sample positions, or NULL when none is set.
nc_halo_catalog_generator_set_footprint
Sets the sky footprint used to sample positions. When a footprint is set, the
generated catalog gains ra and dec columns; when NULL, no positions are generated.
nc_halo_catalog_generator_set_with_radius
Sets whether the generated catalog gains an r_Delta column with the
spherical-overdensity radius (Mpc) of each true halo.
Properties
NumCosmo.HaloCatalogGenerator:footprint
Optional sky footprint. When set, the generated catalog gains ra and dec
columns sampled over the footprint; when unset, no positions are generated.
NumCosmo.HaloCatalogGenerator:with-radius
Whether to append an r_Delta column with the spherical-overdensity radius
(Mpc) of each true halo, computed from the mass definition carried by the
multiplicity function. Disabled by default.
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.