#include "Headers/Pair.h"

Inheritance diagram for cbl::pairs::Pair:

[legend]

Public Member Functions
Member functions used to get private/protected parameters
Dim	pairDim () const
	get the dimension of the pair vectors More...

PairType	pairType () const
	get the pair type More...

PairInfo	pairInfo () const
	get the pair information type More...

CoordinateUnits	angularUnits ()
	get the angular units More...

FunctionDoubleDouble	angularWeight ()
	get the m_angularWeight function More...

virtual double	scale (const int i) const
	get the member m_scale[i] More...

virtual std::vector< double >	scale () const
	get the member std::vector<double> m_scale More...

virtual double	scale_mean (const int i) const
	get the member m_scale_mean[i] More...

virtual std::vector< double >	scale_mean () const
	get the member std::vector<double> m_scale_mean More...

virtual double	scale_S (const int i) const
	get the member m_scale_S[i] More...

virtual std::vector< double >	scale_S () const
	get the member std::vector<double> m_scale_S More...

virtual double	scale_sigma (const int i) const
	get the member m_scale_sigma[i] More...

virtual std::vector< double >	scale_sigma () const
	get the member std::vector<double> m_scale_sigma More...

virtual double	z_mean (const int i) const
	get the protected member Pair1D_extra::m_z_mean[i] More...

virtual std::vector< double >	z_mean () const
	get the protected member Pair1D_extra::m_z_mean More...

virtual double	z_S (const int i) const
	get the protected member Pair1D_extra::m_z_S[i] More...

virtual std::vector< double >	z_S () const
	get the protected member Pair1D_extra::m_z_S More...

virtual double	z_sigma (const int i) const
	get the protected member Pair1D_extra::m_z_sigma[i] More...

virtual std::vector< double >	z_sigma () const
	get the protected member Pair1D_extra::m_z_sigma More...

virtual double	PP1D (const int i) const
	get the member m_PP1D[i] More...

virtual std::vector< double >	PP1D () const
	get the member std::vector<double> m_PP1D More...

virtual double	PP1D_weighted (const int i) const
	get the member m_PP1D_weighted[i] More...

virtual std::vector< double >	PP1D_weighted () const
	get the member std::vector<double> m_PP1D_weighted More...

virtual double	scale_D1 (const int i) const
	get the member m_scale_D1[i] More...

virtual std::vector< double >	scale_D1 () const
	get the member std::vector<double> m_scale_D1 More...

virtual double	scale_D2 (const int i) const
	get the member m_scale_D2[i] More...

virtual std::vector< double >	scale_D2 () const
	get the member std::vector<double> m_scale_D2 More...

virtual double	scale_D1_mean (const int i, const int j) const
	get the protected member m_scale_D1[i][j] More...

virtual std::vector< std::vector< double > >	scale_D1_mean () const
	get the protected member m_scale_D1 More...

virtual double	scale_D2_mean (const int i, const int j) const
	get the protected member m_scale_D2[i][j] More...

virtual std::vector< std::vector< double > >	scale_D2_mean () const
	get the protected member m_scale_D2 More...

virtual double	scale_D1_S (const int i, const int j) const
	get the member m_scale_D1_S[i][j] More...

virtual std::vector< std::vector< double > >	scale_D1_S () const
	get the member std::vector<double> m_scale_D1 More...

virtual double	scale_D2_S (const int i, const int j) const
	get the member m_scale_D2[i][j] More...

virtual std::vector< std::vector< double > >	scale_D2_S () const
	get the member std::vector<double> m_scale_D2 More...

virtual double	scale_D1_sigma (const int i, const int j) const
	get the member m_scale_D1_sigma[i][j] More...

virtual std::vector< std::vector< double > >	scale_D1_sigma () const
	get the member std::vector<double> m_scale_D1 More...

virtual double	scale_D2_sigma (const int i, const int j) const
	get the member m_scale_D2[i][j] More...

virtual std::vector< std::vector< double > >	scale_D2_sigma () const
	get the member std::vector<double> m_scale_D2 More...

virtual double	z_mean (const int i, const int j) const
	get the protected member m_z_mean[i][j] More...

virtual std::vector< std::vector< double > >	z_mean2D () const
	get the protected member m_z_mean More...

virtual double	z_S (const int i, const int j) const
	get the member m_z_sigma[i][j] More...

virtual double	z_sigma (const int i, const int j) const
	get the member m_z_sigma[i][j] More...

virtual std::vector< std::vector< double > >	z_sigma2D () const
	get the member std::vector<double> m_z_sigma More...

virtual double	PP2D (const int i, const int j) const
	get the member m_PP2D[i][j] More...

virtual std::vector< std::vector< double > >	PP2D () const
	get the member std::vector<std::vector<double>> m_PP2D More...

virtual double	PP2D_weighted (const int i, const int j) const
	get the member m_PP2D_weighted[i][j] More...

virtual std::vector< std::vector< double > >	PP2D_weighted () const
	get the member std::vector<std::vector<double>> m_PP2D_weighted More...

virtual double	binSize_inv () const
	get the member m_binSize_inv More...

virtual int	nbins () const
	get the member m_nbins More...

virtual double	shift () const
	get the member m_shift More...

virtual double	binSize_inv_D1 () const
	get the member m_binSize_inv_D1 More...

virtual int	nbins_D1 () const
	get the member m_nbins_D1 More...

virtual double	shift_D1 () const
	get the member m_shift_D1 More...

virtual double	binSize_inv_D2 () const
	get the member m_binSize_inv_D2 More...

virtual int	nbins_D2 () const
	get the member m_nbins_D2 More...

virtual double	shift_D2 () const
	get the member m_shift_D2 More...

virtual double	sMin () const
	get the minimum separation More...

virtual double	sMax () const
	get the the minimum separation More...

virtual double	sMin_D1 () const
	get the minimum separation in the first dimension More...

virtual double	sMax_D1 () const
	get the the minimum separation in the first dimension More...

virtual double	sMin_D2 () const
	get the minimum separation in the second dimension More...

virtual double	sMax_D2 () const
	get the the minimum separation in the second dimension More...

Member functions used to set private/protected members
virtual void	reset ()=0
	reset the pair counts More...

virtual void	set_PP1D (const int i, const double pp)
	set the member m_PP1D[i] More...

