BornAgain  1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
Public Member Functions | List of all members
SimulationElement Class Reference
Simulation description

Data stucture containing both input and output of a single detector cell. More...

Public Member Functions

 SimulationElement (double wavelength, double alpha_i, double phi_i, std::unique_ptr< IPixel > pixel)
 
 SimulationElement (const SimulationElement &other)
 
SimulationElement & operator= (const SimulationElement &other)
 
 SimulationElement (const SimulationElement &other, double x, double y)
 Construct SimulationElement from other element and restrict k_f to specific value in the original detector pixel.
 
 SimulationElement (SimulationElement &&other) noexcept
 
void setPolarization (const Eigen::Matrix2cd &polarization)
 Sets the polarization density matrix (in spin basis along z-axis)
 
void setAnalyzerOperator (const Eigen::Matrix2cd &polarization_operator)
 Sets the polarization analyzer operator (in spin basis along z-axis)
 
const PolarizationHandler & polarizationHandler () const
 Returns assigned PolarizationHandler.
 
double getWavelength () const
 
double getAlphaI () const
 
double getPhiI () const
 
double getAlphaMean () const
 
double getPhiMean () const
 
void setIntensity (double intensity)
 
void addIntensity (double intensity)
 
double getIntensity () const
 
kvector_t getKi () const
 
kvector_t getMeanKf () const
 
kvector_t getMeanQ () const
 
kvector_t getQ (double x, double y) const
 Returns scattering vector Q, with Kf determined from in-pixel coordinates x,y. More...
 
double getIntegrationFactor (double x, double y) const
 
double getSolidAngle () const
 
double getAlpha (double x, double y) const
 
double getPhi (double x, double y) const
 
void setSpecular (bool is_specular)
 Set specularity indication on/off.
 
bool isSpecular () const
 Tells if simulation element corresponds to a specular peak.
 

Detailed Description

Data stucture containing both input and output of a single detector cell.

Definition at line 28 of file SimulationElement.h.

Member Function Documentation

◆ getQ()

kvector_t SimulationElement::getQ ( double  x,
double  y 
) const

Returns scattering vector Q, with Kf determined from in-pixel coordinates x,y.

In-pixel coordinates take values from 0 to 1.

Definition at line 86 of file SimulationElement.cpp.

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