RealDataItem.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      GUI/Model/Data/RealDataItem.h
//! @brief     Defines class RealDataItem
//!
//! @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_REALDATAITEM_H
#define BORNAGAIN_GUI_MODEL_DATA_REALDATAITEM_H
 
#include "GUI/Model/BaseItem/SessionItem.h"
#include "GUI/Support/IO/AbstractDataLoader.h"
 
class DataItem;
class InstrumentItem;
class IntensityDataItem;
class SpecularDataItem;
class MaskContainerItem;
class Datafield;
class ImportDataInfo;
class AbstractDataLoader;
 
//! Provides access to experimental data, for display and fitting.
//! Owns an AbstractDataLoader.
 
class BA_CORE_API_ RealDataItem : public QObject, public SessionItem {
    Q_OBJECT
 
    friend class TestView;
 
private:
    static constexpr auto P_INSTRUMENT_ID{"Instrument Id"};
    static constexpr auto T_INTENSITY_DATA{"Intensity data"};
    static constexpr auto T_NATIVE_DATA{"Native user data axis"};
    static constexpr auto P_NATIVE_DATA_UNITS{"Native user data units"};
 
public:
    static constexpr auto M_TYPE{"RealData"};
 
    RealDataItem();
 
    void initAsSpecularItem();
    void initAsIntensityItem();
 
    //! The name which is presented to the user
    QString dataName() const;
    void setDataName(const QString& name);
 
    IntensityDataItem* intensityDataItem();
    const IntensityDataItem* intensityDataItem() const;
 
    SpecularDataItem* specularDataItem();
    const SpecularDataItem* specularDataItem() const;
 
    DataItem* dataItem();
    const DataItem* dataItem() const;
 
    DataItem* nativeData();
    const DataItem* nativeData() const;
    void initNativeData();
    QString nativeDataUnits() const;
    void setNativeDataUnits(const QString& units);
    void removeNativeData();
    bool hasNativeData() const;
    const Datafield* nativeDatafield() const;
    void setNativeDatafield(Datafield* data);
 
    void setDatafield(Datafield* data);
    void setImportData(ImportDataInfo info);
    bool holdsDimensionalData() const;
 
    QString instrumentId() const;
    void linkToInstrument(const InstrumentItem* instrument);
    void unlinkFromInstrument();
 
    //! Returns the shape of underlying data item
    std::vector<int> shape() const;
 
    bool isIntensityData() const;
    bool isSpecularData() const;
 
    bool hasImportErrors() const;
 
    //! Returns mask container item
    MaskContainerItem* maskContainerItem();
 
    //! The name from where the native data was originally imported
    void setNativeFileName(const QString& filename);
    QString nativeFileName() const;
 
    QByteArray serializeBinaryData() const override;
    void deserializeBinaryData(const QByteArray& data) override;
 
    //! Takes ownership of loader
    void setDataLoader(AbstractDataLoader* loader);
    AbstractDataLoader* dataLoader() const;
 
    //! Returns true, if rotation will affect linked instrument or mask presence.
    bool rotationAffectsSetup() const;
    void rotateData();
 
    void updateNonXMLDataFileNames();
 
signals:
    void importContentsProcessed();
 
private:
    void initDataItem(size_t data_rank, const QString& tag);
    QModelIndex index() const;
 
    //! This does not set the link to the instrument! Use linkToInstrument() if you want
    //! to link to this instrument.
    void updateToInstrument(const InstrumentItem* instrument);
 
    QByteArray m_importSettings;
    QString m_nativeFileName;
 
    std::unique_ptr<AbstractDataLoader> m_dataLoader;
};
 
#endif // BORNAGAIN_GUI_MODEL_DATA_REALDATAITEM_H