virtual void	set_PP1D_weighted (const int i, const double pp)
	set the member m_PP1D_weighted[i] More...

virtual void	set_PP2D (const int i, const int j, const double pp)
	set the member m_PP2D[i][j] More...

virtual void	set_PP2D_weighted (const int i, const int j, const double pp)
	set the member m_PP2D_weighted[i][j] More...

virtual void	add_data1D (const int i, const std::vector< double > data)
	set the protected members by adding new 1D data More...

virtual void	add_data1D (const int i, const std::shared_ptr< pairs::Pair > pair, const double ww=1.)
	set the protected members by adding new 1D data More...

virtual void	add_data2D (const int i, const int j, const std::vector< double > data)
	set the protected members by adding new 2D data More...

virtual void	add_data2D (const int i, const int j, const std::shared_ptr< pairs::Pair > pair, const double ww=1.)
	set the protected members by adding new 2D data More...

Member functions used to handle object pairs (customized in all the derived classes)
virtual void	get (const std::shared_ptr< catalogue::Object > obj1, const std::shared_ptr< catalogue::Object > obj2, int &kk, double &wkk)
	get the pair index and weight More...

virtual void	get (const std::shared_ptr< catalogue::Object > obj1, const std::shared_ptr< catalogue::Object > obj2, int &kk, double &cosmu, double &wkk)
	get the pair index and weight More...

virtual void	get (const std::shared_ptr< catalogue::Object > obj1, const std::shared_ptr< catalogue::Object > obj2, int &ir, int &jr, double &ww)
	get the pair index and weight More...

virtual void	set (const int kk, const double wkk, const double weight=1)
	set the pair vector More...

virtual void	set (const double cosmu, const int kk, const double wkk, const double weight=1)
	set the pair vector More...

virtual void	set (const int ir, const int jr, const double ww, const double weight=1)
	set the pair vector More...

virtual void	put (const std::shared_ptr< catalogue::Object > obj1, const std::shared_ptr< catalogue::Object > obj2)=0
	estimate the distance between two objects and update the pair vector accordingly More...

virtual void	Sum (const std::shared_ptr< Pair > pp, const double ww=1)=0
	sum the number of binned pairs More...

Protected Attributes
Dim	m_pairDim
	pair dimension

PairType	m_pairType
	pair type

PairInfo	m_pairInfo
	pair info

CoordinateUnits	m_angularUnits
	angular units

FunctionDoubleDouble	m_angularWeight
	angular weight function

Private Member Functions
Member functions used to set the binning parameters (customized in all the derived classes)
virtual void	m_set_parameters_nbins ()=0
	set the binning parameters given the number of bins

virtual void	m_set_parameters_binSize ()=0
	set the binning parameters given the bin size

Constructors/destructors
	Pair ()=default
	default constuctor

virtual	~Pair ()=default
	default destructor

static std::shared_ptr< Pair >	Create (const PairType type, const PairInfo info, const double Min, const double Max, const int nbins, const double shift, const CoordinateUnits angularUnits=CoordinateUnits::_radians_, FunctionDoubleDouble angularWeight=nullptr)
	static factory used to construct pairs of any type More...

static std::shared_ptr< Pair >	Create (const PairType type, const PairInfo info, const double Min, const double Max, const double binSize, const double shift, const CoordinateUnits angularUnits=CoordinateUnits::_radians_, FunctionDoubleDouble angularWeight=nullptr)
	static factory used to construct pairs of any type More...

static std::shared_ptr< Pair >	Create (const PairType type, const PairInfo info, const double Min_D1, const double Max_D1, const int nbins_D1, const double shift_D1, const double Min_D2, const double Max_D2, const int nbins_D2, const double shift_D2, const CoordinateUnits angularUnits=CoordinateUnits::_radians_, FunctionDoubleDouble angularWeight=nullptr)
	static factory used to construct pairs of any type More...

static std::shared_ptr< Pair >	Create (const PairType type, const PairInfo info, const double Min_D1, const double Max_D1, const double binSize_D1, const double shift_D1, const double Min_D2, const double Max_D2, const double binSize_D2, const double shift_D2, const CoordinateUnits angularUnits=CoordinateUnits::_radians_, FunctionDoubleDouble angularWeight=nullptr)
	static factory used to construct pairs of any type More...

Detailed Description

The class Pair.

This class is used to handle objects of type Pair . It contains all virtual member functions implemented in the derived classes

Definition at line 144 of file Pair.h.

Member Function Documentation

◆ add_data1D() [1/2]

virtual void cbl::pairs::Pair::add_data1D	(	const int	i,
		const std::shared_ptr< pairs::Pair >	pair,
		const double	ww = `1.`
	)

inlinevirtual

set the protected members by adding new 1D data

Parameters

i	the bin index
pair	pointer to an object of class Pair
ww	a multiplicative factor used for bootstrap

Reimplemented in cbl::pairs::Pair1D_extra, and cbl::pairs::Pair1D.

Definition at line 895 of file Pair.h.

◆ add_data1D() [2/2]

virtual void cbl::pairs::Pair::add_data1D	(	const int	i,
		const std::vector< double >	data
	)

inlinevirtual

set the protected members by adding new 1D data

Parameters

i	the bin index
data	vector containing the new data to be added

Reimplemented in cbl::pairs::Pair1D_extra, and cbl::pairs::Pair1D.

Definition at line 886 of file Pair.h.

◆ add_data2D() [1/2]

virtual void cbl::pairs::Pair::add_data2D	(	const int	i,
		const int	j,
		const std::shared_ptr< pairs::Pair >	pair,
		const double	ww = `1.`
	)

inlinevirtual

set the protected members by adding new 2D data

Parameters

i	the bin index in the first dimension
j	the bin index in the second dimension
pair	pair pointer to an object of class Pair
ww	a multiplicative factor used for bootstrap

Reimplemented in cbl::pairs::Pair2D_extra, and cbl::pairs::Pair2D.

Definition at line 914 of file Pair.h.

◆ add_data2D() [2/2]

virtual void cbl::pairs::Pair::add_data2D	(	const int	i,
		const int	j,
		const std::vector< double >	data
	)

inlinevirtual

set the protected members by adding new 2D data

Parameters

i	the bin index in the first dimension
j	the bin index in the second dimension
data	vector containing the new data to be added

Reimplemented in cbl::pairs::Pair2D_extra, and cbl::pairs::Pair2D.

