Wrapper around OutputData<double> that also provides unit conversions. More...

Public Member Functions
	SimulationResult ()=default

	SimulationResult (const OutputData< double > &data, const IUnitConverter &unit_converter)

	SimulationResult (const SimulationResult &other)

	SimulationResult (SimulationResult &&other)

PyObject *	array (Axes::Units units=Axes::Units::DEFAULT) const
	returns intensity data as Python numpy array More...

std::vector< double >	axis (Axes::Units units=Axes::Units::DEFAULT) const

std::vector< double >	axis (size_t i_axis, Axes::Units units=Axes::Units::DEFAULT) const
	Returns axis coordinates as a numpy array. More...

std::vector< AxisInfo >	axisInfo (Axes::Units units=Axes::Units::DEFAULT) const
	Provide AxisInfo for each axis and the given units. More...

const IUnitConverter &	converter () const
	Returns underlying unit converter. More...

std::unique_ptr< OutputData< double > >	data (Axes::Units units=Axes::Units::DEFAULT) const

bool	empty () const

Histogram2D *	histogram2d (Axes::Units units=Axes::Units::DEFAULT) const

double	max () const

SimulationResult &	operator= (const SimulationResult &other)

SimulationResult &	operator= (SimulationResult &&other)

double &	operator[] (size_t i)
	Data element access. More...

const double &	operator[] (size_t i) const

size_t	size () const

Private Member Functions
void	checkDimensions () const

Private Attributes
std::unique_ptr< OutputData< double > >	m_data

std::unique_ptr< IUnitConverter >	m_unit_converter

Detailed Description

Wrapper around OutputData<double> that also provides unit conversions.

Definition at line 40 of file SimulationResult.h.

Constructor & Destructor Documentation

◆ SimulationResult() [1/4]

SimulationResult::SimulationResult ( )

default

◆ SimulationResult() [2/4]

SimulationResult::SimulationResult	(	const OutputData< double > &	data,
		const IUnitConverter &	unit_converter
	)

Definition at line 18 of file SimulationResult.cpp.

     : m_data(data.clone()), m_unit_converter(unit_converter.clone())
 {
     checkDimensions();
 }

References checkDimensions().

Here is the call graph for this function:

◆ SimulationResult() [3/4]

SimulationResult::SimulationResult ( const SimulationResult & other )

Definition at line 25 of file SimulationResult.cpp.

 {
     if (!other.m_data || !other.m_unit_converter)
         throw std::runtime_error("Error in SimulationResult(const SimulationResult& other): "
                                  "not initialized");
     m_data.reset(other.m_data->clone());
     m_unit_converter.reset(other.m_unit_converter->clone());
 }

References m_data, and m_unit_converter.

◆ SimulationResult() [4/4]

SimulationResult::SimulationResult ( SimulationResult && other )

Definition at line 34 of file SimulationResult.cpp.

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

Member Function Documentation

◆ array()

PyObject * SimulationResult::array ( Axes::Units units = Axes::Units::DEFAULT ) const

returns intensity data as Python numpy array

Definition at line 124 of file SimulationResult.cpp.

 {
     if (!m_data || !m_unit_converter)
         throw std::runtime_error(
             "Error in SimulationResult::array: attempt to access non-initialized data");
     return m_unit_converter->createConvertedData(*m_data, units)->getArray();
 }

References m_data, and m_unit_converter.

◆ axis() [1/2]

std::vector< double > SimulationResult::axis ( Axes::Units units = Axes::Units::DEFAULT ) const

Definition at line 133 of file SimulationResult.cpp.

 {
     return axis(0, units);
 }

Referenced by axis().

◆ axis() [2/2]

std::vector< double > SimulationResult::axis	(	size_t	i_axis,
		Axes::Units	units = `Axes::Units::DEFAULT`
	)		const

Returns axis coordinates as a numpy array.

With no parameters given returns coordinates of x-axis in default units.

Definition at line 138 of file SimulationResult.cpp.

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

References axis(), and m_unit_converter.

Here is the call graph for this function:

◆ axisInfo()

std::vector< AxisInfo > SimulationResult::axisInfo ( Axes::Units units = Axes::Units::DEFAULT ) const

Provide AxisInfo for each axis and the given units.

Definition at line 75 of file SimulationResult.cpp.

 {
     if (!m_unit_converter)
         return {};
     std::vector<AxisInfo> result;
     auto dim = m_unit_converter->dimension();
     for (size_t i = 0; i < dim; ++i) {
         AxisInfo info = {m_unit_converter->axisName(i, units),
                          m_unit_converter->calculateMin(i, units),
                          m_unit_converter->calculateMax(i, units)};
         result.push_back(info);
     }
     return result;
 }

References m_unit_converter.

◆ checkDimensions()

void SimulationResult::checkDimensions ( ) const

private

Definition at line 147 of file SimulationResult.cpp.

 {
     if (m_data->rank() != m_unit_converter->dimension())
         throw std::runtime_error("Error in SimulationResults::checkDimensions(): "
                                  "dimensions of data and unit converter don't match");
 }

References m_data, and m_unit_converter.

Referenced by SimulationResult().

◆ converter()

const IUnitConverter & SimulationResult::converter ( ) const

