FrameUtil.cpp

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Base/Axis/FrameUtil.cpp
//! @brief     Implements namespace DataUtils.
//!
//! @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)
//
//  ************************************************************************************************
 
#include "Base/Axis/FrameUtil.h"
#include "Base/Axis/Bin.h"
#include "Base/Axis/Frame.h"
#include "Base/Axis/IAxis.h"
 
// For axis FixedBinAxis("axis", 8, -5.0, 3.0) the coordinate x=-4.5 (center of bin #0) will
// be converted into 0.5 (which is a bin center expressed in bin fraction coordinates).
// The coordinate -5.0 (outside of axis definition) will be converted to -0.5
// (center of non-existing bin #-1).
// Used for Mask conversion.
 
double FramUtil::coordinateToBinf(double coordinate, const IAxis& axis)
{
    size_t index = axis.findClosestIndex(coordinate);
    Bin1D bin = axis.bin(index);
    double f = (coordinate - bin.m_lower) / bin.binSize();
    return static_cast<double>(index) + f;
}
 
double FramUtil::coordinateFromBinf(double value, const IAxis& axis)
{
    int index = static_cast<int>(value);
 
    double result(0);
    if (index < 0) {
        Bin1D bin = axis.bin(0);
        result = bin.m_lower + value * bin.binSize();
    } else if (index >= static_cast<int>(axis.size())) {
        Bin1D bin = axis.bin(axis.size() - 1);
        result = bin.m_upper + (value - axis.size()) * bin.binSize();
    } else {
        Bin1D bin = axis.bin(static_cast<size_t>(index));
        result = bin.m_lower + (value - static_cast<double>(index)) * bin.binSize();
    }
 
    return result;
}
 
void FramUtil::coordinatesToBinf(double& x, double& y, const Frame& data)
{
    x = coordinateToBinf(x, data.xAxis());
    y = coordinateToBinf(y, data.yAxis());
}
 
void FramUtil::coordinatesFromBinf(double& x, double& y, const Frame& data)
{
    x = coordinateFromBinf(x, data.xAxis());
    y = coordinateFromBinf(y, data.yAxis());
}