Collaboration diagram for OutputData< T >:

Public Types
using	value_type = T

typedef OutputDataIterator< T, OutputData< T > >	iterator

typedef OutputDataIterator< const T, const OutputData< T > >	const_iterator

Public Member Functions
	OutputData ()

	OutputData (const OutputData &)=delete

const OutputData &	operator= (const OutputData &)=delete

	~OutputData ()

OutputData *	clone () const

void	copyFrom (const OutputData< T > &x)

template<class U >
void	copyShapeFrom (const OutputData< U > &other)

OutputData< double > *	meanValues () const

void	addAxis (const IAxis &new_axis)

void	addAxis (const std::string &name, size_t size, double start, double end)

const IAxis &	getAxis (size_t serial_number) const

const IAxis &	getAxis (const std::string &axis_name) const

size_t	getRank () const

size_t	getAllocatedSize () const

std::vector< size_t >	getAllSizes () const

std::vector< T >	getRawDataVector () const

T	totalSum () const

iterator	begin ()

const_iterator	begin () const

iterator	end ()

const_iterator	end () const

std::vector< int >	getAxesBinIndices (size_t global_index) const

size_t	getAxisBinIndex (size_t global_index, size_t i_selected_axis) const

size_t	getAxisBinIndex (size_t global_index, const std::string &axis_name) const

size_t	toGlobalIndex (const std::vector< unsigned > &axes_indices) const

size_t	findGlobalIndex (const std::vector< double > &coordinates) const

double	getAxisValue (size_t global_index, size_t i_selected_axis) const

double	getAxisValue (size_t global_index, const std::string &axis_name) const

std::vector< double >	getAxesValues (size_t global_index) const

Bin1D	getAxisBin (size_t global_index, size_t i_selected_axis) const

Bin1D	getAxisBin (size_t global_index, const std::string &axis_name) const

void	clear ()

void	setAllTo (const T &value)

void	scaleAll (const T &factor)

void	setAxisSizes (size_t rank, int *n_dims)

void	setRawDataVector (const std::vector< T > &data_vector)

void	setRawDataArray (const T *source)

const OutputData< T > &	operator+= (const OutputData< T > &right)

const OutputData< T > &	operator-= (const OutputData< T > &right)

const OutputData< T > &	operator/= (const OutputData< T > &right)

const OutputData< T > &	operator*= (const OutputData< T > &right)

double	getValue (size_t index) const

T &	operator[] (size_t index)

const T &	operator[] (size_t index) const

template<class U >
bool	hasSameDimensions (const OutputData< U > &right) const

template<class U >
bool	hasSameShape (const OutputData< U > &right) const

PyObject *	getArray () const

bool	isInitialized () const

void	allocate ()

Private Member Functions
size_t	getAxisIndex (const std::string &axis_name) const

bool	axisNameExists (const std::string &axis_name) const

Private Attributes
SafePointerVector< IAxis >	m_value_axes

LLData< T > *	mp_ll_data

Friends
class	OutputDataIterator< T, OutputData< T > >

class	OutputDataIterator< const T, const OutputData< T > >

Detailed Description

template<class T>
class OutputData< T >

Template class to store data of any type in multi-dimensional space.

Definition at line 32 of file OutputData.h.

Member Typedef Documentation

◆ value_type

template<class T >

using OutputData< T >::value_type = T

Definition at line 35 of file OutputData.h.

◆ iterator

template<class T >

typedef OutputDataIterator<T, OutputData<T> > OutputData< T >::iterator

Read/write iterator type.

Definition at line 84 of file OutputData.h.

◆ const_iterator

template<class T >

typedef OutputDataIterator<const T, const OutputData<T> > OutputData< T >::const_iterator

Read-only iterator type.

Definition at line 87 of file OutputData.h.

Constructor & Destructor Documentation

◆ OutputData() [1/2]

template<class T >

OutputData< T >::OutputData

Definition at line 242 of file OutputData.h.

                                              : m_value_axes(), mp_ll_data(nullptr)
 {
     allocate();
 }

References OutputData< T >::allocate().

Here is the call graph for this function:

◆ OutputData() [2/2]

template<class T >

OutputData< T >::OutputData ( const OutputData< T > & )

delete

◆ ~OutputData()

template<class T >

OutputData< T >::~OutputData

Definition at line 247 of file OutputData.h.

 {
     clear();
     delete mp_ll_data;
 }

Member Function Documentation

◆ operator=()

template<class T >

