Powerfield Class Reference

Description

Stores radiation power per bin.

Public Member Functions
	Powerfield (const IAxis &xAxis)
	Constructor that clones supplied axis. More...
	Powerfield (const IAxis &xAxis, const IAxis &yAxis)
	Constructor that clones supplied axes. More...
	Powerfield (const Powerfield &)=delete
	Powerfield (const std::vector< IAxis * > &axes)
	Constructor that takes ownership of supplied axes. More...
	Powerfield (const std::vector< IAxis * > &axes, const std::vector< double > &vector)
	Constructor that takes ownership of supplied axes. More...
	Powerfield (Frame *frame, const std::vector< double > &vector)
	Constructor that takes ownership of supplied frame. More...
	Powerfield (Powerfield &&)=default
	~Powerfield ()
const IAxis &	axis (size_t k) const
Powerfield *	clone () const
Powerfield *	crop (double xmin, double xmax) const
Powerfield *	crop (double xmin, double ymin, double xmax, double ymax) const
std::vector< double >	flatVector () const
	Returns copy of raw data vector. More...
const Frame &	frame () const
bool	hasSameShape (const Powerfield &other) const
	Returns true if objects a) have same dimensions b) bin boundaries of axes coincide. More...
bool	hasSameSizes (const Powerfield &other) const
	Returns true if object have same dimensions and number of axes bins. More...
double	maxVal () const
double	minVal () const
Powerfield *	normalizedToMaximum () const
PyObject *	npArray () const
	Returns data as Python numpy array. More...
double &	operator[] (size_t i)
	indexed accessor More...
const double &	operator[] (size_t i) const
	ied accessor (const) More...
size_t	rank () const
void	setAllTo (const double &value)
	Sets content of output data to specific value. More...
void	setAt (size_t i, double val)
void	setVector (const std::vector< double > &data_vector)
	Sets new values to raw data vector. More...
size_t	size () const
	Returns total size of data buffer (product of bin number in every dimension). More...
double	valAt (size_t i) const
const IAxis &	xAxis () const
Powerfield *	xProjection ()
	Project a 2D histogram into 1D histogram along X. The projection is made from all bins along y-axis. More...
Powerfield *	xProjection (double ylow, double yup)
	Project a 2D histogram into 1D histogram along X. The projection is made from all y-bins corresponding to ordinate between ylow and yup. More...
Powerfield *	xProjection (double yvalue)
	Project a 2D histogram into 1D histogram along X. The projection is made from the y-bin closest to given ordinate yvalue. More...
const IAxis &	yAxis () const
Powerfield *	yProjection ()
	Project a 2D histogram into 1D histogram along Y. The projection is made from all bins along x-axis. More...
Powerfield *	yProjection (double xlow, double xup)
	Project a 2D histogram into 1D histogram along Y. The projection is made from all x-bins corresponding to abscissa between xlow and xup. More...
Powerfield *	yProjection (double xvalue)
	Project a 2D histogram into 1D histogram along Y. The projection is made from the x-bin closest to given abscissa xvalue. More...

Constructor & Destructor Documentation

Powerfield() [1/7]

Powerfield::Powerfield	(	Frame *	frame,
		const std::vector< double > &	vector
	)

Constructor that takes ownership of supplied frame.

Powerfield() [2/7]

Powerfield::Powerfield

(

const std::vector< IAxis * > &

axes

)

Constructor that takes ownership of supplied axes.

Powerfield() [3/7]

Powerfield::Powerfield	(	const std::vector< IAxis * > &	axes,
		const std::vector< double > &	vector
	)

Constructor that takes ownership of supplied axes.

Powerfield() [4/7]

Powerfield::Powerfield

(

const IAxis &

xAxis

)

Constructor that clones supplied axis.

Powerfield() [5/7]

Powerfield::Powerfield	(	const IAxis &	xAxis,
		const IAxis &	yAxis
	)

Constructor that clones supplied axes.

