GISASBeamItem Class Reference

Description

Definition at line 94 of file BeamItems.h.

Inheritance diagram for GISASBeamItem:

Collaboration diagram for GISASBeamItem:

Public Member Functions
	GISASBeamItem ()
BeamAzimuthalAngleItem *	azimuthalAngleItem () const
std::unique_ptr< Beam >	createBeam () const
	DOUBLE_PROPERTY (intensity, Intensity)
double	getAzimuthalAngle () const
double	getInclinationAngle () const override
virtual BeamDistributionItem *	inclinationAngleItem () const
virtual void	serialize (Streamer &s)
void	setAzimuthalAngle (double value)
virtual void	setInclinationAngle (double value)
void	setInclinationAngleGetter (std::function< double()> getter)
	Explicitly set a getter function for the inclination angle. More...
void	setWavelength (double value)
double	wavelength () const
BeamWavelengthItem *	wavelengthItem () const

Public Attributes
std::function< double()>	m_inclinationAngleGetter

Protected Member Functions
template<typename T >
void	initInclinationAngle ()
template<typename T >
void	initWavelength ()

Protected Attributes
std::unique_ptr< BeamAzimuthalAngleItem >	m_azimuthalAngleItem
std::unique_ptr< BeamDistributionItem >	m_inclinationAngleItem
std::unique_ptr< BeamWavelengthItem >	m_wavelengthItem

Constructor & Destructor Documentation

GISASBeamItem()

GISASBeamItem::GISASBeamItem

(

)

Definition at line 208 of file BeamItems.cpp.

{
    initInclinationAngle<BeamInclinationAngleItem>();
    initWavelength<BeamWavelengthItem>();
}

Member Function Documentation

azimuthalAngleItem()

BeamAzimuthalAngleItem * BeamItem::azimuthalAngleItem ( ) const

inherited

Definition at line 92 of file BeamItems.cpp.

{
    return m_azimuthalAngleItem.get();
}

References BeamItem::m_azimuthalAngleItem.

Referenced by GISASBeamEditor::GISASBeamEditor().

createBeam()

std::unique_ptr< Beam > BeamItem::createBeam ( ) const

inherited

Definition at line 97 of file BeamItems.cpp.

{
    double lambda = wavelength();
    double inclination_angle = Units::deg2rad(getInclinationAngle());
    double azimuthal_angle = Units::deg2rad(getAzimuthalAngle());
 
    auto result =
        std::make_unique<Beam>(intensity(), lambda, Direction(inclination_angle, azimuthal_angle));
 
    return result;
}

References BeamItem::getAzimuthalAngle(), BeamItem::getInclinationAngle(), and BeamItem::wavelength().

Referenced by SpecularInstrumentItem::createCoordSystem(), Instrument2DItem::createInstrument(), Instrument2DItem::createOffspecSimulation(), and Instrument2DItem::createScatteringSimulation().

Here is the call graph for this function:

DOUBLE_PROPERTY()

BeamItem::DOUBLE_PROPERTY ( intensity  , Intensity    )

inherited

getAzimuthalAngle()

double BeamItem::getAzimuthalAngle ( ) const

inherited

Definition at line 82 of file BeamItems.cpp.

{
    return m_azimuthalAngleItem->azimuthalAngle();
}

References BeamItem::m_azimuthalAngleItem.

Referenced by BeamItem::createBeam().

getInclinationAngle()

double GISASBeamItem::getInclinationAngle ( ) const

overridevirtual

Implements BeamItem.

Definition at line 214 of file BeamItems.cpp.

{
    return m_inclinationAngleGetter
               ? m_inclinationAngleGetter()
               : dynamic_cast<BeamInclinationAngleItem*>(inclinationAngleItem())
                     ->inclinationAngle();
}

References BeamItem::inclinationAngleItem(), and m_inclinationAngleGetter.

Here is the call graph for this function:

inclinationAngleItem()

BeamDistributionItem * BeamItem::inclinationAngleItem ( ) const

virtualinherited

Reimplemented in SpecularBeamItem.

Definition at line 77 of file BeamItems.cpp.

{
    return m_inclinationAngleItem.get();
}

References BeamItem::m_inclinationAngleItem.

Referenced by GISASBeamEditor::GISASBeamEditor(), getInclinationAngle(), and SpecularBeamItem::inclinationAngleItem().

initInclinationAngle()

template<typename T >

void BeamItem::initInclinationAngle

protectedinherited

Definition at line 116 of file BeamItems.cpp.

{
    m_inclinationAngleItem.reset(new T());
}

References BeamItem::m_inclinationAngleItem.

initWavelength()

template<typename T >

void BeamItem::initWavelength

