The class Pair2D_comovingCartesian_loglog. More...

#include <Pair2D.h>

Inheritance diagram for cbl::pairs::Pair2D_comovingCartesian_loglog:

[legend]

Collaboration diagram for cbl::pairs::Pair2D_comovingCartesian_loglog:

[legend]

Public Member Functions
Constructors/destructors
	Pair2D_comovingCartesian_loglog ()
	default constructor

	Pair2D_comovingCartesian_loglog (const double rpMin, const double rpMax, const int nbins_rp, const double shift_rp, const double piMin, const double piMax, const int nbins_pi, const double shift_pi, const CoordinateUnits angularUnits=CoordinateUnits::_radians_, std::function< double(double)> angularWeight=nullptr)
	constructor More...

	Pair2D_comovingCartesian_loglog (const double rpMin, const double rpMax, const double binSize_rp, const double shift_rp, const double piMin, const double piMax, const double binSize_pi, const double shift_pi, const CoordinateUnits angularUnits=CoordinateUnits::_radians_, std::function< double(double)> angularWeight=nullptr)
	constructor More...

	~Pair2D_comovingCartesian_loglog ()=default
	default destructor

Member functions used to handle pairs
void	get (const std::shared_ptr< catalogue::Object > obj1, const std::shared_ptr< catalogue::Object > obj2, int &ir, int &jr, double &ww) override
	get the pair index and weight More...

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

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

Public Member Functions inherited from cbl::pairs::Pair2D_comovingCartesian
	Pair2D_comovingCartesian ()
	default constructor

	Pair2D_comovingCartesian (const double rpMin, const double rpMax, const int nbins_rp, const double shift_rp, const double piMin, const double piMax, const int nbins_pi, const double shift_pi, const CoordinateUnits angularUnits=CoordinateUnits::_radians_, std::function< double(double)> angularWeight=nullptr)
	constructor More...

	Pair2D_comovingCartesian (const double rpMin, const double rpMax, const double binSize_rp, const double shift_rp, const double piMin, const double piMax, const double binSize_pi, const double shift_pi, const CoordinateUnits angularUnits=CoordinateUnits::_radians_, std::function< double(double)> angularWeight=nullptr)
	constructor More...

virtual	~Pair2D_comovingCartesian ()=default
	default destructor

double	sMin_D1 () const override
	get the protected member Pair2D::m_rpMin More...

double	sMax_D1 () const override
	get the protected member Pair2D::m_rpMax More...

double	sMin_D2 () const override
	get the protected member Pair2D::m_piMin More...

double	sMax_D2 () const override
	get the protected member Pair2D::m_piMax More...

Public Member Functions inherited from cbl::pairs::Pair2D
	Pair2D ()
	default constructor

	Pair2D (const double binSize_D1, const int nbins_D1, const double shift_D1, const double binSize_D2, const int nbins_D2, const double shift_D2, const CoordinateUnits angularUnits=CoordinateUnits::_radians_, std::function< double(double)> angularWeight=nullptr)
	constructor More...

virtual	~Pair2D ()=default
	default destructor

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

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

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

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

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

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

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

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

double	binSize_inv_D1 () const override
	get the protected member Pair2D::m_binSize_inv_D1 More...

int	nbins_D1 () const override
	get the protected member Pair2D::m_nbins_D1 More...

double	shift_D1 () const override
	get the protected member Pair2D::m_shift_D1 More...

double	binSize_inv_D2 () const override
	get the protected member Pair2D::m_binSize_inv_D2 More...

int	nbins_D2 () const override
	get the protected member Pair2D::m_nbins_D2 More...

double	shift_D2 () const override
	get the protected member Pair2D::m_shift_D2 More...

void	reset () override
	reset the pair counts More...

void	set_scale_D1 (const int i, const double pp)
	set the protected member Pair2D::m_scale_D1[i] More...

void	set_scale_D2 (const int i, const double pp)
	set the protected member Pair2D::m_scale_D2[i] More...

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

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

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

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

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

Public Member Functions inherited from cbl::pairs::Pair
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_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	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	sMin () const
	get the minimum separation More...

virtual double	sMax () const
	get the the minimum separation 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	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	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	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...

	Pair ()=default
	default constuctor

virtual	~Pair ()=default
	default destructor

Protected Member Functions
Member functions used to set the binning parameters
void	m_set_parameters_nbins () override
	set the binning parameters given the number of bins

void	m_set_parameters_binSize () override
	set the binning parameters given the bin size

Member functions used to set the binning parameters (customized in all the derived classes)
Member functions used to set the binning parameters (customized in all the derived classes)

Additional Inherited Members
Static Public Member Functions inherited from cbl::pairs::Pair
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...

