NcDataClusterNCount

NcDataClusterNCount — Cluster number count data.

Functions

NcDataClusterNCount * nc_data_cluster_ncount_new ()
NcDataClusterNCount * nc_data_cluster_ncount_ref ()
void nc_data_cluster_ncount_free ()
void nc_data_cluster_ncount_clear ()
void nc_data_cluster_ncount_set_n_z_obs ()
void nc_data_cluster_ncount_set_n_z_obs_params ()
void nc_data_cluster_ncount_set_n_M_obs ()
void nc_data_cluster_ncount_set_n_M_obs_params ()
void nc_data_cluster_ncount_set_lnM_true ()
void nc_data_cluster_ncount_set_z_true ()
void nc_data_cluster_ncount_set_lnM_obs ()
void nc_data_cluster_ncount_set_lnM_obs_params ()
void nc_data_cluster_ncount_set_z_obs ()
void nc_data_cluster_ncount_set_z_obs_params ()
gboolean nc_data_cluster_ncount_has_lnM_true ()
gboolean nc_data_cluster_ncount_has_z_true ()
guint nc_data_cluster_ncount_get_len ()
guint nc_data_cluster_ncount_lnM_obs_len ()
guint nc_data_cluster_ncount_lnM_obs_params_len ()
guint nc_data_cluster_ncount_z_obs_len ()
guint nc_data_cluster_ncount_z_obs_params_len ()
NcmVector * nc_data_cluster_ncount_get_lnM_true ()
NcmVector * nc_data_cluster_ncount_get_z_true ()
NcmMatrix * nc_data_cluster_ncount_get_lnM_obs ()
NcmMatrix * nc_data_cluster_ncount_get_lnM_obs_params ()
NcmMatrix * nc_data_cluster_ncount_get_z_obs ()
NcmMatrix * nc_data_cluster_ncount_get_z_obs_params ()
void nc_data_cluster_ncount_true_data ()
gboolean nc_data_cluster_ncount_using_true_data ()
void nc_data_cluster_ncount_init_from_sampling ()
void nc_data_cluster_ncount_print ()
void nc_data_cluster_ncount_set_bin_by_nodes ()
void nc_data_cluster_ncount_set_bin_by_minmax ()
void nc_data_cluster_ncount_set_bin_by_quantile ()
void nc_data_cluster_ncount_set_binned ()
void nc_data_cluster_ncount_catalog_save ()
void nc_data_cluster_ncount_catalog_load ()

Properties

gdouble area Read / Write
gboolean binned Read / Write
NcClusterAbundance * cluster-abundance Read / Write / Construct
gboolean fiducial Read / Write
NcmVector * lnM-nodes Read / Write / Construct
NcmMatrix * lnM-obs Read / Write
NcmMatrix * lnM-obs-params Read / Write
NcmVector * lnM-true Read / Write
guint n-M-obs Read / Write / Construct
guint n-M-obs-params Read / Write / Construct
guint n-z-obs Read / Write / Construct
guint n-z-obs-params Read / Write / Construct
gchar * rng-name Read / Write
guint64 rng-seed Read / Write
gboolean use-true Read / Write
NcmVector * z-nodes Read / Write / Construct
NcmMatrix * z-obs Read / Write
NcmMatrix * z-obs-params Read / Write
NcmVector * z-true Read / Write

Types and Values

Object Hierarchy

    GEnum
    ╰── NcDataClusterAbundanceId
    GObject
    ╰── NcmData
        ╰── NcDataClusterNCount

Description

FIXME

Functions

nc_data_cluster_ncount_new ()

NcDataClusterNCount *
nc_data_cluster_ncount_new (NcClusterAbundance *cad);

FIXME

Parameters

Returns

FIXME


nc_data_cluster_ncount_ref ()

NcDataClusterNCount *
nc_data_cluster_ncount_ref (NcDataClusterNCount *ncount);

FIXME

Parameters

ncount

a NcDataClusterNCount

 

Returns

FIXME.

[transfer full]


nc_data_cluster_ncount_free ()

void
nc_data_cluster_ncount_free (NcDataClusterNCount *ncount);

FIXME

Parameters

ncount

a NcDataClusterNCount

 

nc_data_cluster_ncount_clear ()

void
nc_data_cluster_ncount_clear (NcDataClusterNCount **ncount);

FIXME

Parameters

ncount

a NcDataClusterNCount

 

nc_data_cluster_ncount_set_n_z_obs ()

void
nc_data_cluster_ncount_set_n_z_obs (NcDataClusterNCount *ncount,
                                    guint n_z_obs);

FIXME

Parameters

ncount

a NcDataClusterNCount

 

n_z_obs

FIXME

 

nc_data_cluster_ncount_set_n_z_obs_params ()

void
nc_data_cluster_ncount_set_n_z_obs_params
                               (NcDataClusterNCount *ncount,
                                guint n_z_obs_params);

FIXME

Parameters

ncount

a NcDataClusterNCount

 

n_z_obs_params

FIXME

 

nc_data_cluster_ncount_set_n_M_obs ()

void
nc_data_cluster_ncount_set_n_M_obs (NcDataClusterNCount *ncount,
                                    guint n_M_obs);

FIXME

Parameters

ncount

a NcDataClusterNCount

 

n_M_obs

FIXME

 

nc_data_cluster_ncount_set_n_M_obs_params ()

void
nc_data_cluster_ncount_set_n_M_obs_params
                               (NcDataClusterNCount *ncount,
                                guint n_M_obs_params);

FIXME

Parameters

ncount

a NcDataClusterNCount

 

n_M_obs_params

FIXME

 

nc_data_cluster_ncount_set_lnM_true ()

void
nc_data_cluster_ncount_set_lnM_true (NcDataClusterNCount *ncount,
                                     const NcmVector *v);

Sets the vector v containing the values of the clusters true masses.

Parameters

ncount

a NcDataClusterNCount

 

v

a NcmVector

 

nc_data_cluster_ncount_set_z_true ()

void
nc_data_cluster_ncount_set_z_true (NcDataClusterNCount *ncount,
                                   const NcmVector *v);

Sets the vector v containing the true redshift values of the clusters.

Parameters

ncount

a NcDataClusterNCount

 

v

a NcmVector

 

nc_data_cluster_ncount_set_lnM_obs ()

void
nc_data_cluster_ncount_set_lnM_obs (NcDataClusterNCount *ncount,
                                    const NcmMatrix *m);

Sets the matrix m representing the cluster mass observables.

Parameters

ncount

a NcDataClusterNCount

 

m

a NcmMatrix

 

nc_data_cluster_ncount_set_lnM_obs_params ()

void
nc_data_cluster_ncount_set_lnM_obs_params
                               (NcDataClusterNCount *ncount,
                                const NcmMatrix *m);

Sets the matrix m representing the cluster mass-observable parameters.

Parameters

ncount

a NcDataClusterNCount

 

m

a NcmMatrix

 

nc_data_cluster_ncount_set_z_obs ()

void
nc_data_cluster_ncount_set_z_obs (NcDataClusterNCount *ncount,
                                  const NcmMatrix *m);

Sets the matrix m representing the cluster redshift observables.

Parameters

ncount

a NcDataClusterNCount

 

m

a NcmMatrix

 

nc_data_cluster_ncount_set_z_obs_params ()

void
nc_data_cluster_ncount_set_z_obs_params
                               (NcDataClusterNCount *ncount,
                                const NcmMatrix *m);

Sets the matrix m representing the cluster redshift observable parameters.

Parameters

ncount

a NcDataClusterNCount

 

m

a NcmMatrix

 

nc_data_cluster_ncount_has_lnM_true ()

gboolean
nc_data_cluster_ncount_has_lnM_true (NcDataClusterNCount *ncount);

Parameters

ncount

a NcDataClusterNCount

 

Returns

TRUE if it contains the lnM truth table.


nc_data_cluster_ncount_has_z_true ()

gboolean
nc_data_cluster_ncount_has_z_true (NcDataClusterNCount *ncount);

Parameters

ncount

a NcDataClusterNCount

 

Returns

TRUE if it contains the redshift truth table.


nc_data_cluster_ncount_get_len ()

guint
nc_data_cluster_ncount_get_len (NcDataClusterNCount *ncount);

Gets the total number of objects.

Parameters

ncount

a NcDataClusterNCount

 

Returns

Number of objects in ncount .


nc_data_cluster_ncount_lnM_obs_len ()

guint
nc_data_cluster_ncount_lnM_obs_len (NcDataClusterNCount *ncount);

Number of doubles to describe the observational data related to the mass of each object.

Parameters

ncount

a NcDataClusterNCount

 

Returns

Length of each row describing the mass proxy.


nc_data_cluster_ncount_lnM_obs_params_len ()

guint
nc_data_cluster_ncount_lnM_obs_params_len
                               (NcDataClusterNCount *ncount);

Number of doubles to describe the observational data parameters related mass to each object.

Parameters

ncount

a NcDataClusterNCount

 

Returns

Length of each row describing the mass proxy, it can be zero.


nc_data_cluster_ncount_z_obs_len ()

guint
nc_data_cluster_ncount_z_obs_len (NcDataClusterNCount *ncount);

Number of doubles to describe the observational data related to the redshift of each object.

Parameters

ncount

a NcDataClusterNCount

 