Definition at line 904 of file Pair.h.

◆ angularUnits()

CoordinateUnits cbl::pairs::Pair::angularUnits ( )

inline

get the angular units

Returns: the angular units

Definition at line 348 of file Pair.h.

◆ angularWeight()

FunctionDoubleDouble cbl::pairs::Pair::angularWeight ( )

inline

get the m_angularWeight function

Returns: the m_angularWeight function

Definition at line 354 of file Pair.h.

◆ binSize_inv()

virtual double cbl::pairs::Pair::binSize_inv ( ) const

inlinevirtual

get the member m_binSize_inv

Returns: the inverse of the bin size

Reimplemented in cbl::pairs::Pair1D.

Definition at line 725 of file Pair.h.

◆ binSize_inv_D1()

virtual double cbl::pairs::Pair::binSize_inv_D1 ( ) const

inlinevirtual

get the member m_binSize_inv_D1

Returns: the inverse of the bin size in the first dimension

Reimplemented in cbl::pairs::Pair2D.

Definition at line 746 of file Pair.h.

◆ binSize_inv_D2()

virtual double cbl::pairs::Pair::binSize_inv_D2 ( ) const

inlinevirtual

get the member m_binSize_inv_D2

Returns: the inverse of the bin size in the second dimension

Reimplemented in cbl::pairs::Pair2D.

Definition at line 768 of file Pair.h.

◆ Create() [1/4]

shared_ptr< Pair > cbl::pairs::Pair::Create	(	const PairType	type,
		const PairInfo	info,
		const double	Min,
		const double	Max,
		const double	binSize,
		const double	shift,
		const CoordinateUnits	angularUnits = `CoordinateUnits::_radians_`,
		FunctionDoubleDouble	angularWeight = `nullptr`
	)

static

static factory used to construct pairs of any type

Parameters

type	the pair type; it can be: _angular_lin_, _angular_log_, _comoving_lin_, _comoving_log_, _comoving_multipoles_lin_, _comoving_multipoles_log_
info	the pair information; it can be: _standard_ or _extra_
Min	minimum value of the separation (comoving or angular) used to count the pairs
Max	maximum value of the separation (comoving or angular) used to count the pairs
binSize	the bin size
shift	shift parameter, i.e. the radial shift is binSize*shift
angularUnits	angular units
angularWeight	angular weight function

Returns: a pointer to an object of class Pair of a given type

Definition at line 107 of file Pair.cpp.

◆ Create() [2/4]

shared_ptr< Pair > cbl::pairs::Pair::Create	(	const PairType	type,
		const PairInfo	info,
		const double	Min,
		const double	Max,
		const int	nbins,
		const double	shift,
		const CoordinateUnits	angularUnits = `CoordinateUnits::_radians_`,
		FunctionDoubleDouble	angularWeight = `nullptr`
	)

static

static factory used to construct pairs of any type

Parameters

type	the pair type; it can be: _angular_lin_, _angular_log_, _comoving_lin_, _comoving_log_ _comoving_multipoles_lin_, _comoving_multipoles_log_
info	the pair information; it can be: _standard_ or _extra_
Min	minimum value of the separation (comoving or angular) used to count the pairs
Max	maximum value of the separation (comoving or angular) used to count the pairs
nbins	number of bins
shift	shift parameter, i.e. the radial shift is binSize*shift
angularUnits	angular units
angularWeight	angular weight function

Returns: a pointer to an object of class Pair of a given type

Definition at line 48 of file Pair.cpp.

◆ Create() [3/4]

shared_ptr< Pair > cbl::pairs::Pair::Create	(	const PairType	type,
		const PairInfo	info,
		const double	Min_D1,
		const double	Max_D1,
		const double	binSize_D1,
		const double	shift_D1,
		const double	Min_D2,
		const double	Max_D2,
		const double	binSize_D2,
		const double	shift_D2,
		const CoordinateUnits	angularUnits = `CoordinateUnits::_radians_`,
		FunctionDoubleDouble	angularWeight = `nullptr`
	)

static

static factory used to construct pairs of any type

Parameters

type	the pair type; it can be: _comovingCartesian_linlin_, _comovingCartesian_linlog_, _comovingCartesian_loglin_, _comovingCartesian_loglog_, _comovingPolar_linlin_, _comovingPolar_linlog_, _comovingPolar_loglin_, _comovingPolar_loglog_
info	the pair information; it can be: _standard_ or _extra_
Min_D1	minimum value of the separation (comoving or angular) in the first direction used to count the pairs
Max_D1	maximum value of the separation (comoving or angular) in the first direction used to count the pairs
binSize_D1	the bin size in the first direction
shift_D1	shift parameter in the first direction, i.e. the radial shift is binSize*shift
Min_D2	minimum value of the separation (comoving or angular) in the second direction used to count the pairs
Max_D2	maximum value of the separation (comoving or angular) in the second direction used to count the pairs
binSize_D2	the bin size in the second direction
shift_D2	shift parameter in the second direction, i.e. the radial shift is binSize*shift
angularUnits	angular units
angularWeight	angular weight function

Returns: a pointer to an object of class Pair of a given type

Definition at line 237 of file Pair.cpp.

◆ Create() [4/4]

shared_ptr< Pair > cbl::pairs::Pair::Create	(	const PairType	type,
		const PairInfo	info,
		const double	Min_D1,
		const double	Max_D1,
		const int	nbins_D1,
		const double	shift_D1,
		const double	Min_D2,
		const double	Max_D2,
		const int	nbins_D2,
		const double	shift_D2,
		const CoordinateUnits	angularUnits = `CoordinateUnits::_radians_`,
		FunctionDoubleDouble	angularWeight = `nullptr`
	)

static

static factory used to construct pairs of any type

Parameters

type	the pair type; it can be: _comovingCartesian_linlin_, _comovingCartesian_linlog_, _comovingCartesian_loglin_, _comovingCartesian_loglog_, _comovingPolar_linlin_, _comovingPolar_linlog_, _comovingPolar_loglin_, _comovingPolar_loglog_
info	the pair information; it can be: _standard_ or _extra_
Min_D1	minimum value of the separation (comoving or angular) in the first direction used to count the pairs
Max_D1	maximum value of the separation (comoving or angular) in the first direction used to count the pairs
nbins_D1	number of bins in the first direction
shift_D1	shift parameter in the first direction, i.e. the radial shift is binSize*shift
Min_D2	minimum value of the separation (comoving or angular) in the second direction used to count the pairs
Max_D2	maximum value of the separation (comoving or angular) in the second direction used to count the pairs
nbins_D2	number of bins in the second direction
shift_D2	shift parameter in the second direction, i.e. the radial shift is binSize*shift
angularUnits	angular units
angularWeight	angular weight function

