Datafield Class Reference

Description

Stores radiation power per bin.

Definition at line 30 of file Datafield.h.

Collaboration diagram for Datafield:

Public Member Functions
	Datafield (const Datafield &)=delete
	Datafield (const std::vector< IAxis * > &axes)
	Constructor that takes ownership of supplied axes. More...
	Datafield (const std::vector< IAxis * > &axes, const std::vector< double > &vector)
	Constructor that takes ownership of supplied axes. More...
	Datafield (Datafield &&)=default
	Datafield (Frame *frame)
	Constructor that takes ownership of supplied frame. More...
	Datafield (Frame *frame, const std::vector< double > &vector)
	Constructor that takes ownership of supplied frame. More...
	~Datafield ()
const IAxis &	axis (size_t k) const
Datafield *	clone () const
Datafield *	crop (double xmin, double xmax) const
Datafield *	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 Datafield &other) const
	Returns true if objects a) have same dimensions b) bin boundaries of axes coincide. More...
bool	hasSameSizes (const Datafield &other) const
	Returns true if object have same dimensions and number of axes bins. More...
double	maxVal () const
double	minVal () const
Datafield *	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
Datafield *	xProjection ()
	Project a 2D histogram into 1D histogram along X. The projection is made from all bins along y-axis. More...
Datafield *	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...
Datafield *	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
Datafield *	yProjection ()
	Project a 2D histogram into 1D histogram along Y. The projection is made from all bins along x-axis. More...
Datafield *	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...
Datafield *	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...

Private Member Functions
Datafield *	create_xProjection (int ybinlow, int ybinup)
	Creates projection along X. The projections is made by collecting the data in the range between [ybinlow, ybinup]. More...
Datafield *	create_yProjection (int xbinlow, int xbinup)
	Creates projection along Y. The projections is made by collecting the data in the range between [xbinlow, xbinup]. More...

Private Attributes
std::unique_ptr< Frame >	m_frame
std::vector< double >	m_vec

Constructor & Destructor Documentation

Datafield() [1/6]

Datafield::Datafield

(

Frame *

frame

)

Constructor that takes ownership of supplied frame.

Definition at line 24 of file Datafield.cpp.

    : m_frame(frame)
    , m_vec(m_frame->size())
{
}

Referenced by clone(), create_xProjection(), create_yProjection(), crop(), and normalizedToMaximum().

Datafield() [2/6]

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

Constructor that takes ownership of supplied frame.

Definition at line 30 of file Datafield.cpp.

    : m_frame(frame)
    , m_vec(vector)
{
}

Datafield() [3/6]

Datafield::Datafield

(

const std::vector< IAxis * > &

axes

)

Constructor that takes ownership of supplied axes.

Definition at line 41 of file Datafield.cpp.

    : Datafield(new Frame(axes))
{
}

Datafield() [4/6]

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

Constructor that takes ownership of supplied axes.

Definition at line 36 of file Datafield.cpp.

    : Datafield(new Frame(axes), vector)
{
}

Datafield() [5/6]

Datafield::Datafield ( const Datafield &  )

delete

Datafield() [6/6]

Datafield::Datafield ( Datafield &&  )

default

~Datafield()

Datafield::~Datafield

(

)

Definition at line 46 of file Datafield.cpp.

{}

Member Function Documentation

axis()

const IAxis & Datafield::axis

(

size_t

k

)

const

Definition at line 91 of file Datafield.cpp.

{
    return m_frame->axis(k);
}

References m_frame.

Referenced by ConvolutionDetectorResolution::apply1dConvolution(), ConvolutionDetectorResolution::apply2dConvolution(), DataUtils::Data::create2DArrayfromDatafield(), DataUtils::Data::createRearrangedDataSet(), DataUtils::Array::createVector2D(), npArray(), ReadWriteNumpyTXT::write1DRepresentation(), ReadWriteNumpyTXT::write2DRepresentation(), and ReadWriteINT::writeDatafield().

clone()

Datafield * Datafield::clone

(

)

const

Definition at line 48 of file Datafield.cpp.

{
    return new Datafield(m_frame->cloned_axes(), m_vec);
}

References Datafield(), m_frame, and m_vec.

Referenced by DataUtils::Data::createRearrangedDataSet().

Here is the call graph for this function:

create_xProjection()

Datafield * Datafield::create_xProjection ( int  ybinlow, int  ybinup  )

private

Creates projection along X. The projections is made by collecting the data in the range between [ybinlow, ybinup].

Definition at line 260 of file Datafield.cpp.

