|
Triumvirate C++ API 0.5.0
Three-point clustering measurements in large-scale structure analyses.
|
Namespaces | |
| namespace | array |
| namespace | io |
| namespace | maths |
| namespace | sys |
Classes | |
| struct | BinnedVectors |
| Binned vectors. More... | |
| class | Binning |
| Isotropic coordinate binning. More... | |
| struct | BispecMeasurements |
| Bispectrum measurements. More... | |
| class | FieldStats |
| Field (pseudo-two-point) statistics. More... | |
| struct | LineOfSight |
| Line-of-sight vector. More... | |
| class | MeshField |
| Discretely sampled field on a mesh grid from particle catalogues. More... | |
| class | ParameterSet |
| Parameter set. More... | |
| class | ParticleCatalogue |
| Particle catalogue. More... | |
| struct | ParticleData |
| Particle data container. More... | |
| struct | PowspecMeasurements |
| Power spectrum measurements. More... | |
| struct | SphericalOrderTriplet |
| Spherical order triplet \( (m_1, m_2, M) \). More... | |
| struct | ThreePCFMeasurements |
| Three-point correlation function measurements. More... | |
| struct | ThreePCFWindowMeasurements |
| Three-point correlation function window measurements. More... | |
| struct | TwoPCFMeasurements |
| Two-point correlation function measurements. More... | |
| struct | TwoPCFWindowMeasurements |
| Two-point correlation function window measurements. More... | |
Functions | |
| double | calc_coupling_coeff_3pt (int ell1, int ell2, int ELL, int m1, int m2, int M) |
| Calculate the coupling coefficient for spherical-harmonic components of full three-point statistics. | |
| void | validate_multipole_coupling (trv::ParameterSet ¶ms) |
| Validate three-point correlator multipoles are non-vanishing. | |
| double | calc_bispec_normalisation_from_particles (ParticleCatalogue &particles, double alpha=1.) |
| Calculate particle-based bispectrum normalisation. | |
| double | calc_bispec_normalisation_from_mesh (ParticleCatalogue &particles, trv::ParameterSet ¶ms, double alpha=1.) |
| Calculate mesh-based bispectrum normalisation. | |
| std::complex< double > | calc_ylm_wgtd_shotnoise_amp_for_bispec (ParticleCatalogue &particles_data, ParticleCatalogue &particles_rand, LineOfSight *los_data, LineOfSight *los_rand, double alpha, int ell, int m) |
| Calculate bispectrum shot noise amplitude weighted by reduced spherical harmonics. | |
| std::complex< double > | calc_ylm_wgtd_shotnoise_amp_for_bispec (ParticleCatalogue &particles, LineOfSight *los, double alpha, int ell, int m) |
| Calculate bispectrum shot noise amplitude weighted by reduced spherical harmonics. | |
| trv::BispecMeasurements | compute_bispec (ParticleCatalogue &catalogue_data, ParticleCatalogue &catalogue_rand, LineOfSight *los_data, LineOfSight *los_rand, trv::ParameterSet ¶ms, trv::Binning &kbinning, double norm_factor) |
| Compute bispectrum from paired survey-type catalogues. | |
| trv::ThreePCFMeasurements | compute_3pcf (ParticleCatalogue &catalogue_data, ParticleCatalogue &catalogue_rand, LineOfSight *los_data, LineOfSight *los_rand, trv::ParameterSet ¶ms, trv::Binning &rbinning, double norm_factor) |
| Compute three-point correlation function from paired survey-type catalogues. | |
| trv::BispecMeasurements | compute_bispec_in_gpp_box (ParticleCatalogue &catalogue_data, trv::ParameterSet ¶ms, trv::Binning kbinning, double norm_factor) |
| Compute bispectrum in a periodic box in the global plane-parallel approximation. | |
| trv::ThreePCFMeasurements | compute_3pcf_in_gpp_box (ParticleCatalogue &catalogue_data, trv::ParameterSet ¶ms, trv::Binning &rbinning, double norm_factor) |
| Compute three-point correlation function in a periodic box in the global plane-parallel approximation. | |
| trv::ThreePCFWindowMeasurements | compute_3pcf_window (ParticleCatalogue &catalogue_rand, LineOfSight *los_rand, trv::ParameterSet ¶ms, trv::Binning &rbinning, double alpha, double norm_factor, bool wide_angle=false) |
| Compute three-point correlation function window from a random catalogue. | |
| double | calc_coupling_coeff_2pt (int ell, int ELL, int m, int M) |
| Calculate the coupling coefficient for spherical-harmonic components of full two-point statistics. | |
| double | calc_powspec_normalisation_from_particles (ParticleCatalogue &particles, double alpha=1.) |
| Calculate particle-based power spectrum normalisation. | |
| double | calc_powspec_normalisation_from_mesh (trv::ParticleCatalogue &particles, trv::ParameterSet ¶ms, double alpha=1.) |
| Calculate mesh-based power spectrum normalisation. | |
| double | calc_powspec_normalisation_from_meshes (trv::ParticleCatalogue &particles_data, trv::ParticleCatalogue &particles_rand, trv::ParameterSet ¶ms, double alpha) |
| Calculate power spectrum normalisation from mixed meshes. | |
| double | calc_powspec_normalisation_from_meshes (trv::ParticleCatalogue &particles_data, trv::ParticleCatalogue &particles_rand, trv::ParameterSet ¶ms, double alpha, double padding, double cellsize, const std::string &assignment) |
| Calculate power spectrum normalisation from mixed meshes. | |
| double | calc_powspec_shotnoise_from_particles (ParticleCatalogue &particles, double alpha=1.) |
| Calculate particle-based power spectrum shot noise level. | |
| std::complex< double > | calc_ylm_wgtd_shotnoise_amp_for_powspec (ParticleCatalogue &particles_data, ParticleCatalogue &particles_rand, LineOfSight *los_data, LineOfSight *los_rand, double alpha, int ell, int m) |
| Calculate power spectrum shot noise weighted by reduced spherical harmonics. | |
| std::complex< double > | calc_ylm_wgtd_shotnoise_amp_for_powspec (ParticleCatalogue &particles, LineOfSight *los, double alpha, int ell, int m) |
| Calculate power spectrum shot noise weighted by reduced spherical harmonics. | |
| trv::PowspecMeasurements | compute_powspec (ParticleCatalogue &catalogue_data, ParticleCatalogue &catalogue_rand, LineOfSight *los_data, LineOfSight *los_rand, trv::ParameterSet ¶ms, trv::Binning &kbinning, double norm_factor) |
| Compute power spectrum from paired survey-type catalogues. | |
| trv::TwoPCFMeasurements | compute_corrfunc (ParticleCatalogue &catalogue_data, ParticleCatalogue &catalogue_rand, LineOfSight *los_data, LineOfSight *los_rand, trv::ParameterSet ¶ms, trv::Binning &rbinning, double norm_factor) |
| Compute two-point correlation function from paired survey-type catalogues. | |
| trv::PowspecMeasurements | compute_powspec_in_gpp_box (ParticleCatalogue &catalogue_data, trv::ParameterSet ¶ms, trv::Binning kbinning, double norm_factor) |
| Compute power spectrum in a periodic box in the global plane-parallel approximation. | |
| trv::TwoPCFMeasurements | compute_corrfunc_in_gpp_box (ParticleCatalogue &catalogue_data, trv::ParameterSet ¶ms, trv::Binning &rbinning, double norm_factor) |
| Compute two-point correlation function in a periodic box in the global plane-parallel approximation. | |
| trv::TwoPCFWindowMeasurements | compute_corrfunc_window (trv::ParticleCatalogue &catalogue_rand, trv::LineOfSight *los_rand, trv::ParameterSet ¶ms, trv::Binning rbinning, double alpha, double norm_factor) |
| Compute two-point correlation function window from a random catalogue and optionally save the results. | |
| double trv::calc_coupling_coeff_3pt | ( | int | ell1, |
| int | ell2, | ||
| int | ELL, | ||
| int | m1, | ||
| int | m2, | ||
| int | M ) |
Calculate the coupling coefficient for spherical-harmonic components of full three-point statistics.
The calculated quantity is
\[ (2\ell_1 + 1) (2\ell_2 + 1) (2L + 1) W(\ell_1, \ell_2, L; 0, 0, 0) W(\ell_1, \ell_2, L; m, 0, M) \,. \]
| ell1,ell2,ELL,m1,m2,M | Wigner 3-j components. |
Definition at line 63 of file threept.cpp.
Here is the call graph for this function:
Here is the caller graph for this function:| void trv::validate_multipole_coupling | ( | trv::ParameterSet & | params | ) |
Validate three-point correlator multipoles are non-vanishing.
| params | Parameter set. |
Definition at line 71 of file threept.cpp.
Here is the call graph for this function:
Here is the caller graph for this function:| double trv::calc_bispec_normalisation_from_particles | ( | ParticleCatalogue & | particles, |
| double | alpha = 1. ) |
Calculate particle-based bispectrum normalisation.
| particles | Particle catalogue. |
| alpha | Alpha contrast (default is 1.). |
Definition at line 94 of file threept.cpp.
Here is the call graph for this function:
Here is the caller graph for this function:| double trv::calc_bispec_normalisation_from_mesh | ( | ParticleCatalogue & | particles, |
| trv::ParameterSet & | params, | ||
| double | alpha = 1. ) |
Calculate mesh-based bispectrum normalisation.
| particles | Particle catalogue. |
| params | Parameter set. |
| alpha | Alpha contrast (default is 1.). |
Definition at line 136 of file threept.cpp.
Here is the call graph for this function:
Here is the caller graph for this function:| std::complex< double > trv::calc_ylm_wgtd_shotnoise_amp_for_bispec | ( | ParticleCatalogue & | particles_data, |
| ParticleCatalogue & | particles_rand, | ||
| LineOfSight * | los_data, | ||
| LineOfSight * | los_rand, | ||
| double | alpha, | ||
| int | ell, | ||
| int | m ) |
Calculate bispectrum shot noise amplitude weighted by reduced spherical harmonics.
This calculates the quantity
\[ \bar{S}_{LM} = {\sum_i}{\vphantom{\sum}}' y_{LM}^*(\vec{x}_i) w(\vec{x}_i)^3 \,, \]
where if a pair of catalogues are provided,
\[ {\sum_i}{\vphantom{\sum}}' = \sum_{i \in \mathrm{data}} - \alpha^3 \sum_{i \in \mathrm{rand}} \,, \]
and otherwise
\[ {\sum_i}{\vphantom{\sum}}' = \alpha^3 \sum_{i \in \mathrm{data\ or\ rand}} \,. \]
| particles_data | (Data-source) particle catalogue. |
| particles_rand | (Random-source) particle catalogue. |
| los_data | (Data-source) particle lines of sight. |
| los_rand | (Random-source) particle lines of sight. |
| alpha | Alpha contrast. |
| ell | Degree of the spherical harmonic. |
| m | Order of the spherical harmonic. |
Definition at line 154 of file threept.cpp.
Here is the caller graph for this function:| std::complex< double > trv::calc_ylm_wgtd_shotnoise_amp_for_bispec | ( | ParticleCatalogue & | particles, |
| LineOfSight * | los, | ||
| double | alpha, | ||
| int | ell, | ||
| int | m ) |
Calculate bispectrum shot noise amplitude weighted by reduced spherical harmonics.
| particles | Particle catalogue. |
| los | Particle lines of sight. |
| alpha | Alpha contrast. |
| ell | Degree of the spherical harmonic. |
| m | Order of the spherical harmonic. |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 208 of file threept.cpp.
| trv::BispecMeasurements trv::compute_bispec | ( | ParticleCatalogue & | catalogue_data, |
| ParticleCatalogue & | catalogue_rand, | ||
| LineOfSight * | los_data, | ||
| LineOfSight * | los_rand, | ||
| trv::ParameterSet & | params, | ||
| trv::Binning & | kbinning, | ||
| double | norm_factor ) |
Compute bispectrum from paired survey-type catalogues.
| catalogue_data | (Data-source) particle catalogue. |
| catalogue_rand | (Random-source) particle catalogue. |
| los_data | (Data-source) particle lines of sight. |
| los_rand | (Random-source) particle lines of sight. |
| params | Parameter set. |
| kbinning | Wavenumber binning. |
| norm_factor | Normalisation factor. |
Definition at line 246 of file threept.cpp.
Here is the call graph for this function:
Here is the caller graph for this function:| trv::ThreePCFMeasurements trv::compute_3pcf | ( | ParticleCatalogue & | catalogue_data, |
| ParticleCatalogue & | catalogue_rand, | ||
| LineOfSight * | los_data, | ||
| LineOfSight * | los_rand, | ||
| trv::ParameterSet & | params, | ||
| trv::Binning & | rbinning, | ||
| double | norm_factor ) |
Compute three-point correlation function from paired survey-type catalogues.
| catalogue_data | (Data-source) particle catalogue. |
| catalogue_rand | (Random-source) particle catalogue. |
| los_data | (Data-source) particle lines of sight. |
| los_rand | (Random-source) particle lines of sight. |
| params | Parameter set. |
| rbinning | Separation binning. |
| norm_factor | Normalisation factor. |
Definition at line 986 of file threept.cpp.
Here is the call graph for this function:
Here is the caller graph for this function:| trv::BispecMeasurements trv::compute_bispec_in_gpp_box | ( | ParticleCatalogue & | catalogue_data, |
| trv::ParameterSet & | params, | ||
| trv::Binning | kbinning, | ||
| double | norm_factor ) |
Compute bispectrum in a periodic box in the global plane-parallel approximation.
| catalogue_data | (Data-source) particle catalogue. |
| params | Parameter set. |
| kbinning | Wavenumber binning. |
| norm_factor | Normalisation factor. |
Definition at line 1423 of file threept.cpp.
Here is the call graph for this function:
Here is the caller graph for this function:| trv::ThreePCFMeasurements trv::compute_3pcf_in_gpp_box | ( | ParticleCatalogue & | catalogue_data, |
| trv::ParameterSet & | params, | ||
| trv::Binning & | rbinning, | ||
| double | norm_factor ) |
Compute three-point correlation function in a periodic box in the global plane-parallel approximation.
| catalogue_data | (Data-source) particle catalogue. |
| params | Parameter set. |
| rbinning | Separation binning. |
| norm_factor | Normalisation factor. |
Definition at line 2115 of file threept.cpp.
Here is the call graph for this function:
Here is the caller graph for this function:| trv::ThreePCFWindowMeasurements trv::compute_3pcf_window | ( | ParticleCatalogue & | catalogue_rand, |
| LineOfSight * | los_rand, | ||
| trv::ParameterSet & | params, | ||
| trv::Binning & | rbinning, | ||
| double | alpha, | ||
| double | norm_factor, | ||
| bool | wide_angle = false ) |
Compute three-point correlation function window from a random catalogue.
| catalogue_rand | (Random-source) particle catalogue. |
| los_rand | (Random-source) particle lines of sight. |
| params | Parameter set. |
| rbinning | Separation binning. |
| alpha | Alpha contrast. |
| norm_factor | Normalisation factor. |
| wide_angle | Whether wide-angle corrections or not (default is false). |
Definition at line 2525 of file threept.cpp.
Here is the call graph for this function:
Here is the caller graph for this function:| double trv::calc_coupling_coeff_2pt | ( | int | ell, |
| int | ELL, | ||
| int | m, | ||
| int | M ) |
Calculate the coupling coefficient for spherical-harmonic components of full two-point statistics.
The calculated quantity is
\[ (2\ell + 1) (2L + 1) W(\ell, 0, L; m, 0, M) \,. \]
| ell,ELL,m,M | Wigner 3-j components. |
Definition at line 43 of file twopt.cpp.
Here is the call graph for this function:
Here is the caller graph for this function:| double trv::calc_powspec_normalisation_from_particles | ( | ParticleCatalogue & | particles, |
| double | alpha = 1. ) |
Calculate particle-based power spectrum normalisation.
| particles | Particle catalogue. |
| alpha | Alpha contrast (default is 1.). |
Definition at line 54 of file twopt.cpp.
Here is the call graph for this function:
Here is the caller graph for this function:| double trv::calc_powspec_normalisation_from_mesh | ( | trv::ParticleCatalogue & | particles, |
| trv::ParameterSet & | params, | ||
| double | alpha = 1. ) |
Calculate mesh-based power spectrum normalisation.
| particles | Particle catalogue. |
| params | Parameter set. |
| alpha | Alpha contrast (default is 1.). |
Definition at line 96 of file twopt.cpp.
Here is the call graph for this function:
Here is the caller graph for this function:| double trv::calc_powspec_normalisation_from_meshes | ( | trv::ParticleCatalogue & | particles_data, |
| trv::ParticleCatalogue & | particles_rand, | ||
| trv::ParameterSet & | params, | ||
| double | alpha ) |
Calculate power spectrum normalisation from mixed meshes.
This normalisation convention is used for paired survey-type catalogues only, where the two meshes come from separate data- and random-source particle catalogues.
pypower documentation.| particles_data | Data-source particle catalogue. |
| particles_rand | Random-source particle catalogue. |
| params | Parameter set. |
| alpha | Alpha contrast. |
Definition at line 109 of file twopt.cpp.
Here is the call graph for this function:
Here is the caller graph for this function:| double trv::calc_powspec_normalisation_from_meshes | ( | trv::ParticleCatalogue & | particles_data, |
| trv::ParticleCatalogue & | particles_rand, | ||
| trv::ParameterSet & | params, | ||
| double | alpha, | ||
| double | padding, | ||
| double | cellsize, | ||
| const std::string & | assignment ) |
Calculate power spectrum normalisation from mixed meshes.
The box size per dimension is internally determined by the particle coordinate extents, with a padding factor applied. The mesh number in each dimension is determined by the box size and the cell size.
| particles_data | Data-source particle catalogue. |
| particles_rand | Random-source particle catalogue. |
| params | Parameter set. |
| alpha | Alpha contrast. |
| padding | Padding factor for the box size in each dimension. This overrides the box size set in the parameter set. |
| cellsize | Cell size of the mesh grid in each dimension. This overrides the mesh number set in the parameter set. |
| assignment | Assignment scheme for particles to mesh. This overrides the assignment scheme set in the parameter set. |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 182 of file twopt.cpp.
Here is the call graph for this function:| double trv::calc_powspec_shotnoise_from_particles | ( | ParticleCatalogue & | particles, |
| double | alpha = 1. ) |
| std::complex< double > trv::calc_ylm_wgtd_shotnoise_amp_for_powspec | ( | ParticleCatalogue & | particles_data, |
| ParticleCatalogue & | particles_rand, | ||
| LineOfSight * | los_data, | ||
| LineOfSight * | los_rand, | ||
| double | alpha, | ||
| int | ell, | ||
| int | m ) |
Calculate power spectrum shot noise weighted by reduced spherical harmonics.
This calculates the quantity
\[ \bar{N}_{LM}(\vec{x}) = {\sum_i}{\vphantom{\sum}}' y_{LM}^*(\hat{\vec{x}}) w(\vec{x})^2 \,, \]
where if a pair of catalogues are provided,
\[ {\sum_i}{\vphantom{\sum}}' = \sum_{i \in \mathrm{data}} + \alpha^2 \sum_{i \in \mathrm{rand}} \,, \]
and otherwise
\[ {\sum_i}{\vphantom{\sum}}' = \alpha^2 \sum_{i \in \mathrm{data\ or\ rand}} \,. \]
| particles_data | (Data-source) particle catalogue. |
| particles_rand | (Random-source) particle catalogue. |
| los_data | (Data-source) particle lines of sight. |
| los_rand | (Random-source) particle lines of sight. |
| alpha | Alpha contrast. |
| ell | Degree of the spherical harmonic. |
| m | Order of the spherical harmonic. |
Definition at line 250 of file twopt.cpp.
Here is the caller graph for this function:| std::complex< double > trv::calc_ylm_wgtd_shotnoise_amp_for_powspec | ( | ParticleCatalogue & | particles, |
| LineOfSight * | los, | ||
| double | alpha, | ||
| int | ell, | ||
| int | m ) |
Calculate power spectrum shot noise weighted by reduced spherical harmonics.
| particles | Particle catalogue. |
| los | Particle lines of sight. |
| alpha | Alpha contrast. |
| ell | Degree of the spherical harmonic. |
| m | Order of the spherical harmonic. |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
| trv::PowspecMeasurements trv::compute_powspec | ( | ParticleCatalogue & | catalogue_data, |
| ParticleCatalogue & | catalogue_rand, | ||
| LineOfSight * | los_data, | ||
| LineOfSight * | los_rand, | ||
| trv::ParameterSet & | params, | ||
| trv::Binning & | kbinning, | ||
| double | norm_factor ) |
Compute power spectrum from paired survey-type catalogues.
| catalogue_data | (Data-source) particle catalogue. |
| catalogue_rand | (Random-source) particle catalogue. |
| los_data | (Data-source) particle lines of sight. |
| los_rand | (Random-source) particle lines of sight. |
| params | Parameter set. |
| kbinning | Wavenumber binning. |
| norm_factor | Normalisation factor. |
Definition at line 340 of file twopt.cpp.
Here is the call graph for this function:
Here is the caller graph for this function:| trv::TwoPCFMeasurements trv::compute_corrfunc | ( | ParticleCatalogue & | catalogue_data, |
| ParticleCatalogue & | catalogue_rand, | ||
| LineOfSight * | los_data, | ||
| LineOfSight * | los_rand, | ||
| trv::ParameterSet & | params, | ||
| trv::Binning & | rbinning, | ||
| double | norm_factor ) |
Compute two-point correlation function from paired survey-type catalogues.
| catalogue_data | (Data-source) particle catalogue. |
| catalogue_rand | (Random-source) particle catalogue. |
| los_data | (Data-source) particle lines of sight. |
| los_rand | (Random-source) particle lines of sight. |
| params | Parameter set. |
| rbinning | Separation binning. |
| norm_factor | Normalisation factor. |
Definition at line 454 of file twopt.cpp.
Here is the call graph for this function:
Here is the caller graph for this function:| trv::PowspecMeasurements trv::compute_powspec_in_gpp_box | ( | ParticleCatalogue & | catalogue_data, |
| trv::ParameterSet & | params, | ||
| trv::Binning | kbinning, | ||
| double | norm_factor ) |
Compute power spectrum in a periodic box in the global plane-parallel approximation.
| catalogue_data | (Data-source) particle catalogue. |
| params | Parameter set. |
| kbinning | Wavenumber binning. |
| norm_factor | Normalisation factor. |
Definition at line 568 of file twopt.cpp.
Here is the call graph for this function:
Here is the caller graph for this function:| trv::TwoPCFMeasurements trv::compute_corrfunc_in_gpp_box | ( | ParticleCatalogue & | catalogue_data, |
| trv::ParameterSet & | params, | ||
| trv::Binning & | rbinning, | ||
| double | norm_factor ) |
Compute two-point correlation function in a periodic box in the global plane-parallel approximation.
| catalogue_data | (Data-source) particle catalogue. |
| params | Parameter set. |
| rbinning | Separation binning. |
| norm_factor | Normalisation factor. |
Definition at line 666 of file twopt.cpp.
Here is the call graph for this function:
Here is the caller graph for this function:| trv::TwoPCFWindowMeasurements trv::compute_corrfunc_window | ( | trv::ParticleCatalogue & | catalogue_rand, |
| trv::LineOfSight * | los_rand, | ||
| trv::ParameterSet & | params, | ||
| trv::Binning | rbinning, | ||
| double | alpha, | ||
| double | norm_factor ) |
Compute two-point correlation function window from a random catalogue and optionally save the results.
| catalogue_rand | (Random-source) particle catalogue. |
| los_rand | (Random-source) particle lines of sight. |
| params | Parameter set. |
| rbinning | Separation binning. |
| alpha | Alpha contrast. |
| norm_factor | Normalisation factor. |
Definition at line 761 of file twopt.cpp.
Here is the call graph for this function:
Here is the caller graph for this function: