BornAgain  1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
ISpecularScan Class Referenceabstract

Pure virtual base class for all types of specular scans. More...

+ Inheritance diagram for ISpecularScan:

Public Member Functions

ISpecularScanclone () const override=0
 
virtual std::vector< SpecularSimulationElementgenerateSimulationElements () const =0
 Generates simulation elements for specular simulations.
 
virtual const IAxiscoordinateAxis () const =0
 Returns coordinate axis assigned to the data holder.
 
virtual const IFootprintFactorfootprintFactor () const =0
 Returns IFootprintFactor object pointer.
 
virtual std::vector< double > footprint (size_t i, size_t n_elements) const =0
 Returns footprint correction factor for a range of simulation elements of size n_elements and starting from element with index i.
 
virtual size_t numberOfSimulationElements () const =0
 Returns the number of simulation elements.
 
virtual std::vector< double > createIntensities (const std::vector< SpecularSimulationElement > &sim_elements) const =0
 Returns intensity vector corresponding to convolution of given simulation elements.
 
virtual std::string print () const =0
 Print scan definition in python format.
 
- Public Member Functions inherited from ICloneable
 ICloneable (const ICloneable &)=delete
 
 ICloneable (ICloneable &&)=default
 
virtual void transferToCPP ()
 Used for Python overriding of clone (see swig/tweaks.py)
 

Detailed Description

Pure virtual base class for all types of specular scans.

Definition at line 30 of file ISpecularScan.h.


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