NcGalaxyRedshiftSpline: NumCosmo Reference Manual

NcGalaxyRedshiftSpline

NcGalaxyRedshiftSpline — Class describing spectroscopic galaxy redshifts.

Functions

NcGalaxyRedshiftSpline *	nc_galaxy_redshift_spline_new ()
NcGalaxyRedshiftSpline *	nc_galaxy_redshift_spline_ref ()
void	nc_galaxy_redshift_spline_free ()
void	nc_galaxy_redshift_spline_clear ()
void	nc_galaxy_redshift_spline_set_z_best ()
gdouble	nc_galaxy_redshift_spline_get_z_best ()
void	nc_galaxy_redshift_spline_init_from_vectors ()

Properties

NcmObjArray *	dists	Read / Write
double	z-best	Read / Write

Types and Values

#define

NC_GALAXY_REDSHIFT_SPLINE_LKNOT_DROP

Object Hierarchy

    GObject
    ╰── NcGalaxyRedshift
        ╰── NcGalaxyRedshiftSpline

Description

Class used to define a generic galaxy redshift probability distribution $P^g_i(z)$ using splines for each disjoint interval $i$.

Functions

nc_galaxy_redshift_spline_new ()

NcGalaxyRedshiftSpline *
nc_galaxy_redshift_spline_new (void);

Creates a new NcGalaxyRedshiftSpline.

Returns

The newly created NcGalaxyRedshiftSpline.

[transfer full]

nc_galaxy_redshift_spline_ref ()

NcGalaxyRedshiftSpline *
nc_galaxy_redshift_spline_ref (NcGalaxyRedshiftSpline *gzs);

Increase the reference of gzs by one.

Parameters

gzs

a NcGalaxyRedshiftSpline

Returns

gzs .

[transfer full]

nc_galaxy_redshift_spline_free ()

void
nc_galaxy_redshift_spline_free (NcGalaxyRedshiftSpline *gzs);

Decrease the reference count of gzs by one.

Parameters

gzs

a NcGalaxyRedshiftSpline

nc_galaxy_redshift_spline_clear ()

void
nc_galaxy_redshift_spline_clear (NcGalaxyRedshiftSpline **gzs);

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

Parameters

gzs

a NcGalaxyRedshiftSpline

nc_galaxy_redshift_spline_set_z_best ()

void
nc_galaxy_redshift_spline_set_z_best (NcGalaxyRedshiftSpline *gzs,
                                      const gdouble z_best);

Sets the mode of the redshift distribution z_best .

Parameters

gzs	a NcGalaxyRedshiftSpline
z_best	the mode of the redshift distribution

nc_galaxy_redshift_spline_get_z_best ()

gdouble
nc_galaxy_redshift_spline_get_z_best (NcGalaxyRedshiftSpline *gzs);

Gets $z_\mathrm{best}$, the mode of the redshift distribution.

Parameters

gzs

a NcGalaxyRedshiftSpline

Returns

$z_\mathrm{best}$.

nc_galaxy_redshift_spline_init_from_vectors ()

void
nc_galaxy_redshift_spline_init_from_vectors
                               (NcGalaxyRedshiftSpline *gzs,
                                NcmVector *zv,
                                NcmVector *Pzv);

Initialize gzs (cleaning any previous data) using the data from z and Pzv .

Parameters

gzs	a NcGalaxyRedshiftSpline
zv	a NcmVector containing the redshift knots
Pzv	a NcmVector containing the $P(z)$ at the redshift knots

Types and Values

NC_GALAXY_REDSHIFT_SPLINE_LKNOT_DROP

#define NC_GALAXY_REDSHIFT_SPLINE_LKNOT_DROP (-2.0 * M_LN10)

Property Details

The `“dists”` property

  “dists”                    NcmObjArray *

Distribution objects.

Owner: NcGalaxyRedshiftSpline

Flags: Read / Write

The `“z-best”` property

  “z-best”                   double

Distributions mode.

Owner: NcGalaxyRedshiftSpline

Flags: Read / Write

Allowed values: >= 0

Default value: 0