NcmPowspecCorr3d

NcmPowspecCorr3d — Class to compute filtered power spectrum

Properties

gdouble lnr0 Read / Write
NcmPowspec * powerspectrum Read / Write / Construct Only
gdouble reltol Read / Write / Construct
gdouble reltol-z Read / Write / Construct
gdouble zf Read / Write
gdouble zi Read / Write

Types and Values

Object Hierarchy

    GObject
    ╰── NcmPowspecCorr3d

Description

This class computes the 3d spatial correlation function $\xi(r)$ from the power spectrum using the FFTLog approach (see NcmFftlog), \begin{equation}\lable{eq:variance} \sigma^2(r, z) = \frac{1}{2\pi^2} \int_0^\infty k^2 \ P(k, z) j_0(kr) \ \mathrm{d}k, \end{equation} where $P(k, z)$ is the power spectrum at mode $k$ and redshift $z$ and $j_0(kr)$ is the order zero spherical bessel function.

Functions

ncm_powspec_corr3d_new ()

NcmPowspecCorr3d *
ncm_powspec_corr3d_new (NcmPowspec *ps);

Creates a new NcmPowspecCorr3d from the power spectrum ps .

Parameters

ps

a NcmPowspec

 

Returns

the newly created NcmPowspecCorr3d.

[transfer full]


ncm_powspec_corr3d_ref ()

NcmPowspecCorr3d *
ncm_powspec_corr3d_ref (NcmPowspecCorr3d *psc);

Increases the reference count of psc by one.

Parameters

psc

a NcmPowspecCorr3d

 

Returns

psc .

[transfer full]


ncm_powspec_corr3d_free ()

void
ncm_powspec_corr3d_free (NcmPowspecCorr3d *psc);

Decreases the reference count of psc by one.

Parameters

psc

a NcmPowspecCorr3d

 

ncm_powspec_corr3d_clear ()

void
ncm_powspec_corr3d_clear (NcmPowspecCorr3d **psc);

If psc is different from NULL, decreases the reference count of psc by one and sets fftlog to NULL.

Parameters

psc

a NcmPowspecCorr3d

 

ncm_powspec_corr3d_prepare ()

void
ncm_powspec_corr3d_prepare (NcmPowspecCorr3d *psc,
                            NcmModel *model);

Prepares the object applying the filter to the power spectrum.

Parameters

psc

a NcmPowspecCorr3d

 

model

a NcmModel

 

ncm_powspec_corr3d_prepare_if_needed ()

void
ncm_powspec_corr3d_prepare_if_needed (NcmPowspecCorr3d *psc,
                                      NcmModel *model);

Prepares (if necessary) the object applying the filter to the power spectrum.

Parameters

psc

a NcmPowspecCorr3d

 

model

a NcmModel

 

ncm_powspec_corr3d_set_lnr0 ()

void
ncm_powspec_corr3d_set_lnr0 (NcmPowspecCorr3d *psc,
                             gdouble lnr0);

FIXME

Parameters

psc

a NcmPowspecCorr3d

 

lnr0

the output center value $\ln(r_0)$

 

ncm_powspec_corr3d_set_best_lnr0 ()

void
ncm_powspec_corr3d_set_best_lnr0 (NcmPowspecCorr3d *psc);

FIXME

Parameters

psc

a NcmPowspecCorr3d

 

ncm_powspec_corr3d_set_zi ()

void
ncm_powspec_corr3d_set_zi (NcmPowspecCorr3d *psc,
                           gdouble zi);

FIXME

Parameters

psc

a NcmPowspecCorr3d

 

zi

the output initial time $z_i$

 

ncm_powspec_corr3d_set_zf ()

void
ncm_powspec_corr3d_set_zf (NcmPowspecCorr3d *psc,
                           gdouble zf);

FIXME

Parameters

psc

a NcmPowspecCorr3d

 

zf

the output final time $z_f$

 

ncm_powspec_corr3d_get_r_min ()

gdouble
ncm_powspec_corr3d_get_r_min (NcmPowspecCorr3d *psc);

FIXME

Parameters

psc

a NcmPowspecCorr3d

 

Returns

FIXME


ncm_powspec_corr3d_get_r_max ()

gdouble
ncm_powspec_corr3d_get_r_max (NcmPowspecCorr3d *psc);

FIXME

Parameters

psc

a NcmPowspecCorr3d

 

Returns

FIXME


ncm_powspec_corr3d_eval_xi_lnr ()

gdouble
ncm_powspec_corr3d_eval_xi_lnr (NcmPowspecCorr3d *psc,
                                const gdouble z,
                                const gdouble lnr);

Evaluates the function $\xi(z, r)$ at lnr and z .

Parameters

psc

a NcmPowspecCorr3d

 

z

redshift

 

lnr

logarithm base e of $r$

 

Returns

FIXME


ncm_powspec_corr3d_eval_xi ()

gdouble
ncm_powspec_corr3d_eval_xi (NcmPowspecCorr3d *psc,
                            const gdouble z,
                            const gdouble r);

Evaluate the function $\xi(z, r)$ at r and z .

Parameters

psc

a NcmPowspecCorr3d

 

z

redshift

 

r

FIXME

 

Returns

FIXME

Types and Values

NCM_POWSPEC_CORR3D_DEFAULT_SIZE

#define NCM_POWSPEC_CORR3D_DEFAULT_SIZE (200)

Property Details

The “lnr0” property

  “lnr0”                     gdouble

Output center value.

Owner: NcmPowspecCorr3d

Flags: Read / Write

Default value: 0


The “powerspectrum” property

  “powerspectrum”            NcmPowspec *

NcmPowspec object.

Owner: NcmPowspecCorr3d

Flags: Read / Write / Construct Only


The “reltol” property

  “reltol”                   gdouble

Relative tolerance for calibration.

Owner: NcmPowspecCorr3d

Flags: Read / Write / Construct

Allowed values: [2.22045e-16,1]

Default value: 0.001


The “reltol-z” property

  “reltol-z”                 gdouble

Relative tolerance for calibration in the redshift direction.

Owner: NcmPowspecCorr3d

Flags: Read / Write / Construct

Allowed values: [2.22045e-16,1]

Default value: 1e-06


The “zf” property

  “zf”                       gdouble

Output final time.

Owner: NcmPowspecCorr3d

Flags: Read / Write

Default value: 1


The “zi” property

  “zi”                       gdouble

Output initial time.

Owner: NcmPowspecCorr3d

Flags: Read / Write

Default value: 0