BornAgain  1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
Public Types | Public Member Functions | Protected Attributes | List of all members
SimulationFactory Class Reference
Standard_samples
Inheritance diagram for SimulationFactory:
Collaboration diagram for SimulationFactory:

Public Types

typedef std::function< Simulation *()> CreateItemCallback
 
typedef std::map< std::string, CreateItemCallback > CallbackMap_t
 

Public Member Functions

 SimulationFactory ()
 
Simulation * createItem (const std::string &item_key) const
 
std::unique_ptr< Simulation > createItemPtr (const std::string &item_key) const
 
bool registerItem (const std::string &item_key, CreateItemCallback CreateFn)
 
bool contains (const std::string &item_key) const
 
size_t size () const
 

Protected Attributes

CallbackMap_t m_callbacks
 

Detailed Description

Registry to create standard pre-defined simulations.

Used in functional tests, performance measurements, etc.

Definition at line 26 of file SimulationFactory.h.

Member Typedef Documentation

◆ CreateItemCallback

typedef std::function<Simulation *()> IFactory< std::string , Simulation >::CreateItemCallback
inherited

function which will be used to create object of AbstractProduct base type

Definition at line 32 of file IFactory.h.

◆ CallbackMap_t

typedef std::map<std::string , CreateItemCallback> IFactory< std::string , Simulation >::CallbackMap_t
inherited

map for correspondance between object identifier and object creation function

Definition at line 35 of file IFactory.h.

Constructor & Destructor Documentation

◆ SimulationFactory()

SimulationFactory::SimulationFactory ( )

Definition at line 22 of file SimulationFactory.cpp.