Protected Attributes inherited from cbl::pairs::Pair2D_comovingCartesian
double	m_rpMin
	minimum perpendicular separation used to count the pairs

double	m_rpMax
	maximum perpendicular separation used to count the pairs

double	m_piMin
	minimum parallel separation used to count the pairs

double	m_piMax
	maximum parallel separation used to count the pairs

Protected Attributes inherited from cbl::pairs::Pair2D
std::vector< double >	m_scale_D1
	the binned scales in the first dimension

std::vector< double >	m_scale_D2
	the binned scales in the second dimension

std::vector< std::vector< double > >	m_PP2D
	the number of binned pairs

std::vector< std::vector< double > >	m_PP2D_weighted
	the weighted number of binned pairs

double	m_binSize_inv_D1
	the inverse of the bin size in the first dimension

int	m_nbins_D1
	number of bins in the first dimension

double	m_shift_D1
	radial shift used to centre the output bins in the first dimension

double	m_binSize_inv_D2
	the inverse of the bin size in the second dimension

int	m_nbins_D2
	number of bins in the second dimension

double	m_shift_D2
	radial shift used to centre the output bins in the second dimension

Protected Attributes inherited from cbl::pairs::Pair
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

Detailed Description

The class Pair2D_comovingCartesian_loglog.

"Headers/Pair2D.h"

This class is used to handle objects of type Pair2D_comovingCartesian_loglog .

Definition at line 981 of file Pair2D.h.

Constructor & Destructor Documentation

◆ Pair2D_comovingCartesian_loglog() [1/2]

cbl::pairs::Pair2D_comovingCartesian_loglog::Pair2D_comovingCartesian_loglog	(	const double	rpMin,
		const double	rpMax,
		const int	nbins_rp,
		const double	shift_rp,
		const double	piMin,
		const double	piMax,
		const int	nbins_pi,
		const double	shift_pi,
		const CoordinateUnits	angularUnits = `CoordinateUnits::_radians_`,
		std::function< double(double)>	angularWeight = `nullptr`
	)

inline

constructor

Parameters

rpMin	minimum perpendicular separation used to count the pairs
rpMax	maximum perpendicular separation used to count the pairs
nbins_rp	number of bins in the perpendicular separation
shift_rp	shift parameter in the perpendicular separation, i.e. the shift is binSize*shift
piMin	minimum parallel separation used to count the pairs
piMax	maximum parallel separation used to count the pairs
nbins_pi	number of bins in the parallel separation
shift_pi	shift parameter in the parallel separation, i.e. the shift is binSize*shift
angularUnits	angular units
angularWeight	angular weight function

Definition at line 1037 of file Pair2D.h.

◆ Pair2D_comovingCartesian_loglog() [2/2]

cbl::pairs::Pair2D_comovingCartesian_loglog::Pair2D_comovingCartesian_loglog	(	const double	rpMin,
		const double	rpMax,
		const double	binSize_rp,
		const double	shift_rp,
		const double	piMin,
		const double	piMax,
		const double	binSize_pi,
		const double	shift_pi,
		const CoordinateUnits	angularUnits = `CoordinateUnits::_radians_`,
		std::function< double(double)>	angularWeight = `nullptr`
	)

inline

constructor

Parameters

rpMin	minimum perpendicular separation used to count the pairs
rpMax	maximum perpendicular separation used to count the pairs
binSize_rp	size of the bins in the perpendicular separation
shift_rp	shift parameter in the perpendicular separation, i.e. the shift is binSize*shift
piMin	minimum parallel separation used to count the pairs
piMax	maximum parallel separation used to count the pairs
binSize_pi	size of the bins in the parallel separation
shift_pi	shift parameter in the parallel separation, i.e. the shift is binSize*shift
angularUnits	angular units
angularWeight	angular weight function

Definition at line 1064 of file Pair2D.h.

Member Function Documentation

◆ get()

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

overridevirtual

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 from cbl::pairs::Pair.

Definition at line 478 of file Pair2D.cpp.

◆ put()

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

overridevirtual

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

Implements cbl::pairs::Pair.

Reimplemented in cbl::pairs::Pair2D_comovingCartesian_loglog_extra.

Definition at line 676 of file Pair2D.cpp.

◆ set()

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

overridevirtual

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 from cbl::pairs::Pair.

Definition at line 827 of file Pair2D.cpp.

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

Headers/Pair2D.h
Measure/TwoPointCorrelation/Pair2D.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Pair2D_comovingCartesian_loglog() [1/2]

◆ Pair2D_comovingCartesian_loglog() [2/2]

Member Function Documentation

◆ get()

◆ put()

◆ set()