const OutputData& OutputData< T >::operator= ( const OutputData< T > & )

delete

◆ clone()

template<class T >

OutputData< T > * OutputData< T >::clone

Definition at line 253 of file OutputData.h.

 {
     OutputData<T>* ret = new OutputData<T>();
     ret->m_value_axes = m_value_axes;
     (*ret->mp_ll_data) = *mp_ll_data;
     return ret;
 }

References OutputData< T >::m_value_axes, and OutputData< T >::mp_ll_data.

Referenced by IntensityDataFunctions::createRearrangedDataSet(), IntensityDataFunctions::createRelativeDifferenceData(), and OffSpecSimulation::result().

◆ copyFrom()

template<class T >

void OutputData< T >::copyFrom ( const OutputData< T > & x )

Definition at line 261 of file OutputData.h.

 {
     clear();
     m_value_axes = other.m_value_axes;
     delete mp_ll_data;
     mp_ll_data = 0;
     if (other.mp_ll_data)
         mp_ll_data = new LLData<T>(*other.mp_ll_data);
 }

References OutputData< T >::m_value_axes, and OutputData< T >::mp_ll_data.

Referenced by DetectorMask::DetectorMask(), IHistogram::IHistogram(), OffSpecSimulation::OffSpecSimulation(), and DetectorMask::operator=().

◆ copyShapeFrom()

template<class T >

template<class U >

void OutputData< T >::copyShapeFrom ( const OutputData< U > & other )

Definition at line 271 of file OutputData.h.

 {
     clear();
     size_t rank = other.getRank();
     for (size_t i = 0; i < rank; ++i)
         addAxis(other.getAxis(i));
 }

References OutputData< T >::getAxis(), and OutputData< T >::getRank().

Referenced by DetectorMask::createHistogram(), IHistogram::createOutputData(), and IHistogram::init_from_data().

Here is the call graph for this function:

◆ meanValues()

template<class T >

OutputData< double > * OutputData< T >::meanValues

Definition at line 279 of file OutputData.h.

 {
     auto* ret = new OutputData<double>();
     ret->copyShapeFrom(*this);
     ret->allocate();
     for (size_t i = 0; i < mp_ll_data->getTotalSize(); ++i)
         (*ret)[i] = getValue(i);
     return ret;
 }

Referenced by IntensityDataFunctions::getRelativeDifference().

◆ addAxis() [1/2]

template<class T >

void OutputData< T >::addAxis ( const IAxis & new_axis )

Definition at line 289 of file OutputData.h.

 {
     if (axisNameExists(new_axis.getName()))
         throw Exceptions::LogicErrorException(
             "OutputData<T>::addAxis(const IAxis& new_axis) -> "
             "Error! Attempt to add axis with already existing name '"
             + new_axis.getName() + "'");
     if (new_axis.size() > 0) {
         m_value_axes.push_back(new_axis.clone());
         allocate();
     }
 }

References IAxis::clone(), IAxis::getName(), and IAxis::size().

Referenced by Histogram1D::Histogram1D(), Histogram2D::Histogram2D(), IHistogram::IHistogram(), Histogram2D::initFromShape(), DetectorMask::initMaskData(), OutputDataReadINTStrategy::readOutputData(), OutputDataReadReflectometryStrategy::readOutputData(), SpecularSimulation::result(), OffSpecSimulation::transferDetectorImage(), and OffSpecSimulation::updateIntensityMap().

Here is the call graph for this function:

◆ addAxis() [2/2]

template<class T >

void OutputData< T >::addAxis	(	const std::string &	name,
		size_t	size,
		double	start,
		double	end
	)

Definition at line 303 of file OutputData.h.

 {
     if (axisNameExists(name))
         throw Exceptions::LogicErrorException(
             "OutputData<T>::addAxis(std::string name) -> "
             "Error! Attempt to add axis with already existing name '"
             + name + "'");
     FixedBinAxis new_axis(name, size, start, end);
     addAxis(new_axis);
 }

◆ getAxis() [1/2]

template<class T >

const IAxis & OutputData< T >::getAxis ( size_t serial_number ) const

returns axis with given serial number

Definition at line 314 of file OutputData.h.

 {
     return *m_value_axes[serial_number];
 }

