#include <Data2D.h>

Inheritance diagram for cbl::data::Data2D:

Collaboration diagram for cbl::data::Data2D:

Public Member Functions
Constructors/destructors
	Data2D ()
	default constructor

	Data2D (const std::string input_file, const int skip_nlines=0, const std::vector< int > column={1, 2}, const std::vector< int > column_data={}, const std::vector< int > column_errors={}, const std::vector< int > column_edges={})
	constructor which reads the data from file More...

	Data2D (const std::vector< double > x, const std::vector< double > y, const std::vector< std::vector< double >> data, const std::vector< double > bin_edges_x={}, const std::vector< double > bin_edges_y={})
	constructor which gets the data from an input matrix More...

	Data2D (const std::vector< double > x, const std::vector< double > y, const std::vector< std::vector< double >> data, const std::vector< std::vector< double >> error, const std::vector< double > bin_edges_x={}, const std::vector< double > bin_edges_y={})
	constructor which gets both the data and the errors from input matrices More...

	Data2D (const std::vector< double > x, const std::vector< double > y, const std::vector< double > data, const std::vector< double > error, const std::vector< double > bin_edges_x={}, const std::vector< double > bin_edges_y={})
	constructor which gets both the data and the covariance matrix from input vectors More...

	Data2D (const std::vector< double > x, const std::vector< double > y, const std::vector< double > data, const std::vector< std::vector< double >> covariance, const std::vector< double > bin_edges_x={}, const std::vector< double > bin_edges_y={})
	constructor which gets both the data and the covariance matrix from input matrices More...

	~Data2D ()=default
	default destructor

std::shared_ptr< Data >	as_factory ()
	static factory used to construct objects of class Data2D More...

Member functions used to get the private members
int	xsize () const override
	get the number of points along x More...

int	ysize () const override
	get the number of points along y More...

double	xx (const int i) const override
	get the value of x at index i More...

std::vector< double >	xx () const override
	get the x vector More...

double	yy (const int i) const override
	get the value of y at index i More...

std::vector< double >	yy () const override
	get the y vector More...

std::vector< std::vector< double > >	IndipendentVariable (const int i=-1, const int j=-1) const override
	get the independet variable, to be used in model computation More...

double	data (const int i, const int j) const override
	get data at index i,j More...

void	get_data (std::vector< std::vector< double >> &data) const override
	get data More...

double	error (const int i, const int j) const override
	get error at index i,j More...

void	get_error (std::vector< std::vector< double >> &error) const override
	get error More...

Member functions used to set the private members
void	set_xx (const std::vector< double > x) override
	set interval variable m_x More...

void	set_yy (const std::vector< double > y) override
	set interval variable m_y More...

void	set_edges_xx (const std::vector< double > edges) override
	set interval variable m_edges_xx More...

void	set_edges_yy (const std::vector< double > edges) override
	set interval variable m_edges_yy More...

Input/Output member functions
virtual void	read (const std::string input_file, const int skip_nlines=0, const std::vector< int > column={1, 2}, const std::vector< int > column_data={}, const std::vector< int > column_errors={}, const std::vector< int > column_edges={}) override
	read the data More...

virtual void	Print (const int precision=4) const override
	print the data on screen More...

void	write (const std::string dir, const std::string file, const std::string header, const bool full, const int prec=4, const int ww=8, const int rank=0) const
	write the data More...

void	write_covariance (const std::string dir, const std::string file, const int precision=10) const override
	write the covariance More...

Member functions for data cut
std::shared_ptr< Data >	cut (const double xmin, const double xmax, const double ymin, const double ymax) const
	cut the data More...

Public Member Functions inherited from cbl::data::Data
double	correlation (const int i, const int j) const
	get the value of the data correlation at index i,j More...

std::vector< std::vector< double > >	correlation () const
	get the value of the data correlation at index i,j More...

double	inverse_covariance (const int i, const int j) const
	get the value of data inverse_covariance at index i,j More...

std::vector< std::vector< double > >	inverse_covariance () const
	get the m_inverse_covariance std::vector More...

void	reset (const int ndata)
	reset data object with new empty arrays large enough to store ndata data More...

virtual void	invert_covariance (const double prec, const int Nres)
	invert the covariance matrix More...

virtual double	xx (const int i, const int j) const
	get value of x at position i,j, for Data1D_collection More...

virtual void	get_data (std::vector< double > &data) const
	get data for Data1D More...

virtual DataType	dataType () const
	get the data type More...

virtual int	ndata () const
	the total number of data More...

virtual double	data (const int i) const
	get data at index i More...

virtual std::vector< double >	data () const
	get data More...

