NcGalaxyRedshiftGauss: NumCosmo Reference Manual

NcGalaxyRedshiftGauss

NcGalaxyRedshiftGauss — Class describing Gaussian photometric galaxy redshifts.

Stability Level

Unstable, unless otherwise indicated

Functions

NcGalaxyRedshiftGauss *	nc_galaxy_redshift_gauss_new ()
NcGalaxyRedshiftGauss *	nc_galaxy_redshift_gauss_ref ()
void	nc_galaxy_redshift_gauss_free ()
void	nc_galaxy_redshift_gauss_clear ()
void	nc_galaxy_redshift_gauss_set_obs ()
NcmMatrix *	nc_galaxy_redshift_gauss_peek_obs ()
guint	nc_galaxy_redshift_gauss_len ()

Properties

NcmMatrix *

obs

Read / Write

Object Hierarchy

    GObject
    ╰── NcGalaxyRedshift
        ╰── NcGalaxyRedshiftGauss

Description

Class used to define a generic galaxy redshift probability distribution $P^g_i(z)$.

Functions

nc_galaxy_redshift_gauss_new ()

NcGalaxyRedshiftGauss *
nc_galaxy_redshift_gauss_new (void);

Creates a new NcGalaxyRedshiftGauss.

Returns

The newly created NcGalaxyRedshiftGauss.

[transfer full]

nc_galaxy_redshift_gauss_ref ()

NcGalaxyRedshiftGauss *
nc_galaxy_redshift_gauss_ref (NcGalaxyRedshiftGauss *gzg);

Increase the reference of gzg by one.

Parameters

gzg

a NcGalaxyRedshiftGauss

Returns

gzg .

[transfer full]

nc_galaxy_redshift_gauss_free ()

void
nc_galaxy_redshift_gauss_free (NcGalaxyRedshiftGauss *gzg);

Decrease the reference count of gzg by one.

Parameters

gzg

a NcGalaxyRedshiftGauss

nc_galaxy_redshift_gauss_clear ()

void
nc_galaxy_redshift_gauss_clear (NcGalaxyRedshiftGauss **gzg);

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

Parameters

gzg

a NcGalaxyRedshiftGauss

nc_galaxy_redshift_gauss_set_obs ()

void
nc_galaxy_redshift_gauss_set_obs (NcGalaxyRedshiftGauss *gzg,
                                  NcmMatrix *obs);

Sets the observables of the redshift distribution through the matrix obs . obs should contain two columns where the first contain the mean redshift $\bar{z}$ and the second the standard deviation $\sigma_z$.

Parameters

gzg	a NcGalaxyRedshiftGauss
obs	a NcmMatrix

nc_galaxy_redshift_gauss_peek_obs ()

NcmMatrix *
nc_galaxy_redshift_gauss_peek_obs (NcGalaxyRedshiftGauss *gzg);

Gets observations matrix.

Parameters

gzg

a NcGalaxyRedshiftGauss

Returns

observations matrix.

[transfer none]

nc_galaxy_redshift_gauss_len ()

guint
nc_galaxy_redshift_gauss_len (NcGalaxyRedshiftGauss *gzg);

Property Details

The `“obs”` property

  “obs”                      NcmMatrix *

Redshift observables.

Owner: NcGalaxyRedshiftGauss

Flags: Read / Write