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

DepthProbeConverter class handles the unit translations for depth probe simulations Its default units are radians for x-axis and nm for y-axis. More...

+ Inheritance diagram for DepthProbeConverter:

Public Member Functions

 DepthProbeConverter (const Beam &beam, const IAxis &alpha_axis, const IAxis &z_axis)
 
DepthProbeConverterclone () const final
 
std::vector< Axes::Units > availableUnits () const final
 Returns the list of all available units.
 
Axes::Units defaultUnits () const final
 
- Public Member Functions inherited from UnitConverterSimple
 UnitConverterSimple (const Beam &beam)
 
virtual size_t dimension () const final
 
double calculateMin (size_t i_axis, Axes::Units units_type) const final
 
double calculateMax (size_t i_axis, Axes::Units units_type) const final
 
size_t axisSize (size_t i_axis) const final
 
std::unique_ptr< IAxiscreateConvertedAxis (size_t i_axis, Axes::Units units) const final
 
- Public Member Functions inherited from IUnitConverter
std::string axisName (size_t i_axis, Axes::Units units_type=Axes::Units::DEFAULT) const
 
Axes::Units substituteDefaultUnits (Axes::Units units) const
 
virtual std::unique_ptr< OutputData< double > > createConvertedData (const OutputData< double > &data, Axes::Units units) const
 Creates OutputData array in converter units.
 
- 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)
 

Additional Inherited Members

- Protected Member Functions inherited from UnitConverterSimple
 UnitConverterSimple (const UnitConverterSimple &other)
 
void addDetectorAxis (const IDetector &detector, size_t i_axis)
 
void addAxisData (std::string name, double min, double max, Axes::Units default_units, size_t nbins)
 
- Protected Member Functions inherited from IUnitConverter
void checkIndex (size_t i_axis) const
 
void throwUnitsError (std::string method, std::vector< Axes::Units > available) const
 
- Protected Attributes inherited from UnitConverterSimple
std::vector< AxisDatam_axis_data_table
 
double m_wavelength
 
double m_alpha_i
 
double m_phi_i
 

Detailed Description

DepthProbeConverter class handles the unit translations for depth probe simulations Its default units are radians for x-axis and nm for y-axis.

Definition at line 148 of file SimpleUnitConverters.h.


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