ProfileHelper.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Sample/Processed/ProfileHelper.h
//! @brief     Defines class ProfileHelper.
//!
//! @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)
//
//  ************************************************************************************************
 
#ifdef SWIG
#error no need to expose this header to Swig
#endif
 
#ifndef USER_API
#ifndef BORNAGAIN_SAMPLE_PROCESSED_PROFILEHELPER_H
#define BORNAGAIN_SAMPLE_PROCESSED_PROFILEHELPER_H
 
#include "Sample/Material/Material.h"
#include <utility>
#include <vector>
 
class ProcessedSample;
 
//! Object that can generate the material profile of a sample as a function of depth.
//!
//! The generated profile contains the complex SLD for SLD materials and the parameters
//! delta and beta for refractive index materials
//!
//! @ingroup algorithms_internal
 
class ProfileHelper {
public:
    ProfileHelper(const ProcessedSample& sample);
    ~ProfileHelper();
 
    std::vector<complex_t> calculateProfile(const std::vector<double>& z_values) const;
    std::pair<double, double> defaultLimits() const;
 
private:
    std::vector<complex_t> m_materialdata;
    std::vector<double> m_zlimits;
    std::vector<double> m_sigmas;
};
 
#endif // BORNAGAIN_SAMPLE_PROCESSED_PROFILEHELPER_H
#endif // USER_API