DetectorItems.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      GUI/Model/Device/DetectorItems.h
//! @brief     Defines classes DetectorItems
//!
//! @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_DEVICE_DETECTORITEMS_H
#define BORNAGAIN_GUI_MODEL_DEVICE_DETECTORITEMS_H
 
#include "GUI/Model/Descriptor/SelectionProperty.h"
#include "GUI/Model/Device/MaskItems.h"
#include "GUI/Model/Device/ResolutionFunctionItems.h"
#include <heinz/Vectors3D.h>
 
class MaskContainerItem;
class IDetector;
class IResolutionFunction2D;
class DetectorItem;
class ResolutionFunctionItem;
 
class DetectorItem {
public:
    virtual ~DetectorItem() = default;
 
    std::unique_ptr<IDetector> createDetector() const;
    virtual void serialize(Streamer& s) = 0;
 
    //! Returns the size of x-axis of the detector
    virtual int xSize() const = 0;
 
    //! Returns the size of y-axis of the detector
    virtual int ySize() const = 0;
 
    //! sets the size of x-axis of the detector
    virtual void setXSize(size_t nx) = 0;
 
    //! sets the size of y-axis of the detector
    virtual void setYSize(size_t ny) = 0;
 
    void importMasks(const MaskContainerItem* maskContainer);
    MaskItems& maskItems();
 
    ResolutionFunctionItem* resolutionFunction() const;
    SelectionDescriptor<ResolutionFunctionItem*> resolutionFunctionSelection() const;
    template <typename T>
    T* setResolutionFunctionType();
 
    //! Scales the values provided by axes (to perform deg->rad conversion on the way to domain).
    virtual double axesToCoreUnitsFactor() const { return 1.0; }
 
protected:
    DetectorItem();
 
    virtual std::unique_ptr<IDetector> createDomainDetector() const = 0;
    std::unique_ptr<IResolutionFunction2D> createResolutionFunction() const;
 
    void addMasksToCore(IDetector* detector) const;
 
protected:
    MaskItems m_maskItems; //!< for creation of domain detector; only filled and relevant in jobs
    SelectionProperty<ResolutionFunctionItem*> m_resolutionFunction;
};
 
template <typename T>
T* DetectorItem::setResolutionFunctionType()
{
    m_resolutionFunction.set<T>();
    return dynamic_cast<T*>(m_resolutionFunction.get());
}
 
#endif // BORNAGAIN_GUI_MODEL_DEVICE_DETECTORITEMS_H