ProfileItems.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      GUI/Model/Sample/ProfileItems.h
//! @brief     Defines Profile1DItem's 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)
//
//  ************************************************************************************************
 
#ifndef BORNAGAIN_GUI_MODEL_SAMPLE_PROFILEITEMS_H
#define BORNAGAIN_GUI_MODEL_SAMPLE_PROFILEITEMS_H
 
#include "GUI/Model/Descriptor/DoubleDescriptor.h"
#include "GUI/Model/Descriptor/DoubleProperty.h"
#include "Sample/Correlations/Profiles1D.h"
#include "Sample/Correlations/Profiles2D.h"
#include <memory>
 
class Streamer;
 
class Profile1DItem {
private:
    static constexpr auto P_OMEGA{"Omega"};
 
public:
    virtual std::unique_ptr<IProfile1D> createProfile() const = 0;
    virtual ~Profile1DItem() = default;
    virtual void serialize(Streamer& s);
 
    DoubleDescriptor omega() const;
 
    virtual DoubleDescriptors valueDescriptors() const;
 
protected:
    Profile1DItem();
 
    DoubleProperty m_omega;
};
 
class Profile1DCauchyItem : public Profile1DItem {
public:
    std::unique_ptr<IProfile1D> createProfile() const override;
};
 
class Profile1DGaussItem : public Profile1DItem {
public:
    std::unique_ptr<IProfile1D> createProfile() const override;
};
 
class Profile1DGateItem : public Profile1DItem {
public:
    std::unique_ptr<IProfile1D> createProfile() const override;
};
 
class Profile1DTriangleItem : public Profile1DItem {
public:
    std::unique_ptr<IProfile1D> createProfile() const override;
};
 
class Profile1DCosineItem : public Profile1DItem {
public:
    std::unique_ptr<IProfile1D> createProfile() const override;
};
 
class Profile1DVoigtItem : public Profile1DItem {
public:
    Profile1DVoigtItem();
    std::unique_ptr<IProfile1D> createProfile() const override;
    void serialize(Streamer& s) override;
 
    DoubleDescriptor eta() const;
    DoubleDescriptors valueDescriptors() const override;
 
private:
    DoubleProperty m_eta;
};
 
// --------------------------------------------------------------------------------------------- //
 
class Profile2DItem {
public:
    virtual ~Profile2DItem() = default;
    virtual std::unique_ptr<IProfile2D> createProfile() const = 0;
    virtual void serialize(Streamer& s);
 
    DoubleDescriptor omegaX() const;
    void setOmegaX(double omega_x);
    DoubleDescriptor omegaY() const;
    void setOmegaY(double omega_y);
 
    DoubleDescriptor gamma() const;
    void setGamma(double gamma);
 
    virtual DoubleDescriptors valueDescriptors() const;
 
protected:
    Profile2DItem();
 
    DoubleProperty m_omegaX;
    DoubleProperty m_omegaY;
    DoubleProperty m_gamma;
};
 
class Profile2DCauchyItem : public Profile2DItem {
public:
    std::unique_ptr<IProfile2D> createProfile() const override;
};
 
class Profile2DGaussItem : public Profile2DItem {
public:
    std::unique_ptr<IProfile2D> createProfile() const override;
};
 
class Profile2DGateItem : public Profile2DItem {
public:
    std::unique_ptr<IProfile2D> createProfile() const override;
};
 
class Profile2DConeItem : public Profile2DItem {
public:
    std::unique_ptr<IProfile2D> createProfile() const override;
};
 
class Profile2DVoigtItem : public Profile2DItem {
public:
    Profile2DVoigtItem();
    std::unique_ptr<IProfile2D> createProfile() const override;
    void serialize(Streamer& s) override;
 
    DoubleDescriptor eta() const;
    void setEta(double eta);
 
    DoubleDescriptors valueDescriptors() const override;
 
private:
    DoubleProperty m_eta;
};
 
#endif // BORNAGAIN_GUI_MODEL_SAMPLE_PROFILEITEMS_H