CoordSystem1D.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Device/Coord/CoordSystem1D.h
//! @brief     Defines CoordSystem1D class and derived classes.
//!
//! @homepage  http://www.bornagainproject.org
//! @license   GNU General Public License v3 or higher (see COPYING)
//! @copyright Forschungszentrum Jülich GmbH 2018
//! @authors   Scientific Computing Group at MLZ (see CITATION, AUTHORS)
//
//  ************************************************************************************************
 
#ifdef SWIG
#error no need to expose this header to Swig
#endif
 
#ifndef USER_API
#ifndef BORNAGAIN_DEVICE_COORD_COORDSYSTEM1D_H
#define BORNAGAIN_DEVICE_COORD_COORDSYSTEM1D_H
 
#include "Device/Coord/ICoordSystem.h"
 
#include <functional>
 
class ISpecularScan;
 
 
//! Abstract base class to support coordinate transforms and axis labels for 1D scans.
//! Inherited by AngularReflectometryCoordinates and WavenumberReflectometryCoordinates.
 
class CoordSystem1D : public ICoordSystem {
public:
    CoordSystem1D(const IAxis*&& axis); //!< Takes ownership of axis
    ~CoordSystem1D() override = default;
 
    CoordSystem1D* clone() const override = 0;
 
    //! Returns dimensionality of converted canvas.
    size_t rank() const override { return 1u; }
 
    //! Returns the size of underlying axis.
    size_t axisSize(size_t i_axis) const override;
 
    //! Calculates minimum on-axis value in given units.
    double calculateMin(size_t i_axis, Coords units) const override;
 
    //! Calculates maximum on-axis value in given units.
    double calculateMax(size_t i_axis, Coords units) const override;
 
    //! Creates axis in converted units.
    IAxis* createConvertedAxis(size_t i_axis, Coords units) const override;
 
    //! Creates Datafield array in converter units.
    Datafield* createConvertedData(const Datafield& data, Coords units) const override;
 
protected:
    //! Returns translating functional (rads --> output units)
    virtual std::function<double(double)> getTraslatorTo(Coords units) const = 0;
 
    const IAxis* coordinateAxis() const { return m_axis.get(); }
 
    std::unique_ptr<const IAxis> m_axis; //!< semantics depends on subclass
};
 
 
//! Conversion of axis units for the case of conventional (angle-based) reflectometry.
class AngularReflectometryCoordinates : public CoordSystem1D {
public:
    //! Constructs the object for unit conversion.
    AngularReflectometryCoordinates(double wavelength, const IAxis& axis,
                                    Coords axis_units = Coords::RADIANS);
    ~AngularReflectometryCoordinates() override;
 
    AngularReflectometryCoordinates* clone() const override;
 
    //! Returns the list of all available units
    std::vector<Coords> availableUnits() const override;
 
    //! Returns default units to convert to.
    Coords defaultUnits() const override { return Coords::DEGREES; }
 
 
private:
    AngularReflectometryCoordinates(const AngularReflectometryCoordinates& other);
 
    //! Creates name map for axis in various units
    std::vector<std::map<Coords, std::string>> createNameMaps() const override;
 
    //! Returns translating functional (rads --> desired units)
    std::function<double(double)> getTraslatorTo(Coords units) const override;
 
    double m_wavelength; //!< basic wavelength in nm (for translation to q-space).
};
 
 
//! Conversion of axis units for the case of q-defined reflectometry.
class WavenumberReflectometryCoordinates : public CoordSystem1D {
public:
    WavenumberReflectometryCoordinates(const IAxis*&& axis);
    ~WavenumberReflectometryCoordinates() override;
 
    WavenumberReflectometryCoordinates* clone() const override;
 
    //! Returns the list of all available units
    std::vector<Coords> availableUnits() const override;
 
    //! Returns default units to convert to.
    Coords defaultUnits() const override { return Coords::QSPACE; }
 
private:
    WavenumberReflectometryCoordinates(const WavenumberReflectometryCoordinates& other);
 
    //! Creates name map for axis in various units
    std::vector<std::map<Coords, std::string>> createNameMaps() const override;
 
    //! Returns translating functional (inv. nm --> desired units)
    std::function<double(double)> getTraslatorTo(Coords units) const override;
};
 
#endif // BORNAGAIN_DEVICE_COORD_COORDSYSTEM1D_H
#endif // USER_API