Returns

Length of each row describing the mass proxy.


nc_data_cluster_ncount_z_obs_params_len ()

guint
nc_data_cluster_ncount_z_obs_params_len
                               (NcDataClusterNCount *ncount);

nc_data_cluster_ncount_get_lnM_true ()

NcmVector *
nc_data_cluster_ncount_get_lnM_true (NcDataClusterNCount *ncount);

Gets the vector containing the true values of the masses.

Parameters

ncount

a NcDataClusterNCount

 

Returns

True masses NcmVector.

[transfer full]


nc_data_cluster_ncount_get_z_true ()

NcmVector *
nc_data_cluster_ncount_get_z_true (NcDataClusterNCount *ncount);

Gets the vector containing the true values of the redshifts.

Parameters

ncount

a NcDataClusterNCount

 

Returns

True redshift NcmVector.

[transfer full]


nc_data_cluster_ncount_get_lnM_obs ()

NcmMatrix *
nc_data_cluster_ncount_get_lnM_obs (NcDataClusterNCount *ncount);

Gets the matrix containing the mass observables.

Parameters

ncount

a NcDataClusterNCount

 

Returns

Mass observable NcmMatrix.

[transfer full]


nc_data_cluster_ncount_get_lnM_obs_params ()

NcmMatrix *
nc_data_cluster_ncount_get_lnM_obs_params
                               (NcDataClusterNCount *ncount);

Gets the matrix containing the mass observables parameters.

Parameters

ncount

a NcDataClusterNCount

 

Returns

Mass observable parameters NcmMatrix.

[transfer full]


nc_data_cluster_ncount_get_z_obs ()

NcmMatrix *
nc_data_cluster_ncount_get_z_obs (NcDataClusterNCount *ncount);

Gets the matrix containing the redshift observables.

Parameters

ncount

a NcDataClusterNCount

 

Returns

Redshift observable NcmMatrix.

[transfer full]


nc_data_cluster_ncount_get_z_obs_params ()

NcmMatrix *
nc_data_cluster_ncount_get_z_obs_params
                               (NcDataClusterNCount *ncount);

Gets the matrix containing the redshift observables parameters.

Parameters

ncount

a NcDataClusterNCount

 

Returns

Redshift observable parameters NcmMatrix.

[transfer full]


nc_data_cluster_ncount_true_data ()

void
nc_data_cluster_ncount_true_data (NcDataClusterNCount *ncount,
                                  gboolean use_true_data);

FIXME

Parameters

ncount

a NcDataClusterNCount

 

use_true_data

FIXME

 

nc_data_cluster_ncount_using_true_data ()

gboolean
nc_data_cluster_ncount_using_true_data
                               (NcDataClusterNCount *ncount);

Parameters

ncount

a NcDataClusterNCount

 

Returns

if it is using true data.


nc_data_cluster_ncount_init_from_sampling ()

void
nc_data_cluster_ncount_init_from_sampling
                               (NcDataClusterNCount *ncount,
                                NcmMSet *mset,
                                gdouble area_survey,
                                NcmRNG *rng);

FIXME

Parameters

ncount

a NcDataClusterNCount

 

mset

a NcmMSet

 

area_survey

area in units of square degrees

 

rng

a NcmRNG

 

nc_data_cluster_ncount_print ()

void
nc_data_cluster_ncount_print (NcDataClusterNCount *ncount,
                              NcHICosmo *cosmo,
                              FILE *out,
                              gchar *header);

FIXME

Parameters

ncount

a NcDataClusterNCount

 

cosmo

a NcHICosmo

 

out

FIXME

 

header

FIXME

 

nc_data_cluster_ncount_set_bin_by_nodes ()

void
nc_data_cluster_ncount_set_bin_by_nodes
                               (NcDataClusterNCount *ncount,
                                NcmVector *z_nodes,
                                NcmVector *lnM_nodes);

FIXME

Parameters

ncount

a NcDataClusterNCount

 

z_nodes

a NcmVector

 

lnM_nodes

a NcmVector

 

nc_data_cluster_ncount_set_bin_by_minmax ()

void
nc_data_cluster_ncount_set_bin_by_minmax
                               (NcDataClusterNCount *ncount,
                                guint z_nbins,
                                guint lnM_nbins);

Creates a uniform binning with z_nbins and lnM_nbins .

Parameters

ncount

a NcDataClusterNCount.

 

z_nbins

number of bins in z.

 

lnM_nbins

number of bins in $\ln(M)$.

 

nc_data_cluster_ncount_set_bin_by_quantile ()

void
nc_data_cluster_ncount_set_bin_by_quantile
                               (NcDataClusterNCount *ncount,
                                NcmVector *z_quantiles,
                                NcmVector *lnM_quantiles);

