SpecularBeamInclinationItem Class Reference

Description

BeamInclinationAxisItem contains inclination angle axis for specular/off-specular simulations and also provides distribution functionality. Considering distribution, differs from BeamInclinationAngleItem by any distribution mean value being always zero.

Definition at line 26 of file SpecularBeamInclinationItem.h.

Inheritance diagram for SpecularBeamInclinationItem:

Collaboration diagram for SpecularBeamInclinationItem:

Public Member Functions
	SpecularBeamInclinationItem (const InstrumentItem *owningInstrument)
BasicAxisItem *	alphaAxis () const
	The currently selected axis. More...
DistributionItem *	distribution () const
SelectionDescriptor< DistributionItem * >	distributionSelection () const
std::unique_ptr< ParameterDistribution >	getParameterDistributionForName (ParameterDistribution::WhichParameter which) const
void	initPointwiseAxis (const IAxis &axis, QString units)
void	initUniformAxis (const IAxis &axis)
virtual double	meanValue () const
bool	pointwiseAlphaAxisDefined () const
	True if a pointwise axis was defined. More...
bool	pointwiseAlphaAxisSelected () const
	True if pointwise axis is selected. More...
void	resetToValue (double value)
double	scaleFactor () const override
void	selectPointwiseAxis ()
void	selectUniformAxis ()
void	serialize (Streamer &s) override
void	setDistribution (DistributionItem *d)
template<typename T >
T *	setDistributionType ()
bool	uniformAlphaAxisSelected () const
	True if uniform axis is selected. More...

Protected Member Functions
virtual std::unique_ptr< IDistribution1D >	createDistribution1D () const

Protected Attributes
SelectionProperty< DistributionItem * >	m_distribution

Private Attributes
bool	m_currentAxisIsUniformAxis
const InstrumentItem *	m_owningInstrument
std::unique_ptr< PointwiseAxisItem >	m_pointwiseAlphaAxis
std::unique_ptr< BasicAxisItem >	m_uniformAlphaAxis

Constructor & Destructor Documentation

SpecularBeamInclinationItem()

SpecularBeamInclinationItem::SpecularBeamInclinationItem ( const InstrumentItem *  owningInstrument )

explicit

Definition at line 63 of file SpecularBeamInclinationItem.cpp.

    : BeamDistributionItem()
    , m_owningInstrument(owningInstrument)
{
    m_distribution.initWithInitializer<DistributionItemCatalog>(
        "Distribution", "", "distribution", DistributionItemCatalog::symmetricTypes(),
        initDistribution);
 
    m_uniformAlphaAxis.reset(new BasicAxisItem());
    setAxisPresentationDefaults(m_uniformAlphaAxis.get());
    m_currentAxisIsUniformAxis = true;
}

References SelectionProperty< T >::initWithInitializer(), m_currentAxisIsUniformAxis, BeamDistributionItem::m_distribution, m_uniformAlphaAxis, and DistributionItemCatalog::symmetricTypes().

Here is the call graph for this function:

Member Function Documentation

alphaAxis()

BasicAxisItem * SpecularBeamInclinationItem::alphaAxis

(

)

const

The currently selected axis.

Definition at line 99 of file SpecularBeamInclinationItem.cpp.

{
    return m_currentAxisIsUniformAxis ? m_uniformAlphaAxis.get() : m_pointwiseAlphaAxis.get();
}

References m_currentAxisIsUniformAxis, m_pointwiseAlphaAxis, and m_uniformAlphaAxis.

Referenced by SpecularInstrumentItem::alignedWith(), SpecularBeamItem::inclinationAxis(), InclinationAnglesEditor::onAxisTypeSelected(), and SpecularBeamItem::updateWavelength().

createDistribution1D()

std::unique_ptr< IDistribution1D > BeamDistributionItem::createDistribution1D ( ) const

protectedvirtualinherited

Definition at line 75 of file BeamDistributionItem.cpp.

{
    return distribution()->createDistribution(scaleFactor());
}

References DistributionItem::createDistribution(), BeamDistributionItem::distribution(), and BeamDistributionItem::scaleFactor().

Referenced by BeamDistributionItem::getParameterDistributionForName(), and BeamDistributionItem::meanValue().

Here is the call graph for this function:

distribution()

DistributionItem * BeamDistributionItem::distribution ( ) const

inherited

Definition at line 60 of file BeamDistributionItem.cpp.

{
    return m_distribution.get();
}

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

Referenced by ParameterTreeBuilder::addBeamDistribution(), BeamDistributionItem::createDistribution1D(), DistributionSelector::createDistributionWidgets(), BeamDistributionItem::getParameterDistributionForName(), BeamDistributionItem::meanValue(), SpecularBeamWavelengthItem::setToRange(), DistributionEditor::updatePlot(), and InclinationAnglesEditor::updatePlot().

Here is the call graph for this function:

distributionSelection()

SelectionDescriptor< DistributionItem * > BeamDistributionItem::distributionSelection ( ) const

inherited

Definition at line 65 of file BeamDistributionItem.cpp.

{
    return m_distribution;
}

