SpecularBeamItem Class Reference

Description

Definition at line 69 of file BeamItems.h.

Inheritance diagram for SpecularBeamItem:

Collaboration diagram for SpecularBeamItem:

Public Member Functions
	SpecularBeamItem (const InstrumentItem *owningInstrument)
BeamAzimuthalAngleItem *	azimuthalAngleItem () const
std::unique_ptr< Beam >	createBeam () const
	DOUBLE_PROPERTY (intensity, Intensity)
FootprintItem *	footprint () const
SessionItem *	footprintGroupItem () const
SelectionDescriptor< FootprintItem * >	footprintSelection () const
double	getAzimuthalAngle () const
double	getInclinationAngle () const override
SpecularBeamInclinationItem *	inclinationAngleItem () const override
BasicAxisItem *	inclinationAxis () const
void	serialize (Streamer &s) override
void	setAzimuthalAngle (double value)
template<typename T >
T *	setFootprintType ()
void	setGaussianFootprint (double value)
void	setInclinationAngle (double value) override
void	setSquareFootprint (double value)
void	setWavelength (double value)
void	updateToData (const IAxis &axis, QString units)
void	updateWavelength ()
double	wavelength () const
BeamWavelengthItem *	wavelengthItem () const

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

Private Attributes
SelectionProperty< FootprintItem * >	m_footprint

Constructor & Destructor Documentation

SpecularBeamItem()

SpecularBeamItem::SpecularBeamItem ( const InstrumentItem *  owningInstrument )

explicit

Definition at line 124 of file BeamItems.cpp.

{
    m_inclinationAngleItem.reset(new SpecularBeamInclinationItem(owningInstrument));
    initWavelength<SpecularBeamWavelengthItem>();
 
    m_footprint.init<FootprintItemCatalog>("Type", "Footprint type", "footprint");
}

References SelectionProperty< T >::init(), m_footprint, and BeamItem::m_inclinationAngleItem.

Here is the call graph for this function:

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

footprint()

FootprintItem * SpecularBeamItem::footprint

(

)

const

Definition at line 161 of file BeamItems.cpp.

{
    return m_footprint.get();
}

References SelectionProperty< T >::get(), and m_footprint.

Here is the call graph for this function:

footprintGroupItem()

SessionItem* SpecularBeamItem::footprintGroupItem

(

)

const

footprintSelection()

SelectionDescriptor< FootprintItem * > SpecularBeamItem::footprintSelection

(

)

const

Definition at line 166 of file BeamItems.cpp.

{
    return m_footprint;
}

References m_footprint.

Referenced by FootprintCorrectionEditor::FootprintCorrectionEditor(), and FootprintCorrectionEditor::createFootprintWidgets().

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 SpecularBeamItem::getInclinationAngle ( ) const

overridevirtual

Implements BeamItem.

Definition at line 139 of file BeamItems.cpp.

{
    return 0.0;
}

inclinationAngleItem()

SpecularBeamInclinationItem * SpecularBeamItem::inclinationAngleItem ( ) const

overridevirtual

Reimplemented from BeamItem.

Definition at line 151 of file BeamItems.cpp.

{
    return dynamic_cast<SpecularBeamInclinationItem*>(BeamItem::inclinationAngleItem());
}

References BeamItem::inclinationAngleItem().

Referenced by DepthProbeInstrumentEditor::DepthProbeInstrumentEditor(), SpecularBeamEditor::SpecularBeamEditor(), SpecularInstrumentItem::alignedWith(), inclinationAxis(), updateToData(), and updateWavelength().

Here is the call graph for this function:

inclinationAxis()

BasicAxisItem * SpecularBeamItem::inclinationAxis

(

)

const

Definition at line 156 of file BeamItems.cpp.

{
    return inclinationAngleItem()->alphaAxis();
}

References SpecularBeamInclinationItem::alphaAxis(), and inclinationAngleItem().

Referenced by DepthProbeInstrumentItem::DepthProbeInstrumentItem(), SpecularInstrumentItem::createCoordSystem(), DepthProbeInstrumentItem::createSimulation(), and SpecularInstrumentItem::shape().