Referenced by Histogram2D::addContent(), ConvolutionDetectorResolution::apply1dConvolution(), ConvolutionDetectorResolution::apply2dConvolution(), IntensityDataFunctions::coordinateFromBinf(), IntensityDataFunctions::coordinateToBinf(), OutputData< T >::copyShapeFrom(), IntensityDataFunctions::create2DArrayfromOutputData(), IntensityDataFunctions::createClippedDataSet(), IntensityDataFunctions::createRearrangedDataSet(), anonymous_namespace{Simulation.cpp}::detHasSameDimensions(), IHistogram::getXaxis(), IHistogram::getYaxis(), OutputData< T >::hasSameDimensions(), OutputData< T >::hasSameShape(), DetectorMask::initMaskData(), RegionOfInterest::RegionOfInterest(), anonymous_namespace{OutputDataWriteStrategy.cpp}::Write1DRepresentation(), anonymous_namespace{OutputDataWriteStrategy.cpp}::Write2DRepresentation(), and OutputDataWriteINTStrategy::writeOutputData().

◆ getAxis() [2/2]

template<class T >

const IAxis & OutputData< T >::getAxis ( const std::string & axis_name ) const

returns axis with given name

Definition at line 319 of file OutputData.h.

 {
     return getAxis(getAxisIndex(axis_name));
 }

◆ getRank()

template<class T >

size_t OutputData< T >::getRank ( ) const

inline

Returns number of dimensions.

Definition at line 59 of file OutputData.h.

59 { return m_value_axes.size(); }

SafePointerVector::size

size_t size() const

Definition: SafePointerVector.h:38

References OutputData< T >::m_value_axes, and SafePointerVector< T >::size().

Referenced by ConvolutionDetectorResolution::apply1dConvolution(), ConvolutionDetectorResolution::apply2dConvolution(), ConvolutionDetectorResolution::applyDetectorResolution(), OutputData< T >::copyShapeFrom(), IntensityDataFunctions::create2DArrayfromOutputData(), IntensityDataFunctions::createClippedDataSet(), IUnitConverter::createConvertedData(), UnitConverter1D::createConvertedData(), IHistogram::createHistogram(), IntensityDataFunctions::createRearrangedDataSet(), anonymous_namespace{Simulation.cpp}::detHasSameDimensions(), OutputData< T >::hasSameDimensions(), IHistogram::init_from_data(), DetectorMask::initMaskData(), RegionOfInterest::RegionOfInterest(), OutputDataWriteINTStrategy::writeOutputData(), and OutputDataWriteNumpyTXTStrategy::writeOutputData().

Here is the call graph for this function:

◆ getAllocatedSize()

template<class T >

size_t OutputData< T >::getAllocatedSize ( ) const

inline

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

Definition at line 62 of file OutputData.h.

     {
         if (mp_ll_data)
             return mp_ll_data->getTotalSize();
         return 0;
     }

References OutputData< T >::mp_ll_data.

Referenced by DetectorMask::createHistogram(), IntensityDataFunctions::createRearrangedDataSet(), OutputData< T >::end(), IntensityDataFunctions::getRelativeDifference(), IHistogram::getTotalNumberOfBins(), IHistogram::init_from_data(), DetectorMask::process_masks(), OffSpecSimulation::transferDetectorImage(), and OffSpecSimulation::transferResultsToIntensityMap().

◆ getAllSizes()

template<class T >

std::vector< size_t > OutputData< T >::getAllSizes

inline

Returns all sizes of its axes.

Definition at line 324 of file OutputData.h.

 {
     ASSERT(mp_ll_data);
     std::vector<size_t> result;
     for (size_t i = 0; i < getRank(); ++i) {
         int dim = mp_ll_data->getDimensions()[i];
         result.push_back(dim);
     }
     return result;
 }

References ASSERT.

◆ getRawDataVector()

template<class T >

std::vector< T > OutputData< T >::getRawDataVector

inline

Returns copy of raw data vector.

Definition at line 335 of file OutputData.h.

 {
     ASSERT(mp_ll_data);
     std::vector<T> result;
     for (size_t i = 0; i < getAllocatedSize(); ++i)
         result.push_back((*mp_ll_data)[i]);
     return result;
 }

References ASSERT.

Referenced by ConvolutionDetectorResolution::apply1dConvolution(), ConvolutionDetectorResolution::apply2dConvolution(), Simulation::convertData(), IUnitConverter::createConvertedData(), and UnitConverter1D::createConvertedData().

◆ totalSum()

template<class T >

T OutputData< T >::totalSum

inline

Returns sum of all values in the data structure.

Definition at line 467 of file OutputData.h.

 {
     ASSERT(mp_ll_data);
     return mp_ll_data->getTotalSum();
 }

