#include "Headers/Pair1D.h"

Inheritance diagram for cbl::pairs::Pair1D_comoving_lin:

[legend]

Collaboration diagram for cbl::pairs::Pair1D_comoving_lin:

[legend]

Public Member Functions
Constructors/destructors
	Pair1D_comoving_lin ()
	default constructor

	Pair1D_comoving_lin (const double rMin, const double rMax, const int nbins, const double shift, const CoordinateUnits angularUnits=CoordinateUnits::_radians_, std::function< double(double)> angularWeight=nullptr)
	constructor More...

	Pair1D_comoving_lin (const double rMin, const double rMax, const double binSize, const double shift, const CoordinateUnits angularUnits=CoordinateUnits::_radians_, std::function< double(double)> angularWeight=nullptr)
	constructor More...

	~Pair1D_comoving_lin ()=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 &kk, double &wkk) override
	get the pair index and weight More...

void	set (const int kk, const double wkk, 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::Pair1D_comoving
	Pair1D_comoving ()
	default constructor

	Pair1D_comoving (const double rMin, const double rMax, const int nbins, const double shift, const CoordinateUnits angularUnits=CoordinateUnits::_radians_, std::function< double(double)> angularWeight=nullptr)
	constructor More...

	Pair1D_comoving (const double rMin, const double rMax, const double binSize, const double shift, const CoordinateUnits angularUnits=CoordinateUnits::_radians_, std::function< double(double)> angularWeight=nullptr)
	constructor More...

virtual	~Pair1D_comoving ()=default
	default destructor

double	sMin () const override
	get the protected member Pair1D::m_rMin More...

double	sMax () const override
	get the protected member Pair1D::m_rMax More...

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

	Pair1D (const double binSize, const int nbins, const double shift, const CoordinateUnits angularUnits, std::function< double(double)> angularWeight=nullptr)
	constructor More...

virtual	~Pair1D ()=default
	default destructor

double	scale (const int i) const override
	get the protected member Pair1D::m_scale[i] More...

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

double	PP1D (const int i) const override
	get the protected member Pair1D::m_PP1D[i] More...

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

double	PP1D_weighted (const int i) const override
	get the protected member Pair1D::m_PP1D_weighted[i] More...

std::vector< double >	PP1D_weighted () const override
	get the protected member Pair1D::m_PP1D More...

double	binSize_inv () const override
	get the protected member Pair1D::m_binSize_inv More...

int	nbins () const override
	get the protected member Pair1D::m_nbins More...

double	shift () const override
	get the protected member Pair1D::m_shift More...

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

void	set_scale (const int i, const double ss)
	set the protected member Pair1D::m_scale[i] More...

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

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

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

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

virtual void	Sum (const std::shared_ptr< Pair > pair, 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_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	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_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_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...

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_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...

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 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...

	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::Pair1D_comoving
double	m_rMin
	minimum separation used to count the pairs

double	m_rMax
	maximum separation used to count the pairs

Protected Attributes inherited from cbl::pairs::Pair1D
std::vector< double >	m_scale
	the binned scales

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

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

double	m_binSize_inv
	the inverse of the bin size

int	m_nbins
	number of bins

double	m_shift
	radial shift used to centre the output bins

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 Pair1D_comoving_lin.

This class is used to handle objects of type Pair1D_comoving_lin .

Definition at line 832 of file Pair1D.h.

Constructor & Destructor Documentation

◆ Pair1D_comoving_lin() [1/2]

cbl::pairs::Pair1D_comoving_lin::Pair1D_comoving_lin	(	const double	rMin,
		const double	rMax,
		const int	nbins,
		const double	shift,
		const CoordinateUnits	angularUnits = `CoordinateUnits::_radians_`,
		std::function< double(double)>	angularWeight = `nullptr`
	)

inline

constructor

Parameters

rMin	minimum separation used to count the pairs
rMax	maximum separation 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

Definition at line 881 of file Pair1D.h.

◆ Pair1D_comoving_lin() [2/2]

cbl::pairs::Pair1D_comoving_lin::Pair1D_comoving_lin	(	const double	rMin,
		const double	rMax,
		const double	binSize,
		const double	shift,
		const CoordinateUnits	angularUnits = `CoordinateUnits::_radians_`,
		std::function< double(double)>	angularWeight = `nullptr`
	)

inline

constructor

Parameters

rMin	minimum separation used to count the pairs
rMax	maximum separation used to count the pairs
binSize	size of the bins
shift	shift parameter, i.e. the radial shift is binSize*shift
angularUnits	angular units
angularWeight	angular weight function

Definition at line 901 of file Pair1D.h.

Member Function Documentation

◆ get()

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

overridevirtual

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

Definition at line 280 of file Pair1D.cpp.

◆ put()

void cbl::pairs::Pair1D_comoving_lin::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::Pair1D_comoving_lin_extra.

Definition at line 494 of file Pair1D.cpp.

◆ set()

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

overridevirtual

set the pair vector

Parameters

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

Reimplemented from cbl::pairs::Pair.

Definition at line 391 of file Pair1D.cpp.

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

Headers/Pair1D.h
Measure/TwoPointCorrelation/Pair1D.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Pair1D_comoving_lin() [1/2]

◆ Pair1D_comoving_lin() [2/2]

Member Function Documentation

◆ get()

◆ put()

◆ set()