#include <Triplet1D.h>

Inheritance diagram for cbl::triplets::Triplet1D:

[legend]

Collaboration diagram for cbl::triplets::Triplet1D:

Public Member Functions
Constructors/destructors
	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

Member functions used to get the protected members
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...

Member functions used to set private/protected members
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...

Member functions used to handle triplets
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 void	get_triplet (const double r12, const double r13, const double r23, int &klin)=0
	estimate the distance between two objects and update the triplet vectors accordingly More...

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

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

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

virtual	~Triplet ()
	default destructor

Protected Attributes
std::vector< double >	m_scale
	the binned scales

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

Binning parameters
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

Private Member Functions
Member functions used to set the binning parameters
(customized in all the derived classes)
virtual void	set_parameters ()=0
	set the binning parameters

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

Detailed Description

The class Triplet1D.

"Headers/Triplet1D.h"

This class is used to handle objects of type Triplet1D , used to handle 1D triplets of objects

Definition at line 62 of file Triplet1D.h.

Constructor & Destructor Documentation

◆ Triplet1D()

cbl::triplets::Triplet1D::Triplet1D	(	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 137 of file Triplet1D.h.

Member Function Documentation

◆ add_TT1D()

void cbl::triplets::Triplet1D::add_TT1D	(	const int	i,
		const double	tt
	)

inlinevirtual

set the protected member m_TT1D[i] adding the number of triplets

Parameters

i	the bin index
tt	the number of triplets in the bin

Reimplemented from cbl::triplets::Triplet.

Definition at line 240 of file Triplet1D.h.

◆ binSize()

double cbl::triplets::Triplet1D::binSize ( ) const

inlineoverridevirtual

get the protected member m_binSize

Returns: the bin size

Reimplemented from cbl::triplets::Triplet.

Definition at line 215 of file Triplet1D.h.

◆ nbins()

int cbl::triplets::Triplet1D::nbins ( ) const

inlineoverridevirtual

get the protected member m_nbins

Returns: the number of bins

Reimplemented from cbl::triplets::Triplet.

Definition at line 209 of file Triplet1D.h.

◆ r12()

double cbl::triplets::Triplet1D::r12 ( ) const

inlineoverridevirtual

get the private member m_r12

Returns: the size of r₁₂

Reimplemented from cbl::triplets::Triplet.

Definition at line 185 of file Triplet1D.h.

◆ r12_binSize()

double cbl::triplets::Triplet1D::r12_binSize ( ) const

inlineoverridevirtual

get the private member m_r12_binSize

Returns: the size of the r₁₂ bin

Reimplemented from cbl::triplets::Triplet.

Definition at line 191 of file Triplet1D.h.

◆ r13()

double cbl::triplets::Triplet1D::r13 ( ) const

inlineoverridevirtual

get the private member m_r13

Returns: the size of r₁₃

Reimplemented from cbl::triplets::Triplet.

Definition at line 197 of file Triplet1D.h.

◆ r13_binSize()

double cbl::triplets::Triplet1D::r13_binSize ( ) const

inlineoverridevirtual

get the private member m_r13_binSize

Returns: the size of r₁₃ bin

Reimplemented from cbl::triplets::Triplet.

Definition at line 203 of file Triplet1D.h.

◆ scale() [1/2]

std::vector<double> cbl::triplets::Triplet1D::scale ( ) const

inlineoverridevirtual

get the protected member m_scale

Returns: the vector containing the binned scales

Reimplemented from cbl::triplets::Triplet.

Definition at line 166 of file Triplet1D.h.

◆ scale() [2/2]

double cbl::triplets::Triplet1D::scale ( const int i ) const

inlineoverridevirtual

get the protected member m_scale[i]

Parameters

i	the bin index

Returns: the i-th binned scale

Reimplemented from cbl::triplets::Triplet.

Definition at line 160 of file Triplet1D.h.

◆ set_TT1D()

void cbl::triplets::Triplet1D::set_TT1D	(	const int	i,
		const double	tt
	)

inlinevirtual

set the member m_TT1D[i]

Parameters

i	the bin index
tt	the number of triplets in the bin

Reimplemented from cbl::triplets::Triplet.

Definition at line 231 of file Triplet1D.h.

◆ Sum()

void cbl::triplets::Triplet1D::Sum	(	const std::shared_ptr< Triplet >	tt,
		const double	ww = `1`
	)

overridevirtual

sum the number of triplets

Parameters

tt	pointer to an object of class Triplet
ww	the weight

Implements cbl::triplets::Triplet.

Definition at line 68 of file Triplet.cpp.

◆ TT1D() [1/2]

std::vector<double> cbl::triplets::Triplet1D::TT1D ( ) const

inlineoverridevirtual

get the private member m_TT1D

Returns: the vector containing the number of triplets

Reimplemented from cbl::triplets::Triplet.

Definition at line 179 of file Triplet1D.h.

◆ TT1D() [2/2]

double cbl::triplets::Triplet1D::TT1D ( const int i ) const

inlineoverridevirtual

get the private member m_TT1D[i]

Parameters

i	the bin index

Returns: the number of triplets in the i-th bin

Reimplemented from cbl::triplets::Triplet.

Definition at line 173 of file Triplet1D.h.

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

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

Public Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Triplet1D()

Member Function Documentation

◆ add_TT1D()

◆ binSize()

◆ nbins()

◆ r12()

◆ r12_binSize()

◆ r13()

◆ r13_binSize()

◆ scale() [1/2]

◆ scale() [2/2]

◆ set_TT1D()

◆ Sum()

◆ TT1D() [1/2]

◆ TT1D() [2/2]