References ASSERT.

◆ begin() [1/2]

template<class T >

OutputData< T >::iterator OutputData< T >::begin

Returns read/write iterator that points to the first element.

Definition at line 344 of file OutputData.h.

 {
     typename OutputData<T>::iterator result(this);
     return result;
 }

Referenced by ConvolutionDetectorResolution::apply2dConvolution(), IntensityDataFunctions::createClippedDataSet(), Histogram1D::crop(), Histogram2D::crop(), DataFormatUtils::fillOutputData(), IHistogram::getMaximum(), IHistogram::getMaximumBinIndex(), IHistogram::getMinimum(), IHistogram::getMinimumBinIndex(), and anonymous_namespace{OutputDataWriteStrategy.cpp}::WriteOutputDataDoubles().

◆ begin() [2/2]

template<class T >

OutputData< T >::const_iterator OutputData< T >::begin

Returns read-only iterator that points to the first element.

Definition at line 350 of file OutputData.h.

 {
     typename OutputData<T>::const_iterator result(this);
     return result;
 }

◆ end() [1/2]

template<class T >

iterator OutputData< T >::end ( )

inline

Returns read/write iterator that points to the one past last element.

Definition at line 96 of file OutputData.h.

96 { return iterator(this, getAllocatedSize()); }

OutputData::iterator

OutputDataIterator< T, OutputData< T > > iterator

Read/write iterator type.

Definition: OutputData.h:84

References OutputData< T >::getAllocatedSize().

Referenced by ConvolutionDetectorResolution::apply2dConvolution(), IntensityDataFunctions::createClippedDataSet(), Histogram1D::crop(), Histogram2D::crop(), DataFormatUtils::fillOutputData(), IHistogram::getMaximum(), IHistogram::getMaximumBinIndex(), IHistogram::getMinimum(), IHistogram::getMinimumBinIndex(), and anonymous_namespace{OutputDataWriteStrategy.cpp}::WriteOutputDataDoubles().

Here is the call graph for this function:

◆ end() [2/2]

template<class T >

const_iterator OutputData< T >::end ( ) const

inline

Returns read-only iterator that points to the one past last element.

Definition at line 99 of file OutputData.h.

99 { return const_iterator(this, getAllocatedSize()); }

OutputData::const_iterator

OutputDataIterator< const T, const OutputData< T > > const_iterator

Read-only iterator type.

Definition: OutputData.h:87

References OutputData< T >::getAllocatedSize().

Here is the call graph for this function:

◆ getAxesBinIndices()

template<class T >

std::vector< int > OutputData< T >::getAxesBinIndices ( size_t global_index ) const

Returns vector of axes indices for given global index.

Parameters

global_index The global index of this data structure.

Returns: Vector of bin indices for all axes defined

Definition at line 356 of file OutputData.h.

 {
     ASSERT(mp_ll_data);
     size_t remainder = global_index;
     std::vector<int> result;
     result.resize(mp_ll_data->getRank());
     for (size_t i = 0; i < mp_ll_data->getRank(); ++i) {
         result[mp_ll_data->getRank() - 1 - i] =
             (int)(remainder % m_value_axes[mp_ll_data->getRank() - 1 - i]->size());
         remainder /= m_value_axes[mp_ll_data->getRank() - 1 - i]->size();
     }
     return result;
 }

References ASSERT.

Referenced by IntensityDataFunctions::createRearrangedDataSet().

◆ getAxisBinIndex() [1/2]

template<class T >

size_t OutputData< T >::getAxisBinIndex	(	size_t	global_index,
		size_t	i_selected_axis
	)		const

Returns axis bin index for given global index.

Parameters

global_index	The global index of this data structure.
i_selected_axis	Serial number of selected axis.

Returns: Corresponding bin index for selected axis

Definition at line 371 of file OutputData.h.

 {
     ASSERT(mp_ll_data);
     size_t remainder(global_index);
     for (size_t i = 0; i < mp_ll_data->getRank(); ++i) {
         size_t i_axis = mp_ll_data->getRank() - 1 - i;
         size_t result = remainder % m_value_axes[i_axis]->size();
         if (i_selected_axis == i_axis)
             return result;
         remainder /= m_value_axes[i_axis]->size();
     }
     throw Exceptions::LogicErrorException("OutputData<T>::getAxisBinIndex() -> "
                                           "Error! No axis with given number");
 }

References ASSERT.

Referenced by IHistogram::getXaxisIndex(), and IHistogram::getYaxisIndex().

