The class Triplet1D_comoving_costheta. More...

#include <Triplet1D.h>

Inheritance diagram for cbl::triplets::Triplet1D_comoving_costheta:

[legend]

Collaboration diagram for cbl::triplets::Triplet1D_comoving_costheta:

[legend]

Public Member Functions
Constructors/destructors
	Triplet1D_comoving_costheta ()
	default constructor

	Triplet1D_comoving_costheta (const double r12, const double r12_binSize, const double r13, const double r13_binSize, const int nbins)
	constructor More...

Member functions used to handle triplets
void	get_triplet (const double r12, const double r13, const double r23, int &klin) override
	estimate the distance between two objects and update the triplet vectors accordingly More...

void	set_triplet (const int klin, const double ww=1.) override
	update the triplet More...

void	put (const double r12, const double r13, const double r23, const double ww=1.) override
	estimate the distance between three objects and update the triplet vectors accordingly More...

void	put (const std::shared_ptr< catalogue::Object > obj1, const std::shared_ptr< catalogue::Object > obj2, const std::shared_ptr< catalogue::Object > obj3) override
	estimate the distance between three objects and update the triplet vectors accordingly More...

Public Member Functions inherited from cbl::triplets::Triplet1D_comoving
	Triplet1D_comoving ()=default
	default constructor

	Triplet1D_comoving (const double r12, const double r12_binSize, const double r13, const double r13_binSize, const int nbins)
	constructor More...

virtual	~Triplet1D_comoving ()=default
	default destructor

Public Member Functions inherited from cbl::triplets::Triplet1D
	Triplet1D ()
	default constructor

	Triplet1D (const double r12, const double r12_binSize, const double r13, const double r13_binSize, const int nbins)
	constructor More...

	~Triplet1D ()=default
	default destructor

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

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

double	TT1D (const int i) const override
	get the private member m_TT1D[i] More...

std::vector< double >	TT1D () const override
	get the private member m_TT1D More...

double	r12 () const override
	get the private member m_r12 More...

double	r12_binSize () const override
	get the private member m_r12_binSize More...

double	r13 () const override
	get the private member m_r13 More...

double	r13_binSize () const override
	get the private member m_r13_binSize More...

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

double	binSize () const override
	get the protected member m_binSize More...

void	set_TT1D (const int i, const double tt)
	set the member m_TT1D[i] More...

void	add_TT1D (const int i, const double tt)
	set the protected member m_TT1D[i] adding the number of triplets More...

void	Sum (const std::shared_ptr< Triplet > tt, const double ww=1) override
	sum the number of triplets More...

Public Member Functions inherited from cbl::triplets::Triplet
Dim	tripletDim () const
	get the dimension of the triplet vectors More...

TripletType	tripletType () const
	get the triplet type More...

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

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

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

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

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

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

virtual double	r12_D1 () const
	get the protected member Triplet1D::m_r12_D1 More...

virtual double	r12_binSize_D1 () const
	get the protected member Triplet1D::m_r12_binSize_D1 More...

virtual double	r13_D1 () const
	get the protected member Triplet1D::m_r13_D1 More...

virtual double	r13_binSize_D1 () const
	get the protected member Triplet1D::m_r13_binSize_D1 More...

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

virtual double	binSize_D1 () const
	get the protected member Triplet1D::m_binSize_D1 More...

virtual double	r12_D2 () const
	get the protected member Triplet1D::m_r12_D1 More...

virtual double	r12_binSize_D2 () const
	get the protected member Triplet1D::m_r12_binSize_D1 More...

virtual double	r13_D2 () const
	get the protected member Triplet1D::m_r13_D2 More...

virtual double	r13_binSize_D2 () const
	get the protected member Triplet1D::m_r13_binSize_D2 More...

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

virtual double	binSize_D2 () const
	get the protected member Triplet1D::m_binSize_D2 More...

virtual	~Triplet ()
	default destructor

Private Member Functions
Member functions used to set the binning parameters
void	set_parameters () override
	set the binning parameters More...

Additional Inherited Members
Static Public Member Functions inherited from cbl::triplets::Triplet
static std::shared_ptr< Triplet >	Create (const TripletType type, const double r12, const double r12_binSize, const double r13, const double r13_binSize, const int nbins)
	static factory used to construct triplets of any type More...

Protected Attributes inherited from cbl::triplets::Triplet1D
std::vector< double >	m_scale
	the binned scales

std::vector< double >	m_TT1D
	the number of binned triplets

double	m_r12
	the size of r₁₂

double	m_r12_binSize
	the size of r₁₂ bin

double	m_r13
	the size of r₁₃

double	m_r13_binSize
	the size of r₁₃ bin

int	m_nbins
	the number of bins

double	m_binSize
	the bin size

Protected Attributes inherited from cbl::triplets::Triplet
Dim	m_tripletDim
	the dimension of the triplet vectors

TripletType	m_tripletType
	triplet type

Detailed Description

The class Triplet1D_comoving_costheta.

"Headers/Triplet1D.h"

This class is used to handle objects of type Triplet1D_comoving_costheta , used to handle 1D triplets of objects in comoving coordinates, in bins of the cosine of the angle

Definition at line 679 of file Triplet1D.h.

Constructor & Destructor Documentation

◆ Triplet1D_comoving_costheta()

cbl::triplets::Triplet1D_comoving_costheta::Triplet1D_comoving_costheta	(	const double	r12,
		const double	r12_binSize,
		const double	r13,
		const double	r13_binSize,
		const int	nbins
	)

inline

constructor

Parameters

r12	the size of r₁₂
r12_binSize	the size of r₁₂ bin
r13	the size of r₁₃
r13_binSize	the size of r₁₃ bin
nbins	the number of bins

Definition at line 720 of file Triplet1D.h.

Member Function Documentation

◆ get_triplet()

void cbl::triplets::Triplet1D_comoving_costheta::get_triplet	(	const double	r12,
		const double	r13,
		const double	r23,
		int &	klin
	)

overridevirtual

estimate the distance between two objects and update the triplet vectors accordingly

Parameters

r12	distance between object1 and object2
r13	distance between object1 and object3
r23	distance between object2 and object3
klin	triplet bin

Implements cbl::triplets::Triplet.

Definition at line 233 of file Triplet.cpp.

◆ put() [1/2]

void cbl::triplets::Triplet1D_comoving_costheta::put	(	const double	r12,
		const double	r13,
		const double	r23,
		const double	ww = `1.`
	)

overridevirtual

estimate the distance between three objects and update the triplet vectors accordingly

Parameters

r12	distance between object1 and object2
r13	distance between object1 and object3
r23	distance between object2 and object3
ww	total weight

Implements cbl::triplets::Triplet.

Definition at line 255 of file Triplet.cpp.

◆ put() [2/2]

void cbl::triplets::Triplet1D_comoving_costheta::put	(	const std::shared_ptr< catalogue::Object >	obj1,
		const std::shared_ptr< catalogue::Object >	obj2,
		const std::shared_ptr< catalogue::Object >	obj3
	)

overridevirtual

estimate the distance between three objects and update the triplet vectors accordingly

Parameters

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

Implements cbl::triplets::Triplet.

Definition at line 269 of file Triplet.cpp.

◆ set_parameters()

void cbl::triplets::Triplet1D_comoving_costheta::set_parameters ( )

overrideprivatevirtual

set the binning parameters

Warning: This method has not been implemented yet

Implements cbl::triplets::Triplet1D_comoving.

Definition at line 220 of file Triplet.cpp.

◆ set_triplet()

void cbl::triplets::Triplet1D_comoving_costheta::set_triplet	(	const int	klin,
		const double	ww = `1.`
	)

overridevirtual

update the triplet

Parameters

klin	triplet bin
ww	the weight

Implements cbl::triplets::Triplet.

Definition at line 246 of file Triplet.cpp.

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

Headers/Triplet1D.h
Measure/ThreePointCorrelation/Triplet.cpp

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Triplet1D_comoving_costheta()

Member Function Documentation

◆ get_triplet()

◆ put() [1/2]

◆ put() [2/2]

◆ set_parameters()

◆ set_triplet()