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

A detector with coordinate axes along angles phi and alpha. More...

+ Inheritance diagram for SphericalDetector:

Public Member Functions

 SphericalDetector (const SphericalDetector &other)
 
 SphericalDetector (size_t n_bin, double width, double phi, double alpha)
 Returns a detector with phi and alpha axes that have equal width and binning. More...
 
 SphericalDetector (size_t n_phi, double phi_min, double phi_max, size_t n_alpha, double alpha_min, double alpha_max)
 Returns a detector with given phi and alpha axes. More...
 
void accept (INodeVisitor *visitor) const override
 
SphericalDetector * clone () const override
 
Axes::Units defaultAxesUnits () const override
 return default axes units
 

Protected Member Functions

std::string axisName (size_t index) const override
 Returns the name for the axis with given index.
 
IPixel * createPixel (size_t index) const override
 Creates an IPixel for the given OutputData object and index.
 
size_t indexOfSpecular (const Beam &beam) const override
 Returns index of pixel that contains the specular wavevector. More...
 

Detailed Description

A detector with coordinate axes along angles phi and alpha.

Constructor & Destructor Documentation

◆ SphericalDetector() [1/2]

SphericalDetector::SphericalDetector ( size_t  n_phi,
double  phi_min,
double  phi_max,
size_t  n_alpha,
double  alpha_min,
double  alpha_max 
)

Returns a detector with given phi and alpha axes.

Parameters
n_phinumber of phi-axis bins
phi_minlow edge of first phi-bin
phi_maxupper edge of last phi-bin
n_alphanumber of alpha-axis bins
alpha_minlow edge of first alpha-bin
alpha_maxupper edge of last alpha-bin

◆ SphericalDetector() [2/2]

SphericalDetector::SphericalDetector ( size_t  n_bin,
double  width,
double  phi,
double  alpha 
)

Returns a detector with phi and alpha axes that have equal width and binning.

Parameters
n_binnumber of bins per direction
widthfull width of angular range in phi or alpha
phicentral phi angle
alphacentral alpha angle

Member Function Documentation

◆ indexOfSpecular()

size_t SphericalDetector::indexOfSpecular ( const Beam &  beam) const
overrideprotected

Returns index of pixel that contains the specular wavevector.

If no pixel contains this specular wavevector, the number of pixels is returned. This corresponds to an overflow index.