Class

NumCosmoHaloCatalogMemberGenerator

Description [src]

final class NumCosmo.HaloCatalogMemberGenerator : GObject.Object
{
  /* No available fields */
}

Populates a host NcHaloCatalog with member galaxies through a NcGalaxyHOD.

A standalone, reusable object that consumes an existing host catalog (halos or clusters) and, for each host, draws its central and satellite galaxies from a halo occupation distribution. The members are placed in 3D within the host and projected back to sky coordinates and redshift, and returned as a linked NcHaloCatalog of kind NC_HALO_CATALOG_KIND_MEMBER.

The host catalog must provide the columns produced by NcHaloCatalogGenerator with positions and radius enabled:

  • ra, dec: host sky position (degrees);
  • z_true: host redshift;
  • lnM_true: host natural-log mass (fed to the HOD);
  • r_Delta: host spherical-overdensity radius (Mpc).

For each host the central galaxy sits at the host position; satellites are placed uniformly in volume within r_Delta ($R = r_\Delta\,U^{1/3}$), isotropically in direction ($\cos\theta$ uniform, $\phi$ uniform). The displacement is decomposed about the line of sight: the radial part $R\cos\theta$ becomes a Hubble-flow redshift offset $\delta z = H(z)\, R\cos\theta / c$, and the transverse part $R\sin\theta$ becomes an angular separation $R\sin\theta / d_A(z)$ applied to the host position with the spherical law of cosines. (Two inconsistencies of the reference Python prototype are not reproduced: it used $c$ in m/s while $H$ is in km/s/Mpc, and it used the full $R$ instead of $R\sin\theta$ for the transverse separation; here $c$ is in km/s and the projection uses $R\sin\theta$.)

The generated member catalog has columns galaxy_id (id), parent_id (linking back to the host id, or the host row index when the host has no id column), is_central, ra, dec and z.

Ancestors

Constructors

nc_halo_catalog_member_generator_new

Creates a new NcHaloCatalogMemberGenerator drawing members through hod.

Functions

nc_halo_catalog_member_generator_clear

If memgen is different from NULL, decreases its reference count and sets memgen to NULL.

Instance methods

nc_halo_catalog_member_generator_free

Decreases the reference count of memgen by one.

nc_halo_catalog_member_generator_generate

Draws member galaxies for every object in host through the HOD and places them in 3D, returning them as a NcHaloCatalog of kind NC_HALO_CATALOG_KIND_MEMBER. See the class description for the host schema and the column layout of the result.

nc_halo_catalog_member_generator_peek_distance

Gets the distance object used by memgen, or NULL when none is set.

nc_halo_catalog_member_generator_peek_hod

Gets the halo occupation distribution used by memgen.

nc_halo_catalog_member_generator_ref

Increases the reference count of memgen by one.

nc_halo_catalog_member_generator_set_distance

Sets the distance object used to compute angular-diameter distances.

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Properties

NumCosmo.HaloCatalogMemberGenerator:distance

Optional NcDistance used to convert the transverse member displacement into an angular separation. When unset, a temporary one covering the host redshift range is built for each generation.

NumCosmo.HaloCatalogMemberGenerator:hod

The halo occupation distribution used to draw the member galaxies.

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.

Class structure

struct NumCosmoHaloCatalogMemberGeneratorClass {
  GObjectClass parent_class;
  
}

No description available.

Class members
parent_class: GObjectClass

No description available.