{
    std::vector<double> out(xAxis().size());
    for (size_t i = 0; i < size(); ++i) {
        int ybin = static_cast<int>(m_frame->projectedIndex(i, 1));
        if (ybin >= ybinlow && ybin <= ybinup) {
            double x = m_frame->projectedCoord(i, 0);
            ASSERT(xAxis().contains(x));
            size_t iout = xAxis().findClosestIndex(x);
            out[iout] += valAt(i);
        }
    }
    return new Datafield({xAxis().clone()}, out);
}

References Datafield(), ASSERT, IAxis::clone(), IAxis::findClosestIndex(), m_frame, size(), valAt(), and xAxis().

Referenced by xProjection().

Here is the call graph for this function:

create_yProjection()

Datafield * Datafield::create_yProjection ( int  xbinlow, int  xbinup  )

private

Creates projection along Y. The projections is made by collecting the data in the range between [xbinlow, xbinup].

Definition at line 275 of file Datafield.cpp.

{
    std::vector<double> out(yAxis().size());
    for (size_t i = 0; i < size(); ++i) {
        int xbin = static_cast<int>(m_frame->projectedIndex(i, 0));
        if (xbin >= xbinlow && xbin <= xbinup) {
 
            // TODO: duplicates code from create_xProjection, move to Frame ?
 
            double y = m_frame->projectedCoord(i, 1);
            ASSERT(yAxis().contains(y));
            size_t iout = yAxis().findClosestIndex(y);
            out[iout] += valAt(i);
        }
    }
    return new Datafield({yAxis().clone()}, out);
}

References Datafield(), ASSERT, IAxis::clone(), IAxis::findClosestIndex(), m_frame, size(), valAt(), and yAxis().

Referenced by yProjection().

Here is the call graph for this function:

crop() [1/2]

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

Definition at line 165 of file Datafield.cpp.

{
    const std::unique_ptr<IAxis> xaxis{xAxis().clone()};
    xaxis->clip(xmin, xmax);
    std::vector<double> out(size());
    size_t iout = 0;
    for (size_t i = 0; i < size(); ++i) {
        const double x = m_frame->projectedCoord(i, 0);
        if (xaxis->contains(x))
            out[iout++] = m_vec[i];
    }
    return new Datafield(m_frame->cloned_axes(), out);
}

References Datafield(), IAxis::clip(), IAxis::clone(), m_frame, m_vec, size(), and xAxis().

Here is the call graph for this function:

crop() [2/2]

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

Definition at line 147 of file Datafield.cpp.

{
    const std::unique_ptr<IAxis> xaxis{xAxis().clone()};
    const std::unique_ptr<IAxis> yaxis{yAxis().clone()};
    xaxis->clip(xmin, xmax);
    yaxis->clip(ymin, ymax);
 
    std::vector<double> out(size());
    size_t iout = 0;
    for (size_t i = 0; i < size(); ++i) {
        double x = m_frame->projectedCoord(i, 0);
        double y = m_frame->projectedCoord(i, 1);
        if (xaxis->contains(x) && yaxis->contains(y))
            out[iout++] = m_vec[i];
    }
    return new Datafield(m_frame->cloned_axes(), out);
}

References Datafield(), IAxis::clip(), IAxis::clone(), m_frame, m_vec, size(), xAxis(), and yAxis().

Here is the call graph for this function:

flatVector()

std::vector< double > Datafield::flatVector

(

)

const

Returns copy of raw data vector.

Definition at line 119 of file Datafield.cpp.

{
    std::vector<double> ret(size());
    for (size_t i = 0; i < size(); ++i)
        ret[i] = (*this)[i];
    return ret;
}

References size().

Referenced by ConvolutionDetectorResolution::apply1dConvolution(), ConvolutionDetectorResolution::apply2dConvolution(), ICoordSystem::createConvertedData(), CoordSystem1D::createConvertedData(), DataUtils::Array::createVector1D(), SimDataPair::experimental_array(), SimDataPair::simulation_array(), SimDataPair::uncertainties_array(), and SimDataPair::user_weights_array().

Here is the call graph for this function:

frame()

const Frame & Datafield::frame

(

)

const

Definition at line 86 of file Datafield.cpp.

{
    return *m_frame;
}

References m_frame.

Referenced by ConvolutionDetectorResolution::apply2dConvolution(), IDetector::applyDetectorResolution(), DataUtils::Data::createRearrangedDataSet(), hasSameShape(), hasSameSizes(), normalizedToMaximum(), DiffUtil::relativeDifferenceField(), setVector(), and size().

hasSameShape()

bool Datafield::hasSameShape

(

const Datafield &

other

)

const

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

Returns true if object have same dimensions and shape of axis.

Definition at line 114 of file Datafield.cpp.

{
    return frame() == other.frame();
}

References frame().

Referenced by DiffUtil::relativeDifferenceField().

Here is the call graph for this function:

hasSameSizes()

bool Datafield::hasSameSizes

(

const Datafield &

other

)

const

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

Returns true if object have same dimensions.

Definition at line 108 of file Datafield.cpp.

{
    return frame().hasSameSizes(other.frame());
}

References frame(), and Frame::hasSameSizes().

Here is the call graph for this function:

maxVal()

double Datafield::maxVal

(

)

const

Definition at line 137 of file Datafield.cpp.

{
    return *std::max_element(m_vec.begin(), m_vec.end());
}

References m_vec.

Referenced by normalizedToMaximum().

minVal()

double Datafield::minVal

(

)

const

Definition at line 142 of file Datafield.cpp.

{
    return *std::min_element(m_vec.begin(), m_vec.end());
}

References m_vec.

normalizedToMaximum()

Datafield * Datafield::normalizedToMaximum

(

)

const

Definition at line 127 of file Datafield.cpp.

{
    double maxval = maxVal();
    ASSERT(maxval > 0);
    std::vector<double> out(frame().size());
    for (size_t i = 0; i < frame().size(); ++i)
        out[i] = m_vec[i] / maxval;
    return new Datafield(m_frame->cloned_axes(), out);
}

References Datafield(), ASSERT, frame(), m_frame, m_vec, maxVal(), Frame::size(), and size().

Here is the call graph for this function:

npArray()

PyObject * Datafield::npArray

(

)

const

Returns data as Python numpy array.

Definition at line 181 of file Datafield.cpp.

{
    std::vector<size_t> dimensions;
    for (size_t i = 0; i < rank(); i++)
        dimensions.push_back(axis(i).size());
 
    // for rot90 of 2-dim arrays to conform with numpy
    if (dimensions.size() == 2)
        std::swap(dimensions[0], dimensions[1]);
 
    // creating ndarray objects describing size of dimensions
    npy_int ndim_numpy = (int)dimensions.size();
    auto* ndimsizes_numpy = new npy_intp[dimensions.size()];
    for (size_t i = 0; i < dimensions.size(); i++)
        ndimsizes_numpy[i] = dimensions[i];
 
    // creating standalone numpy array
    PyObject* pyarray = PyArray_SimpleNew(ndim_numpy, ndimsizes_numpy, NPY_DOUBLE);
    delete[] ndimsizes_numpy;
    ASSERT(pyarray);
 
    // getting pointer to data buffer of numpy array
    double* array_buffer = (double*)PyArray_DATA((PyArrayObject*)pyarray);
 
    // filling numpy array with output_data
    if (rank() == 2) {
        for (size_t i = 0; i < size(); ++i) {
            std::vector<int> axes_indices = m_frame->allIndices(i);
            size_t offset =
                axes_indices[0] + axis(0).size() * (axis(1).size() - 1 - axes_indices[1]);
            array_buffer[offset] = (*this)[i];
        }
    } else {
        for (size_t i = 0; i < size(); ++i)
            *array_buffer++ = (*this)[i];
    }
 
    return pyarray;
}

References ASSERT, axis(), m_frame, rank(), size(), and IAxis::size().

Here is the call graph for this function:

operator[]() [1/2]

double& Datafield::operator[] ( size_t  i )

inline

indexed accessor

Definition at line 78 of file Datafield.h.

{ return m_vec[i]; }

References m_vec.

operator[]() [2/2]

const double& Datafield::operator[] ( size_t  i ) const

inline

ied accessor (const)

Definition at line 81 of file Datafield.h.

{ return m_vec[i]; }

References m_vec.

rank()

size_t Datafield::rank

(

)

const

Definition at line 75 of file Datafield.cpp.

{
    return m_frame->rank();
}

References m_frame.

Referenced by ConvolutionDetectorResolution::apply1dConvolution(), ConvolutionDetectorResolution::apply2dConvolution(), ConvolutionDetectorResolution::applyDetectorResolution(), DataUtils::Data::create2DArrayfromDatafield(), CoordSystem1D::createConvertedData(), DataUtils::Data::createRearrangedDataSet(), DataUtils::Array::createVector1D(), npArray(), ReadWriteINT::writeDatafield(), and ReadWriteNumpyTXT::writeDatafield().

setAllTo()

void Datafield::setAllTo

(

const double &

value

)

Sets content of output data to specific value.

Definition at line 63 of file Datafield.cpp.

{
    for (double& e : m_vec)
        e = value;
}

References m_vec.

setAt()

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

Definition at line 53 of file Datafield.cpp.

{
    m_vec[i] = val;
}

References m_vec.

setVector()

void Datafield::setVector

(

const std::vector< double > &

data_vector

)

Sets new values to raw data vector.

Definition at line 69 of file Datafield.cpp.

{
    ASSERT(vector.size() == frame().size());
    m_vec = vector;
}

