The namespace of the two-point correlation function More...

Classes
class	TwoPointCorrelation
	The class TwoPointCorrelation. More...

class	TwoPointCorrelation1D
	The class TwoPointCorrelation1D. More...

class	TwoPointCorrelation1D_angular
	The class TwoPointCorrelation1D_angular. More...

class	TwoPointCorrelation1D_filtered
	The class TwoPointCorrelation1D_filtered. More...

class	TwoPointCorrelation1D_monopole
	The class TwoPointCorrelation1D_monopole. More...

class	TwoPointCorrelation2D
	The class TwoPointCorrelation2D. More...

class	TwoPointCorrelation2D_cartesian
	The class TwoPointCorrelation2D_cartesian. More...

class	TwoPointCorrelation2D_polar
	The class TwoPointCorrelation2D_polar. More...

class	TwoPointCorrelation_deprojected
	The class TwoPointCorrelation_deprojected. More...

class	TwoPointCorrelation_multipoles_direct
	The class TwoPointCorrelation_multipoles_direct. More...

class	TwoPointCorrelation_multipoles_integrated
	The class TwoPointCorrelation_multipoles_integrated. More...

class	TwoPointCorrelation_projected
	The class TwoPointCorrelation_projected. More...

class	TwoPointCorrelation_wedges
	The class TwoPointCorrelation_wedges. More...

class	TwoPointCorrelationCross
	The class TwoPointCorrelationCross. More...

class	TwoPointCorrelationCross1D
	The class TwoPointCorrelationCross1D. More...

class	TwoPointCorrelationCross1D_monopole
	The class TwoPointCorrelationCross1D_monopole. More...

Enumerations
enum class	TwoPType { _monopole_ , _projected_ , _deprojected_ , _multipoles_integrated_ , _multipoles_direct_ , _wedges_ , _filtered_ , _angular_ , _2D_Cartesian_ , _2D_polar_ }
	the two-point correlation function type More...

enum class	Estimator { _natural_ , _LandySzalay_ , _SzapudiSzalay_ }
	the two-point correlation estimator More...

Functions
std::vector< std::string >	TwoPTypeNames ()
	return a vector containing the TwoPType names More...

TwoPType	TwoPTypeCast (const int twoPTypeIndex)
	cast an enum of type TwoPType from its index More...

TwoPType	TwoPTypeCast (const std::string twoPTypeName)
	cast an enum of type TwoPType from its name More...

std::vector< TwoPType >	TwoPTypeCast (const std::vector< int > twoPTypeIndeces)
	cast an enum of type TwoPType from indeces More...

std::vector< TwoPType >	TwoPTypeCast (const std::vector< std::string > twoPTypeNames)
	cast an enum of type TwoPType from thier names More...

std::vector< std::string >	EstimatorNames ()
	return a vector containing the Estimator names More...

Estimator	EstimatorCast (const int estimatorIndex)
	cast an enum of type Estimator from its index More...

Estimator	EstimatorCast (const std::string estimatorName)
	cast an enum of type Estimator from its name More...

std::vector< Estimator >	EstimatorCast (const std::vector< int > estimatorIndeces)
	cast an enum of type Estimator from indeces More...

std::vector< Estimator >	EstimatorCast (const std::vector< std::string > estimatorNames)
	cast an enum of type Estimator from thier names More...

Detailed Description

The namespace of the two-point correlation function

The measure::twopt namespace contains all the functions and classes to measure the two-point correlation function

Enumeration Type Documentation

◆ Estimator

enum cbl::measure::twopt::Estimator

strong

the two-point correlation estimator

Enumerator
_natural_	natural estimator
_LandySzalay_	Landy&Szalay estimator.
_SzapudiSzalay_	Szapudi&Szalay estimator.

Definition at line 144 of file TwoPointCorrelation.h.

◆ TwoPType

enum cbl::measure::twopt::TwoPType

strong

the two-point correlation function type

