SimulationResult Class Reference

Description

Wrapper around Datafield that also provides unit conversions.

Definition at line 29 of file SimulationResult.h.

Collaboration diagram for SimulationResult:

Public Member Functions
	SimulationResult ()=default
	SimulationResult (const Datafield &data, const ICoordSystem &coords)
	SimulationResult (const Datafield &data, const ICoordSystem *&&coords)
	SimulationResult (const SimulationResult &other)
	SimulationResult (SimulationResult &&other)
	~SimulationResult ()
PyObject *	array (Coords units=Coords::UNDEFINED) const
	Returns intensity data as Python numpy array. More...
std::pair< double, double >	axisMinMax (size_t i, Coords units=Coords::UNDEFINED) const
std::string	axisName (size_t i, Coords units=Coords::UNDEFINED) const
std::vector< double >	convertedBinCenters (Coords units=Coords::UNDEFINED) const
std::vector< double >	convertedBinCenters (size_t i_axis, Coords units=Coords::UNDEFINED) const
	Returns axis coordinates as a numpy array. With no parameters given Returns coordinates of x-axis in default units. More...
const ICoordSystem &	converter () const
	Returns underlying unit converter. More...
Datafield *	datafield (Coords units=Coords::UNDEFINED) const
bool	empty () const
std::vector< double >	flatVector (Coords units=Coords::UNDEFINED) const
SimulationResult &	operator= (const SimulationResult &other)
SimulationResult &	operator= (SimulationResult &&other)
double &	operator[] (size_t i)
const double &	operator[] (size_t i) const
size_t	rank () const
	Data element access. More...
SimulationResult	relativeToMaximum () const
	Returns modified SimulationResult: all intensities dvided by maximum intensity. More...
void	setTitle (const std::string &title)
size_t	size () const
std::string	title ()

Private Member Functions
void	checkRank () const

Private Attributes
std::unique_ptr< const ICoordSystem >	m_coordsys
std::unique_ptr< Datafield >	m_data
std::string	m_title

Constructor & Destructor Documentation

SimulationResult() [1/5]

SimulationResult::SimulationResult ( )

default

SimulationResult() [2/5]

SimulationResult::SimulationResult	(	const Datafield &	data,
		const ICoordSystem &	coords
	)

Definition at line 22 of file SimulationResult.cpp.

    : m_data(data.clone())
    , m_coordsys(coords.clone())
{
    checkRank();
}

References checkRank().

Here is the call graph for this function:

SimulationResult() [3/5]

SimulationResult::SimulationResult	(	const Datafield &	data,
		const ICoordSystem *&&	coords
	)

Definition at line 29 of file SimulationResult.cpp.

    : m_data(data.clone())
    , m_coordsys(coords)
{
    checkRank();
}

References checkRank().

Here is the call graph for this function:

~SimulationResult()

SimulationResult::~SimulationResult ( )

default

SimulationResult() [4/5]

SimulationResult::SimulationResult

(

const SimulationResult &

other

)

Definition at line 38 of file SimulationResult.cpp.

{
    m_data.reset(other.m_data->clone());
    m_coordsys.reset(other.m_coordsys->clone());
}

References m_coordsys, and m_data.

SimulationResult() [5/5]

SimulationResult::SimulationResult

(

SimulationResult &&

other

)

Definition at line 44 of file SimulationResult.cpp.

    : m_data(std::move(other.m_data))
    , m_coordsys(std::move(other.m_coordsys))
{
}

Member Function Documentation

array()

PyObject * SimulationResult::array

(

Coords

units = Coords::UNDEFINED

)

const

Returns intensity data as Python numpy array.

Definition at line 119 of file SimulationResult.cpp.

{
    std::unique_ptr<Datafield> data(m_coordsys->createConvertedData(*m_data, units));
    return data->npArray();
}

References m_coordsys, and m_data.

axisMinMax()

std::pair< double, double > SimulationResult::axisMinMax	(	size_t	i,
		Coords	units = Coords::UNDEFINED
	)		const

Definition at line 87 of file SimulationResult.cpp.

{
    return {m_coordsys->calculateMin(i, units), m_coordsys->calculateMax(i, units)};
}

References m_coordsys.

axisName()

std::string SimulationResult::axisName	(	size_t	i,
		Coords	units = Coords::UNDEFINED
	)		const

Definition at line 92 of file SimulationResult.cpp.

{
    return m_coordsys->axisName(i, units);
}

References m_coordsys.

checkRank()

void SimulationResult::checkRank ( ) const

private

Definition at line 140 of file SimulationResult.cpp.

{
    ASSERT(m_data);
    ASSERT(m_coordsys);
    ASSERT(m_data->rank() == m_coordsys->rank());
}

References ASSERT, m_coordsys, and m_data.

Referenced by SimulationResult().

convertedBinCenters() [1/2]

std::vector< double > SimulationResult::convertedBinCenters

(

Coords

units = Coords::UNDEFINED

)

const

Definition at line 126 of file SimulationResult.cpp.

{
    return convertedBinCenters(0, units);
}

convertedBinCenters() [2/2]

std::vector< double > SimulationResult::convertedBinCenters	(	size_t	i_axis,
		Coords	units = Coords::UNDEFINED
	)		const

Returns axis coordinates as a numpy array. With no parameters given Returns coordinates of x-axis in default units.

Definition at line 131 of file SimulationResult.cpp.

{
    if (i_axis >= m_coordsys->rank())
        throw std::runtime_error(
            "Error in SimulationResult::axis: no axis corresponds to passed index.");
    auto axis = m_coordsys->createConvertedAxis(i_axis, units);
    return axis->binCenters();
}

References m_coordsys.

converter()

const ICoordSystem & SimulationResult::converter

(

)

const

Returns underlying unit converter.

Definition at line 97 of file SimulationResult.cpp.

{
    return *m_coordsys;
}

References m_coordsys.

Referenced by SimDataPair::execSimulation().

datafield()

Datafield * SimulationResult::datafield

(

Coords

units = Coords::UNDEFINED

)

const

Definition at line 82 of file SimulationResult.cpp.

{
    return m_coordsys->createConvertedData(*m_data, units);
}

References m_coordsys, and m_data.

Referenced by SimDataPair::experimental_array(), flatVector(), SimDataPair::simulation_array(), SimDataPair::uncertainties_array(), SimDataPair::user_weights_array(), and IOFactory::writeSimulationResult().

empty()

bool SimulationResult::empty ( ) const

inline

Definition at line 57 of file SimulationResult.h.

{ return size() == 0; }

References size().

Referenced by SimDataPair::absoluteDifference(), SimDataPair::execSimulation(), SimDataPair::experimental_array(), SimDataPair::experimentalData(), DiffUtil::meanRelativeDifference(), SimDataPair::relativeDifference(), SimDataPair::simulation_array(), SimDataPair::simulationResult(), SimDataPair::uncertainties(), SimDataPair::uncertainties_array(), SimDataPair::user_weights_array(), and SimDataPair::userWeights().

Here is the call graph for this function:

flatVector()

std::vector< double > SimulationResult::flatVector

(

Coords

units = Coords::UNDEFINED

)

const

Definition at line 76 of file SimulationResult.cpp.

{
    std::unique_ptr<Datafield> f(datafield(units));
    return f->flatVector();
}

References datafield().

Referenced by RQ4Metric::compute().

Here is the call graph for this function:

operator=() [1/2]

SimulationResult & SimulationResult::operator=

(

const SimulationResult &

other

)

Definition at line 50 of file SimulationResult.cpp.

{
    if (&other == this)
        return *this;
    m_data.reset(other.m_data->clone());
    m_coordsys.reset(other.m_coordsys->clone());
    return *this;
}

References m_coordsys, and m_data.

operator=() [2/2]

SimulationResult & SimulationResult::operator=

(

SimulationResult &&

other

)

Definition at line 59 of file SimulationResult.cpp.

{
    m_data = std::move(other.m_data);
    m_coordsys = std::move(other.m_coordsys);
    return *this;
}

References m_coordsys, and m_data.

operator[]() [1/2]

double & SimulationResult::operator[]

(

size_t

i

)

Definition at line 102 of file SimulationResult.cpp.

{
    return (*m_data)[i];
}

References m_data.

operator[]() [2/2]

const double & SimulationResult::operator[]

(

size_t

i

)

const

Definition at line 107 of file SimulationResult.cpp.

{
    return (*m_data)[i];
}

References m_data.

rank()

size_t SimulationResult::rank

(

)

const

Data element access.

Definition at line 66 of file SimulationResult.cpp.

{
    return m_data->rank();
}

References m_data.

relativeToMaximum()

SimulationResult SimulationResult::relativeToMaximum

(

)

const

Returns modified SimulationResult: all intensities dvided by maximum intensity.

Definition at line 112 of file SimulationResult.cpp.

{
    std::unique_ptr<Datafield> data2(m_data->normalizedToMaximum());
    return {*data2, m_coordsys->clone()};
}

References m_coordsys, and m_data.

setTitle()

void SimulationResult::setTitle ( const std::string &  title )

inline

Definition at line 73 of file SimulationResult.h.

{ m_title = title; }

References m_title, and title().

Here is the call graph for this function:

size()

size_t SimulationResult::size

(

)

const

Definition at line 71 of file SimulationResult.cpp.

{
    return m_data ? m_data->size() : 0;
}

References m_data.

Referenced by SimDataPair::absoluteDifference(), empty(), DiffUtil::meanRelativeDifference(), and SimDataPair::relativeDifference().

title()

std::string SimulationResult::title ( )

inline

Definition at line 74 of file SimulationResult.h.

{ return m_title; }

References m_title.

Referenced by setTitle().

Member Data Documentation

m_coordsys

std::unique_ptr<const ICoordSystem> SimulationResult::m_coordsys

private

Definition at line 80 of file SimulationResult.h.

Referenced by SimulationResult(), array(), axisMinMax(), axisName(), checkRank(), convertedBinCenters(), converter(), datafield(), operator=(), and relativeToMaximum().

m_data

std::unique_ptr<Datafield> SimulationResult::m_data

private

Definition at line 79 of file SimulationResult.h.

Referenced by SimulationResult(), array(), checkRank(), datafield(), operator=(), operator[](), rank(), relativeToMaximum(), and size().

m_title

std::string SimulationResult::m_title

private

Definition at line 82 of file SimulationResult.h.

Referenced by setTitle(), and title().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Device/Histo/SimulationResult.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Device/Histo/SimulationResult.cpp