References ASSERT, frame(), m_vec, and size().

Referenced by ConvolutionDetectorResolution::apply1dConvolution(), IDetector::applyDetectorResolution(), ICoordSystem::createConvertedData(), and CoordSystem1D::createConvertedData().

Here is the call graph for this function:

size()

size_t Datafield::size

(

)

const

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

Definition at line 80 of file Datafield.cpp.

{
    ASSERT(frame().size() == m_vec.size());
    return frame().size();
}

References ASSERT, frame(), m_vec, and Frame::size().

Referenced by ConvolutionDetectorResolution::apply2dConvolution(), create_xProjection(), create_yProjection(), CoordSystem1D::createConvertedData(), DataUtils::Data::createRearrangedDataSet(), crop(), DataUtils::Format::fillDatafield(), flatVector(), normalizedToMaximum(), npArray(), DiffUtil::relativeDifferenceField(), setVector(), ReadWriteINT::writeDatafieldDoubles(), xProjection(), and yProjection().

Here is the call graph for this function:

valAt()

double Datafield::valAt

(

size_t

i

)

const

Definition at line 58 of file Datafield.cpp.

{
    return m_vec[i];
}

References m_vec.

Referenced by create_xProjection(), create_yProjection(), and DiffUtil::relativeDifferenceField().

xAxis()

const IAxis & Datafield::xAxis

(

)

const

Definition at line 96 of file Datafield.cpp.

{
    return m_frame->axis(0);
}

References m_frame.

Referenced by create_xProjection(), crop(), DataUtils::Data::FindPeaks(), xProjection(), and yProjection().

xProjection() [1/3]

Datafield * Datafield::xProjection

(

)

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

Definition at line 224 of file Datafield.cpp.

{
    return create_xProjection(0, static_cast<int>(xAxis().size()) - 1);
}

References create_xProjection(), size(), and xAxis().

Here is the call graph for this function:

xProjection() [2/3]

Datafield * Datafield::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

Definition at line 235 of file Datafield.cpp.

{
    int ybinlow = static_cast<int>(yAxis().findClosestIndex(ylow));
    int ybinup = static_cast<int>(yAxis().findClosestIndex(yup));
    return create_xProjection(ybinlow, ybinup);
}

References create_xProjection(), IAxis::findClosestIndex(), and yAxis().

Here is the call graph for this function:

xProjection() [3/3]

Datafield * Datafield::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

Definition at line 229 of file Datafield.cpp.

{
    int ybin_selected = static_cast<int>(yAxis().findClosestIndex(yvalue));
    return create_xProjection(ybin_selected, ybin_selected);
}

References create_xProjection(), IAxis::findClosestIndex(), and yAxis().

Here is the call graph for this function:

yAxis()

const IAxis & Datafield::yAxis

(

)

const

Definition at line 101 of file Datafield.cpp.

{
    return m_frame->axis(1);
}

References m_frame.

Referenced by create_yProjection(), crop(), DataUtils::Data::FindPeaks(), and xProjection().

yProjection() [1/3]

Datafield * Datafield::yProjection

(

)

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

Definition at line 242 of file Datafield.cpp.

{
    return create_yProjection(0, static_cast<int>(xAxis().size()) - 1);
}

References create_yProjection(), size(), and xAxis().

Here is the call graph for this function:

yProjection() [2/3]

Datafield * Datafield::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

Definition at line 253 of file Datafield.cpp.

{
    int xbinlow = static_cast<int>(xAxis().findClosestIndex(xlow));
    int xbinup = static_cast<int>(xAxis().findClosestIndex(xup));
    return create_yProjection(xbinlow, xbinup);
}

References create_yProjection(), IAxis::findClosestIndex(), and xAxis().

Here is the call graph for this function:

yProjection() [3/3]

Datafield * Datafield::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

Definition at line 247 of file Datafield.cpp.

{
    int xbin_selected = static_cast<int>(xAxis().findClosestIndex(xvalue));
    return create_yProjection(xbin_selected, xbin_selected);
}

References create_yProjection(), IAxis::findClosestIndex(), and xAxis().

Here is the call graph for this function:

Member Data Documentation

m_frame

std::unique_ptr<Frame> Datafield::m_frame

private

Definition at line 140 of file Datafield.h.

Referenced by axis(), clone(), create_xProjection(), create_yProjection(), crop(), frame(), normalizedToMaximum(), npArray(), rank(), xAxis(), and yAxis().

m_vec

std::vector<double> Datafield::m_vec

private

Definition at line 141 of file Datafield.h.

Referenced by clone(), crop(), maxVal(), minVal(), normalizedToMaximum(), operator[](), setAllTo(), setAt(), setVector(), size(), and valAt().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Device/Data/Datafield.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Device/Data/Datafield.cpp