Returns: a pointer to an object of class Pair of a given type

Definition at line 166 of file Pair.cpp.

◆ get() [1/3]

virtual void cbl::pairs::Pair::get	(	const std::shared_ptr< catalogue::Object >	obj1,
		const std::shared_ptr< catalogue::Object >	obj2,
		int &	ir,
		int &	jr,
		double &	ww
	)

inlinevirtual

get the pair index and weight

Parameters

obj1	pointer to an object of class Object
obj2	pointer to an object of class Object
ir	the bin index in the first dimension
jr	the bin index in the second dimension
ww	weight of the pair

Reimplemented in cbl::pairs::Pair2D_comovingPolar_loglog, cbl::pairs::Pair2D_comovingPolar_linlog, cbl::pairs::Pair2D_comovingPolar_loglin, cbl::pairs::Pair2D_comovingPolar_linlin, cbl::pairs::Pair2D_comovingCartesian_loglog, cbl::pairs::Pair2D_comovingCartesian_linlog, cbl::pairs::Pair2D_comovingCartesian_loglin, and cbl::pairs::Pair2D_comovingCartesian_linlin.

Definition at line 954 of file Pair.h.

◆ get() [2/3]

virtual void cbl::pairs::Pair::get	(	const std::shared_ptr< catalogue::Object >	obj1,
		const std::shared_ptr< catalogue::Object >	obj2,
		int &	kk,
		double &	cosmu,
		double &	wkk
	)

inlinevirtual

get the pair index and weight

Parameters

obj1	pointer to an object of class Object
obj2	pointer to an object of class Object
kk	index of the pairs
cosmu	cosine of the angle between objects
wkk	weight of the pair

Reimplemented in cbl::pairs::Pair1D_comoving_multipoles_log, and cbl::pairs::Pair1D_comoving_multipoles_lin.

Definition at line 943 of file Pair.h.

◆ get() [3/3]

virtual void cbl::pairs::Pair::get	(	const std::shared_ptr< catalogue::Object >	obj1,
		const std::shared_ptr< catalogue::Object >	obj2,
		int &	kk,
		double &	wkk
	)

inlinevirtual

get the pair index and weight

Parameters

obj1	pointer to an object of class Object
obj2	pointer to an object of class Object
kk	index of the pairs
wkk	weight of the pair

Reimplemented in cbl::pairs::Pair1D_comoving_log, cbl::pairs::Pair1D_comoving_lin, cbl::pairs::Pair1D_angular_log, and cbl::pairs::Pair1D_angular_lin.

Definition at line 932 of file Pair.h.

◆ nbins()

virtual int cbl::pairs::Pair::nbins ( ) const

inlinevirtual

get the member m_nbins

Returns: the number of bins

Reimplemented in cbl::pairs::Pair1D.

Definition at line 732 of file Pair.h.

◆ nbins_D1()

virtual int cbl::pairs::Pair::nbins_D1 ( ) const

inlinevirtual

get the member m_nbins_D1

Returns: the number of bins in the first dimension

Reimplemented in cbl::pairs::Pair2D.

Definition at line 753 of file Pair.h.

◆ nbins_D2()

virtual int cbl::pairs::Pair::nbins_D2 ( ) const

inlinevirtual

get the member m_nbins_D2

Returns: the number of bins in the second dimension

Reimplemented in cbl::pairs::Pair2D.

Definition at line 775 of file Pair.h.

◆ pairDim()

Dim cbl::pairs::Pair::pairDim ( ) const

inline

get the dimension of the pair vectors

Returns: the dimension of the pair vectors

Definition at line 330 of file Pair.h.

◆ pairInfo()

PairInfo cbl::pairs::Pair::pairInfo ( ) const

inline

get the pair information type

Returns: the pair information type

Definition at line 342 of file Pair.h.

◆ pairType()

PairType cbl::pairs::Pair::pairType ( ) const

inline

get the pair type

Returns: the pair type

Definition at line 336 of file Pair.h.

◆ PP1D() [1/2]

virtual std::vector<double> cbl::pairs::Pair::PP1D ( ) const

inlinevirtual

get the member std::vector<double> m_PP1D

Returns: the vector containing the binned number of pairs

Reimplemented in cbl::pairs::Pair1D.

Definition at line 483 of file Pair.h.

◆ PP1D() [2/2]

virtual double cbl::pairs::Pair::PP1D ( const int i ) const

inlinevirtual

get the member m_PP1D[i]

Parameters

i	the bin index

Returns: the number of pairs in the i-th bin

Reimplemented in cbl::pairs::Pair1D.

Definition at line 476 of file Pair.h.

◆ PP1D_weighted() [1/2]

virtual std::vector<double> cbl::pairs::Pair::PP1D_weighted ( ) const

inlinevirtual

get the member std::vector<double> m_PP1D_weighted

Returns: the vector containing the binned weighted number of pairs

Reimplemented in cbl::pairs::Pair1D.

Definition at line 499 of file Pair.h.

◆ PP1D_weighted() [2/2]

virtual double cbl::pairs::Pair::PP1D_weighted ( const int i ) const

inlinevirtual

get the member m_PP1D_weighted[i]

Parameters

i	the bin index

Returns: the number of weighted pairs in the i-th bin

Reimplemented in cbl::pairs::Pair1D.

Definition at line 491 of file Pair.h.

◆ PP2D() [1/2]

virtual std::vector<std::vector<double> > cbl::pairs::Pair::PP2D ( ) const

inlinevirtual

get the member std::vector<std::vector<double>> m_PP2D

Returns: the vector containing the binned number of pairs

Reimplemented in cbl::pairs::Pair2D.

Definition at line 701 of file Pair.h.

◆ PP2D() [2/2]

virtual double cbl::pairs::Pair::PP2D	(	const int	i,
		const int	j
	)		const

inlinevirtual

get the member m_PP2D[i][j]

Parameters

