Class

NumCosmoGalaxyHOD

Description [src]

abstract class NumCosmo.GalaxyHOD : NumCosmoMath.Model
{
  /* No available fields */
}

Abstract halo occupation distribution.

Base class for halo occupation distribution (HOD) models, describing how many central and satellite galaxies populate a halo of a given mass. Concrete subclasses provide the mean central and satellite occupations as functions of the halo mass (nc_galaxy_hod_mean_n_central() and nc_galaxy_hod_mean_n_satellite()); this base class turns those means into an integer realization in nc_galaxy_hod_gen().

The central galaxy is drawn as a Bernoulli trial with probability equal to the mean central occupation (clamped to [0, 1]) when NcGalaxyHOD:stochastic-central is TRUE, or placed deterministically when the mean is at least one half otherwise. Satellites are drawn from a Poisson distribution and only when a central is present.

As an NcmModel its occupation parameters live in the model parameter vector and can be fit; it is meant to be composed by the mock member generators.

Ancestors

Descendants

NcGalaxyHODZheng07

Functions

nc_galaxy_hod_clear

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

nc_galaxy_hod_id

No description available.

Instance methods

nc_galaxy_hod_free

Decreases the reference count of hod by one.

nc_galaxy_hod_gen

Draws an integer realization of the central and satellite occupations of a halo of mass $e^{\ln M}$. Satellites are drawn only when a central is present.

nc_galaxy_hod_get_stochastic_central

Gets whether the central galaxy is drawn stochastically.

nc_galaxy_hod_mean_n_central

Computes the mean central galaxy occupation of a halo of mass $e^{\ln M}$.

nc_galaxy_hod_mean_n_satellite

Computes the mean satellite galaxy occupation of a halo of mass $e^{\ln M}$.

nc_galaxy_hod_ref

Increases the reference count of hod by one.

nc_galaxy_hod_set_stochastic_central

Sets whether the central galaxy is drawn stochastically.

Methods inherited from NcmModel (89)

Please see NcmModel for a full list of methods.

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Properties

NumCosmo.GalaxyHOD:stochastic-central

Whether the central galaxy is a Bernoulli draw with probability equal to the mean central occupation (TRUE) or placed deterministically when the mean is at least one half (FALSE).

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 NumCosmoGalaxyHODClass {
  gdouble (* mean_n_central) (
    NcGalaxyHOD* hod,
    const gdouble lnM
  );
  gdouble (* mean_n_satellite) (
    NcGalaxyHOD* hod,
    const gdouble lnM
  );
  
}

No description available.

Class members

mean_n_central: gdouble (* mean_n_central) ( NcGalaxyHOD* hod, const gdouble lnM ): No description available.
mean_n_satellite: gdouble (* mean_n_satellite) ( NcGalaxyHOD* hod, const gdouble lnM ): No description available.

Virtual methods

NumCosmo.GalaxyHODClass.mean_n_central