23 {
24  registerItem("BasicGISAS", StandardSimulations::BasicGISAS);
25 
26  registerItem("BasicGISAS00", StandardSimulations::BasicGISAS00);
27 
28  registerItem("BasicPolarizedGISAS", StandardSimulations::BasicPolarizedGISAS);
29 
30  registerItem("MiniGISAS", StandardSimulations::MiniGISAS);
31 
32  registerItem("MiniGISAS_v2", StandardSimulations::MiniGISAS_v2);
33 
34  registerItem("MiniGISASBeamDivergence", StandardSimulations::MiniGISASBeamDivergence);
35 
36  registerItem("MiniGISASDetectorResolution", StandardSimulations::MiniGISASDetectorResolution);
37 
38  registerItem("MiniGISASSpecular", StandardSimulations::MiniGISASSpecularPeak);
39 
40  registerItem("GISASWithMasks", StandardSimulations::GISASWithMasks);
41 
42  registerItem("MaxiGISAS", StandardSimulations::MaxiGISAS);
43 
44  registerItem("MaxiGISAS00", StandardSimulations::MaxiGISAS00);
45 
46  registerItem("IsGISAXSSimulation1", StandardSimulations::IsGISAXSSimulation1);
47 
48  registerItem("IsGISAXSSimulation2", StandardSimulations::IsGISAXSSimulation2);
49 
50  // polarization
51 
52  registerItem("MiniGISASPolarizationPP", StandardSimulations::MiniGISASPolarizationPP);
53 
54  registerItem("MiniGISASPolarizationPM", StandardSimulations::MiniGISASPolarizationPM);
55 
56  registerItem("MiniGISASPolarizationMP", StandardSimulations::MiniGISASPolarizationMP);
57 
58  registerItem("MiniGISASPolarizationMM", StandardSimulations::MiniGISASPolarizationMM);
59 
60  // rectangular detectors
61 
62  registerItem("RectDetectorGeneric", StandardSimulations::RectDetectorGeneric);
63 
64  registerItem("RectDetectorPerpToSample", StandardSimulations::RectDetectorPerpToSample);
65 
66  registerItem("RectDetectorPerpToDirectBeam", StandardSimulations::RectDetectorPerpToDirectBeam);
67 
68  registerItem("RectDetectorPerpToReflectedBeam",
69  StandardSimulations::RectDetectorPerpToReflectedBeam);
70 
71  registerItem("RectDetectorPerpToReflectedBeamDpos",
72  StandardSimulations::RectDetectorPerpToReflectedBeamDpos);
73 
74  registerItem("ExtraLongWavelengthGISAS", StandardSimulations::ExtraLongWavelengthGISAS);
75 
76  // Monte-Carlo
77  registerItem("MiniGISASMonteCarlo", StandardSimulations::MiniGISASMonteCarlo);
78 
79  // region of interest
80 
81  registerItem("SphericalDetWithRoi", StandardSimulations::SphericalDetWithRoi);
82  registerItem("RectDetWithRoi", StandardSimulations::RectDetWithRoi);
83 
84  // background
85 
86  registerItem("ConstantBackground", StandardSimulations::ConstantBackgroundGISAS);
87 
88  // specular simulations
89 
90  registerItem("BasicSpecular", StandardSimulations::BasicSpecular);
91 
92  registerItem("BasicSpecularQ", StandardSimulations::BasicSpecularQ);
93 
94  registerItem("SpecularWithGaussianBeam", StandardSimulations::SpecularWithGaussianBeam);
95 
96  registerItem("SpecularWithSquareBeam", StandardSimulations::SpecularWithSquareBeam);
97 
98  registerItem("SpecularDivergentBeam", StandardSimulations::SpecularDivergentBeam);
99 
100  registerItem("TOFRWithRelativeResolution", StandardSimulations::TOFRWithRelativeResolution);
101 
102  registerItem("TOFRWithPointwiseResolution", StandardSimulations::TOFRWithPointwiseResolution);
103 
104  registerItem("OffSpecMini", StandardSimulations::MiniOffSpec);
105 
106  // polarized specular
107 
108  registerItem("BasicSpecularPP", StandardSimulations::BasicSpecularPP);
109 
110  registerItem("BasicSpecularMM", StandardSimulations::BasicSpecularMM);
111 
112  registerItem("BasicSpecularPM", StandardSimulations::BasicSpecularPM);
113 
114  registerItem("BasicSpecularMP", StandardSimulations::BasicSpecularMP);
115 
116  registerItem("BasicQSpecularPP", StandardSimulations::BasicSpecularQPP);
117 
118  registerItem("BasicQSpecularMM", StandardSimulations::BasicSpecularQMM);
119 
120  registerItem("BasicQSpecularPM", StandardSimulations::BasicSpecularQPM);
121 
122  registerItem("BasicQSpecularMP", StandardSimulations::BasicSpecularQMP);
123 
124  // depth probe simulations
125 
126  registerItem("BasicDepthProbe", StandardSimulations::BasicDepthProbe);
127 
128  registerItem("MiniGISASFit", StandardSimulations::MiniGISASFit);
129 }
IFactory< std::string, Simulation >::registerItem
bool registerItem(const std::string &item_key, CreateItemCallback CreateFn)
Registers object's creation function.
Definition: IFactory.h:53
StandardSimulations::BasicSpecularQPP
SpecularSimulation * BasicSpecularQPP()
Definition: StandardSimulations.cpp:563
StandardSimulations::RectDetectorPerpToReflectedBeam
GISASSimulation * RectDetectorPerpToReflectedBeam()
GISAS simulation with the rectangular detector perpendicular to the reflected beam.
Definition: StandardSimulations.cpp:322
StandardSimulations::BasicGISAS00
GISASSimulation * BasicGISAS00()
Basic GISAS for polarization studies.
Definition: StandardSimulations.cpp:60
StandardSimulations::RectDetectorPerpToDirectBeam
GISASSimulation * RectDetectorPerpToDirectBeam()
GISAS simulation with the rectangular detector perpendicular to the direct beam.
Definition: StandardSimulations.cpp:308
StandardSimulations::BasicSpecularMP
SpecularSimulation * BasicSpecularMP()
Definition: StandardSimulations.cpp:547
StandardSimulations::BasicGISAS
GISASSimulation * BasicGISAS()
Basic GISAS simulation with the detector phi[0,2], theta[0,2].
Definition: StandardSimulations.cpp:49
StandardSimulations::MiniGISASBeamDivergence
GISASSimulation * MiniGISASBeamDivergence()
GISAS simulation with beam divergence applied.
Definition: StandardSimulations.cpp:104
StandardSimulations::SpecularWithSquareBeam
SpecularSimulation * SpecularWithSquareBeam()
Definition: StandardSimulations.cpp:458
StandardSimulations::GISASWithMasks
GISASSimulation * GISASWithMasks()
GISAS simulation with multiple masks on the detector plane.
Definition: StandardSimulations.cpp:127
StandardSimulations::MiniGISAS
GISASSimulation * MiniGISAS()
GISAS simulation with small detector and phi[-2,2], theta[0,2].
Definition: StandardSimulations.cpp:82
StandardSimulations::BasicSpecularPM
SpecularSimulation * BasicSpecularPM()
Definition: StandardSimulations.cpp:539
StandardSimulations::IsGISAXSSimulation1
GISASSimulation * IsGISAXSSimulation1()
Typical IsGISAXS simulation with the detector phi[-1,1], theta[0,2].
Definition: StandardSimulations.cpp:253
StandardSimulations::MiniOffSpec
OffSpecSimulation * MiniOffSpec()
Definition: StandardSimulations.cpp:598
StandardSimulations::ExtraLongWavelengthGISAS
GISASSimulation * ExtraLongWavelengthGISAS()
GISAS simulation with an extra long wavelength.
Definition: StandardSimulations.cpp:394
StandardSimulations::RectDetectorPerpToSample
GISASSimulation * RectDetectorPerpToSample()
GISAS simulation with the rectangular detector perpendicular to the sample.
Definition: StandardSimulations.cpp:294
StandardSimulations::SphericalDetWithRoi
GISASSimulation * SphericalDetWithRoi()
GISAS simulation with spherical detector, region of interest and mask.
Definition: StandardSimulations.cpp:361
StandardSimulations::MiniGISASPolarizationPM
GISASSimulation * MiniGISASPolarizationPM()
Definition: StandardSimulations.cpp:181
StandardSimulations::TOFRWithRelativeResolution
SpecularSimulation * TOFRWithRelativeResolution()
Definition: StandardSimulations.cpp:500
StandardSimulations::MiniGISASDetectorResolution
GISASSimulation * MiniGISASDetectorResolution()
GISAS simulation with detector resolution.
Definition: StandardSimulations.cpp:161
StandardSimulations::BasicSpecularQMP
SpecularSimulation * BasicSpecularQMP()
Definition: StandardSimulations.cpp:587
StandardSimulations::MiniGISASMonteCarlo
GISASSimulation * MiniGISASMonteCarlo()
GISAS simulation with Monte-Carlo integration switched ON.
Definition: StandardSimulations.cpp:352
StandardSimulations::SpecularWithGaussianBeam
SpecularSimulation * SpecularWithGaussianBeam()
Definition: StandardSimulations.cpp:443
StandardSimulations::MiniGISASPolarizationMM
GISASSimulation * MiniGISASPolarizationMM()
Definition: StandardSimulations.cpp:205
StandardSimulations::MiniGISASPolarizationMP
GISASSimulation * MiniGISASPolarizationMP()
Definition: StandardSimulations.cpp:193
StandardSimulations::BasicDepthProbe
DepthProbeSimulation * BasicDepthProbe()
Definition: StandardSimulations.cpp:624
StandardSimulations::IsGISAXSSimulation2
GISASSimulation * IsGISAXSSimulation2()
Typical IsGISAXS simulation with the detector phi[0,2], theta[0,2].
Definition: StandardSimulations.cpp:266
StandardSimulations::ConstantBackgroundGISAS
GISASSimulation * ConstantBackgroundGISAS()
Definition: StandardSimulations.cpp:384
StandardSimulations::BasicSpecularQPM
SpecularSimulation * BasicSpecularQPM()
Definition: StandardSimulations.cpp:579
StandardSimulations::RectDetectorGeneric
GISASSimulation * RectDetectorGeneric()
GISAS simulation with generic rectangular detector.
Definition: StandardSimulations.cpp:279
StandardSimulations::BasicSpecularMM
SpecularSimulation * BasicSpecularMM()
Definition: StandardSimulations.cpp:555
StandardSimulations::MiniGISASPolarizationPP
GISASSimulation * MiniGISASPolarizationPP()
Definition: StandardSimulations.cpp:169
StandardSimulations::BasicSpecularPP
SpecularSimulation * BasicSpecularPP()
Definition: StandardSimulations.cpp:531
StandardSimulations::BasicSpecularQ
SpecularSimulation * BasicSpecularQ()
Definition: StandardSimulations.cpp:420
StandardSimulations::MaxiGISAS
GISASSimulation * MaxiGISAS()
GISAS simulation with large detector to test performance.
Definition: StandardSimulations.cpp:231
StandardSimulations::MiniGISAS_v2
GISASSimulation * MiniGISAS_v2()
GISAS simulation with small detector and phi[-1,1], theta[0,1].
Definition: StandardSimulations.cpp:93
StandardSimulations::RectDetectorPerpToReflectedBeamDpos
GISASSimulation * RectDetectorPerpToReflectedBeamDpos()
GISAS simulation with the rectangular detector perpendicular to the reflected beam when the coordinat...
Definition: StandardSimulations.cpp:337
StandardSimulations::TOFRWithPointwiseResolution
SpecularSimulation * TOFRWithPointwiseResolution()
Definition: StandardSimulations.cpp:512
StandardSimulations::MiniGISASSpecularPeak
GISASSimulation * MiniGISASSpecularPeak()
GISAS simulation with small detector and including specular peak.
Definition: StandardSimulations.cpp:219
StandardSimulations::RectDetWithRoi
GISASSimulation * RectDetWithRoi()
GISAS simulation with rectangular detector, region of interest and mask.
Definition: StandardSimulations.cpp:376
StandardSimulations::MiniGISASFit
GISASSimulation * MiniGISASFit()
Simulation with fitting.
Definition: StandardSimulations.cpp:644
StandardSimulations::BasicPolarizedGISAS
GISASSimulation * BasicPolarizedGISAS()
Basic GISAS simulation for spin flip channel.
Definition: StandardSimulations.cpp:71
StandardSimulations::SpecularDivergentBeam
SpecularSimulation * SpecularDivergentBeam()
Definition: StandardSimulations.cpp:473
StandardSimulations::BasicSpecularQMM
SpecularSimulation * BasicSpecularQMM()
Definition: StandardSimulations.cpp:571
StandardSimulations::MaxiGISAS00
GISASSimulation * MaxiGISAS00()
Basic GISAS for polarization studies.
Definition: StandardSimulations.cpp:242
StandardSimulations::BasicSpecular
SpecularSimulation * BasicSpecular()
Definition: StandardSimulations.cpp:406

