NcGalaxyRedshiftSpec

NcGalaxyRedshiftSpec — Class describing spectroscopic galaxy redshifts.

Properties

gdouble z-spec Read / Write / Construct

Object Hierarchy

    GObject
    ╰── NcGalaxyRedshift
        ╰── NcGalaxyRedshiftSpec

Description

Class used to define a generic galaxy redshift probability distribution $P_g(z) = \delta(z - z_\mathrm{spec})$.

Functions

nc_galaxy_redshift_spec_new ()

NcGalaxyRedshiftSpec *
nc_galaxy_redshift_spec_new (const gdouble z_spec);

Creates a new NcGalaxyRedshiftSpec with $z_\mathrm{spec}$ = z_spec .

Parameters

z_spec

the spectroscopic redshift $z_\mathrm{spec}$

 

Returns

The newly created NcGalaxyRedshiftSpec.

[transfer full]


nc_galaxy_redshift_spec_ref ()

NcGalaxyRedshiftSpec *
nc_galaxy_redshift_spec_ref (NcGalaxyRedshiftSpec *gzs);

Increase the reference of gzs by one.

Parameters

Returns

gzs .

[transfer full]


nc_galaxy_redshift_spec_free ()

void
nc_galaxy_redshift_spec_free (NcGalaxyRedshiftSpec *gzs);

Decrease the reference count of gzs by one.

Parameters


nc_galaxy_redshift_spec_clear ()

void
nc_galaxy_redshift_spec_clear (NcGalaxyRedshiftSpec **gzs);

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

Parameters


nc_galaxy_redshift_spec_set_z ()

void
nc_galaxy_redshift_spec_set_z (NcGalaxyRedshiftSpec *gzs,
                               const gdouble z_spec);

Sets $z_\mathrm{spec}$ = z_spec .

Parameters

gzs

a NcGalaxyRedshiftSpec

 

z_spec

the spectroscopic redshift $z_\mathrm{spec}$

 

nc_galaxy_redshift_spec_get_z ()

gdouble
nc_galaxy_redshift_spec_get_z (NcGalaxyRedshiftSpec *gzs);

Gets $z_\mathrm{spec}$.

Parameters

Returns

$z_\mathrm{spec}$.

Property Details

The “z-spec” property

  “z-spec”                   gdouble

Spectroscopic redshift.

Owner: NcGalaxyRedshiftSpec

Flags: Read / Write / Construct

Allowed values: >= 0

Default value: 0