Enumerator
_monopole_	the angle-averaged two-point correlation function, i.e. the monopole, ξ(r)
_projected_	the projected two-point correlation function, w(r_p)
_deprojected_	the deprojected two-point correlation function, ξ(r)
_multipoles_integrated_	the multipoles of the two-point correlation function, ξ_i(r), computed with the integrated estimator
_multipoles_direct_	the multipoles of the two-point correlation function, ξ_i(r), computed with the direct estimator
_wedges_	the wedges of the two-point correlation function, ξ_i(r)
_filtered_	filtered two-point correlation function
_angular_	angular two-point correlation function
_2D_Cartesian_	2D two-point correlation function in Cartesian coordinates, ξ(r_p,π)
_2D_polar_	2D two-point correlation function in polar coordinates, ξ(r,μ)

Definition at line 64 of file TwoPointCorrelation.h.

Function Documentation

◆ EstimatorCast() [1/4]

Estimator cbl::measure::twopt::EstimatorCast ( const int estimatorIndex )

inline

cast an enum of type Estimator from its index

Parameters

estimatorIndex the estimator index

Returns: object of class Estimator

Definition at line 170 of file TwoPointCorrelation.h.

◆ EstimatorCast() [2/4]

Estimator cbl::measure::twopt::EstimatorCast ( const std::string estimatorName )

inline

cast an enum of type Estimator from its name

Parameters

estimatorName the estimator name

Returns: object of class Estimator

Definition at line 178 of file TwoPointCorrelation.h.

◆ EstimatorCast() [3/4]

std::vector<Estimator> cbl::measure::twopt::EstimatorCast ( const std::vector< int > estimatorIndeces )

inline

cast an enum of type Estimator from indeces

Parameters

estimatorIndeces the estimator indeces

Returns: object of class Estimator

Definition at line 186 of file TwoPointCorrelation.h.

◆ EstimatorCast() [4/4]

std::vector<Estimator> cbl::measure::twopt::EstimatorCast ( const std::vector< std::string > estimatorNames )

inline

cast an enum of type Estimator from thier names

Parameters

estimatorNames the estimator names

Returns: vector of Estimator enums

Definition at line 194 of file TwoPointCorrelation.h.

◆ EstimatorNames()

std::vector<std::string> cbl::measure::twopt::EstimatorNames ( )

inline

return a vector containing the Estimator names

Returns: a vector containing the Estimator names

Definition at line 162 of file TwoPointCorrelation.h.

◆ TwoPTypeCast() [1/4]

TwoPType cbl::measure::twopt::TwoPTypeCast ( const int twoPTypeIndex )

inline

cast an enum of type TwoPType from its index

Parameters

twoPTypeIndex the twoPType index

Returns: object of class TwoPType

Definition at line 111 of file TwoPointCorrelation.h.

◆ TwoPTypeCast() [2/4]

TwoPType cbl::measure::twopt::TwoPTypeCast ( const std::string twoPTypeName )

inline

cast an enum of type TwoPType from its name

Parameters

twoPTypeName the twoPType name

Returns: object of class TwoPType

Definition at line 119 of file TwoPointCorrelation.h.

◆ TwoPTypeCast() [3/4]

std::vector<TwoPType> cbl::measure::twopt::TwoPTypeCast ( const std::vector< int > twoPTypeIndeces )

inline

cast an enum of type TwoPType from indeces

Parameters

twoPTypeIndeces the twoPType indeces

Returns: vector of objects of class TwoPType

Definition at line 128 of file TwoPointCorrelation.h.

◆ TwoPTypeCast() [4/4]

std::vector<TwoPType> cbl::measure::twopt::TwoPTypeCast ( const std::vector< std::string > twoPTypeNames )

inline

cast an enum of type TwoPType from thier names

Parameters

twoPTypeNames the twoPType names

Returns: vector of objects of class TwoPType

Definition at line 137 of file TwoPointCorrelation.h.

◆ TwoPTypeNames()

std::vector<std::string> cbl::measure::twopt::TwoPTypeNames ( )

inline

return a vector containing the TwoPType names

Returns: a vector containing the TwoPType names

Definition at line 103 of file TwoPointCorrelation.h.

Classes

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ Estimator

◆ TwoPType

Function Documentation

◆ EstimatorCast() [1/4]

◆ EstimatorCast() [2/4]

◆ EstimatorCast() [3/4]

◆ EstimatorCast() [4/4]

◆ EstimatorNames()

◆ TwoPTypeCast() [1/4]

◆ TwoPTypeCast() [2/4]

◆ TwoPTypeCast() [3/4]

◆ TwoPTypeCast() [4/4]

◆ TwoPTypeNames()