virtual double	error (const int i) const
	get value of data standard deviation at index i More...

virtual std::vector< double >	error () const
	get standard deviation More...

virtual double	covariance (const int i, const int j) const
	get the value of the data covariance at index i,j More...

virtual std::vector< std::vector< double > >	covariance () const
	get the m_covariance vector More...

virtual double	edges_xx (const int i) const
	get value of x variable bin edge at index i More...

virtual std::vector< double >	edges_xx () const
	get x variable bin edges More...

virtual double	edges_yy (const int i) const
	get value of y variable bin edge at index i More...

virtual std::vector< double >	edges_yy () const
	get y variable bin edges More...

virtual void	get_error (std::vector< double > &error) const
	get standard deviation for Data1D More...

virtual double	extra_info (const int i, const int j) const
	return the value of the extra information at index i,j More...

virtual std::vector< std::vector< double > >	extra_info () const
	return the m_exta_info std::vector More...

virtual void	set_xx (const int i, const std::vector< double > x)
	set interval variable m_x in the i-th dataset, for Data1D_collection More...

virtual void	set_xx (const std::vector< std::vector< double >> x)
	set interval variable m_x, for Data1D_collection More...

virtual void	set_data (const std::vector< std::vector< double >> data)
	set interval variable m_data, for Data1D_collection, Data2D More...

virtual void	set_extra_info (const std::vector< std::vector< double >> extra_info)
	set interval variable m_error_fx More...

void	set_data (const std::vector< double > data)
	set interval variable data More...

void	set_error (const std::vector< double > error)
	set interval variable m_error_fx More...

void	set_error (const std::vector< std::vector< double >> covariance)
	set interval variable m_error_fx More...

void	set_covariance (const std::string filename, const int cov_col=2, const int skipped_lines=0)
	set the interval variable m_covariance, reading from an input file More...

void	set_covariance (const double value, const int i, const int j)
	set interval the variable m_covariance More...

void	set_covariance (const std::vector< std::vector< double >> covariance)
	set interval the variable m_covariance More...

void	set_covariance (const std::vector< double > error)
	set interval the variable m_covariance More...

virtual int	ndata (const int i) const
	function that returns number of data for one dataset, for Data1D_collection More...

virtual int	ndataset () const
	function that returns total number of datasets More...

virtual int	xsize (const int i) const
	get the number of points along x More...

virtual void	read (const std::vector< std::string > input_file, const int skip_nlines=0, const std::vector< int > column={0}, const std::vector< int > column_data={}, const std::vector< int > column_errors={}, const std::vector< int > column_edges={})
	read the data from a set of input files More...

virtual void	write (const std::string dir, const std::string file, const std::string header, const int prec=4, const int ww=8, const int rank=0) const
	write the data More...

virtual void	write (const std::string dir, const std::vector< std::string > files, const std::string header, const int prec=10, const int ww=8, const int rank=0) const
	write the data More...

void	cut (const std::vector< bool > mask, std::vector< double > &data, std::vector< double > &error, std::vector< std::vector< double >> &covariance_matrix) const
	cut the dataset using a mask More...

virtual std::shared_ptr< Data >	cut (const std::vector< bool > mask) const
	cut the data, for Data1D More...

virtual std::shared_ptr< Data >	cut (const double xmin, const double xmax) const
	cut the data, for Data1D More...

virtual std::shared_ptr< Data >	cut (const int dataset, const double xmin, const double xmax) const
	cut the data, for Data1D_collection More...

virtual std::shared_ptr< Data >	cut (const std::vector< double > xmin, const std::vector< double > xmax) const
	cut the data, for Data1D_collection type More...

	Data ()=default
	default constructor

	Data (const DataType dataType)
	constructor which sets only the data type More...

	Data (const DataType dataType, const int ndata)
	constructor which sets both the data type and the number of data More...

	Data (const DataType dataType, const std::vector< double > data)
	constructor which gets the data from an input vector More...

	Data (const DataType dataType, const std::vector< double > data, const std::vector< double > error)
	constructor which gets both the data and the errors from input vectors More...

	Data (const DataType dataType, const std::vector< double > data, const std::vector< std::vector< double >> covariance)
	constructor which gets both the data and the covariance matrix from input vectors More...

virtual	~Data ()=default
	default destructor

Protected Attributes
Data input
std::vector< double >	m_x
	ordered x axis points

std::vector< double >	m_y
	ordered y axis points

int	m_xsize
	number of points along x

int	m_ysize
	number of points along y

Protected Attributes inherited from cbl::data::Data
DataType	m_dataType
	type of data

int	m_ndata
	number of data