References StandardSimulations::BasicDepthProbe(), StandardSimulations::BasicGISAS(), StandardSimulations::BasicGISAS00(), StandardSimulations::BasicPolarizedGISAS(), StandardSimulations::BasicSpecular(), StandardSimulations::BasicSpecularMM(), StandardSimulations::BasicSpecularMP(), StandardSimulations::BasicSpecularPM(), StandardSimulations::BasicSpecularPP(), StandardSimulations::BasicSpecularQ(), StandardSimulations::BasicSpecularQMM(), StandardSimulations::BasicSpecularQMP(), StandardSimulations::BasicSpecularQPM(), StandardSimulations::BasicSpecularQPP(), StandardSimulations::ConstantBackgroundGISAS(), StandardSimulations::ExtraLongWavelengthGISAS(), StandardSimulations::GISASWithMasks(), StandardSimulations::IsGISAXSSimulation1(), StandardSimulations::IsGISAXSSimulation2(), StandardSimulations::MaxiGISAS(), StandardSimulations::MaxiGISAS00(), StandardSimulations::MiniGISAS(), StandardSimulations::MiniGISAS_v2(), StandardSimulations::MiniGISASBeamDivergence(), StandardSimulations::MiniGISASDetectorResolution(), StandardSimulations::MiniGISASFit(), StandardSimulations::MiniGISASMonteCarlo(), StandardSimulations::MiniGISASPolarizationMM(), StandardSimulations::MiniGISASPolarizationMP(), StandardSimulations::MiniGISASPolarizationPM(), StandardSimulations::MiniGISASPolarizationPP(), StandardSimulations::MiniGISASSpecularPeak(), StandardSimulations::MiniOffSpec(), StandardSimulations::RectDetectorGeneric(), StandardSimulations::RectDetectorPerpToDirectBeam(), StandardSimulations::RectDetectorPerpToReflectedBeam(), StandardSimulations::RectDetectorPerpToReflectedBeamDpos(), StandardSimulations::RectDetectorPerpToSample(), StandardSimulations::RectDetWithRoi(), IFactory< std::string, Simulation >::registerItem(), StandardSimulations::SpecularDivergentBeam(), StandardSimulations::SpecularWithGaussianBeam(), StandardSimulations::SpecularWithSquareBeam(), StandardSimulations::SphericalDetWithRoi(), StandardSimulations::TOFRWithPointwiseResolution(), and StandardSimulations::TOFRWithRelativeResolution().