Here is the call graph for this function:

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 SpecularBeamItem::serialize ( Streamer &  s )

overridevirtual

Reimplemented from BeamItem.

Definition at line 132 of file BeamItems.cpp.

{
    s.assertVersion(0);
    Serialize::rwBaseClass<BeamItem>(s, "BeamItem", this);
    Serialize::rwSelected<FootprintItemCatalog>(s, m_footprint);
}

References Streamer::assertVersion(), and m_footprint.

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.

setFootprintType()

template<typename T >

T* SpecularBeamItem::setFootprintType

(

)

setGaussianFootprint()

void SpecularBeamItem::setGaussianFootprint

(

double

value

)

Definition at line 171 of file BeamItems.cpp.

{
    m_footprint.set(new FootprintGaussianItem(value));
}

References m_footprint, and SelectionProperty< T >::set().

Here is the call graph for this function:

setInclinationAngle()

void SpecularBeamItem::setInclinationAngle ( double  value )

overridevirtual

Reimplemented from BeamItem.

Definition at line 144 of file BeamItems.cpp.

{
    ASSERT(value == 0.0);
    value = 0.0;
    BeamItem::setInclinationAngle(value);
}

References BeamItem::setInclinationAngle().

Here is the call graph for this function:

setSquareFootprint()

void SpecularBeamItem::setSquareFootprint

(

double

value

)

Definition at line 176 of file BeamItems.cpp.

{
    m_footprint.set(new FootprintSquareItem(value));
}

References m_footprint, and SelectionProperty< T >::set().

Here is the call graph for this function:

setWavelength()

void BeamItem::setWavelength ( double  value )

inherited

Definition at line 62 of file BeamItems.cpp.

{
    m_wavelengthItem->resetToValue(value);
}

References BeamItem::m_wavelengthItem.

updateToData()

void SpecularBeamItem::updateToData	(	const IAxis &	axis,
		QString	units
	)

Definition at line 181 of file BeamItems.cpp.

{
    if (units == "nbins") {
        inclinationAngleItem()->initUniformAxis(axis);
        inclinationAngleItem()->selectUniformAxis();
    } else {
        inclinationAngleItem()->initPointwiseAxis(axis, units);
        inclinationAngleItem()->selectPointwiseAxis();
    }
    updateWavelength();
}

References inclinationAngleItem(), SpecularBeamInclinationItem::initPointwiseAxis(), SpecularBeamInclinationItem::initUniformAxis(), SpecularBeamInclinationItem::selectPointwiseAxis(), SpecularBeamInclinationItem::selectUniformAxis(), and updateWavelength().

Referenced by SpecularInstrumentItem::updateToRealData().

Here is the call graph for this function:

updateWavelength()

void SpecularBeamItem::updateWavelength

(

)

Definition at line 193 of file BeamItems.cpp.

{
    auto* item = inclinationAngleItem()->alphaAxis();
    auto* wavelength = dynamic_cast<SpecularBeamWavelengthItem*>(wavelengthItem());
    if (auto* pointwiseAxis = dynamic_cast<PointwiseAxisItem*>(item)) {
        const auto* axis = pointwiseAxis->axis();
        if (axis && pointwiseAxis->getUnitsLabel() == "q-space")
            wavelength->setToRange(getLimits(axis->max()));
    } else
        wavelength->setToRange(RealLimits::positive());
}

References SpecularBeamInclinationItem::alphaAxis(), inclinationAngleItem(), BeamItem::wavelength(), and BeamItem::wavelengthItem().

Referenced by updateToData().

Here is the call graph for this function:

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 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 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_footprint

SelectionProperty<FootprintItem*> SpecularBeamItem::m_footprint

private

Definition at line 91 of file BeamItems.h.

Referenced by SpecularBeamItem(), footprint(), footprintSelection(), serialize(), setGaussianFootprint(), and setSquareFootprint().

m_inclinationAngleItem

std::unique_ptr<BeamDistributionItem> BeamItem::m_inclinationAngleItem

protectedinherited

Definition at line 66 of file BeamItems.h.

Referenced by 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