FootprintGauss.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Device/Beam/FootprintGauss.h
//! @brief     Defines class FootprintGauss.
//!
//! @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_DEVICE_BEAM_FOOTPRINTGAUSS_H
#define BORNAGAIN_DEVICE_BEAM_FOOTPRINTGAUSS_H
 
#include "Device/Beam/IFootprintFactor.h"
 
//! Gaussian beam footprint.
//!
//! Beam width is the full width at half maximum.
//! @ingroup beam
 
class FootprintGauss : public IFootprintFactor {
public:
    FootprintGauss(std::vector<double> P);
    FootprintGauss(double width_ratio);
 
    FootprintGauss* clone() const override;
    std::string className() const final { return "FootprintGauss"; }
    // const auto tooltip = "class_tooltip";
    std::vector<ParaMeta> parDefs() const final
    {
        return {{"BeamToSampleWidthRatio", "", "ratio of beam width to sample width", 0, INF, 1.}};
    }
 
    //! Calculate footprint correction coefficient from the beam incident angle _alpha_.
    double calculate(double alpha) const override;
 
    std::string name() const override { return "FootprintGauss"; }
};
 
#endif // BORNAGAIN_DEVICE_BEAM_FOOTPRINTGAUSS_H