Beam.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Device/Beam/Beam.h
//! @brief     Defines class Beam.
//!
//! @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_DEVICE_BEAM_BEAM_H
#define BORNAGAIN_DEVICE_BEAM_BEAM_H
 
#include "Base/Vector/Direction.h"
#include "Fit/Param/RealLimits.h"
#include "Param/Node/INode.h"
 
class IFootprintFactor;
class SpinMatrix;
 
//! An incident neutron or x-ray beam.
//! @ingroup beam
 
class Beam : public INode {
public:
    Beam(double intensity, double wavelength, const Direction& direction);
    Beam(const Beam& other);
    Beam& operator=(const Beam& other);
    ~Beam() override;
 
    Beam* clone() const;
    std::string className() const final { return "Beam"; }
 
    static Beam horizontalBeam();
 
    std::vector<const INode*> nodeChildren() const override;
 
    //! Returns the beam intensity in neutrons/sec
    double intensity() const { return m_intensity; }
    double wavelength() const { return m_wavelength; }
    // Direction& direction() { return m_direction; }
    Direction direction() const { return {m_alpha, m_phi}; } // TODO -> const .. &
 
    //! Returns polarization density as Bloch vector
    R3 polVector() const;
    //! Returns the polarization density matrix (in spin basis along z-axis)
    SpinMatrix polMatrix() const;
 
    //! Returns footprint factor.
    const IFootprintFactor* footprintFactor() const;
 
    //! Check for limits, set the value if within limits.
    //! Throws if limits are violated.
    void setInclinationAngleGuarded(double value);
 
    //! Check for limits, set the value if within limits.
    //! Throws if limits are violated.
    void setAzimuthalAngleGuarded(double value);
 
    //! Check for limits, set the value if within limits.
    //! Throws if limits are violated.
    void setWavelengthGuarded(double value);
 
 
    void setWavelength(double wavelength);
    void setDirection(const Direction& direction);
    void setInclination(double alpha);
    void setInclinationLimits(const RealLimits& limits);
    //! Sets the beam intensity in neutrons/sec
    void setIntensity(double intensity) { m_intensity = intensity; }
    //! Sets footprint factor to the beam.
    void setFootprintFactor(const IFootprintFactor& shape_factor);
    //! Sets the polarization density matrix according to the given Bloch vector
    void setPolarization(R3 bloch_vector);
 
private:
    Beam();             // needed by Swig
    double m_intensity; //!< beam intensity (neutrons/sec)
    double m_wavelength;
    // Direction m_direction; TODO
    double m_alpha;
    double m_phi;
    std::unique_ptr<IFootprintFactor> m_shape_factor; //!< footprint correction handler
    R3 m_beamPolarization; //!< Bloch vector encoding the beam's polarization
 
    RealLimits m_alphaLimits;
 
    friend class DepthProbeSimulationTest;
};
 
#endif // BORNAGAIN_DEVICE_BEAM_BEAM_H