i	the bin index in the first dimension
j	the bin index in the second dimension

Returns: the number of pairs in the i-th bin

Reimplemented in cbl::pairs::Pair2D.

Definition at line 694 of file Pair.h.

◆ PP2D_weighted() [1/2]

virtual std::vector<std::vector<double> > cbl::pairs::Pair::PP2D_weighted ( ) const

inlinevirtual

get the member std::vector<std::vector<double>> m_PP2D_weighted

Returns: the vector containing the binned weighted number of pairs

Reimplemented in cbl::pairs::Pair2D.

Definition at line 718 of file Pair.h.

◆ PP2D_weighted() [2/2]

virtual double cbl::pairs::Pair::PP2D_weighted	(	const int	i,
		const int	j
	)		const

inlinevirtual

get the member m_PP2D_weighted[i][j]

Parameters

i	the bin index in the first dimension
j	the bin index in the second dimension

Returns: the number of weighted pairs in the i-th bin

Reimplemented in cbl::pairs::Pair2D.

Definition at line 710 of file Pair.h.

◆ put()

virtual void cbl::pairs::Pair::put	(	const std::shared_ptr< catalogue::Object >	obj1,
		const std::shared_ptr< catalogue::Object >	obj2
	)

pure virtual

estimate the distance between two objects and update the pair vector accordingly

Parameters

obj1	pointer to an object of class Object
obj2	pointer to an object of class Object

◆ reset()

virtual void cbl::pairs::Pair::reset ( )

pure virtual

reset the pair counts

set to 0 the pair vector elements

Implemented in cbl::pairs::Pair2D, and cbl::pairs::Pair1D.

◆ scale() [1/2]

virtual std::vector<double> cbl::pairs::Pair::scale ( ) const

inlinevirtual

get the member std::vector<double> m_scale

Returns: the vector containing the binned scales

Reimplemented in cbl::pairs::Pair1D.

Definition at line 368 of file Pair.h.

◆ scale() [2/2]

virtual double cbl::pairs::Pair::scale ( const int i ) const

inlinevirtual

get the member m_scale[i]

Parameters

i	the bin index

Returns: the i-th binned scale

Reimplemented in cbl::pairs::Pair1D.

Definition at line 361 of file Pair.h.

◆ scale_D1() [1/2]

virtual std::vector<double> cbl::pairs::Pair::scale_D1 ( ) const

inlinevirtual

get the member std::vector<double> m_scale_D1

Returns: the vector containing the binned scales in the first dimension

Reimplemented in cbl::pairs::Pair2D.

Definition at line 515 of file Pair.h.

◆ scale_D1() [2/2]

virtual double cbl::pairs::Pair::scale_D1 ( const int i ) const

inlinevirtual

get the member m_scale_D1[i]

Parameters

i	the bin index

Returns: the i-th binned scale in the first dimension

Reimplemented in cbl::pairs::Pair2D.

Definition at line 507 of file Pair.h.

◆ scale_D1_mean() [1/2]

virtual std::vector<std::vector<double> > cbl::pairs::Pair::scale_D1_mean ( ) const

inlinevirtual

get the protected member m_scale_D1

Returns: the matrix containing the mean scales in the first dimension

Reimplemented in cbl::pairs::Pair2D_extra.

Definition at line 547 of file Pair.h.

◆ scale_D1_mean() [2/2]

virtual double cbl::pairs::Pair::scale_D1_mean	(	const int	i,
		const int	j
	)		const

inlinevirtual

get the protected member m_scale_D1[i][j]

Parameters

i	the bin index in the first dimension
j	the bin index in the second dimension

Returns: the mean scale in the first dimension, in the i-j bin

Reimplemented in cbl::pairs::Pair2D_extra.

Definition at line 540 of file Pair.h.

◆ scale_D1_S() [1/2]

virtual std::vector<std::vector<double> > cbl::pairs::Pair::scale_D1_S ( ) const

inlinevirtual

get the member std::vector<double> m_scale_D1

Returns: the vector the square of the standard deviations of the scale distribution, multiplied by the total weight, in the first dimension

Reimplemented in cbl::pairs::Pair2D_extra.

Definition at line 584 of file Pair.h.

◆ scale_D1_S() [2/2]

virtual double cbl::pairs::Pair::scale_D1_S	(	const int	i,
		const int	j
	)		const

inlinevirtual

get the member m_scale_D1_S[i][j]

Parameters

i	the bin index in the first dimension
j	the bin index in the second dimension

Returns: the square of the standard deviations of the scale distribution, multiplied by the total weight, in the i-th bin, in the first dimension

Reimplemented in cbl::pairs::Pair2D_extra.

Definition at line 575 of file Pair.h.

◆ scale_D1_sigma() [1/2]

virtual std::vector<std::vector<double> > cbl::pairs::Pair::scale_D1_sigma ( ) const

inlinevirtual

get the member std::vector<double> m_scale_D1

Returns: the vector containing the standard deviations of the scale distribution in the first dimension

Reimplemented in cbl::pairs::Pair2D_extra.

Definition at line 622 of file Pair.h.

◆ scale_D1_sigma() [2/2]

virtual double cbl::pairs::Pair::scale_D1_sigma	(	const int	i,
		const int	j
	)		const

inlinevirtual

get the member m_scale_D1_sigma[i][j]

Parameters

i	the bin index in the first dimension
j	the bin index in the second dimension

Returns: the standard deviation of the scale distribution in the i-th bin, in the first dimension

Reimplemented in cbl::pairs::Pair2D_extra.

Definition at line 614 of file Pair.h.

◆ scale_D2() [1/2]

virtual std::vector<double> cbl::pairs::Pair::scale_D2 ( ) const

inlinevirtual

get the member std::vector<double> m_scale_D2

Returns: the vector containing the binned scales in the second dimension

Reimplemented in cbl::pairs::Pair2D.

Definition at line 531 of file Pair.h.

◆ scale_D2() [2/2]

virtual double cbl::pairs::Pair::scale_D2 ( const int i ) const

inlinevirtual

get the member m_scale_D2[i]

Parameters

i	the bin index

Returns: the i-th binned scale in the second dimension

Reimplemented in cbl::pairs::Pair2D.

Definition at line 523 of file Pair.h.

◆ scale_D2_mean() [1/2]

virtual std::vector<std::vector<double> > cbl::pairs::Pair::scale_D2_mean ( ) const