Powerfield() [6/7]

Powerfield::Powerfield ( const Powerfield &  )

delete

Powerfield() [7/7]

Powerfield::Powerfield ( Powerfield &&  )

default

~Powerfield()

Powerfield::~Powerfield

(

)

Member Function Documentation

axis()

const IAxis& Powerfield::axis

(

size_t

k

)

const

clone()

Powerfield* Powerfield::clone

(

)

const

crop() [1/2]

Powerfield* Powerfield::crop	(	double	xmin,
		double	xmax
	)		const

crop() [2/2]

Powerfield* Powerfield::crop	(	double	xmin,
		double	ymin,
		double	xmax,
		double	ymax
	)		const

flatVector()

std::vector<double> Powerfield::flatVector

(

)

const

Returns copy of raw data vector.

frame()

const Frame& Powerfield::frame

(

)

const

hasSameShape()

bool Powerfield::hasSameShape

(

const Powerfield &

other

)

const

Returns true if objects a) have same dimensions b) bin boundaries of axes coincide.

hasSameSizes()

bool Powerfield::hasSameSizes

(

const Powerfield &

other

)

const

Returns true if object have same dimensions and number of axes bins.

maxVal()

double Powerfield::maxVal

(

)

const

minVal()

double Powerfield::minVal

(

)

const

normalizedToMaximum()

Powerfield* Powerfield::normalizedToMaximum

(

)

const

npArray()

PyObject* Powerfield::npArray

(

)

const

Returns data as Python numpy array.

operator[]() [1/2]

double& Powerfield::operator[]

(

size_t

i

)

indexed accessor

operator[]() [2/2]

const double& Powerfield::operator[]

(

size_t

i

)

const

ied accessor (const)

rank()

size_t Powerfield::rank

(

)

const

setAllTo()

void Powerfield::setAllTo

(

const double &

value

)

Sets content of output data to specific value.

setAt()

void Powerfield::setAt	(	size_t	i,
		double	val
	)

setVector()

void Powerfield::setVector

(

const std::vector< double > &

data_vector

)

Sets new values to raw data vector.

size()

size_t Powerfield::size

(

)

const

Returns total size of data buffer (product of bin number in every dimension).

valAt()

double Powerfield::valAt

(

size_t

i

)

const

xAxis()

const IAxis& Powerfield::xAxis

(

)

const

xProjection() [1/3]

Powerfield* Powerfield::xProjection

(

)

Project a 2D histogram into 1D histogram along X. The projection is made from all bins along y-axis.

xProjection() [2/3]

Powerfield* Powerfield::xProjection	(	double	ylow,
		double	yup
	)

Project a 2D histogram into 1D histogram along X. The projection is made from all y-bins corresponding to ordinate between ylow and yup.

Parameters

ylow	lower edje on y-axis
yup	upper edje on y-axis

xProjection() [3/3]

Powerfield* Powerfield::xProjection

(

double

yvalue

)

Project a 2D histogram into 1D histogram along X. The projection is made from the y-bin closest to given ordinate yvalue.

Parameters

yvalue

the value on y-axis at which projection is taken

yAxis()

const IAxis& Powerfield::yAxis

(

)

const

yProjection() [1/3]

Powerfield* Powerfield::yProjection

(

)

Project a 2D histogram into 1D histogram along Y. The projection is made from all bins along x-axis.

yProjection() [2/3]

Powerfield* Powerfield::yProjection	(	double	xlow,
		double	xup
	)

Project a 2D histogram into 1D histogram along Y. The projection is made from all x-bins corresponding to abscissa between xlow and xup.

Parameters

xlow	lower edje on x-axis
xup	upper edje on x-axis

yProjection() [3/3]

Powerfield* Powerfield::yProjection

(

double

xvalue

)

Project a 2D histogram into 1D histogram along Y. The projection is made from the x-bin closest to given abscissa xvalue.

Parameters

xvalue

the value on x-axis at which projection is taken