◆ getAxisBinIndex() [2/2]

template<class T >

size_t OutputData< T >::getAxisBinIndex	(	size_t	global_index,
		const std::string &	axis_name
	)		const

Returns axis bin index for given global index.

Parameters

global_index	The global index of this data structure.
axis_name	The name of selected axis.

Returns: Corresponding bin index for selected axis

Definition at line 387 of file OutputData.h.

 {
     return getAxisBinIndex(global_index, getAxisIndex(axis_name));
 }

◆ toGlobalIndex()

template<class T >

size_t OutputData< T >::toGlobalIndex ( const std::vector< unsigned > & axes_indices ) const

Returns global index for specified indices of axes.

Parameters

axes_indices Vector of axes indices for all specified axes in this dataset

Returns: Corresponding global index

Definition at line 393 of file OutputData.h.

 {
     ASSERT(mp_ll_data);
     if (axes_indices.size() != mp_ll_data->getRank())
         throw Exceptions::LogicErrorException(
             "size_t OutputData<T>::toGlobalIndex() -> "
             "Error! Number of coordinates must match rank of data structure");
     size_t result = 0;
     size_t step_size = 1;
     for (size_t i = mp_ll_data->getRank(); i > 0; --i) {
         if (axes_indices[i - 1] >= m_value_axes[i - 1]->size()) {
             std::ostringstream message;
             message << "size_t OutputData<T>::toGlobalIndex() -> Error. Index ";
             message << axes_indices[i - 1] << " is out of range. Axis ";
             message << m_value_axes[i - 1]->getName();
             message << " size " << m_value_axes[i - 1]->size() << ".\n";
             throw Exceptions::LogicErrorException(message.str());
         }
         result += axes_indices[i - 1] * step_size;
         step_size *= m_value_axes[i - 1]->size();
     }
     return result;
 }

References ASSERT.

Referenced by IHistogram::getGlobalBin().

◆ findGlobalIndex()

template<class T >

size_t OutputData< T >::findGlobalIndex ( const std::vector< double > & coordinates ) const

Returns global index for specified axes values.

Parameters

coordinates Vector of axes coordinates for all specified axes in this dataset

Returns: Closest global index

Definition at line 418 of file OutputData.h.

 {
     ASSERT(mp_ll_data);
     if (coordinates.size() != mp_ll_data->getRank())
         throw Exceptions::LogicErrorException(
             "OutputData<T>::findClosestIndex() -> "
             "Error! Number of coordinates must match rank of data structure");
     std::vector<unsigned> axes_indexes;
     axes_indexes.resize(mp_ll_data->getRank());
     for (size_t i = 0; i < mp_ll_data->getRank(); ++i)
         axes_indexes[i] = static_cast<unsigned>(m_value_axes[i]->findClosestIndex(coordinates[i]));
     return toGlobalIndex(axes_indexes);
 }

References ASSERT.

Referenced by Histogram2D::fill(), and IHistogram::findGlobalBin().

◆ getAxisValue() [1/2]

template<class T >

double OutputData< T >::getAxisValue	(	size_t	global_index,
		size_t	i_selected_axis
	)		const

Returns the value of selected axis for given global_index.

Parameters

global_index	The global index of this data structure.
i_selected_axis	Serial number of selected axis.

Returns: corresponding bin center of selected axis

Definition at line 433 of file OutputData.h.

 {
     auto axis_index = getAxisBinIndex(global_index, i_selected_axis);
     return (*m_value_axes[i_selected_axis])[axis_index];
 }

Referenced by IntensityDataFunctions::createClippedDataSet(), Histogram1D::crop(), Histogram2D::crop(), IHistogram::getXaxisValue(), and IHistogram::getYaxisValue().

◆ getAxisValue() [2/2]

template<class T >

double OutputData< T >::getAxisValue	(	size_t	global_index,
		const std::string &	axis_name
	)		const

Returns the value of selected axis for given global_index.

Parameters

global_index	The global index of this data structure.
axis_name	The name of selected axis.

Returns: corresponding bin center of selected axis

Definition at line 440 of file OutputData.h.

 {
     return getAxisValue(global_index, getAxisIndex(axis_name));
 }

◆ getAxesValues()

template<class T >

std::vector< double > OutputData< T >::getAxesValues ( size_t global_index ) const

Returns values on all defined axes for given globalbin number.

Parameters

global_index The global index of this data structure.

Returns: Vector of corresponding bin centers

