![]() |
CosmoBolognaLib
Free Software C++/Python libraries for cosmological calculations
|
The class Pair2D_extra. More...
#include "Headers/Pair2D_extra.h"


Public Member Functions | |
Constructors/destructors | |
| 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 | |
Member functions to get the protected members | |
| 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... | |
Member functions used to set the protected members | |
| 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... | |
Member functions used to handle object pairs | |
| 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 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_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 | 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... | |
| Pair ()=default | |
| default constuctor | |
| virtual | ~Pair ()=default |
| default destructor | |
Protected Attributes | |
| 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 | |
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 Member Functions inherited from cbl::pairs::Pair2D | |
| 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 | |
The class Pair2D_extra.
This class is used to handle objects of type Pair2D_extra .
Definition at line 57 of file Pair2D_extra.h.
|
inline |
constructor
| binSize_D1 | the bin size in the first dimension |
| nbins_D1 | number of bins in the first dimension |
| shift_D1 | radial shift used to centre the output bins in the first dimension |
| binSize_D2 | the bin size in the second dimension |
| nbins_D2 | number of bins in the second dimension |
| shift_D2 | radial shift used to centre the output bins in the second dimension |
| angularUnits | angular units |
| angularWeight | angular weight function |
Definition at line 114 of file Pair2D_extra.h.
|
overridevirtual |
set the protected members by adding new data
| 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 from cbl::pairs::Pair2D.
Definition at line 435 of file Pair2D_extra.cpp.
|
overridevirtual |
set the protected members by adding new data
| 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 from cbl::pairs::Pair2D.
Definition at line 374 of file Pair2D_extra.cpp.
|
inlineoverridevirtual |
get the protected member m_scale_D1_mean
Reimplemented from cbl::pairs::Pair.
Definition at line 144 of file Pair2D_extra.h.
|
inlineoverridevirtual |
get the protected member m_scale_D1_mean[i][j]
| i | the bin index in the first dimension |
| j | the bin index in the second dimension |
Reimplemented from cbl::pairs::Pair.
Definition at line 137 of file Pair2D_extra.h.
|
inlineoverridevirtual |
get the member std::vector<double> m_scale_D1_S
Reimplemented from cbl::pairs::Pair.
Definition at line 177 of file Pair2D_extra.h.
|
inlineoverridevirtual |
get the member m_scale_D1_S[i][j]
| i | the bin index in the first dimension |
| j | the bin index in the second dimension |
Reimplemented from cbl::pairs::Pair.
Definition at line 169 of file Pair2D_extra.h.
|
inlineoverridevirtual |
get the member std::vector<double> m_scale_D1_sigma
Reimplemented from cbl::pairs::Pair.
Definition at line 211 of file Pair2D_extra.h.
|
inlineoverridevirtual |
get the member m_scale_D1_sigma[i][j]
| i | the bin index in the first dimension |
| j | the bin index in the second dimension |
Reimplemented from cbl::pairs::Pair.
Definition at line 204 of file Pair2D_extra.h.
|
inlineoverridevirtual |
get the protected member m_scale_D2_mean
Reimplemented from cbl::pairs::Pair.
Definition at line 159 of file Pair2D_extra.h.
|
inlineoverridevirtual |
get the protected member m_scale_D2_mean[i][j]
| i | the bin index in the first dimension |
| j | the bin index in the second dimension |
Reimplemented from cbl::pairs::Pair.
Definition at line 152 of file Pair2D_extra.h.
|
inlineoverridevirtual |
get the member std::vector<double> m_scale_D2_S
Reimplemented from cbl::pairs::Pair.
Definition at line 195 of file Pair2D_extra.h.
|
inlineoverridevirtual |
get the member m_scale_D2_S[i][j]
| i | the bin index in the first dimension |
| j | the bin index in the second dimension |
Reimplemented from cbl::pairs::Pair.
Definition at line 187 of file Pair2D_extra.h.
|
inlineoverridevirtual |
get the member std::vector<double> m_scale_D2_sigma
Reimplemented from cbl::pairs::Pair.
Definition at line 227 of file Pair2D_extra.h.
|
inlineoverridevirtual |
get the member m_scale_D2_sigma[i][j]
| i | the bin index in the first dimension |
| j | the bin index in the second dimension |
Reimplemented from cbl::pairs::Pair.
Definition at line 220 of file Pair2D_extra.h.
|
inline |
set the protected member Pair2D::m_scale_D1[i][j]
| i | the bin index in the first dimension |
| j | the bin index in the second dimension |
| ss | the mean scale in the first dimension |
Definition at line 271 of file Pair2D_extra.h.
|
inline |
set the protected member Pair2D::m_scale_D1[i][j]
| i | the bin index in the first dimension |
| j | the bin index in the second dimension |
| ss | the standard deviation of the scale distribution in the first dimension |
Definition at line 290 of file Pair2D_extra.h.
|
inline |
set the protected member Pair2D::m_scale_D2[i][j]
| i | the bin index in the second dimension |
| j | the bin index in the second dimension |
| ss | the mean scale in the second dimension |
Definition at line 280 of file Pair2D_extra.h.
|
inline |
set the protected member Pair2D::m_scale_D2[i][j]
| i | the bin index in the first dimension |
| j | the bin index in the second dimension |
| ss | the standard deviation of the scale distribution in the second dimension |
Definition at line 300 of file Pair2D_extra.h.
|
inline |
set the protected member Pair2D::m_z_mean[i][j]
| i | the bin index in the first dimension |
| j | the bin index in the second dimension |
| ss | the mean redshift |
Definition at line 309 of file Pair2D_extra.h.
|
inline |
set the protected member Pair2D::m_z_sigma[i][j]
| i | the bin index in the first dimension |
| j | the bin index in the second dimension |
| ss | the standard deviation of the redshift distribution |
Definition at line 319 of file Pair2D_extra.h.
|
overridevirtual |
sum the number of binned pairs
| pair | an object of class Pair |
| ww | the weight |
Reimplemented from cbl::pairs::Pair2D.
Definition at line 444 of file Pair2D_extra.cpp.
|
inlineoverridevirtual |
get the protected member m_z_mean[i][j]
| i | the bin index in the first dimension |
| j | the bin index in the second dimension |
Reimplemented from cbl::pairs::Pair.
Definition at line 235 of file Pair2D_extra.h.
|
inlineoverridevirtual |
get the member m_z_S[i][j]
| i | the bin index in the first dimension |
| j | the bin index in the second dimension |
Reimplemented from cbl::pairs::Pair.
Definition at line 245 of file Pair2D_extra.h.
|
inlineoverridevirtual |
get the member m_z_sigma[i][j]
| i | the bin index in the first dimension |
| j | the bin index in the second dimension |
Reimplemented from cbl::pairs::Pair.
Definition at line 254 of file Pair2D_extra.h.