Abstract Cluster Redshift Object

Abstract Cluster Redshift Object — Observed redshift distribution

Synopsis

#define             NC_CLUSTER_REDSHIFT_IMPL_ALL
struct              NcClusterRedshift;
struct              NcClusterRedshiftClass;
enum                NcClusterRedshiftImpl;
void                nc_cluster_redshift_free            (NcClusterRedshift *clusterz);
NcClusterRedshiftImpl nc_cluster_redshift_impl          (NcClusterRedshift *clusterz);
gdouble             nc_cluster_redshift_intp            (NcClusterRedshift *clusterz,
                                                         gdouble lnM,
                                                         gdouble z);
void                nc_cluster_redshift_n_limits        (NcClusterRedshift *clusterz,
                                                         gdouble *z_lower,
                                                         gdouble *z_upper);
NcClusterRedshift * nc_cluster_redshift_new_from_name   (gchar *redshift_name);
guint               nc_cluster_redshift_obs_len         (NcClusterRedshift *clusterz);
guint               nc_cluster_redshift_obs_params_len  (NcClusterRedshift *clusterz);
gdouble             nc_cluster_redshift_p               (NcClusterRedshift *clusterz,
                                                         gdouble lnM,
                                                         gdouble z,
                                                         gdouble *z_obs,
                                                         gdouble *z_obs_params);
void                nc_cluster_redshift_p_limits        (NcClusterRedshift *clusterz,
                                                         gdouble *z_obs,
                                                         gdouble *z_obs_params,
                                                         gdouble *z_lower,
                                                         gdouble *z_upper);
NcClusterRedshift * nc_cluster_redshift_ref             (NcClusterRedshift *clusterz);
gboolean            nc_cluster_redshift_resample        (NcClusterRedshift *clusterz,
                                                         gdouble lnM,
                                                         gdouble z,
                                                         gdouble *z_obs,
                                                         gdouble *z_obs_params);

Object Hierarchy

  GObject
   +----NcClusterRedshift
         +----NcClusterPhotozGauss
         +----NcClusterPhotozGaussGlobal
         +----NcClusterRedshiftNodist

Description

FIXME

Details

NC_CLUSTER_REDSHIFT_IMPL_ALL

#define NC_CLUSTER_REDSHIFT_IMPL_ALL (~0)

struct NcClusterRedshift

struct NcClusterRedshift;

struct NcClusterRedshiftClass

struct NcClusterRedshiftClass {
};

enum NcClusterRedshiftImpl

typedef enum {
  NC_CLUSTER_REDSHIFT_P        = 1 << 0,
  NC_CLUSTER_REDSHIFT_INTP     = 1 << 1,
  NC_CLUSTER_REDSHIFT_RESAMPLE = 1 << 2,
  NC_CLUSTER_REDSHIFT_P_LIMITS = 1 << 3,
  NC_CLUSTER_REDSHIFT_N_LIMTS  = 1 << 4,
} NcClusterRedshiftImpl;

NC_CLUSTER_REDSHIFT_P

FIXME

NC_CLUSTER_REDSHIFT_INTP

FIXME

NC_CLUSTER_REDSHIFT_RESAMPLE

FIXME

NC_CLUSTER_REDSHIFT_P_LIMITS

FIXME

NC_CLUSTER_REDSHIFT_N_LIMTS

FIXME

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.

clusterz :

a NcClusterRedshift.

nc_cluster_redshift_impl ()

NcClusterRedshiftImpl nc_cluster_redshift_impl          (NcClusterRedshift *clusterz);

FIXME

clusterz :

FIXME.

Returns :

FIXME

nc_cluster_redshift_intp ()

gdouble             nc_cluster_redshift_intp            (NcClusterRedshift *clusterz,
                                                         gdouble lnM,
                                                         gdouble z);

FIXME

clusterz :

a NcClusterRedshift.

z :

true redshift.

lnM :

true mass.

Returns :

FIXME

nc_cluster_redshift_n_limits ()

void                nc_cluster_redshift_n_limits        (NcClusterRedshift *clusterz,
                                                         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.

clusterz :

a NcClusterRedshift.

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_new_from_name ()

NcClusterRedshift * nc_cluster_redshift_new_from_name   (gchar *redshift_name);

This function returns a new NcClusterRedshift whose type is defined by redshift_name.

redshift_name :

string which specifies the type of the redshift distribution.

Returns :

A new NcClusterRedshift.

nc_cluster_redshift_obs_len ()

guint               nc_cluster_redshift_obs_len         (NcClusterRedshift *clusterz);

FIXME

clusterz :

FIXME.

Returns :

FIXME

nc_cluster_redshift_obs_params_len ()

guint               nc_cluster_redshift_obs_params_len  (NcClusterRedshift *clusterz);

FIXME

clusterz :

FIXME.

Returns :

FIXME

nc_cluster_redshift_p ()

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

FIXME

clusterz :

a NcClusterRedshift.

z :

true redshift.

lnM :

true mass.

z_obs :

observed redshift.

z_obs_params :

observed redshift params.

Returns :

FIXME

nc_cluster_redshift_p_limits ()

void                nc_cluster_redshift_p_limits        (NcClusterRedshift *clusterz,
                                                         gdouble *z_obs,
                                                         gdouble *z_obs_params,
                                                         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.

clusterz :

a NcClusterRedshift.

z_obs :

observed redshift.

z_obs_params :

observed redshift params.

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_ref ()

NcClusterRedshift * nc_cluster_redshift_ref             (NcClusterRedshift *clusterz);

FIXME

clusterz :

FIXME.

Returns :

clusterz. [transfer full]

nc_cluster_redshift_resample ()

gboolean            nc_cluster_redshift_resample        (NcClusterRedshift *clusterz,
                                                         gdouble lnM,
                                                         gdouble z,
                                                         gdouble *z_obs,
                                                         gdouble *z_obs_params);

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

clusterz :

a NcClusterRedshift.

z :

true redshift.

lnM :

true mass.

z_obs :

observed redshift. [out]

z_obs_params :

observed redshift params. [out]

Returns :

FIXME