BornAgain  1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
UnitConverter1D Class Referenceabstract

Conversion of axis units for the case of 1D simulation result. More...

+ Inheritance diagram for UnitConverter1D:

Public Member Functions

UnitConverter1Dclone () const override=0
 
size_t dimension () const override
 Returns dimensionality of converted canvas.
 
double calculateMin (size_t i_axis, Axes::Units units_type) const override
 Calculates minimum on-axis value in given units.
 
double calculateMax (size_t i_axis, Axes::Units units_type) const override
 Calculates maximum on-axis value in given units.
 
std::unique_ptr< IAxiscreateConvertedAxis (size_t i_axis, Axes::Units units) const override
 Creates axis in converted units.
 
std::unique_ptr< OutputData< double > > createConvertedData (const OutputData< double > &data, Axes::Units units) const override
 Creates OutputData array in converter units.
 
- Public Member Functions inherited from IUnitConverter
virtual size_t axisSize (size_t i_axis) const =0
 
std::string axisName (size_t i_axis, Axes::Units units_type=Axes::Units::DEFAULT) const
 
virtual std::vector< Axes::Units > availableUnits () const =0
 
virtual Axes::Units defaultUnits () const =0
 
Axes::Units substituteDefaultUnits (Axes::Units units) const
 
- 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)
 

Static Public Member Functions

static std::unique_ptr< UnitConverter1DcreateUnitConverter (const ISpecularScan &handler)
 Factory function to create unit converter for particular type of specular data.
 

Protected Member Functions

virtual std::function< double(double)> getTraslatorTo (Axes::Units units_type) const =0
 Returns translating functional (rads --> output units)
 
virtual const IAxiscoordinateAxis () const =0
 
- Protected Member Functions inherited from IUnitConverter
void checkIndex (size_t i_axis) const
 
void throwUnitsError (std::string method, std::vector< Axes::Units > available) const
 

Detailed Description

Conversion of axis units for the case of 1D simulation result.

Definition at line 29 of file UnitConverter1D.h.


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