FIXME

Parameters

ncount

a NcDataClusterNCount.

 

z_quantiles

FIXME

 

lnM_quantiles

FIXME

 

nc_data_cluster_ncount_set_binned ()

void
nc_data_cluster_ncount_set_binned (NcDataClusterNCount *ncount,
                                   gboolean on);

FIXME

Parameters

ncount

a NcDataClusterNCount.

 

on

FIXME

 

nc_data_cluster_ncount_catalog_save ()

void
nc_data_cluster_ncount_catalog_save (NcDataClusterNCount *ncount,
                                     gchar *filename,
                                     gboolean overwrite);

FIXME

Parameters

ncount

a NcDataClusterNCount.

 

filename

name of the file

 

overwrite

FIXME

 

nc_data_cluster_ncount_catalog_load ()

void
nc_data_cluster_ncount_catalog_load (NcDataClusterNCount *ncount,
                                     gchar *filename);

FIXME

Parameters

ncount

a NcDataClusterNCount.

 

filename

name of the file

 

Types and Values

enum NcDataClusterAbundanceId

Members

NC_DATA_CLUSTER_ABUNDANCE_FIT

FIXME

 

NC_DATA_CLUSTER_ABUNDANCE_TXT

FIXME

 

NC_DATA_CLUSTER_ABUNDANCE_SAMPLING

FIXME

 

Property Details

The “area” property

  “area”                     gdouble

Cluster observation area.

Owner: NcDataClusterNCount

Flags: Read / Write

Allowed values: >= 0

Default value: 0


The “binned” property

  “binned”                   gboolean

Whether use binned data.

Owner: NcDataClusterNCount

Flags: Read / Write

Default value: FALSE


The “cluster-abundance” property

  “cluster-abundance”        NcClusterAbundance *

Cluster abundance.

Owner: NcDataClusterNCount

Flags: Read / Write / Construct


The “fiducial” property

  “fiducial”                 gboolean

If it is fiducial data.

Owner: NcDataClusterNCount

Flags: Read / Write

Default value: FALSE


The “lnM-nodes” property

  “lnM-nodes”                NcmVector *

Clusters mass nodes for binning.

Owner: NcDataClusterNCount

Flags: Read / Write / Construct


The “lnM-obs” property

  “lnM-obs”                  NcmMatrix *

Clusters mass observables.

Owner: NcDataClusterNCount

Flags: Read / Write


The “lnM-obs-params” property

  “lnM-obs-params”           NcmMatrix *

Clusters mass observables parameters.

Owner: NcDataClusterNCount

Flags: Read / Write


The “lnM-true” property

  “lnM-true”                 NcmVector *

Clusters true masses.

Owner: NcDataClusterNCount

Flags: Read / Write


The “n-M-obs” property

  “n-M-obs”                  guint

Number of mass observables.

Owner: NcDataClusterNCount

Flags: Read / Write / Construct

Allowed values: >= 1

Default value: 1


The “n-M-obs-params” property

  “n-M-obs-params”           guint

Number of mass observables parameters.

Owner: NcDataClusterNCount

Flags: Read / Write / Construct

Default value: 0


The “n-z-obs” property

  “n-z-obs”                  guint

Number of redshift observables.

Owner: NcDataClusterNCount

Flags: Read / Write / Construct

Allowed values: >= 1

Default value: 1


The “n-z-obs-params” property

  “n-z-obs-params”           guint

Number of redshift observables parameters.

Owner: NcDataClusterNCount

Flags: Read / Write / Construct

Default value: 0


The “rng-name” property

  “rng-name”                 gchar *

Random number generator name.

Owner: NcDataClusterNCount

Flags: Read / Write

Default value: NULL


The “rng-seed” property

  “rng-seed”                 guint64

Random number generator seed.

Owner: NcDataClusterNCount

Flags: Read / Write

Default value: 0


The “use-true” property

  “use-true”                 gboolean

If the true data must be used.

Owner: NcDataClusterNCount

Flags: Read / Write

Default value: FALSE


The “z-nodes” property

  “z-nodes”                  NcmVector *

Clusters redshifts nodes for binning.

Owner: NcDataClusterNCount

Flags: Read / Write / Construct


The “z-obs” property

  “z-obs”                    NcmMatrix *

Clusters redshift observables.

Owner: NcDataClusterNCount

Flags: Read / Write


The “z-obs-params” property

  “z-obs-params”             NcmMatrix *

Clusters redshift observables parameters.

Owner: NcDataClusterNCount

Flags: Read / Write


The “z-true” property

  “z-true”                   NcmVector *

Clusters true redshifts.

Owner: NcDataClusterNCount

Flags: Read / Write