Definition at line 445 of file OutputData.h.

 {
     std::vector<int> indices = getAxesBinIndices(global_index);
     std::vector<double> result;
     for (size_t i_axis = 0; i_axis < indices.size(); ++i_axis)
         result.push_back((*m_value_axes[i_axis])[indices[i_axis]]);
     return result;
 }

◆ getAxisBin() [1/2]

template<class T >

Bin1D OutputData< T >::getAxisBin	(	size_t	global_index,
		size_t	i_selected_axis
	)		const

Returns bin of selected axis for given global_index.

Parameters

global_index	The global index of this data structure.
i_selected_axis	Serial number of selected axis.

Returns: Corresponding Bin1D object

Definition at line 455 of file OutputData.h.

 {
     auto axis_index = getAxisBinIndex(global_index, i_selected_axis);
     return m_value_axes[i_selected_axis]->getBin(axis_index);
 }

Referenced by DetectorMask::process_masks().

◆ getAxisBin() [2/2]

template<class T >

Bin1D OutputData< T >::getAxisBin	(	size_t	global_index,
		const std::string &	axis_name
	)		const

Returns bin of selected axis for given global_index.

Parameters

global_index	The global index of this data structure.
axis_name	The name of selected axis.

Returns: Corresponding Bin1D object

Definition at line 462 of file OutputData.h.

 {
     return getAxisBin(global_index, getAxisIndex(axis_name));
 }

◆ clear()

template<class T >

void OutputData< T >::clear

Sets object into initial state (no dimensions, data)

Definition at line 473 of file OutputData.h.

 {
     m_value_axes.clear();
     allocate();
 }

Referenced by DetectorMask::addMask(), DetectorMask::initMaskData(), DetectorMask::removeMasks(), and OffSpecSimulation::updateIntensityMap().

◆ setAllTo()

template<class T >

void OutputData< T >::setAllTo ( const T & value )

Sets content of output data to specific value.

Definition at line 479 of file OutputData.h.

 {
     if (!mp_ll_data)
         throw Exceptions::ClassInitializationException(
             "OutputData::setAllTo() -> Error! Low-level data object was not yet initialized.");
     mp_ll_data->setAll(value);
 }

Referenced by DataFormatUtils::fillOutputData(), DetectorMask::process_masks(), IHistogram::reset(), SpecularSimulation::result(), and OffSpecSimulation::updateIntensityMap().

◆ scaleAll()

template<class T >

void OutputData< T >::scaleAll ( const T & factor )

multiply every item of this output data by value

Definition at line 487 of file OutputData.h.

 {
     if (!mp_ll_data)
         throw Exceptions::ClassInitializationException(
             "OutputData::scaleAll() -> Error! Low-level data object was not yet initialized.");
     mp_ll_data->scaleAll(factor);
 }

◆ setAxisSizes()

template<class T >

void OutputData< T >::setAxisSizes	(	size_t	rank,
		int *	n_dims
	)

Adds 'rank' axes with indicated sizes.

Definition at line 495 of file OutputData.h.

 {
     clear();
     std::string basename("axis");
     for (size_t i = 0; i < rank; ++i) {
         std::ostringstream name;
         name << basename << i;
         addAxis(name.str(), n_dims[i], 0.0, (double)(n_dims[i] - 1));
     }
 }

◆ setRawDataVector()

template<class T >

void OutputData< T >::setRawDataVector ( const std::vector< T > & data_vector )

inline

Sets new values to raw data vector.

Definition at line 559 of file OutputData.h.

 {
     if (data_vector.size() != getAllocatedSize())
         throw Exceptions::RuntimeErrorException(
             "OutputData<T>::setRawDataVector() -> Error! "
             "setRawDataVector can only be called with a data vector of the correct size.");
     for (size_t i = 0; i < getAllocatedSize(); ++i)
         (*mp_ll_data)[i] = data_vector[i];
 }

Referenced by ConvolutionDetectorResolution::apply1dConvolution(), IDetector::applyDetectorResolution(), OutputDataReadReflectometryStrategy::readOutputData(), and SpecularSimulation::result().

◆ setRawDataArray()

template<class T >

void OutputData< T >::setRawDataArray ( const T * source )

inline

Sets new values to raw data array.

Definition at line 569 of file OutputData.h.

 {
     for (size_t i = 0; i < getAllocatedSize(); ++i)
         (*mp_ll_data)[i] = source[i];
 }

◆ operator+=()

template<class T >

