BornAgain  1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
ConstKBinAxis Class Reference

Axis with fixed bin size in sin(angle) space. More...

+ Inheritance diagram for ConstKBinAxis:

Public Member Functions

 ConstKBinAxis (const std::string &name, size_t nbins, double start, double end)
 ConstKBinAxis constructor. More...
 
ConstKBinAxisclone () const final
 clone function
 
ConstKBinAxiscreateClippedAxis (double left, double right) const final
 Creates a new clipped axis.
 
- Public Member Functions inherited from VariableBinAxis
 VariableBinAxis (const std::string &name, size_t nbins, const std::vector< double > &bin_boundaries)
 VariableBinAxis constructor. More...
 
VariableBinAxisclone () const
 clone function
 
size_t size () const
 retrieve the number of bins
 
double operator[] (size_t index) const
 indexed accessor retrieves a sample
 
Bin1D getBin (size_t index) const
 retrieve a 1d bin for the given index
 
double getMin () const
 Returns value of first point of axis.
 
double getMax () const
 Returns value of last point of axis.
 
double getBinCenter (size_t index) const
 
size_t findClosestIndex (double value) const
 find bin index which is best match for given value
 
std::vector< double > getBinCenters () const
 
std::vector< double > getBinBoundaries () const
 
std::string pyString (const std::string &units, size_t offset) const final
 
- Public Member Functions inherited from IAxis
 IAxis (const std::string &name)
 constructors
 
virtual ~IAxis ()
 destructor
 
std::string getName () const
 retrieve the label of the axis
 
void setName (std::string name)
 Sets the axis label.
 
bool operator== (const IAxis &right) const
 test for equality
 
bool operator!= (const IAxis &right) const
 
virtual bool contains (double value) const
 Returns true if axis contains given point.
 

Protected Member Functions

 ConstKBinAxis (const std::string &name, size_t nbins)
 
void print (std::ostream &ostr) const final
 
bool equals (const IAxis &other) const final
 
- Protected Member Functions inherited from VariableBinAxis
 VariableBinAxis (const std::string &name, size_t nbins=0)
 
void setBinBoundaries (const std::vector< double > &bin_boundaries)
 

Protected Attributes

double m_start
 
double m_end
 
- Protected Attributes inherited from VariableBinAxis
size_t m_nbins
 

Detailed Description

Axis with fixed bin size in sin(angle) space.

Definition at line 23 of file ConstKBinAxis.h.

Constructor & Destructor Documentation

◆ ConstKBinAxis()

ConstKBinAxis::ConstKBinAxis ( const std::string &  name,
size_t  nbins,
double  start,
double  end 
)

ConstKBinAxis constructor.

Parameters
nameAxis name
nbinsnumber of bins
startlow edge of first bin
endupper edge of last bin

Definition at line 25 of file ConstKBinAxis.cpp.


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