File: ConstantBackground.h

package info (click to toggle)
bornagain 23.0-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 103,936 kB
  • sloc: cpp: 423,131; python: 40,997; javascript: 11,167; awk: 630; sh: 318; ruby: 173; xml: 130; makefile: 51; ansic: 24
file content (45 lines) | stat: -rw-r--r-- 1,499 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Sim/Background/ConstantBackground.h
//! @brief     Defines class ConstantBackground.
//!
//! @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_SIM_BACKGROUND_CONSTANTBACKGROUND_H
#define BORNAGAIN_SIM_BACKGROUND_CONSTANTBACKGROUND_H

#include "Sim/Background/IBackground.h"

//! Constant background, to be added to simulated scattering.
//!

class ConstantBackground : public IBackground {
public:
    ConstantBackground(std::vector<double> P);
    ConstantBackground(double background_value);

#ifndef SWIG
    ConstantBackground* clone() const override;
#endif // SWIG

    std::string className() const final { return "ConstantBackground"; }
    std::vector<ParaMeta> parDefs() const final { return {{"BackgroundValue", ""}}; }

    double backgroundValue() const { return m_background_value; }

    double addBackground(double intensity) const override;

    std::string validate() const override;

private:
    const double& m_background_value;
};

#endif // BORNAGAIN_SIM_BACKGROUND_CONSTANTBACKGROUND_H