const OutputData< T > & OutputData< T >::operator+= ( const OutputData< T > & right )

addition-assignment operator for two output data

Definition at line 506 of file OutputData.h.

 {
     ASSERT(mp_ll_data);
     *this->mp_ll_data += *right.mp_ll_data;
     return *this;
 }

References ASSERT, and OutputData< T >::mp_ll_data.

◆ operator-=()

template<class T >

const OutputData< T > & OutputData< T >::operator-= ( const OutputData< T > & right )

substraction-assignment operator for two output data

Definition at line 513 of file OutputData.h.

 {
     ASSERT(mp_ll_data);
     *this->mp_ll_data -= *right.mp_ll_data;
     return *this;
 }

References ASSERT, and OutputData< T >::mp_ll_data.

◆ operator/=()

template<class T >

const OutputData< T > & OutputData< T >::operator/= ( const OutputData< T > & right )

division-assignment operator for two output data

Definition at line 538 of file OutputData.h.

 {
     ASSERT(mp_ll_data);
     *this->mp_ll_data /= *right.mp_ll_data;
     return *this;
 }

References ASSERT, and OutputData< T >::mp_ll_data.

◆ operator*=()

template<class T >

const OutputData< T > & OutputData< T >::operator*= ( const OutputData< T > & right )

multiplication-assignment operator for two output data

Definition at line 520 of file OutputData.h.

 {
     ASSERT(mp_ll_data);
     *this->mp_ll_data *= *right.mp_ll_data;
     return *this;
 }

References ASSERT, and OutputData< T >::mp_ll_data.

◆ getValue()

template<class T >

double OutputData< T >::getValue ( size_t index ) const

Returns value or summed value, depending on T.

◆ operator[]() [1/2]

template<class T >

T& OutputData< T >::operator[] ( size_t index )

inline

indexed accessor

Definition at line 195 of file OutputData.h.

     {
         ASSERT(mp_ll_data);
         return (*mp_ll_data)[index];
     }

References ASSERT, and OutputData< T >::mp_ll_data.

◆ operator[]() [2/2]

template<class T >

const T& OutputData< T >::operator[] ( size_t index ) const

inline

indexed accessor (const)

Definition at line 202 of file OutputData.h.

     {
         ASSERT(mp_ll_data);
         return (*mp_ll_data)[index];
     }

References ASSERT, and OutputData< T >::mp_ll_data.

◆ hasSameDimensions()

template<class T >

template<class U >

bool OutputData< T >::hasSameDimensions ( const OutputData< U > & right ) const

inline

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

Returns true if object have same dimensions.

Definition at line 578 of file OutputData.h.

 {
     if (!isInitialized())
         return false;
     if (!right.isInitialized())
         return false;
     if (getRank() != right.getRank())
         return false;
     for (size_t i_axis = 0; i_axis < getRank(); ++i_axis)
         if (getAxis(i_axis).size() != right.getAxis(i_axis).size())
             return false;
     return true;
 }

References OutputData< T >::getAxis(), OutputData< T >::getRank(), OutputData< T >::isInitialized(), and IAxis::size().

Referenced by IntensityDataFunctions::createRelativeDifferenceData(), IntensityDataFunctions::getRelativeDifference(), and IHistogram::hasSameDimensions().

Here is the call graph for this function:

◆ hasSameShape()

template<class T >

template<class U >

bool OutputData< T >::hasSameShape ( const OutputData< U > & right ) 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 595 of file OutputData.h.

 {
     if (!hasSameDimensions(right))
         return false;
  
     for (size_t i = 0; i < m_value_axes.size(); ++i)
         if (!HaveSameNameAndShape(getAxis(i), right.getAxis(i)))
             return false;
     return true;
 }

References OutputData< T >::getAxis(), and HaveSameNameAndShape().

Referenced by IHistogram::hasSameShape().

Here is the call graph for this function:

◆ getArray()

template<class T >

PyObject* OutputData< T >::getArray ( ) const

returns data as Python numpy array

◆ isInitialized()

template<class T >

bool OutputData< T >::isInitialized

returns true if object is correctly initialized

Definition at line 527 of file OutputData.h.

 {
     if (!mp_ll_data)
         return false;
     if (getRank() != mp_ll_data->getRank())
         return false;
     if (!getRank())
         return false;
     return true;
 }

Referenced by OutputData< T >::hasSameDimensions().

◆ allocate()

template<class T >

void OutputData< T >::allocate

memory allocation for current dimensions configuration