inlinevirtual

get the protected member m_scale_D2

Returns: the matrix containing the mean scales in the second dimension

Reimplemented in cbl::pairs::Pair2D_extra.

Definition at line 564 of file Pair.h.

◆ scale_D2_mean() [2/2]

virtual double cbl::pairs::Pair::scale_D2_mean	(	const int	i,
		const int	j
	)		const

inlinevirtual

get the protected member m_scale_D2[i][j]

Parameters

i	the bin index in the first dimension
j	the bin index in the second dimension

Returns: the mean scale in the second dimension, in the i-j bin

Reimplemented in cbl::pairs::Pair2D_extra.

Definition at line 556 of file Pair.h.

◆ scale_D2_S() [1/2]

virtual std::vector<std::vector<double> > cbl::pairs::Pair::scale_D2_S ( ) const

inlinevirtual

get the member std::vector<double> m_scale_D2

Returns: the vector the square of the standard deviations of the scale distribution, multiplied by the total weight, in the second dimension

Reimplemented in cbl::pairs::Pair2D_extra.

Definition at line 604 of file Pair.h.

◆ scale_D2_S() [2/2]

virtual double cbl::pairs::Pair::scale_D2_S	(	const int	i,
		const int	j
	)		const

inlinevirtual

get the member m_scale_D2[i][j]

Parameters

i	the bin index in the first dimension
j	the bin index in the second dimension

Returns: the square of the standard deviations of the scale distribution, multiplied by the total weight, in the i-th bin, in the second dimension

Reimplemented in cbl::pairs::Pair2D_extra.

Definition at line 595 of file Pair.h.

◆ scale_D2_sigma() [1/2]

virtual std::vector<std::vector<double> > cbl::pairs::Pair::scale_D2_sigma ( ) const

inlinevirtual

get the member std::vector<double> m_scale_D2

Returns: the vector containing the standard deviations of the scale distribution in the second dimension

Reimplemented in cbl::pairs::Pair2D_extra.

Definition at line 640 of file Pair.h.

◆ scale_D2_sigma() [2/2]

virtual double cbl::pairs::Pair::scale_D2_sigma	(	const int	i,
		const int	j
	)		const

inlinevirtual

get the member m_scale_D2[i][j]

Parameters

i	the bin index in the first dimension
j	the bin index in the second dimension

Returns: the standard deviation of the scale distribution in the i-th bin, in the second dimension

Reimplemented in cbl::pairs::Pair2D_extra.

Definition at line 632 of file Pair.h.

◆ scale_mean() [1/2]

virtual std::vector<double> cbl::pairs::Pair::scale_mean ( ) const

inlinevirtual

get the member std::vector<double> m_scale_mean

Returns: the vector containing the mean scales

Reimplemented in cbl::pairs::Pair1D_extra.

Definition at line 383 of file Pair.h.

◆ scale_mean() [2/2]

virtual double cbl::pairs::Pair::scale_mean ( const int i ) const

inlinevirtual

get the member m_scale_mean[i]

Parameters

i	the bin index

Returns: the mean scale in the i-th bin

Reimplemented in cbl::pairs::Pair1D_extra.

Definition at line 376 of file Pair.h.

◆ scale_S() [1/2]

virtual std::vector<double> cbl::pairs::Pair::scale_S ( ) const

inlinevirtual

get the member std::vector<double> m_scale_S

Returns: the vector the square of the standard deviations of the scale distribution, multiplied by the total weight

Reimplemented in cbl::pairs::Pair1D_extra.

Definition at line 401 of file Pair.h.

◆ scale_S() [2/2]

virtual double cbl::pairs::Pair::scale_S ( const int i ) const

inlinevirtual

get the member m_scale_S[i]

Parameters

i	the bin index

Returns: the square of the standard deviations of the scale distribution, multiplied by the total weight, in the i-th bin

Reimplemented in cbl::pairs::Pair1D_extra.

Definition at line 393 of file Pair.h.

◆ scale_sigma() [1/2]

virtual std::vector<double> cbl::pairs::Pair::scale_sigma ( ) const

inlinevirtual

get the member std::vector<double> m_scale_sigma

Returns: the vector containing the standard deviations of the scale distribution

Reimplemented in cbl::pairs::Pair1D_extra.

Definition at line 418 of file Pair.h.

◆ scale_sigma() [2/2]

virtual double cbl::pairs::Pair::scale_sigma ( const int i ) const

inlinevirtual

get the member m_scale_sigma[i]

Parameters

i	the bin index

Returns: the standard deviation of the scale distribution in the i-th bin

Reimplemented in cbl::pairs::Pair1D_extra.

Definition at line 410 of file Pair.h.

◆ set() [1/3]

virtual void cbl::pairs::Pair::set	(	const double	cosmu,
		const int	kk,
		const double	wkk,
		const double	weight = `1`
	)

inlinevirtual

set the pair vector

Parameters

cosmu	cosine of the angle between objects
kk	index of the pairs
wkk	weight of the pair
weight	the weght of the region

Reimplemented in cbl::pairs::Pair1D_comoving_multipoles_log, and cbl::pairs::Pair1D_comoving_multipoles_lin.

Definition at line 973 of file Pair.h.

◆ set() [2/3]

virtual void cbl::pairs::Pair::set	(	const int	ir,
		const int	jr,
		const double	ww,
		const double	weight = `1`
	)

inlinevirtual

set the pair vector

Parameters

ir	the bin index in the first dimension
jr	the bin index in the second dimension
ww	weight of the pair
weight	the weight of the region

Reimplemented in cbl::pairs::Pair2D_comovingPolar_loglog, cbl::pairs::Pair2D_comovingPolar_linlog, cbl::pairs::Pair2D_comovingPolar_loglin, cbl::pairs::Pair2D_comovingPolar_linlin, cbl::pairs::Pair2D_comovingCartesian_loglog, cbl::pairs::Pair2D_comovingCartesian_linlog, cbl::pairs::Pair2D_comovingCartesian_loglin, and cbl::pairs::Pair2D_comovingCartesian_linlin.

Definition at line 983 of file Pair.h.

◆ set() [3/3]

virtual void cbl::pairs::Pair::set	(	const int	kk,
		const double	wkk,
		const double	weight = `1`
	)

inlinevirtual

set the pair vector

Parameters

