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

Axis with fixed bin size in sin(angle) space used for numerical comparison with IsGisaxs. More...

+ Inheritance diagram for CustomBinAxis:

Public Member Functions

 CustomBinAxis (const std::string &name, size_t nbins, double start, double end)
 CustomBinAxis constructor. More...
 
CustomBinAxisclone () const
 clone function
 
Bin1D getBin (size_t index) const
 retrieve a 1d bin for the given index
 
std::vector< double > getBinCenters () const
 
CustomBinAxiscreateClippedAxis (double left, double right) const
 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

void print (std::ostream &ostr) const
 
bool equals (const IAxis &other) const
 
- 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
 
std::vector< double > m_bin_centers
 
- Protected Attributes inherited from VariableBinAxis
size_t m_nbins
 

Detailed Description

Axis with fixed bin size in sin(angle) space used for numerical comparison with IsGisaxs.

The main feature of the axis is that it produces zero bin sizes.

Definition at line 24 of file CustomBinAxis.h.

Constructor & Destructor Documentation

◆ CustomBinAxis()

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

CustomBinAxis constructor.

Parameters
nameAxis name
nbinsnumber of bins
startcenter of first bin (IsGisaxs convention)
endcenter of last bin (IsGisaxs convention)

Definition at line 21 of file CustomBinAxis.cpp.


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