std::vector< double >	m_data
	data values

std::vector< double >	m_error
	standard deviations

std::vector< double >	m_edges_xx
	bin edges for the x variable

std::vector< double >	m_edges_yy
	bin edges for the y variable

std::vector< std::vector< double > >	m_covariance
	covariance matrix

std::vector< std::vector< double > >	m_inverse_covariance
	inverse covariance matrix

Additional Inherited Members
Static Public Member Functions inherited from cbl::data::Data
static std::shared_ptr< Data >	Create (const DataType dataType)
	static factory used to construct objects of class Data1D More...

Protected Member Functions inherited from cbl::data::Data
void	set_dataType (const DataType dataType)
	set the data type More...

Detailed Description

The class Data2D.

"Headers/Data2D.h"

This is the base class used to manage 2D data

Definition at line 50 of file Data2D.h.

Constructor & Destructor Documentation

◆ Data2D() [1/5]

cbl::data::Data2D::Data2D	(	const std::string	input_file,
		const int	skip_nlines = `0`,
		const std::vector< int >	column = `{1, 2}`,
		const std::vector< int >	column_data = `{}`,
		const std::vector< int >	column_errors = `{}`,
		const std::vector< int >	column_edges = `{}`
	)

inline

constructor which reads the data from file

Parameters

input_file	input file
skip_nlines	skip header lines
column	vector containing the columns of x and y values in the input file; if it is not provided, the first column will be used by default
column_data	the column of data values in the input file; the size of column_data is the number of data to be read (e.g. the size should be 3 in the case of the 3 multipole moments of the two-point correlation function); if the size of column_data is larger than 1, more than 1 data vectors are read and then added one after the other in a single data object; if column_data is not provided, the first column after the column of y values will be used by default, assuming that only 1 data vector has to be read
column_errors	the column of error values in the input file; the size of column_error must be equal to the size of column_data; if the size of column_error is larger than 1, more than 1 error vectors are read and then added one after the other in a single data object; if column_random is not provided, the second column after the column of y values will be used by default, assuming that only 1 random vector has to be read; if the input file has less than 4 columns, the errors will be set to 1
column_edges	vector containing the columns of x and y bin edge values in the input file; if it is not provided, the third and four columns after the column of y values will be used; if these columns do no exist the edges are not read

Definition at line 122 of file Data2D.h.

◆ Data2D() [2/5]

cbl::data::Data2D::Data2D	(	const std::vector< double >	x,
		const std::vector< double >	y,
		const std::vector< std::vector< double >>	data,
		const std::vector< double >	bin_edges_x = `{}`,
		const std::vector< double >	bin_edges_y = `{}`
	)

constructor which gets the data from an input matrix

Parameters

x	vector containing the x values
y	vector containing the y values
data	matrix containing the f(x,y) values
bin_edges_x	the x variable bin edges
bin_edges_y	the y variable bin edges

Definition at line 45 of file Data2D.cpp.

◆ Data2D() [3/5]

cbl::data::Data2D::Data2D	(	const std::vector< double >	x,
		const std::vector< double >	y,
		const std::vector< std::vector< double >>	data,
		const std::vector< std::vector< double >>	error,
		const std::vector< double >	bin_edges_x = `{}`,
		const std::vector< double >	bin_edges_y = `{}`
	)

constructor which gets both the data and the errors from input matrices

Parameters

x	vector containing the x values
y	vector containing the y values
data	matrix containing the data
error	matrix containing the errors
bin_edges_x	the x variable bin edges
bin_edges_y	the y variable bin edges

Definition at line 75 of file Data2D.cpp.

◆ Data2D() [4/5]

cbl::data::Data2D::Data2D	(	const std::vector< double >	x,
		const std::vector< double >	y,
		const std::vector< double >	data,
		const std::vector< double >	error,
		const std::vector< double >	bin_edges_x = `{}`,
		const std::vector< double >	bin_edges_y = `{}`
	)

constructor which gets both the data and the covariance matrix from input vectors

Parameters

x	vector containing the x values
y	vector containing the y values
data	vector containing the data
error	vector containing the errors
bin_edges_x	the x variable bin edges
bin_edges_y	the y variable bin edges

Definition at line 111 of file Data2D.cpp.

◆ Data2D() [5/5]

cbl::data::Data2D::Data2D	(	const std::vector< double >	x,
		const std::vector< double >	y,
		const std::vector< double >	data,
		const std::vector< std::vector< double >>	covariance,
		const std::vector< double >	bin_edges_x = `{}`,
		const std::vector< double >	bin_edges_y = `{}`
	)

constructor which gets both the data and the covariance matrix from input matrices

