FootprintGauss.h

Go to the documentation of this file.

// ************************************************************************** //
//
//  BornAgain: simulate and fit scattering at grazing incidence
//
//! @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_CORE_BEAM_FOOTPRINTGAUSS_H
#define BORNAGAIN_CORE_BEAM_FOOTPRINTGAUSS_H
 
#include "Device/Beam/IFootprintFactor.h"
 
//! Calculates footprint coefficient for a gaussian beam
//! Beam width is interpreted as the full width on the level
//! of \f[ \exp{-1/2} \f] from the peak intensity.
//! @ingroup beam
 
class FootprintGauss : public IFootprintFactor
{
public:
    FootprintGauss(const std::vector<double> P);
    FootprintGauss(double width_ratio);
 
    void accept(INodeVisitor* visitor) const override { visitor->visit(this); }
 
    FootprintGauss* clone() const override;
 
    //! Calculate footprint correction coefficient from the beam incident angle _alpha_.
    double calculate(double alpha) const override;
 
    //! Print python-formatted footprint definition
    std::string print() const override;
};
 
#endif // BORNAGAIN_CORE_BEAM_FOOTPRINTGAUSS_H