BornAgain  1.19.0
Simulate and fit neutron and x-ray scattering at grazing incidence
AxisNames.h
Go to the documentation of this file.
1 // ************************************************************************************************
2 //
3 // BornAgain: simulate and fit reflection and scattering
4 //
5 //! @file Device/Unit/AxisNames.h
6 //! @brief Defines namespace AxisNames.
7 //!
8 //! @homepage http://www.bornagainproject.org
9 //! @license GNU General Public License v3 or higher (see COPYING)
10 //! @copyright Forschungszentrum Jülich GmbH 2018
11 //! @authors Scientific Computing Group at MLZ (see CITATION, AUTHORS)
12 //
13 // ************************************************************************************************
14 
15 #ifdef SWIG
16 #error no need to expose this header to Swig
17 #endif
18 
19 #ifndef USER_API
20 #ifndef BORNAGAIN_DEVICE_UNIT_AXISNAMES_H
21 #define BORNAGAIN_DEVICE_UNIT_AXISNAMES_H
22 
24 #include <map>
25 
26 //! Contains functions to create maps that give the right axis names for different
27 //! detector types and units
28 //! @ingroup detector
29 
30 namespace AxisNames {
31 std::map<Axes::Units, std::string> InitSphericalAxis0();
32 std::map<Axes::Units, std::string> InitSphericalAxis1();
33 std::map<Axes::Units, std::string> InitRectangularAxis0();
34 std::map<Axes::Units, std::string> InitRectangularAxis1();
35 std::map<Axes::Units, std::string> InitOffSpecularAxis0();
36 std::map<Axes::Units, std::string> InitOffSpecularAxis1();
37 std::map<Axes::Units, std::string> InitSpecAxis();
38 std::map<Axes::Units, std::string> InitSpecAxisQ();
39 std::map<Axes::Units, std::string> InitSampleDepthAxis();
40 } // namespace AxisNames
41 
42 #endif // BORNAGAIN_DEVICE_UNIT_AXISNAMES_H
43 #endif // USER_API
Defines interface IUnitConverter and possible axis units.
Contains functions to create maps that give the right axis names for different detector types and uni...
Definition: AxisNames.cpp:18
std::map< Axes::Units, std::string > InitOffSpecularAxis1()
Definition: AxisNames.cpp:73
std::map< Axes::Units, std::string > InitRectangularAxis0()
Definition: AxisNames.cpp:41
std::map< Axes::Units, std::string > InitSpecAxisQ()
Definition: AxisNames.cpp:93
std::map< Axes::Units, std::string > InitRectangularAxis1()
Definition: AxisNames.cpp:52
std::map< Axes::Units, std::string > InitSphericalAxis0()
Definition: AxisNames.cpp:20
std::map< Axes::Units, std::string > InitSphericalAxis1()
Definition: AxisNames.cpp:30
std::map< Axes::Units, std::string > InitSpecAxis()
Definition: AxisNames.cpp:82
std::map< Axes::Units, std::string > InitOffSpecularAxis0()
Definition: AxisNames.cpp:65
std::map< Axes::Units, std::string > InitSampleDepthAxis()
Definition: AxisNames.cpp:108