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_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 ()
void nc_data_cluster_ncount_set_lnM_obs_bins ()
void nc_data_cluster_ncount_set_z_obs_bins ()
void nc_data_cluster_ncount_set_bin_count ()
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_add_bin ()
void nc_data_cluster_ncount_del_bins ()
void nc_data_cluster_ncount_set_binned ()
void nc_data_cluster_ncount_bin_data ()
void nc_data_cluster_ncount_catalog_save ()
void nc_data_cluster_ncount_catalog_load ()

Properties

double area Read / Write
NcmVector * bin-count Read / Write
gboolean binned Read / Write
NcClusterAbundance * cluster-abundance Read / Write / Construct
gboolean fiducial Read / Write
NcmMatrix * lnM-obs Read / Write
NcmObjArray * lnM-obs-bins Read / Write
NcmMatrix * lnM-obs-params Read / Write
NcmVector * lnM-true Read / Write
char * mass-type Read / Write / Construct Only
char * redshift-type Read / Write / Construct Only
char * rng-name Read / Write
guint64 rng-seed Read / Write
gboolean use-true Read / Write
NcmMatrix * z-obs Read / Write
NcmObjArray * z-obs-bins Read / Write
NcmMatrix * z-obs-params Read / Write
NcmVector * z-true Read / Write

Types and Values

Object Hierarchy

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

Description

A likelihood function for cluster number count data.

Functions

nc_data_cluster_ncount_new ()

NcDataClusterNCount *
nc_data_cluster_ncount_new (NcClusterAbundance *cad,
                            const gchar *redshift_type,
                            const gchar *mass_type);

Creates a new NcDataClusterNCount object.

Parameters

cad

a NcClusterAbundance

 

redshift_type

NcClusterRedshift class string

 

mass_type

NcClusterMass class string

 

Returns

the newly created NcDataClusterNCount.

[transfer full]


nc_data_cluster_ncount_ref ()

NcDataClusterNCount *
nc_data_cluster_ncount_ref (NcDataClusterNCount *ncount);

Increases the reference count of the NcDataClusterNCount.

Parameters

ncount

a NcDataClusterNCount

 

Returns

the NcDataClusterNCount.

[transfer full]


nc_data_cluster_ncount_free ()

void
nc_data_cluster_ncount_free (NcDataClusterNCount *ncount);

Decreases the reference count of the NcDataClusterNCount. If the reference count reaches zero, the NcDataClusterNCount is freed.

Parameters

ncount

a NcDataClusterNCount

 

nc_data_cluster_ncount_clear ()

void
nc_data_cluster_ncount_clear (NcDataClusterNCount **ncount);

If *ncount is not NULL, decreases the reference count of the NcDataClusterNCount. If the reference count reaches zero, the NcDataClusterNCount is freed. Sets the *ncount to NULL.

Parameters

ncount

a NcDataClusterNCount

 

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

void
nc_data_cluster_ncount_set_lnM_obs_bins
                               (NcDataClusterNCount *ncount,
                                NcmObjArray *lnM_obs_bins);

Sets array of NcmVector's representing the lower and upper bounds of each bin.

Parameters

ncount

a NcDataClusterNCount

 

lnM_obs_bins

a NcmObjArray

 

nc_data_cluster_ncount_set_z_obs_bins ()

void
nc_data_cluster_ncount_set_z_obs_bins (NcDataClusterNCount *ncount,
                                       NcmObjArray *z_obs_bins);

Sets array of NcmVector's representing the lower and upper bounds of each bin.

Parameters

ncount

a NcDataClusterNCount

 

z_obs_bins

a NcmObjArray

 

nc_data_cluster_ncount_set_bin_count ()

void
nc_data_cluster_ncount_set_bin_count (NcDataClusterNCount *ncount,
                                      NcmVector *bin_count);

Sets vector containing the bin counts.

Parameters

ncount

a NcDataClusterNCount

 

bin_count

a NcmVector

 

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

Sets whether to use the true data or not.

Parameters

ncount

a NcDataClusterNCount

 

use_true_data

if TRUE it will use the true data.

 

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

Initialize ncount from a sampling using mset as the fiducial model. The area of the survey is area_survey in units of square degrees. The random number generator rng is used to sample the data.

Parameters

ncount

a NcDataClusterNCount

 

mset

a NcmMSet

 

area_survey

area in units of square degrees

 

rng

a NcmRNG

 

nc_data_cluster_ncount_add_bin ()

void
nc_data_cluster_ncount_add_bin (NcDataClusterNCount *ncount,
                                NcmVector *lnM_obs_lb,
                                NcmVector *lnM_obs_ub,
                                NcmVector *z_obs_lb,
                                NcmVector *z_obs_ub);

Adds a new bin using the lower and upper bounds defined in (lnM_obs_lb , lnM_obs_ub ), (z_obs_lb z_obs_ub ).

Parameters

ncount

a NcDataClusterNCount

 

lnM_obs_lb

a NcmVector

 

lnM_obs_ub

a NcmVector

 

z_obs_lb

a NcmVector

 

z_obs_ub

a NcmVector

 

nc_data_cluster_ncount_del_bins ()

void
nc_data_cluster_ncount_del_bins (NcDataClusterNCount *ncount);

Remove all bins in ncount .

Parameters

ncount

a NcDataClusterNCount

 

nc_data_cluster_ncount_set_binned ()

void
nc_data_cluster_ncount_set_binned (NcDataClusterNCount *ncount,
                                   gboolean on);

Sets whether to use binned data or not.

Parameters

ncount

a NcDataClusterNCount.

 

on

whether to use binned data or not.

 

nc_data_cluster_ncount_bin_data ()

void
nc_data_cluster_ncount_bin_data (NcDataClusterNCount *ncount);

Bin the current data present in ncount . The bins must be already set.

Parameters

ncount

a NcDataClusterNCount

 

nc_data_cluster_ncount_catalog_save ()

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

Saves the current data present in ncount to a FITS file.

Parameters

ncount

a NcDataClusterNCount

 

filename

name of the file

 

overwrite

whether to overwrite the file or not

 

nc_data_cluster_ncount_catalog_load ()

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

Loads the data present in filename to ncount .

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”                     double

Cluster observation area.

Owner: NcDataClusterNCount

Flags: Read / Write

Allowed values: >= 0

Default value: 0


The “bin-count” property

  “bin-count”                NcmVector *

Bin count.

Owner: NcDataClusterNCount

Flags: Read / Write


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-obs” property

  “lnM-obs”                  NcmMatrix *

Clusters mass observables.

Owner: NcDataClusterNCount

Flags: Read / Write


The “lnM-obs-bins” property

  “lnM-obs-bins”             NcmObjArray *

Clusters mass bins.

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 “mass-type” property

  “mass-type”                char *

Cluster mass proxy type.

Owner: NcDataClusterNCount

Flags: Read / Write / Construct Only

Default value: "NcClusterMass"


The “redshift-type” property

  “redshift-type”            char *

Cluster redshift proxy type.

Owner: NcDataClusterNCount

Flags: Read / Write / Construct Only

Default value: "NcClusterRedshift"


The “rng-name” property

  “rng-name”                 char *

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-obs” property

  “z-obs”                    NcmMatrix *

Clusters redshift observables.

Owner: NcDataClusterNCount

Flags: Read / Write


The “z-obs-bins” property

  “z-obs-bins”               NcmObjArray *

Clusters redshifts bins.

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