Definition at line 545 of file OutputData.h.

 {
     delete mp_ll_data;
     size_t rank = m_value_axes.size();
     int* dims = new int[rank];
     for (size_t i = 0; i < rank; ++i) {
         dims[i] = (int)getAxis(i).size();
     }
     mp_ll_data = new LLData<T>(rank, dims);
     T default_value = {};
     mp_ll_data->setAll(default_value);
     delete[] dims;
 }

Referenced by OutputData< T >::OutputData().

◆ getAxisIndex()

template<class T >

size_t OutputData< T >::getAxisIndex ( const std::string & axis_name ) const

private

returns serial number of axis with given name

Definition at line 612 of file OutputData.h.

 {
     for (size_t i = 0; i < m_value_axes.size(); ++i)
         if (m_value_axes[i]->getName() == axis_name)
             return i;
     throw Exceptions::LogicErrorException("OutputData<T>::getAxisIndex() -> "
                                           "Error! Axis with given name not found '"
                                           + axis_name + "'");
 }

◆ axisNameExists()

template<class T >

bool OutputData< T >::axisNameExists ( const std::string & axis_name ) const

private

checks if given axis name exists

Definition at line 622 of file OutputData.h.

 {
     for (size_t i = 0; i < m_value_axes.size(); ++i)
         if (m_value_axes[i]->getName() == axis_name)
             return true;
     return false;
 }

Friends And Related Function Documentation

◆ OutputDataIterator< T, OutputData< T > >

template<class T >

friend class OutputDataIterator< T, OutputData< T > >

friend

Definition at line 76 of file OutputData.h.

◆ OutputDataIterator< const T, const OutputData< T > >

template<class T >

friend class OutputDataIterator< const T, const OutputData< T > >

friend

Definition at line 76 of file OutputData.h.

Member Data Documentation

◆ m_value_axes

template<class T >

SafePointerVector<IAxis> OutputData< T >::m_value_axes

private

Definition at line 234 of file OutputData.h.

Referenced by OutputData< T >::clone(), OutputData< T >::copyFrom(), and OutputData< T >::getRank().

◆ mp_ll_data

template<class T >

LLData<T>* OutputData< T >::mp_ll_data

private

Definition at line 235 of file OutputData.h.

Referenced by OutputData< T >::clone(), OutputData< T >::copyFrom(), OutputData< T >::getAllocatedSize(), OutputData< T >::operator*=(), OutputData< T >::operator+=(), OutputData< T >::operator-=(), OutputData< T >::operator/=(), and OutputData< T >::operator[]().

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

/home/www/ba/Device/Data/OutputData.h

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

template<class T> class OutputData< T >

Member Typedef Documentation

◆ value_type

◆ iterator

◆ const_iterator

Constructor & Destructor Documentation

◆ OutputData() [1/2]

◆ OutputData() [2/2]

◆ ~OutputData()

Member Function Documentation

◆ operator=()

◆ clone()

◆ copyFrom()

◆ copyShapeFrom()

◆ meanValues()

◆ addAxis() [1/2]

◆ addAxis() [2/2]

◆ getAxis() [1/2]

◆ getAxis() [2/2]

◆ getRank()

◆ getAllocatedSize()

◆ getAllSizes()

◆ getRawDataVector()

◆ totalSum()

◆ begin() [1/2]

◆ begin() [2/2]

◆ end() [1/2]

◆ end() [2/2]

◆ getAxesBinIndices()

◆ getAxisBinIndex() [1/2]

◆ getAxisBinIndex() [2/2]

◆ toGlobalIndex()

◆ findGlobalIndex()

◆ getAxisValue() [1/2]

◆ getAxisValue() [2/2]

◆ getAxesValues()

◆ getAxisBin() [1/2]

◆ getAxisBin() [2/2]

◆ clear()

◆ setAllTo()

◆ scaleAll()

◆ setAxisSizes()

◆ setRawDataVector()

◆ setRawDataArray()

◆ operator+=()

◆ operator-=()

◆ operator/=()

◆ operator*=()

◆ getValue()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ hasSameDimensions()

◆ hasSameShape()

◆ getArray()

◆ isInitialized()

◆ allocate()

◆ getAxisIndex()

◆ axisNameExists()

Friends And Related Function Documentation

◆ OutputDataIterator< T, OutputData< T > >

◆ OutputDataIterator< const T, const OutputData< T > >

Member Data Documentation

◆ m_value_axes

◆ mp_ll_data

template<class T>
class OutputData< T >