NcClusterAbundance: NumCosmo Reference Manual

NcClusterAbundance

NcClusterAbundance — Cluster abundance distribution

Functions

gdouble	(*NcClusterAbundanceN) ()
gdouble	(*NcClusterAbundanceIntPd2N) ()
gdouble	(*NcClusterAbundanceIntPd2NBias) ()
#define	nc_cluster_abundance_d2NdzdlnM_val()
#define	nc_cluster_abundance_dNdz_val()
#define	nc_cluster_abundance_dNdlnM_val()
#define	nc_cluster_abundance_N_val()
NcClusterAbundance *	nc_cluster_abundance_new ()
NcClusterAbundance *	nc_cluster_abundance_nodist_new ()
NcClusterAbundance *	nc_cluster_abundance_ref ()
void	nc_cluster_abundance_free ()
void	nc_cluster_abundance_clear ()
void	nc_cluster_abundance_prepare ()
void	nc_cluster_abundance_prepare_if_needed ()
void	nc_cluster_abundance_set_area ()
void	nc_cluster_abundance_prepare_inv_dNdz ()
void	nc_cluster_abundance_prepare_inv_dNdlnM_z ()
gdouble	nc_cluster_abundance_z_p_lnM_p_d2n ()
gdouble	nc_cluster_abundance_z_p_d2n ()
gdouble	nc_cluster_abundance_lnM_p_d2n ()
gdouble	nc_cluster_abundance_d2n ()
gdouble	nc_cluster_abundance_true_n ()
gdouble	nc_cluster_abundance_n ()
gdouble	nc_cluster_abundance_intp_d2n ()
gdouble	nc_cluster_abundance_intp_bin_d2n ()
void	nc_bias_mean_prepare ()
gdouble	nc_bias_mean_val ()
gdouble	nc_ca_mean_bias_numerator ()
gdouble	nc_ca_mean_bias_denominator ()
gdouble	nc_ca_mean_bias ()
gdouble	nc_ca_mean_bias_Mobs_numerator ()
gdouble	nc_ca_mean_bias_Mobs_denominator ()
gdouble	nc_cluster_abundance_intp_d2n_bias ()
gdouble	nc_cluster_abundance_intp_bin_d2n_bias ()
gdouble	nc_cluster_abundance_mean_bias ()

Properties

NcHaloMassFunction *	halo-mass-function	Read / Write / Construct Only
NcHaloBias *	mean-bias	Read / Write / Construct Only

Types and Values

typedef	NcClusterAbundanceDataBinZ
	NcClusterAbundanceDataBin
	NcClusterAbundanceDataBinM
	NcClusterAbundanceDataP

Object Hierarchy

    GObject
    ╰── NcClusterAbundance

Description

FIXME

Functions

NcClusterAbundanceN ()

gdouble
(*NcClusterAbundanceN) (NcClusterAbundance *cad,
                        NcHICosmo *cosmo,
                        NcClusterRedshift *clusterz,
                        NcClusterMass *clusterm);

NcClusterAbundanceIntPd2N ()

gdouble
(*NcClusterAbundanceIntPd2N) (NcClusterAbundance *cad,
                              NcHICosmo *cosmo,
                              NcClusterRedshift *clusterz,
                              NcClusterMass *clusterm,
                              gdouble lnM,
                              gdouble z);

NcClusterAbundanceIntPd2NBias ()

gdouble
(*NcClusterAbundanceIntPd2NBias) (NcClusterAbundance *cad,
                                  NcHICosmo *cosmo,
                                  NcClusterRedshift *clusterz,
                                  NcClusterMass *clusterm,
                                  gdouble *lnM_obs,
                                  gdouble *lnM_obs_params,
                                  gdouble *z_obs,
                                  gdouble *z_obs_params);

nc_cluster_abundance_d2NdzdlnM_val()

#define nc_cluster_abundance_d2NdzdlnM_val(cad, cp, lnM, z) (cad)->d2NdzdlnM_val (cad, cp, lnM, z)

nc_cluster_abundance_dNdz_val()

#define nc_cluster_abundance_dNdz_val(cad, cp, lnMl, lnMu, z) (cad)->dNdz_val (cad, cp, lnMl, lnMu, z)

