Class

NumCosmoMathSkyFootprint

Description [src]

abstract class NumCosmoMath.SkyFootprint : GObject.Object
{
  /* No available fields */
}

Abstract sky region with sampling and density.

A generic, cosmology-agnostic description of a region of the celestial sphere in right ascension and declination. It provides uniform sampling of positions within the region (ncm_sky_footprint_gen_ra_dec()), a membership test (ncm_sky_footprint_contains()), the solid angle (ncm_sky_footprint_get_area()) and the normalized position density (ncm_sky_footprint_density() and its log).

It is meant to be shared by composition: both the galaxy sample position distribution used in weak-lensing likelihoods and the halo/cluster mock generators hold a footprint and delegate their sky sampling and geometry to it. Concrete shapes (for example NcmSkyFootprintRectangular) implement the virtual methods.

Ancestors

GObject

Descendants

NcmSkyFootprintRectangular

Functions

ncm_sky_footprint_clear

If footprint is different from NULL, decreases its reference count and sets footprint to NULL.

Instance methods

ncm_sky_footprint_contains

Checks whether the position (ra, dec) lies within footprint.

ncm_sky_footprint_density

Computes the normalized position density at (ra, dec), in units of inverse square degree, returning zero outside the footprint.

ncm_sky_footprint_free

Decreases the reference count of footprint by one.

ncm_sky_footprint_gen_ra_dec

Samples a position uniformly distributed within footprint.

ncm_sky_footprint_get_area

Gets the solid angle covered by footprint.

ncm_sky_footprint_ln_density

Computes the natural logarithm of the normalized position density at (ra, dec), returning negative infinity outside the footprint.

ncm_sky_footprint_ref

Increases the reference count of footprint by one.

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Signals

Signals inherited from GObject (1)

GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure

struct NumCosmoMathSkyFootprintClass {
  void (* gen_ra_dec) (
    NcmSkyFootprint* footprint,
    NcmRNG* rng,
    gdouble* ra,
    gdouble* dec
  );
  gboolean (* contains) (
    NcmSkyFootprint* footprint,
    const gdouble ra,
    const gdouble dec
  );
  gdouble (* get_area) (
    NcmSkyFootprint* footprint
  );
  gdouble (* density) (
    NcmSkyFootprint* footprint,
    const gdouble ra,
    const gdouble dec
  );
  gdouble (* ln_density) (
    NcmSkyFootprint* footprint,
    const gdouble ra,
    const gdouble dec
  );
  
}

No description available.

Class members

gen_ra_dec: void (* gen_ra_dec) ( NcmSkyFootprint* footprint, NcmRNG* rng, gdouble* ra, gdouble* dec ): No description available.
contains: gboolean (* contains) ( NcmSkyFootprint* footprint, const gdouble ra, const gdouble dec ): No description available.
get_area: gdouble (* get_area) ( NcmSkyFootprint* footprint ): No description available.
density: gdouble (* density) ( NcmSkyFootprint* footprint, const gdouble ra, const gdouble dec ): No description available.
ln_density: gdouble (* ln_density) ( NcmSkyFootprint* footprint, const gdouble ra, const gdouble dec ): No description available.