Parameters

x	vector containing the x values
y	vector containing the y values
data	matrix containing the data
covariance	matrix containing the covariance
bin_edges_x	the x variable bin edges
bin_edges_y	the y variable bin edges

Definition at line 140 of file Data2D.cpp.

Member Function Documentation

◆ as_factory()

shared_ptr< Data > cbl::data::Data2D::as_factory ( )

virtual

static factory used to construct objects of class Data2D

Returns: a shared pointer to an object of class Data

Reimplemented from cbl::data::Data.

Reimplemented in cbl::data::Data2D_extra.

Definition at line 491 of file Data2D.cpp.

◆ cut()

shared_ptr< Data > cbl::data::Data2D::cut	(	const double	xmin,
		const double	xmax,
		const double	ymin,
		const double	ymax
	)		const

virtual

cut the data

Parameters

xmin	minumum value for the independent variable x
xmax	maximum value for the independent variable x
ymin	minumum value for the independent variable y
ymax	maximum value for the independent variable y

Returns: pointer to an object of type Data2D

Reimplemented from cbl::data::Data.

Reimplemented in cbl::data::Data2D_extra.

Definition at line 442 of file Data2D.cpp.

◆ data()

double cbl::data::Data2D::data	(	const int	i,
		const int	j
	)		const

inlineoverridevirtual

get data at index i,j

Parameters

i	index
j	index

Returns: the value of the m_data vector at position i,j

Reimplemented from cbl::data::Data.

Definition at line 279 of file Data2D.h.

◆ error()

double cbl::data::Data2D::error	(	const int	i,
		const int	j
	)		const

inlineoverridevirtual

get error at index i,j

Parameters

i	index
j	index

Returns: the value of the m_error vector at position i,j

Reimplemented from cbl::data::Data.

Definition at line 294 of file Data2D.h.

◆ get_data()

void cbl::data::Data2D::get_data ( std::vector< std::vector< double >> & data ) const

overridevirtual

get data

Parameters

[out] data vector containing the dataset

Reimplemented from cbl::data::Data.

Definition at line 173 of file Data2D.cpp.

◆ get_error()

void cbl::data::Data2D::get_error ( std::vector< std::vector< double >> & error ) const

overridevirtual

get error

Parameters

[out] error vector containing the error

Reimplemented from cbl::data::Data.

Definition at line 187 of file Data2D.cpp.

◆ IndipendentVariable()

std::vector<std::vector<double> > cbl::data::Data2D::IndipendentVariable	(	const int	i = `-1`,
		const int	j = `-1`
	)		const

inlineoverridevirtual

get the independet variable, to be used in model computation

Parameters

i	index of the extra_info containing the first independent variable
j	index of the extra_info containing the second independent variable

Returns: the independent variable

Reimplemented from cbl::data::Data.

Reimplemented in cbl::data::Data2D_extra.

Definition at line 270 of file Data2D.h.

◆ Print()

void cbl::data::Data2D::Print ( const int precision = 4 ) const

overridevirtual

print the data on screen

Parameters

precision the float precision

Reimplemented from cbl::data::Data.

Reimplemented in cbl::data::Data2D_extra.

Definition at line 329 of file Data2D.cpp.

◆ read()

void cbl::data::Data2D::read	(	const std::string	input_file,
		const int	skip_nlines = `0`,
		const std::vector< int >	column = `{1, 2}`,
		const std::vector< int >	column_data = `{}`,
		const std::vector< int >	column_errors = `{}`,
		const std::vector< int >	column_edges = `{}`
	)

overridevirtual

read the data

Parameters

input_file	the input data file
skip_nlines	the header lines to be skipped
column	vector containing the columns of x and y values in the input file; if it is not provided, the first column will be used by default
column_data	the column of data values in the input file; the size of column_data is the number of data to be read (e.g. the size should be 3 in the case of the 3 multipole moments of the two-point correlation function); if the size of column_data is larger than 1, more than 1 data vectors are read and then added one after the other in a single data object; if column_data is not provided, the first column after the column of y values will be used by default, assuming that only 1 data vector has to be read
column_errors	the column of error values in the input file; the size of column_error must be equal to the size of column_data; if the size of column_error is larger than 1, more than 1 error vectors are read and then added one after the other in a single data object; if column_random is not provided, the second column after the column of y values will be used by default, assuming that only 1 random vector has to be read; if the input file has less than 4 columns, the errors will be set to 1
column_edges	vector containing the columns of x and y bin edge values in the input file; if it is not provided, the third and four columns after the column of y values will be used; if these columns do no exist the edges are not read

Reimplemented from cbl::data::Data.

