NcGalaxySelfunc

NcGalaxySelfunc — Galaxy phenomelogical selection function.

Functions

Properties

guint nshells Read / Write / Construct
NcmObjArray * shell-splines Read / Write

Object Hierarchy

    GObject
    ╰── NcGalaxySelfunc

Includes

#include <nc_galaxy_selfunc.h>

Description

FIXME

Functions

nc_galaxy_selfunc_new ()

NcGalaxySelfunc *
nc_galaxy_selfunc_new (const guint nshells);

Creates a new instance of NcGalaxySelfunc.

Parameters

nshells

number of redshift shells

 

Returns

a new NcGalaxySelfunc.

[transfer full]


nc_galaxy_selfunc_ref ()

NcGalaxySelfunc *
nc_galaxy_selfunc_ref (NcGalaxySelfunc *gsf);

Increase the reference of diff by one.

Parameters

gsf

a NcGalaxySelfunc

 

Returns

gsf .

[transfer full]


nc_galaxy_selfunc_free ()

void
nc_galaxy_selfunc_free (NcGalaxySelfunc *gsf);

Decrease the reference count of diff by one.

Parameters

gsf

a NcGalaxySelfunc

 

nc_galaxy_selfunc_clear ()

void
nc_galaxy_selfunc_clear (NcGalaxySelfunc **gsf);

Decrease the reference count of diff by one, and sets the pointer *diff to NULL.

Parameters

gsf

a NcGalaxySelfunc

 

nc_galaxy_selfunc_set_nshells ()

void
nc_galaxy_selfunc_set_nshells (NcGalaxySelfunc *gsf,
                               const guint nshells);

Sets the number of shells in gsf . This also delete all data inside gsf if nshells is different from the current value.

Parameters

gsf

a NcGalaxySelfunc

 

nshells

number of shells

 

nc_galaxy_selfunc_get_nshells ()

guint
nc_galaxy_selfunc_get_nshells (NcGalaxySelfunc *gsf);

Gets the current number of shells in gsf .

Parameters

gsf

a NcGalaxySelfunc

 

Returns

the current number of shells.


nc_galaxy_selfunc_set_shell_splines ()

void
nc_galaxy_selfunc_set_shell_splines (NcGalaxySelfunc *gsf,
                                     NcmObjArray *dNdz_a);

Sets splines for each shell using the splines in dNdz_a .

Parameters

gsf

a NcGalaxySelfunc

 

dNdz_a

a NcmObjArray

 

nc_galaxy_selfunc_get_shell_splines ()

NcmObjArray *
nc_galaxy_selfunc_get_shell_splines (NcGalaxySelfunc *gsf);

Gets the shell splines.

Parameters

gsf

a NcGalaxySelfunc

 

Returns

the current shell splines array.


nc_galaxy_selfunc_load_from_txts ()

void
nc_galaxy_selfunc_load_from_txts (NcGalaxySelfunc *gsf,
                                  const gchar *prefix,
                                  const gchar *suffix);

Reads each shell selection function from files. The files are named as prefix.n .suffix or prefix.n if suffix is NULL. The value of n goes from 0 to nshells - 1. Each file must contain pairs of doubles describing the redshift its corresponding selection function value.

Parameters

gsf

a NcGalaxySelfunc

 

prefix

files prefix

 

suffix

files prefix.

[nullable]

nc_galaxy_selfunc_eval ()

gdouble
nc_galaxy_selfunc_eval (NcGalaxySelfunc *gsf,
                        const guint shell,
                        const gdouble z);

Evaluates the shell -th shell at redshift $z=$z .

Parameters

gsf

a NcGalaxySelfunc

 

shell

shell number

 

z

redshift $z$

 

Returns

the selection function at shell and z .


nc_galaxy_selfunc_get_zmin ()

gdouble
nc_galaxy_selfunc_get_zmin (NcGalaxySelfunc *gsf,
                            const guint shell);

Gets the shell -th shell lowest redshift.

Parameters

gsf

a NcGalaxySelfunc

 

shell

shell number

 

Returns

the lowest redshift at shell .


nc_galaxy_selfunc_get_zmean ()

gdouble
nc_galaxy_selfunc_get_zmean (NcGalaxySelfunc *gsf,
                             const guint shell);

Gets the shell -th shell mean redshift.

Parameters

gsf

a NcGalaxySelfunc

 

shell

shell number

 

Returns

the mean redshift at shell .


nc_galaxy_selfunc_get_zmax ()

gdouble
nc_galaxy_selfunc_get_zmax (NcGalaxySelfunc *gsf,
                            const guint shell);

Gets the shell -th shell maximum redshift.

Parameters

gsf

a NcGalaxySelfunc

 

shell

shell number

 

Returns

the maximum redshift at shell .

Property Details

The “nshells” property

  “nshells”                  guint

Galaxy survey number of redshift shells.

Owner: NcGalaxySelfunc

Flags: Read / Write / Construct

Allowed values: >= 1

Default value: 1


The “shell-splines” property

  “shell-splines”            NcmObjArray *

Galaxy survey shell splines.

Owner: NcGalaxySelfunc

Flags: Read / Write