IntensityDataFunctions.h

Go to the documentation of this file.

// ************************************************************************** //
//
//  BornAgain: simulate and fit scattering at grazing incidence
//
//! @file      Device/Instrument/IntensityDataFunctions.h
//! @brief     Defines class IntensityDataFunctions.
//!
//! @homepage  http://www.bornagainproject.org
//! @license   GNU General Public License v3 or higher (see COPYING)
//! @copyright Forschungszentrum Jülich GmbH 2018
//! @authors   Scientific Computing Group at MLZ (see CITATION, AUTHORS)
//
// ************************************************************************** //
 
#ifndef BORNAGAIN_CORE_INTENSITY_INTENSITYDATAFUNCTIONS_H
#define BORNAGAIN_CORE_INTENSITY_INTENSITYDATAFUNCTIONS_H
 
#include "Device/Data/OutputData.h"
#include <memory>
 
class IHistogram;
class SimulationResult;
class Simulation;
 
//! Functions to work with intensity data.
//! @ingroup tools
 
namespace IntensityDataFunctions
{
//! Returns sum of relative differences between each pair of elements:
//! (a, b) -> 2*abs(a - b)/(a + b)      ( and zero if  a-b=0 )
double RelativeDifference(const SimulationResult& dat, const SimulationResult& ref);
 
//! Returns relative difference between two data sets sum(dat[i] - ref[i])/ref[i]).
double getRelativeDifference(const OutputData<double>& dat, const OutputData<double>& ref);
 
//! Returns true is relative difference is below threshold; prints informative output
bool checkRelativeDifference(const OutputData<double>& dat, const OutputData<double>& ref,
                             const double threshold);
 
double getRelativeDifference(const IHistogram& dat, const IHistogram& ref);
 
//! Transforms coordinate on axis into the bin-fraction-coordinate.
double coordinateToBinf(double coordinate, const IAxis& axis);
 
//! Transforms bin-fraction-coordinate into axis coordinate.
double coordinateFromBinf(double value, const IAxis& axis);
 
//! Transforms x,y coordinate from OutputData axes coordinates to bin-fraction-coordinates.
void coordinateToBinf(double& x, double& y, const OutputData<double>& data);
 
//! Transforms x,y coordinate from bin-fraction-coordinates to OutputData's axes coordinates.
void coordinateFromBinf(double& x, double& y, const OutputData<double>& data);
 
//! Creates a vector of vectors of double (2D Array) from OutputData.
std::vector<std::vector<double>> create2DArrayfromOutputData(const OutputData<double>& data);
 
//! Creates a Fourier Transform of a 2D Array (vector of vectors).
std::vector<std::vector<double>> FT2DArray(const std::vector<std::vector<double>>& signal);
 
#ifndef SWIG
 
std::unique_ptr<OutputData<double>>
createRelativeDifferenceData(const OutputData<double>& data, const OutputData<double>& reference);
 
//! Returns new object with input data rotated by
//! n*90 deg counterclockwise (n > 0) or clockwise (n < 0)
//! Axes are swapped if the data is effectively rotated by 90 or 270 degrees
//! Applicable to 2D arrays only
std::unique_ptr<OutputData<double>> createRearrangedDataSet(const OutputData<double>& data, int n);
 
//! Returns new IntensityData objects which axes clipped to represent the specified rectangle.
std::unique_ptr<OutputData<double>>
createClippedDataSet(const OutputData<double>& origin, double x1, double y1, double x2, double y2);
 
//! Creates OutputData from a 2D Array.
std::unique_ptr<OutputData<double>>
createOutputDatafrom2DArray(const std::vector<std::vector<double>>& array_2d);
 
//! Creates Fourier Transform (OutputData format) of intensity map (OutputData format).
std::unique_ptr<OutputData<double>> createFFT(const OutputData<double>& data);
 
#endif // SWIG
 
}; // namespace IntensityDataFunctions
 
#endif // BORNAGAIN_CORE_INTENSITY_INTENSITYDATAFUNCTIONS_H