ICoordSystem.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Device/Coord/ICoordSystem.h
//! @brief     Defines interface ICoordSystem and possible axis units.
//!
//! @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_ICOORDSYSTEM_H
#define BORNAGAIN_DEVICE_COORD_ICOORDSYSTEM_H
 
#include "Base/Types/ICloneable.h"
#include "Device/Coord/Tags.h"
#include <map>
#include <memory>
#include <string>
#include <vector>
 
class IAxis;
class Datafield;
 
 
//! Interface to provide axis translations to different units for simulation output
 
//! Child classes are currently declared in
//! - Device/Detector/CoordSystem2D.h,
//! - Core/Scan/CoordSystem1D.h.
 
class ICoordSystem : public ICloneable {
public:
    ~ICoordSystem() override;
 
    ICoordSystem* clone() const override = 0;
 
    virtual size_t rank() const = 0;
 
    virtual double calculateMin(size_t i_axis, Coords units) const = 0;
    virtual double calculateMax(size_t i_axis, Coords units) const = 0;
    virtual size_t axisSize(size_t i_axis) const = 0;
 
    std::string axisName(size_t i_axis, Coords units = Coords::UNDEFINED) const;
 
    virtual std::vector<Coords> availableUnits() const = 0;
    virtual Coords defaultUnits() const = 0;
 
    virtual IAxis* createConvertedAxis(size_t i_axis, Coords units) const = 0;
 
    std::vector<IAxis*> defaultAxes() const;
    std::vector<IAxis*> convertedAxes(Coords units) const;
 
    //! Creates Datafield array in converter units.
    virtual Datafield* createConvertedData(const Datafield& data, Coords units) const;
 
protected:
    Coords substituteDefaultUnits(Coords units) const;
    [[noreturn]] void throwUnitsError(std::string method, std::vector<Coords> available) const;
 
private:
    virtual std::vector<std::map<Coords, std::string>> createNameMaps() const = 0;
};
 
#endif // BORNAGAIN_DEVICE_COORD_ICOORDSYSTEM_H
#endif // USER_API