protectedinherited

Definition at line 110 of file BeamItems.cpp.

{
    m_wavelengthItem.reset(new T());
}

References BeamItem::m_wavelengthItem.

serialize()

void BeamItem::serialize ( Streamer &  s )

virtualinherited

Reimplemented in SpecularBeamItem.

Definition at line 48 of file BeamItems.cpp.

{
    s.assertVersion(0);
    Serialize::rwProperty(s, m_intensity);
    Serialize::rwClass(s, "wavelength", *m_wavelengthItem);
    Serialize::rwClass(s, "azimuth", *m_azimuthalAngleItem);
    Serialize::rwClass(s, "inclination", *m_inclinationAngleItem);
}

References Streamer::assertVersion(), BeamItem::m_azimuthalAngleItem, BeamItem::m_inclinationAngleItem, BeamItem::m_wavelengthItem, Serialize::rwClass(), and Serialize::rwProperty().

Here is the call graph for this function:

setAzimuthalAngle()

void BeamItem::setAzimuthalAngle ( double  value )

inherited

Definition at line 87 of file BeamItems.cpp.

{
    m_azimuthalAngleItem->resetToValue(value);
}

References BeamItem::m_azimuthalAngleItem.

setInclinationAngle()

void BeamItem::setInclinationAngle ( double  value )

virtualinherited

Reimplemented in SpecularBeamItem.

Definition at line 72 of file BeamItems.cpp.

{
    m_inclinationAngleItem->resetToValue(value);
}

References BeamItem::m_inclinationAngleItem.

Referenced by SpecularBeamItem::setInclinationAngle().

setInclinationAngleGetter()

void GISASBeamItem::setInclinationAngleGetter

(

std::function< double()>

getter

)

Explicitly set a getter function for the inclination angle.

If a getter is set, it overrides the behavior in getInclinationAngle(). Helpful if the angle can't be determined from the internal beam parameters, but from external information.

Definition at line 222 of file BeamItems.cpp.

{
    m_inclinationAngleGetter = getter;
}

References m_inclinationAngleGetter.

Referenced by OffspecInstrumentItem::OffspecInstrumentItem().

setWavelength()

void BeamItem::setWavelength ( double  value )

inherited

Definition at line 62 of file BeamItems.cpp.

{
    m_wavelengthItem->resetToValue(value);
}

References BeamItem::m_wavelengthItem.

wavelength()

double BeamItem::wavelength ( ) const

inherited

Definition at line 57 of file BeamItems.cpp.

{
    return m_wavelengthItem->wavelength();
}

References BeamItem::m_wavelengthItem.

Referenced by BeamItem::createBeam(), and SpecularBeamItem::updateWavelength().

wavelengthItem()

BeamWavelengthItem * BeamItem::wavelengthItem ( ) const

inherited

Definition at line 67 of file BeamItems.cpp.

{
    return m_wavelengthItem.get();
}

References BeamItem::m_wavelengthItem.

Referenced by GISASBeamEditor::GISASBeamEditor(), SpecularBeamEditor::SpecularBeamEditor(), and SpecularBeamItem::updateWavelength().

Member Data Documentation

m_azimuthalAngleItem

std::unique_ptr<BeamAzimuthalAngleItem> BeamItem::m_azimuthalAngleItem

protectedinherited

Definition at line 65 of file BeamItems.h.

Referenced by BeamItem::BeamItem(), BeamItem::azimuthalAngleItem(), BeamItem::getAzimuthalAngle(), BeamItem::serialize(), and BeamItem::setAzimuthalAngle().

m_inclinationAngleGetter

std::function<double()> GISASBeamItem::m_inclinationAngleGetter

Definition at line 107 of file BeamItems.h.

Referenced by getInclinationAngle(), and setInclinationAngleGetter().

m_inclinationAngleItem

std::unique_ptr<BeamDistributionItem> BeamItem::m_inclinationAngleItem

protectedinherited

Definition at line 66 of file BeamItems.h.

Referenced by SpecularBeamItem::SpecularBeamItem(), BeamItem::inclinationAngleItem(), BeamItem::initInclinationAngle(), BeamItem::serialize(), and BeamItem::setInclinationAngle().

m_wavelengthItem

std::unique_ptr<BeamWavelengthItem> BeamItem::m_wavelengthItem

protectedinherited

Definition at line 64 of file BeamItems.h.

Referenced by BeamItem::initWavelength(), BeamItem::serialize(), BeamItem::setWavelength(), BeamItem::wavelength(), and BeamItem::wavelengthItem().

---

The documentation for this class was generated from the following files:

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/Device/BeamItems.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/Device/BeamItems.cpp