kk	index of the pairs
wkk	weight of the pair
weight	the weight of the region

Reimplemented in cbl::pairs::Pair1D_comoving_log, cbl::pairs::Pair1D_comoving_lin, cbl::pairs::Pair1D_angular_log, and cbl::pairs::Pair1D_angular_lin.

Definition at line 963 of file Pair.h.

◆ set_PP1D()

virtual void cbl::pairs::Pair::set_PP1D	(	const int	i,
		const double	pp
	)

inlinevirtual

set the member m_PP1D[i]

Parameters

i	the bin index
pp	the number of pairs in the bin

Reimplemented in cbl::pairs::Pair1D.

Definition at line 852 of file Pair.h.

◆ set_PP1D_weighted()

virtual void cbl::pairs::Pair::set_PP1D_weighted	(	const int	i,
		const double	pp
	)

inlinevirtual

set the member m_PP1D_weighted[i]

Parameters

i	the bin index
pp	the number of weighted pairs in the bin

Reimplemented in cbl::pairs::Pair1D.

Definition at line 860 of file Pair.h.

◆ set_PP2D()

virtual void cbl::pairs::Pair::set_PP2D	(	const int	i,
		const int	j,
		const double	pp
	)

inlinevirtual

set the member m_PP2D[i][j]

Parameters

i	the bin index in the first dimension
j	the bin index in the second dimension
pp	the number of pairs in the bin

Reimplemented in cbl::pairs::Pair2D.

Definition at line 869 of file Pair.h.

◆ set_PP2D_weighted()

virtual void cbl::pairs::Pair::set_PP2D_weighted	(	const int	i,
		const int	j,
		const double	pp
	)

inlinevirtual

set the member m_PP2D_weighted[i][j]

Parameters

i	the bin index in the first dimension
j	the bin index in the second dimension
pp	the number of weighted pairs in the bin

Reimplemented in cbl::pairs::Pair2D.

Definition at line 878 of file Pair.h.

◆ shift()

virtual double cbl::pairs::Pair::shift ( ) const

inlinevirtual

get the member m_shift

Returns: the radial shift used to centre the output bins

Reimplemented in cbl::pairs::Pair1D.

Definition at line 739 of file Pair.h.

◆ shift_D1()

virtual double cbl::pairs::Pair::shift_D1 ( ) const

inlinevirtual

get the member m_shift_D1

Returns: the radial shift in the first dmension used to centre the output bins

Reimplemented in cbl::pairs::Pair2D.

Definition at line 761 of file Pair.h.

◆ shift_D2()

virtual double cbl::pairs::Pair::shift_D2 ( ) const

inlinevirtual

get the member m_shift_D2

Returns: the radial shift in the second dimension used to centre the output bins

Reimplemented in cbl::pairs::Pair2D.

Definition at line 783 of file Pair.h.

◆ sMax()

virtual double cbl::pairs::Pair::sMax ( ) const

inlinevirtual

get the the minimum separation

Returns: the maximum separation used to count the pairs

Reimplemented in cbl::pairs::Pair1D_comoving_multipoles, cbl::pairs::Pair1D_comoving, and cbl::pairs::Pair1D_angular.

Definition at line 797 of file Pair.h.

◆ sMax_D1()

virtual double cbl::pairs::Pair::sMax_D1 ( ) const

inlinevirtual

get the the minimum separation in the first dimension

Returns: the maximum separation in the first dimension used to count the pairs

Reimplemented in cbl::pairs::Pair2D_comovingPolar, and cbl::pairs::Pair2D_comovingCartesian.

Definition at line 813 of file Pair.h.

◆ sMax_D2()

virtual double cbl::pairs::Pair::sMax_D2 ( ) const

inlinevirtual

get the the minimum separation in the second dimension

Returns: the maximum separation in the second dimension used to count the pairs

Reimplemented in cbl::pairs::Pair2D_comovingPolar, and cbl::pairs::Pair2D_comovingCartesian.

Definition at line 829 of file Pair.h.

◆ sMin()

virtual double cbl::pairs::Pair::sMin ( ) const

inlinevirtual

get the minimum separation

Returns: the minimum separation used to count the pairs

Reimplemented in cbl::pairs::Pair1D_comoving_multipoles, cbl::pairs::Pair1D_comoving, and cbl::pairs::Pair1D_angular.

Definition at line 790 of file Pair.h.

◆ sMin_D1()

virtual double cbl::pairs::Pair::sMin_D1 ( ) const

inlinevirtual

get the minimum separation in the first dimension

Returns: the minimum separation in the first dimension used to count the pairs

Reimplemented in cbl::pairs::Pair2D_comovingPolar, and cbl::pairs::Pair2D_comovingCartesian.

Definition at line 805 of file Pair.h.

◆ sMin_D2()

virtual double cbl::pairs::Pair::sMin_D2 ( ) const

inlinevirtual

get the minimum separation in the second dimension

Returns: the minimum separation in the second dimension used to count the pairs

Reimplemented in cbl::pairs::Pair2D_comovingPolar, and cbl::pairs::Pair2D_comovingCartesian.

Definition at line 821 of file Pair.h.

◆ Sum()

virtual void cbl::pairs::Pair::Sum	(	const std::shared_ptr< Pair >	pp,
		const double	ww = `1`
	)

pure virtual

sum the number of binned pairs

Parameters

pp	an object of class Pair
ww	the weight

Implemented in cbl::pairs::Pair2D, cbl::pairs::Pair2D_extra, cbl::pairs::Pair1D_comoving_multipoles_log_extra, cbl::pairs::Pair1D_comoving_multipoles_lin_extra, cbl::pairs::Pair1D_extra, cbl::pairs::Pair1D_comoving_multipoles_log, cbl::pairs::Pair1D_comoving_multipoles_lin, and cbl::pairs::Pair1D.

◆ z_mean() [1/3]

virtual std::vector<double> cbl::pairs::Pair::z_mean ( ) const

inlinevirtual

get the protected member Pair1D_extra::m_z_mean

Returns: the vector containing the mean redshifts

Reimplemented in cbl::pairs::Pair1D_extra.

Definition at line 433 of file Pair.h.

◆ z_mean() [2/3]

virtual double cbl::pairs::Pair::z_mean ( const int i ) const

inlinevirtual

get the protected member Pair1D_extra::m_z_mean[i]

