Class

NumCosmoClusterRedshift

Description [src]

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

Abstract class for cluster redshift distributions.

Ancestors

Functions

nc_cluster_redshift_clear

Atomically decrements the reference count of clusterz by one. Set pointer to NULL.

nc_cluster_redshift_id
No description available.

nc_cluster_redshift_log_all_models

This function lists all implemented models of cluster redshift distributions.

Instance methods

nc_cluster_redshift_free

Atomically decrements the reference count of clusterz by one. If the reference count drops to 0, all memory allocated by clusterz is released.

nc_cluster_redshift_intp

It computes the clusterz probability distribution of z lying in the range $[z^{obs}{min}, z^{obs}{max}]$, namely, $$ intp = \int_{z^{obs}{min}}^{z^{obs}{max}} p \, dz^{obs},$$ where $p$ is [nc_cluster_redshift_p()].

nc_cluster_redshift_intp_bin

Computes the integrated probability over the observed redshift bin.

nc_cluster_redshift_n_limits

Computes the redshift limits for the cluster abundance calculation. The function which will call this one is responsible to allocate memory for z_lower and z_upper.

nc_cluster_redshift_p

It computes the probability density function (pdf) of the cluster redshift distribution clusterz given z, lnM and the measured redshit z_obs and its parameter(s) z_obs_params.

nc_cluster_redshift_p_bin_limits

Computes the integration limits for the true redshift given the observed redshift bin boundaries.

nc_cluster_redshift_p_limits

Computes the integration limits for the true redshift given the observed redshift and its parameters.

nc_cluster_redshift_ref

Increases the reference count of clusterz by one.

nc_cluster_redshift_resample

Randomly samples the redshift distribution clusterz given z, lnM and z_obs_params, and assigns the sampled redshift to z_obs.

nc_cluster_redshift_volume

Computes the effective volume in the observable redshift space.

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

Properties inherited from NcmModel (9)
NumCosmoMath.Model:implementation
No description available.
NumCosmoMath.Model:name
No description available.
NumCosmoMath.Model:nick
No description available.
NumCosmoMath.Model:params-types
No description available.
NumCosmoMath.Model:reparam
No description available.
NumCosmoMath.Model:scalar-params-len
No description available.
NumCosmoMath.Model:sparam-array
No description available.
NumCosmoMath.Model:submodel-array
No description available.
NumCosmoMath.Model:vector-params-len
No description available.

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 NumCosmoClusterRedshiftClass {
  gdouble (* P) (
    NcClusterRedshift* clusterz,
    NcHICosmo* cosmo,
    const gdouble lnM,
    const gdouble z,
    const gdouble* z_obs,
    const gdouble* z_obs_params
  );
  gdouble (* intP) (
    NcClusterRedshift* clusterz,
    NcHICosmo* cosmo,
    const gdouble lnM,
    const gdouble z
  );
  gdouble (* intP_bin) (
    NcClusterRedshift* clusterz,
    NcHICosmo* cosmo,
    const gdouble lnM,
    const gdouble z,
    const gdouble* z_obs_lower,
    const gdouble* z_obs_upper,
    const gdouble* z_obs_params
  );
  gboolean (* resample) (
    NcClusterRedshift* clusterz,
    NcHICosmo* cosmo,
    const gdouble lnM,
    const gdouble z,
    gdouble* z_obs,
    const gdouble* z_obs_params,
    NcmRNG* rng
  );
  void (* P_limits) (
    NcClusterRedshift* clusterz,
    NcHICosmo* cosmo,
    const gdouble* z_obs,
    const gdouble* z_obs_params,
    gdouble* z_lower,
    gdouble* z_upper
  );
  void (* P_bin_limits) (
    NcClusterRedshift* clusterz,
    NcHICosmo* cosmo,
    const gdouble* z_obs_lower,
    const gdouble* z_obs_upper,
    const gdouble* z_obs_params,
    gdouble* z_lower,
    gdouble* z_upper
  );
  void (* N_limits) (
    NcClusterRedshift* clusterz,
    NcHICosmo* cosmo,
    gdouble* z_lower,
    gdouble* z_upper
  );
  gdouble (* volume) (
    NcClusterRedshift* clusterz
  );
  
}

No description available.

Class members
P: gdouble (* P) ( NcClusterRedshift* clusterz, NcHICosmo* cosmo, const gdouble lnM, const gdouble z, const gdouble* z_obs, const gdouble* z_obs_params )

No description available.

intP: gdouble (* intP) ( NcClusterRedshift* clusterz, NcHICosmo* cosmo, const gdouble lnM, const gdouble z )

No description available.

intP_bin: gdouble (* intP_bin) ( NcClusterRedshift* clusterz, NcHICosmo* cosmo, const gdouble lnM, const gdouble z, const gdouble* z_obs_lower, const gdouble* z_obs_upper, const gdouble* z_obs_params )

No description available.

resample: gboolean (* resample) ( NcClusterRedshift* clusterz, NcHICosmo* cosmo, const gdouble lnM, const gdouble z, gdouble* z_obs, const gdouble* z_obs_params, NcmRNG* rng )

No description available.

P_limits: void (* P_limits) ( NcClusterRedshift* clusterz, NcHICosmo* cosmo, const gdouble* z_obs, const gdouble* z_obs_params, gdouble* z_lower, gdouble* z_upper )

No description available.

P_bin_limits: void (* P_bin_limits) ( NcClusterRedshift* clusterz, NcHICosmo* cosmo, const gdouble* z_obs_lower, const gdouble* z_obs_upper, const gdouble* z_obs_params, gdouble* z_lower, gdouble* z_upper )

No description available.

N_limits: void (* N_limits) ( NcClusterRedshift* clusterz, NcHICosmo* cosmo, gdouble* z_lower, gdouble* z_upper )

No description available.

volume: gdouble (* volume) ( NcClusterRedshift* clusterz )

No description available.

Virtual methods

NumCosmo.ClusterRedshiftClass.N_limits
No description available.

NumCosmo.ClusterRedshiftClass.P
No description available.

NumCosmo.ClusterRedshiftClass.P_bin_limits
No description available.

NumCosmo.ClusterRedshiftClass.P_limits
No description available.

NumCosmo.ClusterRedshiftClass.intP
No description available.

NumCosmo.ClusterRedshiftClass.intP_bin
No description available.

NumCosmo.ClusterRedshiftClass.resample

Randomly samples the redshift distribution clusterz given z, lnM and z_obs_params, and assigns the sampled redshift to z_obs.

NumCosmo.ClusterRedshiftClass.volume

Computes the effective volume in the observable redshift space.

Class methods

nc_cluster_redshift_class_obs_len

The number of observable redshifts of each cluster, e.g., 1 - only photometric redshift, 1 - only spectroscopic redshift, 2 - both photometric and spectroscopic redshifts.

nc_cluster_redshift_class_obs_params_len

The number of parameters related to the observable redshifts of each cluster, e.g., 1 - measured error of the photometric redshift.