OffSpecularSimulation.cpp

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Core/Simulation/OffSpecularSimulation.cpp
//! @brief     Implements class OffSpecularSimulation.
//!
//! @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 "Core/Simulation/OffSpecularSimulation.h"
#include "Device/Detector/SimpleUnitConverters.h"
#include "Param/Base/ParameterPool.h"
#include "Param/Base/RealParameter.h"
#include "Param/Distrib/Distributions.h"
#include "Sample/SampleBuilderEngine/ISampleBuilder.h"
 
OffSpecularSimulation::OffSpecularSimulation(const Beam& beam, const MultiLayer& sample,
                                             const IDetector& detector)
    : ISimulation2D(beam, sample, detector)
{
}
 
OffSpecularSimulation::OffSpecularSimulation()
{
    initialize();
}
 
void OffSpecularSimulation::prepareSimulation()
{
    checkInitialization();
    ISimulation2D::prepareSimulation();
}
 
size_t OffSpecularSimulation::numberOfSimulationElements() const
{
    checkInitialization();
    return ISimulation2D::numberOfSimulationElements() * m_alpha_i_axis->size();
}
 
SimulationResult OffSpecularSimulation::result() const
{
    auto data = std::unique_ptr<OutputData<double>>(m_intensity_map.clone());
    OffSpecularConverter converter(detector2D(), beam(), *m_alpha_i_axis);
    return SimulationResult(*data, converter);
}
 
void OffSpecularSimulation::setBeamParameters(double wavelength, const IAxis& alpha_axis,
                                              double phi_i)
{
    m_alpha_i_axis.reset(alpha_axis.clone());
    if (alpha_axis.size() < 1)
        throw std::runtime_error("OffSpecularSimulation::prepareSimulation() "
                                 "-> Error. Incoming alpha range size < 1.");
    const double alpha_zero = alpha_axis.lowerBound();
    instrument().setBeamParameters(wavelength, alpha_zero, phi_i);
    updateIntensityMap();
}
 
const IAxis* OffSpecularSimulation::beamAxis() const
{
    return m_alpha_i_axis.get();
}
 
std::unique_ptr<IUnitConverter> OffSpecularSimulation::createUnitConverter() const
{
    const IAxis* axis = beamAxis();
    if (!axis)
        throw std::runtime_error("Error in OffSpecularSimulation::createUnitConverter:"
                                 " missing inclination angle axis");
    return std::make_unique<OffSpecularConverter>(detector2D(), beam(), *axis);
}
 
size_t OffSpecularSimulation::intensityMapSize() const
{
    checkInitialization();
    return m_alpha_i_axis->size() * detector().axis(1).size();
}
 
OffSpecularSimulation::OffSpecularSimulation(const OffSpecularSimulation& other)
    : ISimulation2D(other)
{
    if (other.m_alpha_i_axis)
        m_alpha_i_axis.reset(other.m_alpha_i_axis->clone());
    m_intensity_map.copyFrom(other.m_intensity_map);
    initialize();
}
 
void OffSpecularSimulation::initSimulationElementVector()
{
    m_sim_elements.clear();
    Beam beam2 = beam();
    for (size_t i = 0; i < m_alpha_i_axis->size(); ++i) {
        beam2.setInclination(m_alpha_i_axis->bin(i).center());
        std::vector<SimulationElement> sim_elements_i = generateSimulationElements(beam2);
        for (auto ele : sim_elements_i)
            m_sim_elements.emplace_back(ele);
    }
    if (m_cache.empty())
        m_cache.resize(m_sim_elements.size(), 0.0);
}
 
void OffSpecularSimulation::validateParametrization(const ParameterDistribution& par_distr) const
{
    const bool zero_mean = par_distr.getDistribution()->getMean() == 0.0;
    if (zero_mean)
        return;
 
    std::unique_ptr<ParameterPool> parameter_pool(createParameterTree());
    const std::vector<RealParameter*> names =
        parameter_pool->getMatchedParameters(par_distr.getMainParameterName());
    for (const auto par : names)
        if (par->getName().find("InclinationAngle") != std::string::npos && !zero_mean)
            throw std::runtime_error("Error in OffSpecularSimulation: parameter distribution of "
                                     "beam inclination angle should have zero mean.");
}
 
void OffSpecularSimulation::transferResultsToIntensityMap()
{
    checkInitialization();
    const IAxis& phi_axis = detector().axis(0);
    size_t phi_f_size = phi_axis.size();
    if (phi_f_size * m_intensity_map.getAllocatedSize() != m_sim_elements.size())
        throw std::runtime_error(
            "OffSpecularSimulation::transferResultsToIntensityMap: "
            "intensity map size does not conform to number of calculated intensities");
    for (size_t i = 0; i < m_alpha_i_axis->size(); ++i)
        transferDetectorImage(i);
}
 
void OffSpecularSimulation::updateIntensityMap()
{
    m_intensity_map.clear();
    if (m_alpha_i_axis)
        m_intensity_map.addAxis(*m_alpha_i_axis);
    size_t detector_dimension = detector().dimension();
    if (detector_dimension == 2)
        m_intensity_map.addAxis(detector().axis(1));
    m_intensity_map.setAllTo(0.);
}
 
void OffSpecularSimulation::transferDetectorImage(size_t index)
{
    OutputData<double> detector_image;
    size_t detector_dimension = detector().dimension();
    for (size_t dim = 0; dim < detector_dimension; ++dim)
        detector_image.addAxis(detector().axis(dim));
    size_t detector_size = detector_image.getAllocatedSize();
    for (size_t i = 0; i < detector_size; ++i)
        detector_image[i] = m_sim_elements[index * detector_size + i].intensity();
    detector().applyDetectorResolution(&detector_image);
    size_t y_axis_size = detector().axis(1).size();
    for (size_t i = 0; i < detector_size; ++i)
        m_intensity_map[index * y_axis_size + i % y_axis_size] += detector_image[i];
}
 
void OffSpecularSimulation::checkInitialization() const
{
    if (!m_alpha_i_axis || m_alpha_i_axis->size() < 1)
        throw std::runtime_error("OffSpecularSimulation::checkInitialization() "
                                 "Incoming alpha range not configured.");
    if (detector().dimension() != 2)
        throw std::runtime_error(
            "OffSpecularSimulation::checkInitialization: detector is not two-dimensional");
}
 
void OffSpecularSimulation::initialize()
{
    setName("OffSpecularSimulation");
}