Parameters

i	the bin index

Returns: the mean redshift in the i-th bin

Reimplemented in cbl::pairs::Pair1D_extra.

Definition at line 426 of file Pair.h.

◆ z_mean() [3/3]

virtual double cbl::pairs::Pair::z_mean	(	const int	i,
		const int	j
	)		const

inlinevirtual

get the protected member m_z_mean[i][j]

Parameters

i	the bin index in the first dimension
j	the bin index in the second dimension

Returns: the mean redshift, in the i-j bin

Reimplemented in cbl::pairs::Pair2D_extra.

Definition at line 649 of file Pair.h.

◆ z_mean2D()

virtual std::vector<std::vector<double> > cbl::pairs::Pair::z_mean2D ( ) const

inlinevirtual

get the protected member m_z_mean

Returns: the matrix containing the mean redshifts

Definition at line 656 of file Pair.h.

◆ z_S() [1/3]

virtual std::vector<double> cbl::pairs::Pair::z_S ( ) const

inlinevirtual

get the protected member Pair1D_extra::m_z_S

Returns: the vector the square of the standard deviations of the redshift distribution, multiplied by the total weight

Reimplemented in cbl::pairs::Pair1D_extra.

Definition at line 451 of file Pair.h.

◆ z_S() [2/3]

virtual double cbl::pairs::Pair::z_S ( const int i ) const

inlinevirtual

get the protected member Pair1D_extra::m_z_S[i]

Parameters

i	the bin index

Returns: the square of the standard deviations of the redshift distribution, multiplied by the total weight, in the i-th bin

Reimplemented in cbl::pairs::Pair1D_extra.

Definition at line 443 of file Pair.h.

◆ z_S() [3/3]

virtual double cbl::pairs::Pair::z_S	(	const int	i,
		const int	j
	)		const

inlinevirtual

get the member m_z_sigma[i][j]

Parameters

i	the bin index in the first dimension
j	the bin index in the second dimension

Returns: the square of the standard deviations of the redshift distribution, multiplied by the total weight, in the i-th bin

Reimplemented in cbl::pairs::Pair2D_extra.

Definition at line 667 of file Pair.h.

◆ z_sigma() [1/3]

virtual std::vector<double> cbl::pairs::Pair::z_sigma ( ) const

inlinevirtual

get the protected member Pair1D_extra::m_z_sigma

Returns: the vector containing the standard deviations of the redshift distribution

Reimplemented in cbl::pairs::Pair1D_extra.

Definition at line 468 of file Pair.h.

◆ z_sigma() [2/3]

virtual double cbl::pairs::Pair::z_sigma ( const int i ) const

inlinevirtual

get the protected member Pair1D_extra::m_z_sigma[i]

Parameters

i	the bin index

Returns: the standard deviation of the redshift distribution in the i-th bin

Reimplemented in cbl::pairs::Pair1D_extra.

Definition at line 460 of file Pair.h.

◆ z_sigma() [3/3]

virtual double cbl::pairs::Pair::z_sigma	(	const int	i,
		const int	j
	)		const

inlinevirtual

get the member m_z_sigma[i][j]

Parameters

i	the bin index in the first dimension
j	the bin index in the second dimension

Returns: the standard deviation of the redshift distribution in the i-th bin

Reimplemented in cbl::pairs::Pair2D_extra.

Definition at line 677 of file Pair.h.

◆ z_sigma2D()

virtual std::vector<std::vector<double> > cbl::pairs::Pair::z_sigma2D ( ) const

inlinevirtual

get the member std::vector<double> m_z_sigma

Returns: the vector containing the standard deviations of the redshift distribution

Definition at line 685 of file Pair.h.

The documentation for this class was generated from the following files:

Headers/Pair.h
Measure/TwoPointCorrelation/Pair.cpp

Public Member Functions

Protected Attributes

Private Member Functions

Constructors/destructors

Detailed Description

Member Function Documentation

◆ add_data1D() [1/2]

◆ add_data1D() [2/2]

◆ add_data2D() [1/2]

◆ add_data2D() [2/2]

◆ angularUnits()

◆ angularWeight()

◆ binSize_inv()

◆ binSize_inv_D1()

◆ binSize_inv_D2()

◆ Create() [1/4]

◆ Create() [2/4]

◆ Create() [3/4]

◆ Create() [4/4]

◆ get() [1/3]

◆ get() [2/3]

◆ get() [3/3]

◆ nbins()

◆ nbins_D1()

◆ nbins_D2()

◆ pairDim()

◆ pairInfo()

◆ pairType()

◆ PP1D() [1/2]

◆ PP1D() [2/2]

◆ PP1D_weighted() [1/2]

◆ PP1D_weighted() [2/2]

◆ PP2D() [1/2]

◆ PP2D() [2/2]

◆ PP2D_weighted() [1/2]

◆ PP2D_weighted() [2/2]

◆ put()

◆ reset()

◆ scale() [1/2]

◆ scale() [2/2]

◆ scale_D1() [1/2]

◆ scale_D1() [2/2]

◆ scale_D1_mean() [1/2]

◆ scale_D1_mean() [2/2]

◆ scale_D1_S() [1/2]

◆ scale_D1_S() [2/2]

◆ scale_D1_sigma() [1/2]

◆ scale_D1_sigma() [2/2]

◆ scale_D2() [1/2]

◆ scale_D2() [2/2]

◆ scale_D2_mean() [1/2]

◆ scale_D2_mean() [2/2]

◆ scale_D2_S() [1/2]

◆ scale_D2_S() [2/2]

◆ scale_D2_sigma() [1/2]

◆ scale_D2_sigma() [2/2]

◆ scale_mean() [1/2]

◆ scale_mean() [2/2]

◆ scale_S() [1/2]

◆ scale_S() [2/2]

◆ scale_sigma() [1/2]

◆ scale_sigma() [2/2]

◆ set() [1/3]

◆ set() [2/3]

◆ set() [3/3]

◆ set_PP1D()

◆ set_PP1D_weighted()

◆ set_PP2D()

◆ set_PP2D_weighted()

◆ shift()

◆ shift_D1()

◆ shift_D2()

◆ sMax()

◆ sMax_D1()

◆ sMax_D2()

◆ sMin()

◆ sMin_D1()

◆ sMin_D2()

◆ Sum()

◆ z_mean() [1/3]