BornAgain  1.19.0
Simulate and fit neutron and x-ray scattering at grazing incidence
SpecularSimulation Class Reference

Main class to run a specular simulation. More...

+ Inheritance diagram for SpecularSimulation:

Public Member Functions

void accept (INodeVisitor *visitor) const final
 
SpecularSimulationclone () const override
 
const IAxis * coordinateAxis () const
 Returns a pointer to coordinate axis.
 
const IFootprintFactor * footprintFactor () const
 Returns a pointer to footprint factor holder.
 
size_t intensityMapSize () const override
 Returns the total number of the intensity values in the simulation result.
 
void prepareSimulation () override
 Put into a clean state for running a simulation.
 
SimulationResult result () const override
 Returns the results of the simulation in a format that supports unit conversion and export to numpy arrays. More...
 
void setScan (const ISpecularScan &scan)
 Sets chosen specular scan to the simulation.
 

Detailed Description

Main class to run a specular simulation.

Member Function Documentation

◆ result()

SimulationResult SpecularSimulation::result ( ) const
override

Returns the results of the simulation in a format that supports unit conversion and export to numpy arrays.

If simulation was not run, returns an array of proper size filled with zeros.