nc_cluster_abundance_dNdlnM_val()

#define nc_cluster_abundance_dNdlnM_val(cad, cp, lnM, zl, zu) (cad)->dNdlnM_val (cad, cp, lnM, zl, zu)

nc_cluster_abundance_N_val()

#define nc_cluster_abundance_N_val(cad, cp, lnMl, lnMu, zl, zu) (cad)->N_val (cad, cp, lnMl, lnMu, zl, zu)

nc_cluster_abundance_new ()

NcClusterAbundance *
nc_cluster_abundance_new (NcHaloMassFunction *mfp,
                          NcHaloBias *mbiasf);

This function allocates memory for a new NcClusterAbundance object and sets its properties to the values from the input arguments.

Parameters

mfp	a NcHaloMassFunction
mbiasf	a NcHaloBias.	[allow-none]

Returns

A new NcClusterAbundance.

nc_cluster_abundance_nodist_new ()

NcClusterAbundance *
nc_cluster_abundance_nodist_new (NcHaloMassFunction *mfp,
                                 NcHaloBias *mbiasf);

This function allocates memory for a new NcClusterAbundance object and sets its properties to the values from the input arguments.

Parameters

mfp	a NcHaloMassFunction
mbiasf	a NcHaloBias.	[allow-none]

Returns

A new NcClusterAbundance.

nc_cluster_abundance_ref ()

NcClusterAbundance *
nc_cluster_abundance_ref (NcClusterAbundance *cad);

Increases the reference count of cad by one.

Parameters

cad

a NcClusterAbundance

Returns

cad .

[transfer full]

nc_cluster_abundance_free ()

void
nc_cluster_abundance_free (NcClusterAbundance *cad);

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

Parameters

cad

a NcClusterAbundance

nc_cluster_abundance_clear ()

void
nc_cluster_abundance_clear (NcClusterAbundance **cad);

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

Parameters

cad

a NcClusterAbundance

nc_cluster_abundance_prepare ()

void
nc_cluster_abundance_prepare (NcClusterAbundance *cad,
                              NcHICosmo *cosmo,
                              NcClusterRedshift *clusterz,
                              NcClusterMass *clusterm);

This function prepares ...

Parameters

cad	a NcClusterAbundance
cosmo	a NcHICosmo
clusterz	a NcClusterRedshift
clusterm	a NcClusterMass

nc_cluster_abundance_prepare_if_needed ()

void
nc_cluster_abundance_prepare_if_needed
                               (NcClusterAbundance *cad,
                                NcHICosmo *cosmo,
                                NcClusterRedshift *clusterz,
                                NcClusterMass *clusterm);

FIXME

Parameters

cad	a NcClusterAbundance
cosmo	a NcHICosmo
clusterz	a NcClusterRedshift
clusterm	a NcClusterMass

nc_cluster_abundance_set_area ()

void
nc_cluster_abundance_set_area (NcClusterAbundance *cad,
                               const gdouble area);

This function prepares ...

Parameters

cad	a NcClusterAbundance
area	FIXME

nc_cluster_abundance_prepare_inv_dNdz ()

void
nc_cluster_abundance_prepare_inv_dNdz (NcClusterAbundance *cad,
                                       NcHICosmo *cosmo,
                                       const gdouble lnMi);

This function prepares a bidimensional spline...

Parameters

cad	a NcClusterAbundance
cosmo	a NcHICosmo
lnMi	logarithm base e of the minimum mass $\ln(M_i)$

nc_cluster_abundance_prepare_inv_dNdlnM_z ()

void
nc_cluster_abundance_prepare_inv_dNdlnM_z
                               (NcClusterAbundance *cad,
                                NcHICosmo *cosmo,
                                const gdouble lnMi,
                                gdouble z);

This function prepares a spline where the x array corresponds to the value of $\int_{\ln M_0} ^{\ln M_1} d^2N/dzd\ln M dM/ \int_lnMi^lnMf dN/dz dM$ given a redshift $z$ and the y array contains the values of logarithms base e of the mass. It is used to generate a sample of $\ln M$ values.

Parameters

cad	a NcClusterAbundance
cosmo	a NcHICosmo
lnMi	logarithm base e of the minimum mass $\ln(M_i)$
z	redshift $z$

nc_cluster_abundance_z_p_lnM_p_d2n ()

gdouble
nc_cluster_abundance_z_p_lnM_p_d2n (NcClusterAbundance *cad,
                                    NcHICosmo *cosmo,
                                    NcClusterRedshift *clusterz,
                                    NcClusterMass *clusterm,
                                    gdouble *lnM_obs,
                                    gdouble *lnM_obs_params,
                                    gdouble *z_obs,
                                    gdouble *z_obs_params);

This function computes $ \int_0^\infty dz \int_{-\infty}^\infty d\ln M \frac{d^2N(\ln M, z)}{dzd\ln M} * P(z^{phot}|z) * P(\ln M^{obs}|\ln M, z) $. We studied the convergence of this integral to optimize this function. We verified that it converges to 5 decimal places at the redshift interval $ [z^{phot} - 10\sigma^{phot}, z^{phot} + 10\sigma^{phot}] $ and the mass interval $ [\ln M^{obs} - 7\sigma_{\ln M}, \ln M^{obs} + 7\sigma_{\ln M}] $.

Parameters

cad	a NcClusterAbundance
cosmo	a NcHICosmo
clusterz	a NcClusterRedshift
clusterm	a NcClusterMass
lnM_obs	logarithm base e of the observed mass.	[array][element-type gdouble]
lnM_obs_params	FIXME.	[array][element-type gdouble]
z_obs	observed redshift.	[array][element-type gdouble]
z_obs_params	FIXME.	[array][element-type gdouble]

Returns

a gdouble which represents $ \frac{d^2N(\ln M^{obs}, z^{phot})}{dzd\ln M} $.

nc_cluster_abundance_z_p_d2n ()

gdouble
nc_cluster_abundance_z_p_d2n (NcClusterAbundance *cad,
                              NcHICosmo *cosmo,
                              NcClusterRedshift *clusterz,
                              NcClusterMass *clusterm,
                              gdouble lnM,
                              gdouble *z_obs,
                              gdouble *z_obs_params);

This function computes $ \int_{z_{phot} - 10\sigma_{phot}}^{z_{phot} + 10\sigma_{phot}} dz \, \frac{d^2N}{dzdlnM} * P(z^{photo}|z) $. The integral limits were determined requiring a precision to five decimal places.

Parameters

cad	a NcClusterAbundance
cosmo	a NcHICosmo
clusterz	a NcClusterRedshift
clusterm	a NcClusterMass
lnM	the logarithm base e of the mass (gdouble)
z_obs	observed redshift.	[array][element-type gdouble]
z_obs_params	FIXME.	[array][element-type gdouble]

Returns

a gdouble which corresponds to $ \int_{z_{phot} - 10\sigma_{phot}}^{z_{phot} + 10\sigma_{phot}} dz \, \frac{d^2N}{dzdlnM} * P(z^{photo}|z) $.

nc_cluster_abundance_lnM_p_d2n ()

gdouble
nc_cluster_abundance_lnM_p_d2n (NcClusterAbundance *cad,
                                NcHICosmo *cosmo,
                                NcClusterRedshift *clusterz,
                                NcClusterMass *clusterm,
                                gdouble *lnM_obs,
                                gdouble *lnM_obs_params,
                                gdouble z);

This function computes $ \int_{\ln M^{obs} - 7\sigma_{\ln M}}^{\ln M^{obs} + 7\sigma_{\ln M}} d\ln M \, \frac{d^2N}{dzdlnM} * P(\ln M^{obs}|\ln M) $. The integral limits were determined requiring a precision to five decimal places.

Parameters

cad	a NcClusterAbundance
cosmo	a NcHICosmo
clusterz	a NcClusterRedshift
clusterm	a NcClusterMass
lnM_obs	logarithm base e of the observed mass.	[array][element-type gdouble]
lnM_obs_params	other information of the observed mass, such as its error.	[array][element-type gdouble][allow-none]
z	redshift

Returns

a gdouble which corresponds to $ \int_{\ln M^{obs} - 7\sigma_{\ln M}}^{\ln M^{obs} + 7\sigma_{\ln M}} d\ln M \, \frac{d^2N}{dzdlnM} * P(\ln M^{obs}|\ln M) $.

nc_cluster_abundance_d2n ()

gdouble
nc_cluster_abundance_d2n (NcClusterAbundance *cad,
                          NcHICosmo *cosmo,
                          NcClusterRedshift *clusterz,
                          NcClusterMass *clusterm,
                          gdouble lnM,
                          gdouble z);

Parameters

cad	a NcClusterAbundance
cosmo	a NcHICosmo
clusterz	a NcClusterRedshift
clusterm	a NcClusterMass
lnM	true mass
z	true redshift

Returns

a gdouble which corresponds to $ \int_{\ln M^{obs} - 7\sigma_{\ln M}}^{\ln M^{obs} + 7\sigma_{\ln M}} d\ln M \, \frac{d^2N}{dzdlnM} * P(\ln M^{obs}|\ln M) $.

nc_cluster_abundance_true_n ()

gdouble
nc_cluster_abundance_true_n (NcClusterAbundance *cad,
                             NcHICosmo *cosmo,
                             NcClusterRedshift *clusterz,
                             NcClusterMass *clusterm);

This function computes the total number of "true" clusters, i.e., halos within redshift and mass intervals, and over a sky area.

Parameters

cad	a NcClusterAbundance
cosmo	a NcHICosmo
clusterz	a NcClusterRedshift
clusterm	a NcClusterMass

Returns

total number of halos (normalization)

nc_cluster_abundance_n ()

gdouble
nc_cluster_abundance_n (NcClusterAbundance *cad,
                        NcHICosmo *cosmo,
                        NcClusterRedshift *clusterz,
                        NcClusterMass *clusterm);

This function computes the total number of clusters within specific redshift and mass intervals, which are defined in clusterz and clusterm , respectively, and over a sky area.

Parameters

cad	a NcClusterAbundance
cosmo	a NcHICosmo
clusterz	a NcClusterRedshift
clusterm	a NcClusterMass

Returns

total number of clusters.

nc_cluster_abundance_intp_d2n ()

gdouble
nc_cluster_abundance_intp_d2n (NcClusterAbundance *cad,
                               NcHICosmo *cosmo,
                               NcClusterRedshift *clusterz,
                               NcClusterMass *clusterm,
                               gdouble lnM,
                               gdouble z);

FIXME

Parameters

cad	a NcClusterAbundance
cosmo	a NcHICosmo
clusterz	a NcClusterRedshift
clusterm	a NcClusterMass
lnM	logarithm base e of the cluster mass
z	redshift

Returns

FIXME

nc_cluster_abundance_intp_bin_d2n ()

gdouble
nc_cluster_abundance_intp_bin_d2n (NcClusterAbundance *cad,
                                   NcHICosmo *cosmo,
                                   NcClusterRedshift *clusterz,
                                   NcClusterMass *clusterm,
                                   const gdouble *lnM_obs_lower,
                                   const gdouble *lnM_obs_upper,
                                   const gdouble *lnM_obs_params,
                                   const gdouble *z_obs_lower,
                                   const gdouble *z_obs_upper,
                                   const gdouble *z_obs_params);

FIXME

Parameters

cad	a NcClusterAbundance
cosmo	a NcHICosmo
clusterz	a NcClusterRedshift
clusterm	a NcClusterMass
lnM_obs_lower	FIXME.	[array][element-type gdouble]
lnM_obs_upper	FIXME.	[array][element-type gdouble]
lnM_obs_params	FIXME.	[array][element-type gdouble][allow-none]
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_bias_mean_prepare ()

void
nc_bias_mean_prepare (NcClusterAbundance *cad,
                      NcHICosmo *cosmo);

nc_bias_mean_val ()

gdouble
nc_bias_mean_val (NcClusterAbundance *cad,
                  NcHICosmo *cosmo,
                  gdouble lnMl,
                  gdouble lnMu,
                  gdouble z);

nc_ca_mean_bias_numerator ()