References BeamDistributionItem::m_distribution.

Referenced by DistributionSelector::DistributionSelector(), and DistributionSelector::refresh().

getParameterDistributionForName()

std::unique_ptr< ParameterDistribution > BeamDistributionItem::getParameterDistributionForName ( ParameterDistribution::WhichParameter  which ) const

inherited

Definition at line 22 of file BeamDistributionItem.cpp.

{
    if (const auto* d = distribution()) {
        auto distribution1D = createDistribution1D();
 
        if (distribution1D) {
            const auto nbrOfSamples = d->numberOfSamples();
            const double sigmaFactor = d->hasSigmaFactor() ? d->sigmaFactor() : 0.0;
            const auto limits = d->limits().scaledLimits(scaleFactor());
 
            return std::make_unique<ParameterDistribution>(which, *distribution1D, nbrOfSamples,
                                                           sigmaFactor, limits);
        }
    }
    return {};
}

References BeamDistributionItem::createDistribution1D(), BeamDistributionItem::distribution(), and BeamDistributionItem::scaleFactor().

Here is the call graph for this function:

initPointwiseAxis()

void SpecularBeamInclinationItem::initPointwiseAxis	(	const IAxis &	axis,
		QString	units
	)

Definition at line 135 of file SpecularBeamInclinationItem.cpp.

{
    if (!m_pointwiseAlphaAxis) {
        m_pointwiseAlphaAxis.reset(new PointwiseAxisItem());
        m_pointwiseAlphaAxis->setOwningInstrument(m_owningInstrument);
        setAxisPresentationDefaults(m_pointwiseAlphaAxis.get());
    }
 
    m_pointwiseAlphaAxis->init(axis, units);
    m_pointwiseAlphaAxis->updateIndicators();
}

References m_owningInstrument, and m_pointwiseAlphaAxis.

Referenced by SpecularBeamItem::updateToData().

initUniformAxis()

void SpecularBeamInclinationItem::initUniformAxis

(

const IAxis &

axis

)

Definition at line 130 of file SpecularBeamInclinationItem.cpp.

{
    m_uniformAlphaAxis->setBinCount(static_cast<int>(axis.size()));
}

References m_uniformAlphaAxis.

Referenced by SpecularBeamItem::updateToData().

meanValue()

double BeamDistributionItem::meanValue ( ) const

virtualinherited

Definition at line 40 of file BeamDistributionItem.cpp.

{
    std::unique_ptr<IDistribution1D> domainDistr = createDistribution1D();
    if (domainDistr)
        return domainDistr->mean() / scaleFactor();
    return dynamic_cast<SymmetricResolutionItem*>(distribution())->mean();
}

References BeamDistributionItem::createDistribution1D(), BeamDistributionItem::distribution(), and BeamDistributionItem::scaleFactor().

Referenced by BeamAzimuthalAngleItem::azimuthalAngle(), BeamInclinationAngleItem::inclinationAngle(), and BeamWavelengthItem::wavelength().

Here is the call graph for this function:

pointwiseAlphaAxisDefined()

bool SpecularBeamInclinationItem::pointwiseAlphaAxisDefined

(

)

const

True if a pointwise axis was defined.

It still is no necessarily the selected axis! Not to be confused with pointwiseAlphaAxisSelected

Definition at line 104 of file SpecularBeamInclinationItem.cpp.

{
    return m_pointwiseAlphaAxis.get() != nullptr;
}

References m_pointwiseAlphaAxis.

Referenced by InclinationAnglesEditor::InclinationAnglesEditor(), and selectPointwiseAxis().

pointwiseAlphaAxisSelected()

bool SpecularBeamInclinationItem::pointwiseAlphaAxisSelected

(

)

const

True if pointwise axis is selected.

Not to be confused with pointwiseAlphaAxisDefined

Definition at line 109 of file SpecularBeamInclinationItem.cpp.

{
    return !m_currentAxisIsUniformAxis;
}

References m_currentAxisIsUniformAxis.

Referenced by InclinationAnglesEditor::InclinationAnglesEditor(), and InclinationAnglesEditor::onAxisTypeSelected().

resetToValue()

void BeamDistributionItem::resetToValue ( double  value )

inherited

Definition at line 48 of file BeamDistributionItem.cpp.

{
    auto* d = new DistributionNoneItem();
    d->setMean(value);
    m_distribution.set(d);
}

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

Here is the call graph for this function:

scaleFactor()

double SpecularBeamInclinationItem::scaleFactor ( ) const

overridevirtual

Reimplemented from BeamDistributionItem.

Definition at line 94 of file SpecularBeamInclinationItem.cpp.

{
    return Units::deg;
}

selectPointwiseAxis()

void SpecularBeamInclinationItem::selectPointwiseAxis

(

)

Definition at line 124 of file SpecularBeamInclinationItem.cpp.

{
    ASSERT(pointwiseAlphaAxisDefined());
    m_currentAxisIsUniformAxis = false;
}

References m_currentAxisIsUniformAxis, and pointwiseAlphaAxisDefined().

Referenced by InclinationAnglesEditor::onAxisTypeSelected(), and SpecularBeamItem::updateToData().

