NcClusterRedshift: NumCosmo Reference Manual

NcClusterRedshift

NcClusterRedshift — Abstract class for cluster redshift distributions.

Functions

guint	nc_cluster_redshift_class_obs_len ()
guint	nc_cluster_redshift_class_obs_params_len ()
NcClusterRedshift *	nc_cluster_redshift_ref ()
void	nc_cluster_redshift_free ()
void	nc_cluster_redshift_clear ()
gdouble	nc_cluster_redshift_p ()
gdouble	nc_cluster_redshift_intp ()
gdouble	nc_cluster_redshift_intp_bin ()
gboolean	nc_cluster_redshift_resample ()
void	nc_cluster_redshift_p_limits ()
void	nc_cluster_redshift_p_bin_limits ()
void	nc_cluster_redshift_n_limits ()
gdouble	nc_cluster_redshift_volume ()
void	nc_cluster_redshift_log_all_models ()

Types and Values

enum	NcClusterRedshiftImpl
#define	NC_CLUSTER_REDSHIFT_IMPL_ALL

Object Hierarchy

    GEnum
    ╰── NcClusterRedshiftImpl
    GObject
    ╰── NcmModel
        ╰── NcClusterRedshift
            ├── NcClusterPhotozGauss
            ├── NcClusterPhotozGaussGlobal
            ╰── NcClusterRedshiftNodist

Description

FIXME

Functions

nc_cluster_redshift_class_obs_len ()

guint
nc_cluster_redshift_class_obs_len (NcClusterRedshiftClass *clusterz_class);

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

Parameters

clusterz_class

a NcClusterRedshiftClass

Returns

The number of observable redshifts.

nc_cluster_redshift_class_obs_params_len ()

guint
nc_cluster_redshift_class_obs_params_len
                               (NcClusterRedshiftClass *clusterz_class);

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

Parameters

clusterz_class

a NcClusterRedshiftClass

Returns

The number of parameters related to the observable redshifts.

nc_cluster_redshift_ref ()

NcClusterRedshift *
nc_cluster_redshift_ref (NcClusterRedshift *clusterz);

Increases the reference count of clusterz by one.

Parameters

clusterz

a NcClusterRedshift

Returns

clusterz .

[transfer full]

nc_cluster_redshift_free ()

void
nc_cluster_redshift_free (NcClusterRedshift *clusterz);

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

Parameters

clusterz

a NcClusterRedshift

nc_cluster_redshift_clear ()

void
nc_cluster_redshift_clear (NcClusterRedshift **clusterz);

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

Parameters

clusterz

a NcClusterRedshift

nc_cluster_redshift_p ()

gdouble
nc_cluster_redshift_p (NcClusterRedshift *clusterz,
                       NcHICosmo *cosmo,
                       const gdouble lnM,
                       const gdouble z,
                       const gdouble *z_obs,
                       const gdouble *z_obs_params);

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 .

Parameters

clusterz	a NcClusterRedshift
cosmo	a NcHICosmo
z	true redshift
lnM	true mass
z_obs	measured redshift.	[array][element-type gdouble]
z_obs_params	measured redshift params.	[array][element-type gdouble]

Returns

The pdf of clusterz .

nc_cluster_redshift_intp ()

gdouble
nc_cluster_redshift_intp (NcClusterRedshift *clusterz,
                          NcHICosmo *cosmo,
                          const gdouble lnM,
                          const gdouble z);

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()].

Parameters

clusterz	a NcClusterRedshift
cosmo	a NcHICosmo
z	true redshift
lnM	true mass

Returns

The probability distribution of z lying within $[z^{obs}_{min}, z^{obs}_{max}]$.

nc_cluster_redshift_intp_bin ()

gdouble
nc_cluster_redshift_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);

FIXME

Parameters

clusterz	a NcClusterRedshift
cosmo	a NcHICosmo
z	true redshift
lnM	true mass
z_obs_lower	FIXME.	[array][element-type gdouble]
z_obs_upper	FIXME.	[array][element-type gdouble]
z_obs_params	FIXME.	[array][element-type gdouble][allow-none]

Returns

FIXME

nc_cluster_redshift_resample ()

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

FIXME

Parameters

clusterz	a NcClusterRedshift
cosmo	a NcHICosmo
z	true redshift
lnM	true mass
z_obs	observed redshift.	[out]
z_obs_params	observed redshift params.	[out]
rng	a NcmRNG

Returns

FIXME

nc_cluster_redshift_p_limits ()

void
nc_cluster_redshift_p_limits (NcClusterRedshift *clusterz,
                              NcHICosmo *cosmo,
                              const gdouble *z_obs,
                              const gdouble *z_obs_params,
                              gdouble *z_lower,
                              gdouble *z_upper);

FIXME

Parameters

clusterz	a NcClusterRedshift
cosmo	a NcHICosmo
z_obs	observed redshift.	[array][element-type gdouble]
z_obs_params	observed redshift params.	[array][element-type gdouble]
z_lower	pointer to the lower limit of the true redshift integration.	[out]
z_upper	pointer to the upper limit of the true redshift integration.	[out]

nc_cluster_redshift_p_bin_limits ()

void
nc_cluster_redshift_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);

FIXME

Parameters

clusterz	a NcClusterRedshift
cosmo	a NcHICosmo
z_obs_lower	observed redshift.	[array][element-type gdouble]
z_obs_upper	observed redshift.	[array][element-type gdouble]
z_obs_params	observed redshift params.	[array][element-type gdouble]
z_lower	pointer to the lower limit of the true redshift integration.	[out]
z_upper	pointer to the upper limit of the true redshift integration.	[out]

nc_cluster_redshift_n_limits ()

void
nc_cluster_redshift_n_limits (NcClusterRedshift *clusterz,
                              NcHICosmo *cosmo,
                              gdouble *z_lower,
                              gdouble *z_upper);

FIXME The function which will call this one is responsible to allocate memory for z_lower and z_upper .

Parameters

clusterz	a NcClusterRedshift
cosmo	a NcHICosmo
z_lower	pointer to the lower limit of the true redshift.	[out]
z_upper	pointer to the upper limit of the true redshift.	[out]

nc_cluster_redshift_volume ()

gdouble
nc_cluster_redshift_volume (NcClusterRedshift *clusterz);

FIXME

Parameters

clusterz

a NcClusterRedshift

Returns

FIXME

nc_cluster_redshift_log_all_models ()

void
nc_cluster_redshift_log_all_models (void);

This function lists all implemented models of cluster redshift distributions.

Types and Values

enum NcClusterRedshiftImpl

Members

NC_CLUSTER_REDSHIFT_P	probability density function of the true-measured cluster redshifts
NC_CLUSTER_REDSHIFT_INTP	probability distribution (integration over the measured redshift)
NC_CLUSTER_REDSHIFT_RESAMPLE	resample function to generate the cluster redshifts following the underlying cluster redshift distribution.
NC_CLUSTER_REDSHIFT_P_LIMITS	function to set the lower and upper limits of the to compute the integral of the cluster redshift distribution.
NC_CLUSTER_REDSHIFT_N_LIMTS	function to set the lower and upper thresholds of the observable cluster redshift to compute the normalization of the cluster redshift distribution.

NC_CLUSTER_REDSHIFT_IMPL_ALL

#define NC_CLUSTER_REDSHIFT_IMPL_ALL NCM_MODEL_CLASS_IMPL_ALL