Instrument.h

Go to the documentation of this file.

// ************************************************************************** //
//
//  BornAgain: simulate and fit scattering at grazing incidence
//
//! @file      Device/Instrument/Instrument.h
//! @brief     Defines class Instrument.
//!
//! @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_CORE_INSTRUMENT_INSTRUMENT_H
#define BORNAGAIN_CORE_INSTRUMENT_INSTRUMENT_H
 
#include "Device/Beam/Beam.h"
#include <memory>
 
template <class T> class OutputData;
class Histogram2D;
class DetectorMask;
class IAxis;
class IDetector;
class IDetector2D;
class IResolutionFunction2D;
class SimulationElement;
 
//! Assembles beam, detector and their relative positions with respect to the sample.
//! @ingroup simulation_internal
 
class Instrument : public INode
{
public:
    Instrument();
    Instrument(const Instrument& other);
    Instrument& operator=(const Instrument& other);
 
    virtual ~Instrument();
 
    void accept(INodeVisitor* visitor) const final { visitor->visit(this); }
 
    Beam& getBeam() { return m_beam; }
    const Beam& getBeam() const { return m_beam; }
    void setBeam(const Beam& beam);
 
    //! Sets the beam wavelength and incoming angles
    void setBeamParameters(double wavelength, double alpha_i, double phi_i);
 
    void setBeamIntensity(double intensity);
 
    //! Sets the beam's polarization according to the given Bloch vector
    void setBeamPolarization(const kvector_t bloch_vector);
 
    double getBeamIntensity() const;
 
    const IDetector* getDetector() const;
    IDetector& detector();
    const IDetector& detector() const;
 
    IDetector2D& detector2D();
    const IDetector2D& detector2D() const;
 
    const DetectorMask* getDetectorMask() const;
 
    const IAxis& getDetectorAxis(size_t index) const;
 
    size_t getDetectorDimension() const;
 
    //! Sets the detector (axes can be overwritten later)
    void setDetector(const IDetector& detector);
 
    //! Sets detector resolution function
    void setDetectorResolutionFunction(const IResolutionFunction2D& p_resolution_function);
 
    //! Removes detector resolution function.
    void removeDetectorResolution();
 
    //! Sets the polarization analyzer characteristics of the detector
    void setAnalyzerProperties(const kvector_t direction, double efficiency,
                               double total_transmission);
 
    //! apply the detector resolution to the given intensity map
    void applyDetectorResolution(OutputData<double>* p_intensity_map) const;
 
    //! init detector with beam settings
    void initDetector();
 
    std::vector<const INode*> getChildren() const;
 
protected:
    std::unique_ptr<IDetector> m_detector;
    Beam m_beam;
};
 
#endif // BORNAGAIN_CORE_INSTRUMENT_INSTRUMENT_H