Here is the call graph for this function:

selectUniformAxis()

void SpecularBeamInclinationItem::selectUniformAxis

(

)

Definition at line 119 of file SpecularBeamInclinationItem.cpp.

{
    m_currentAxisIsUniformAxis = true;
}

References m_currentAxisIsUniformAxis.

Referenced by InclinationAnglesEditor::onAxisTypeSelected(), and SpecularBeamItem::updateToData().

serialize()

void SpecularBeamInclinationItem::serialize ( Streamer &  s )

overridevirtual

Implements BeamDistributionItem.

Definition at line 76 of file SpecularBeamInclinationItem.cpp.

{
    s.assertVersion(0);
    Serialize::rwSelected<DistributionItemCatalog>(s, m_distribution);
    Serialize::rwValue(s, "currentAxisIsUniformAxis", m_currentAxisIsUniformAxis);
    Serialize::rwInitializable<BasicAxisItem>(s, "uniformAxis", m_uniformAlphaAxis,
                                              setAxisPresentationDefaults);
    Serialize::rwInitializable<PointwiseAxisItem>(s, "pointwiseAxis", m_pointwiseAlphaAxis,
                                                  setAxisPresentationDefaults);
 
    if (s.xmlReader()) {
        m_distribution->setLimits(RealLimits::limited(-90.0, 90.0));
        m_distribution->setUnit(Unit::degree);
        if (m_pointwiseAlphaAxis)
            m_pointwiseAlphaAxis->setOwningInstrument(m_owningInstrument);
    }
}

References Streamer::assertVersion(), degree, m_currentAxisIsUniformAxis, BeamDistributionItem::m_distribution, m_owningInstrument, m_pointwiseAlphaAxis, m_uniformAlphaAxis, Serialize::rwValue(), DistributionItem::setLimits(), DistributionItem::setUnit(), and Streamer::xmlReader().

Here is the call graph for this function:

setDistribution()

void BeamDistributionItem::setDistribution ( DistributionItem *  d )

inherited

Definition at line 70 of file BeamDistributionItem.cpp.

{
    m_distribution.set(d);
}

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

Here is the call graph for this function:

setDistributionType()

template<typename T >

T * BeamDistributionItem::setDistributionType

inherited

Definition at line 52 of file BeamDistributionItem.h.

{
    m_distribution.set<T>();
    return dynamic_cast<T*>(m_distribution.get());
}

References SelectionProperty< T >::get(), BeamDistributionItem::m_distribution, and SelectionProperty< T >::set().

Here is the call graph for this function:

uniformAlphaAxisSelected()

bool SpecularBeamInclinationItem::uniformAlphaAxisSelected

(

)

const

True if uniform axis is selected.

Definition at line 114 of file SpecularBeamInclinationItem.cpp.

{
    return m_currentAxisIsUniformAxis;
}

References m_currentAxisIsUniformAxis.

Referenced by SpecularInstrumentItem::alignedWith().

Member Data Documentation

m_currentAxisIsUniformAxis

bool SpecularBeamInclinationItem::m_currentAxisIsUniformAxis

private

Definition at line 59 of file SpecularBeamInclinationItem.h.

Referenced by SpecularBeamInclinationItem(), alphaAxis(), pointwiseAlphaAxisSelected(), selectPointwiseAxis(), selectUniformAxis(), serialize(), and uniformAlphaAxisSelected().

m_distribution

SelectionProperty<DistributionItem*> BeamDistributionItem::m_distribution

protectedinherited

Definition at line 48 of file BeamDistributionItem.h.

Referenced by BeamAzimuthalAngleItem::BeamAzimuthalAngleItem(), BeamInclinationAngleItem::BeamInclinationAngleItem(), BeamWavelengthItem::BeamWavelengthItem(), SpecularBeamInclinationItem(), BeamDistributionItem::distribution(), BeamDistributionItem::distributionSelection(), BeamDistributionItem::resetToValue(), BeamAzimuthalAngleItem::serialize(), BeamInclinationAngleItem::serialize(), BeamWavelengthItem::serialize(), serialize(), BeamDistributionItem::setDistribution(), and BeamDistributionItem::setDistributionType().

m_owningInstrument

const InstrumentItem* SpecularBeamInclinationItem::m_owningInstrument

private

Definition at line 61 of file SpecularBeamInclinationItem.h.

Referenced by initPointwiseAxis(), and serialize().

m_pointwiseAlphaAxis

std::unique_ptr<PointwiseAxisItem> SpecularBeamInclinationItem::m_pointwiseAlphaAxis

private

Definition at line 58 of file SpecularBeamInclinationItem.h.

Referenced by alphaAxis(), initPointwiseAxis(), pointwiseAlphaAxisDefined(), and serialize().

m_uniformAlphaAxis

std::unique_ptr<BasicAxisItem> SpecularBeamInclinationItem::m_uniformAlphaAxis

private

Definition at line 57 of file SpecularBeamInclinationItem.h.

Referenced by SpecularBeamInclinationItem(), alphaAxis(), initUniformAxis(), and serialize().

---

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

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