IntensityDataItem.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      GUI/Model/Data/IntensityDataItem.h
//! @brief     Defines class IntensityDataItem
//!
//! @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_DATA_INTENSITYDATAITEM_H
#define BORNAGAIN_GUI_MODEL_DATA_INTENSITYDATAITEM_H
 
#include "GUI/Model/Data/DataItem.h"
#include "GUI/Model/Descriptor/SelectionDescriptor.h"
 
class BasicAxisItem;
class AmplitudeAxisItem;
class MaskContainerItem;
class ProjectionContainerItem;
 
class BA_CORE_API_ IntensityDataItem : public DataItem {
private:
    static constexpr auto P_PROJECTIONS{"Projections"};
    static constexpr auto P_TITLE{"Title"};
    static constexpr auto P_IS_INTERPOLATED{"Interpolation"};
    static constexpr auto P_GRADIENT{"Gradient"};
    static constexpr auto P_XAXIS{"x-axis"};
    static constexpr auto P_YAXIS{"y-axis"};
    static constexpr auto P_ZAXIS{"color-axis"};
    static constexpr auto T_MASKS{"Mask tag"};
    static constexpr auto T_PROJECTIONS{"Projection tag"};
 
public:
    static constexpr auto M_TYPE{"IntensityData"};
 
    IntensityDataItem();
 
    void setDatafield(Datafield* data) override;
 
    // TODO: consider using index-based functions for axes' handlers
 
    int xSize() const;
    int ySize() const;
 
    //! Returns lower and upper zoom ranges of x-axis
    double getLowerX() const;
    double getUpperX() const;
 
    //! Returns min and max range of x-axis as given by IntensityData
    double xMin() const;
    double xMax() const;
 
    //! Returns lower and upper zoom ranges of y-axis
    double getLowerY() const;
    double getUpperY() const;
 
    //! Returns min and max range of y-axis as given by IntensityData
    double yMin() const;
    double yMax() const;
 
    //! Returns lower and upper zoom ranges of z-axis
    double getLowerZ() const;
    double getUpperZ() const;
 
    QString getGradientValue() const;
    ComboProperty getGradient() const;
    void setGradient(const ComboProperty& gradient);
    SelectionDescriptor<QString> gradient() const;
 
    bool isLogz() const;
    bool isInterpolated() const;
    QString getXaxisTitle() const;
    QString getYaxisTitle() const;
 
    //! Returns true if min, max range of Z-axis is locked (change not allowed)
    bool isZAxisLocked() const;
    void setZAxisLocked(bool state);
 
    void updateDataRange();
    void computeDataRange();
    QPair<double, double> dataRange() const;
 
    const BasicAxisItem* xAxisItem() const;
    BasicAxisItem* xAxisItem();
    const BasicAxisItem* yAxisItem() const;
    BasicAxisItem* yAxisItem();
    const AmplitudeAxisItem* zAxisItem() const;
    AmplitudeAxisItem* zAxisItem();
 
    void resetView();
 
    MaskContainerItem* maskContainerItem();
    const MaskContainerItem* maskContainerItem() const;
    MaskContainerItem* getOrCreateMaskContainerItem();
 
    ProjectionContainerItem* projectionContainerItem();
    const ProjectionContainerItem* projectionContainerItem() const;
    ProjectionContainerItem* getOrCreateProjectionContainerItem();
 
    bool hasMasks() const;
    bool hasProjections() const;
 
    void setXaxisTitle(const QString& title) override;
    void setYaxisTitle(const QString& title) override;
    void setAxesRangeToData() override;
    void updateCoords(const InstrumentItem* instrument) override;
    std::vector<int> shape() const override;
 
    //! Returns data to the state defined by user (imported) data.
    void reset(ImportDataInfo data) override;
 
    static bool isInterpolatedPropertyName(const QString& name);
    static bool isGradientPropertyName(const QString& name);
    static bool isXaxisPropertyName(const QString& name);
    static bool isYaxisPropertyName(const QString& name);
    static bool isZaxisPropertyName(const QString& name);
 
public slots:
    void setLowerX(double value);
    void setUpperX(double value);
    void setLowerY(double value);
    void setUpperY(double value);
    void setLowerAndUpperZ(double zmin, double zmax);
    void setLowerZ(double zmin);
    void setUpperZ(double zmax);
    void setLogz(bool logz);
    void setInterpolated(bool interp);
 
private:
    void updateAxesZoomLevel();
    void updateAxesLabels();
};
 
#endif // BORNAGAIN_GUI_MODEL_DATA_INTENSITYDATAITEM_H