gdouble
nc_ca_mean_bias_numerator (NcClusterAbundance *cad,
                           NcHICosmo *cosmo,
                           gdouble lnM,
                           gdouble z);

nc_ca_mean_bias_denominator ()

gdouble
nc_ca_mean_bias_denominator (NcClusterAbundance *cad,
                             NcHICosmo *cosmo,
                             gdouble lnM,
                             gdouble z);

nc_ca_mean_bias ()

gdouble
nc_ca_mean_bias (NcClusterAbundance *cad,
                 NcHICosmo *cosmo,
                 gdouble lnM,
                 gdouble z);

nc_ca_mean_bias_Mobs_numerator ()

gdouble
nc_ca_mean_bias_Mobs_numerator (NcClusterAbundance *cad,
                                NcHICosmo *cosmo,
                                gdouble lnMobs,
                                gdouble z);

nc_ca_mean_bias_Mobs_denominator ()

gdouble
nc_ca_mean_bias_Mobs_denominator (NcClusterAbundance *cad,
                                  NcHICosmo *cosmo,
                                  gdouble lnMobs,
                                  gdouble z);

nc_cluster_abundance_intp_d2n_bias ()

gdouble
nc_cluster_abundance_intp_d2n_bias (NcClusterAbundance *cad,
                                    NcHICosmo *cosmo,
                                    NcClusterRedshift *clusterz,
                                    NcClusterMass *clusterm,
                                    gdouble *lnM_obs,
                                    gdouble *lnM_obs_params,
                                    gdouble *z_obs,
                                    gdouble *z_obs_params);

FIXME

Parameters

cad	a NcClusterAbundance
cosmo	a NcHICosmo
clusterz	a NcClusterRedshift
clusterm	a NcClusterMass
lnM_obs	FIXME.	[array][element-type gdouble]
lnM_obs_params	FIXME.	[array][element-type gdouble][allow-none]
z_obs	FIXME.	[array][element-type gdouble]
z_obs_params	FIXME.	[array][element-type gdouble][allow-none]

Returns

FIXME

nc_cluster_abundance_intp_bin_d2n_bias ()

gdouble
nc_cluster_abundance_intp_bin_d2n_bias
                               (NcClusterAbundance *cad,
                                NcHICosmo *cosmo,
                                NcClusterRedshift *clusterz,
                                NcClusterMass *clusterm,
                                const gdouble *lnM_obs_lower,
                                const gdouble *lnM_obs_upper,
                                const gdouble *lnM_obs_params,
                                const gdouble *z_obs_lower,
                                const gdouble *z_obs_upper,
                                const gdouble *z_obs_params);

FIXME

Parameters

cad	a NcClusterAbundance
cosmo	a NcHICosmo
clusterz	a NcClusterRedshift
clusterm	a NcClusterMass
lnM_obs_lower	FIXME.	[array][element-type gdouble]
lnM_obs_upper	FIXME.	[array][element-type gdouble]
lnM_obs_params	FIXME.	[array][element-type gdouble][allow-none]
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_abundance_mean_bias ()

gdouble
nc_cluster_abundance_mean_bias (NcClusterAbundance *cad,
                                NcHICosmo *cosmo,
                                NcClusterRedshift *clusterz,
                                NcClusterMass *clusterm);

Types and Values

NcClusterAbundanceDataBinZ

typedef struct _NcClusterAbundanceDataBinz NcClusterAbundanceDataBinZ;

NcClusterAbundanceDataBin

typedef struct _NcClusterAbundanceDataBin NcClusterAbundanceDataBin;

NcClusterAbundanceDataBinM

typedef struct _NcClusterAbundanceDataBinM NcClusterAbundanceDataBinM;

NcClusterAbundanceDataP

typedef struct _NcClusterAbundanceDataP NcClusterAbundanceDataP;

Property Details

The `“halo-mass-function”` property

  “halo-mass-function”       NcHaloMassFunction *

Number density of halos with mass [M, M + dM].

Owner: NcClusterAbundance

Flags: Read / Write / Construct Only

The `“mean-bias”` property

  “mean-bias”                NcHaloBias *

FIXME

Owner: NcClusterAbundance

Flags: Read / Write / Construct Only