Returns underlying unit converter.

Definition at line 90 of file SimulationResult.cpp.

 {
     ASSERT(m_unit_converter);
     return *m_unit_converter;
 }

References ASSERT, and m_unit_converter.

Referenced by SimDataPair::initResultArrays(), and JobItemUtils::setResults().

◆ data()

std::unique_ptr< OutputData< double > > SimulationResult::data ( Axes::Units units = Axes::Units::DEFAULT ) const

Definition at line 57 of file SimulationResult.cpp.

 {
     if (!m_data)
         throw std::runtime_error(
             "Error in SimulationResult::data:Attempt to access non-initialized data");
     return m_unit_converter->createConvertedData(*m_data, units);
 }

References m_data, and m_unit_converter.

Referenced by HistoUtils::agreesWithReference(), RQ4Metric::compute(), SimDataPair::experimental_array(), histogram2d(), SimDataPair::simulation_array(), SimDataPair::uncertainties_array(), GUIFitObserver::update(), SimDataPair::user_weights_array(), and IntensityDataIOFactory::writeSimulationResult().

◆ empty()

bool SimulationResult::empty ( ) const

inline

Definition at line 68 of file SimulationResult.h.

68 { return size() == 0; }

SimulationResult::size

size_t size() const

Definition: SimulationResult.cpp:108

References size().

Referenced by SimDataPair::experimental_array(), SimDataPair::experimentalData(), HistoUtils::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:

◆ histogram2d()

Histogram2D * SimulationResult::histogram2d ( Axes::Units units = Axes::Units::DEFAULT ) const

Definition at line 65 of file SimulationResult.cpp.

 {
     if (m_data->rank() != 2 || m_unit_converter->dimension() != 2)
         throw std::runtime_error("Error in SimulationResult::histogram2d: "
                                  "dimension of data is not 2. Please use axis(), array() and "
                                  "data() functions for 1D data.");
     auto P_data = data(units);
     return new Histogram2D(*P_data);
 }

References data(), m_data, and m_unit_converter.

Here is the call graph for this function:

◆ max()

double SimulationResult::max ( ) const

Definition at line 113 of file SimulationResult.cpp.

 {
     ASSERT(m_data);
     double result = 0;
     for (size_t i = 0; i < size(); ++i)
         if ((*m_data)[i] > result)
             result = (*m_data)[i];
     return result;
 }

References ASSERT, m_data, and size().

Here is the call graph for this function:

◆ operator=() [1/2]

SimulationResult & SimulationResult::operator= ( const SimulationResult & other )

Definition at line 39 of file SimulationResult.cpp.

 {
     if (!other.m_data || !other.m_unit_converter)
         throw std::runtime_error("Error in SimulationResult(const SimulationResult& other): "
                                  "not initialized");
  
     m_data.reset(other.m_data->clone());
     m_unit_converter.reset(other.m_unit_converter->clone());
     return *this;
 }

References m_data, and m_unit_converter.

◆ operator=() [2/2]

SimulationResult & SimulationResult::operator= ( SimulationResult && other )

Definition at line 50 of file SimulationResult.cpp.

 {
     m_data.reset(other.m_data.release());
     m_unit_converter.reset(other.m_unit_converter.release());
     return *this;
 }

References m_data, and m_unit_converter.

◆ operator[]() [1/2]

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

Data element access.

Definition at line 96 of file SimulationResult.cpp.

 {
     ASSERT(m_data);
     return (*m_data)[i];
 }

References ASSERT, and m_data.

◆ operator[]() [2/2]

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

Definition at line 102 of file SimulationResult.cpp.

 {
     ASSERT(m_data);
     return (*m_data)[i];
 }

References ASSERT, and m_data.

◆ size()

size_t SimulationResult::size ( ) const

Definition at line 108 of file SimulationResult.cpp.

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

References m_data.

Referenced by SimDataPair::absoluteDifference(), empty(), SimDataPair::initResultArrays(), max(), SimDataPair::relativeDifference(), and HistoUtils::RelativeDifference().

Member Data Documentation

◆ m_data

std::unique_ptr<OutputData<double> > SimulationResult::m_data

private

Definition at line 84 of file SimulationResult.h.

Referenced by SimulationResult(), array(), checkDimensions(), data(), histogram2d(), max(), operator=(), operator[](), and size().

◆ m_unit_converter

std::unique_ptr<IUnitConverter> SimulationResult::m_unit_converter

private

Definition at line 85 of file SimulationResult.h.

Referenced by SimulationResult(), array(), axis(), axisInfo(), checkDimensions(), converter(), data(), histogram2d(), and operator=().

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

/home/www/ba/Device/Histo/SimulationResult.h
/home/www/ba/Device/Histo/SimulationResult.cpp

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SimulationResult() [1/4]

◆ SimulationResult() [2/4]

◆ SimulationResult() [3/4]

◆ SimulationResult() [4/4]

Member Function Documentation

◆ array()

◆ axis() [1/2]

◆ axis() [2/2]

◆ axisInfo()

◆ checkDimensions()

◆ converter()

◆ data()

◆ empty()

◆ histogram2d()

◆ max()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ size()

Member Data Documentation

◆ m_data

◆ m_unit_converter