Reimplemented in cbl::data::Data2D_extra.

Definition at line 201 of file Data2D.cpp.

◆ set_edges_xx()

void cbl::data::Data2D::set_edges_xx ( const std::vector< double > edges )

inlineoverridevirtual

set interval variable m_edges_xx

Parameters

edges std::vector containing the x bin edges

Reimplemented from cbl::data::Data.

Definition at line 327 of file Data2D.h.

◆ set_edges_yy()

void cbl::data::Data2D::set_edges_yy ( const std::vector< double > edges )

inlineoverridevirtual

set interval variable m_edges_yy

Parameters

edges std::vector containing the y bin edges

Reimplemented from cbl::data::Data.

Definition at line 333 of file Data2D.h.

◆ set_xx()

void cbl::data::Data2D::set_xx ( const std::vector< double > x )

inlineoverridevirtual

set interval variable m_x

Parameters

x	vector containing x points

Reimplemented from cbl::data::Data.

Definition at line 315 of file Data2D.h.

◆ set_yy()

void cbl::data::Data2D::set_yy ( const std::vector< double > y )

inlineoverridevirtual

set interval variable m_y

Parameters

y	vector containing y points

Reimplemented from cbl::data::Data.

Definition at line 321 of file Data2D.h.

◆ write()

void cbl::data::Data2D::write	(	const std::string	dir,
		const std::string	file,
		const std::string	header,
		const bool	full,
		const int	prec = `4`,
		const int	ww = `8`,
		const int	rank = `0`
	)		const

virtual

write the data

Parameters

dir	output directory
file	output file
header	text with the variable names to be written at the first line of the output file
full	false → simply store the data; true → duplicate the data in the other three quadrands (usefull e.g. when storing the 2D correlation function)
prec	the floating point precision
ww	number of characters to be used as field width
rank	cpu index (for MPI usage)

Reimplemented from cbl::data::Data.

Reimplemented in cbl::data::Data2D_extra.

Definition at line 345 of file Data2D.cpp.

◆ write_covariance()

void cbl::data::Data2D::write_covariance	(	const std::string	dir,
		const std::string	file,
		const int	precision = `10`
	)		const

overridevirtual

write the covariance

Parameters

dir	the output directory
file	the output file
precision	the floating point precision

Reimplemented from cbl::data::Data.

Definition at line 406 of file Data2D.cpp.

◆ xsize()

int cbl::data::Data2D::xsize ( ) const

inlineoverridevirtual

get the number of points along x

Returns: the number of points along x

Reimplemented from cbl::data::Data.

Definition at line 219 of file Data2D.h.

◆ xx() [1/2]

std::vector<double> cbl::data::Data2D::xx ( ) const

inlineoverridevirtual

get the x vector

Returns: the x vector

Reimplemented from cbl::data::Data.

Definition at line 241 of file Data2D.h.

◆ xx() [2/2]

double cbl::data::Data2D::xx ( const int i ) const

inlineoverridevirtual

get the value of x at index i

Parameters

i index

Returns: the value of the m_x vector at position i

Reimplemented from cbl::data::Data.

Definition at line 234 of file Data2D.h.

◆ ysize()

int cbl::data::Data2D::ysize ( ) const

inlineoverridevirtual

get the number of points along y

Returns: the number of points along y

Reimplemented from cbl::data::Data.

Definition at line 226 of file Data2D.h.

◆ yy() [1/2]

std::vector<double> cbl::data::Data2D::yy ( ) const

inlineoverridevirtual

get the y vector

Returns: the y vector

Reimplemented from cbl::data::Data.

Definition at line 255 of file Data2D.h.

◆ yy() [2/2]

double cbl::data::Data2D::yy ( const int i ) const

inlineoverridevirtual

get the value of y at index i

Parameters

i index

Returns: the value of the m_y vector at position i

Reimplemented from cbl::data::Data.

Definition at line 248 of file Data2D.h.

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

Headers/Data2D.h
Data/Data2D.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Data2D() [1/5]

◆ Data2D() [2/5]

◆ Data2D() [3/5]

◆ Data2D() [4/5]

◆ Data2D() [5/5]

Member Function Documentation

◆ as_factory()

◆ cut()

◆ data()

◆ error()

◆ get_data()

◆ get_error()

◆ IndipendentVariable()

◆ Print()

◆ read()

◆ set_edges_xx()

◆ set_edges_yy()

◆ set_xx()

◆ set_yy()

◆ write()

◆ write_covariance()

◆ xsize()

◆ xx() [1/2]

◆ xx() [2/2]

◆ ysize()

◆ yy() [1/2]

◆ yy() [2/2]