CosmoBolognaLib
Free Software C++/Python libraries for cosmological calculations
cbl::pairs::Pair2D_comovingCartesian_loglin_extra Class Reference

The class Pair2D_comovingCartesian_loglin_extra. More...

#include <Pair2D_extra.h>

Inheritance diagram for cbl::pairs::Pair2D_comovingCartesian_loglin_extra:
Collaboration diagram for cbl::pairs::Pair2D_comovingCartesian_loglin_extra:

Public Member Functions

Constructors/destructors
 Pair2D_comovingCartesian_loglin_extra ()
 default constructor
 
 Pair2D_comovingCartesian_loglin_extra (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_loglin_extra (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_loglin_extra ()=default
 default destructor
 
Member functions used to handle pairs
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_extra
 Pair2D_comovingCartesian_extra ()=default
 default constructor
 
 Pair2D_comovingCartesian_extra (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_extra (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_extra ()=default
 default destructor
 
- Public Member Functions inherited from cbl::pairs::Pair2D_extra
 Pair2D_extra ()=default
 default constructor
 
 Pair2D_extra (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_extra ()=default
 default destructor
 
double scale_D1_mean (const int i, const int j) const override
 get the protected member m_scale_D1_mean[i][j] More...
 
std::vector< std::vector< double > > scale_D1_mean () const override
 get the protected member m_scale_D1_mean More...
 
double scale_D2_mean (const int i, const int j) const override
 get the protected member m_scale_D2_mean[i][j] More...
 
std::vector< std::vector< double > > scale_D2_mean () const override
 get the protected member m_scale_D2_mean More...
 
double scale_D1_S (const int i, const int j) const override
 get the member m_scale_D1_S[i][j] More...
 
std::vector< std::vector< double > > scale_D1_S () const override
 get the member std::vector<double> m_scale_D1_S More...
 
double scale_D2_S (const int i, const int j) const override
 get the member m_scale_D2_S[i][j] More...
 
std::vector< std::vector< double > > scale_D2_S () const override
 get the member std::vector<double> m_scale_D2_S More...
 
double scale_D1_sigma (const int i, const int j) const override
 get the member m_scale_D1_sigma[i][j] More...
 
std::vector< std::vector< double > > scale_D1_sigma () const override
 get the member std::vector<double> m_scale_D1_sigma More...
 
double scale_D2_sigma (const int i, const int j) const override
 get the member m_scale_D2_sigma[i][j] More...
 
std::vector< std::vector< double > > scale_D2_sigma () const override
 get the member std::vector<double> m_scale_D2_sigma More...
 
double z_mean (const int i, const int j) const override
 get the protected member m_z_mean[i][j] More...
 
double z_S (const int i, const int j) const override
 get the member m_z_S[i][j] More...
 
double z_sigma (const int i, const int j) const override
 get the member m_z_sigma[i][j] More...
 
void set_scale_D1_mean (const int i, const int j, const double ss)
 set the protected member Pair2D::m_scale_D1[i][j] More...
 
void set_scale_D2_mean (const int i, const int j, const double ss)
 set the protected member Pair2D::m_scale_D2[i][j] More...
 
void set_scale_D1_sigma (const int i, const int j, const double ss)
 set the protected member Pair2D::m_scale_D1[i][j] More...
 
void set_scale_D2_sigma (const int i, const int j, const double ss)
 set the protected member Pair2D::m_scale_D2[i][j] More...
 
void set_z_mean (const int i, const int j, const double ss)
 set the protected member Pair2D::m_z_mean[i][j] More...
 
void set_z_sigma (const int i, const int j, const double ss)
 set the protected member Pair2D::m_z_sigma[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 > pair, const double ww=1) override
 sum the number of binned pairs 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...
 
- 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 std::vector< std::vector< double > > z_mean2D () const
 get the protected member m_z_mean 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
 
- 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_comovingCartesian_loglin
 Pair2D_comovingCartesian_loglin ()
 default constructor
 
 Pair2D_comovingCartesian_loglin (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_loglin (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_loglin ()=default
 default destructor
 
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...
 

Additional Inherited Members

- Static Public Member Functions inherited from cbl::pairs::Pair
static std::shared_ptr< PairCreate (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< PairCreate (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< PairCreate (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< PairCreate (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...
 
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)
- Protected Member Functions inherited from cbl::pairs::Pair2D_comovingCartesian_loglin
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
 
- Protected Attributes inherited from cbl::pairs::Pair2D_extra
std::vector< std::vector< double > > m_scale_D1_mean
 the mean scales in each bin, in the first dimension
 
std::vector< std::vector< double > > m_scale_D2_mean
 the mean scales in each bin, in the second dimension
 
std::vector< std::vector< double > > m_scale_D1_S
 the square of the standard deviations of the scale distributions in each bin, in the first dimension, multiplied by the total weight
 
std::vector< std::vector< double > > m_scale_D2_S
 the square of the standard deviations of the scale distributions in each bin, in the second dimension, multiplied by the total weight
 
std::vector< std::vector< double > > m_scale_D1_sigma
 the standard deviations of the scale distributions in each bin, in the first dimension
 
std::vector< std::vector< double > > m_scale_D2_sigma
 the standard deviations of the scale distributions in each bin, in the second dimension
 
std::vector< std::vector< double > > m_z_mean
 the mean redshifts in each bin
 
std::vector< std::vector< double > > m_z_S
 the square of the standard deviations of the redshift distributions in each bin, multiplied by the total weight
 
std::vector< std::vector< double > > m_z_sigma
 the standard deviations of the redshift distributions in each bin
 
- 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
 
- 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
 

Detailed Description

The class Pair2D_comovingCartesian_loglin_extra.

"Headers/Pair2D_extra.h"

This class is used to handle objects of type Pair2D_comovingCartesian_loglin_extra .

Definition at line 586 of file Pair2D_extra.h.

Constructor & Destructor Documentation

◆ Pair2D_comovingCartesian_loglin_extra() [1/2]

cbl::pairs::Pair2D_comovingCartesian_loglin_extra::Pair2D_comovingCartesian_loglin_extra ( 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
rpMinminimum perpendicular separation used to count the pairs
rpMaxmaximum perpendicular separation used to count the pairs
nbins_rpnumber of bins in the perpendicular separation
shift_rpshift parameter in the perpendicular separation, i.e. the shift is binSize*shift
piMinminimum parallel separation used to count the pairs
piMaxmaximum parallel separation used to count the pairs
nbins_pinumber of bins in the parallel separation
shift_pishift parameter in the parallel separation, i.e. the shift is binSize*shift
angularUnitsangular units
angularWeightangular weight function

Definition at line 621 of file Pair2D_extra.h.

◆ Pair2D_comovingCartesian_loglin_extra() [2/2]

cbl::pairs::Pair2D_comovingCartesian_loglin_extra::Pair2D_comovingCartesian_loglin_extra ( 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
rpMinminimum perpendicular separation used to count the pairs
rpMaxmaximum perpendicular separation used to count the pairs
binSize_rpsize of the bins in the perpendicular separation
shift_rpshift parameter in the perpendicular separation, i.e. the shift is binSize*shift
piMinminimum parallel separation used to count the pairs
piMaxmaximum parallel separation used to count the pairs
binSize_pisize of the bins in the parallel separation
shift_pishift parameter in the parallel separation, i.e. the shift is binSize*shift
angularUnitsangular units
angularWeightangular weight function

Definition at line 657 of file Pair2D_extra.h.

Member Function Documentation

◆ put()

void cbl::pairs::Pair2D_comovingCartesian_loglin_extra::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
obj1pointer to an object of class Object
obj2pointer to an object of class Object

Reimplemented from cbl::pairs::Pair2D_comovingCartesian_loglin.

Definition at line 128 of file Pair2D_extra.cpp.


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