Here is the call graph for this function:

Member Function Documentation

◆ createItem()

Simulation * IFactory< std::string , Simulation >::createItem ( const std::string &  item_key) const
inlineinherited

Creates object by calling creation function corresponded to given identifier.

Definition at line 38 of file IFactory.h.

39  {
40  auto it = m_callbacks.find(item_key);
41  assert(it != m_callbacks.end());
42  return (it->second)();
43  }
IFactory< std::string, Simulation >::m_callbacks
CallbackMap_t m_callbacks
map of correspondence of objectsId and creation functions
Definition: IFactory.h:68

◆ createItemPtr()

std::unique_ptr<Simulation > IFactory< std::string , Simulation >::createItemPtr ( const std::string &  item_key) const
inlineinherited

Definition at line 46 of file IFactory.h.

47  {
48  return std::unique_ptr<AbstractProduct>{createItem(item_key)};
49  }
IFactory< std::string, Simulation >::createItem
Simulation * createItem(const std::string &item_key) const
Creates object by calling creation function corresponded to given identifier.
Definition: IFactory.h:38

◆ registerItem()

bool IFactory< std::string , Simulation >::registerItem ( const std::string &  item_key,
CreateItemCallback  CreateFn 
)
inlineinherited

Registers object's creation function.

Definition at line 53 of file IFactory.h.

54  {
55  assert(m_callbacks.find(item_key) == m_callbacks.end());
56  return m_callbacks.insert(make_pair(item_key, CreateFn)).second;
57  }

◆ contains()

bool IFactory< std::string , Simulation >::contains ( const std::string &  item_key) const
inlineinherited

Definition at line 59 of file IFactory.h.

60  {
61  return m_callbacks.find(item_key) != m_callbacks.end();
62  }

◆ size()

size_t IFactory< std::string , Simulation >::size ( ) const
inlineinherited

Returns number of registered objects.

Definition at line 65 of file IFactory.h.

65 { return m_callbacks.size(); }

Member Data Documentation

◆ m_callbacks

CallbackMap_t IFactory< std::string , Simulation >::m_callbacks
protectedinherited

map of correspondence of objectsId and creation functions

Definition at line 68 of file IFactory.h.

The documentation for this class was generated from the following files: