BeamDistributionItem Class Reference

Description

The BeamDistributionItem handles wavelength, inclination and azimuthal parameter distribution for BeamItem.

Definition at line 25 of file BeamDistributionItem.h.

Inheritance diagram for BeamDistributionItem:

Collaboration diagram for BeamDistributionItem:

Public Member Functions
virtual	~BeamDistributionItem ()=default
DistributionItem *	distribution () const
SelectionDescriptor< DistributionItem * >	distributionSelection () const
std::unique_ptr< ParameterDistribution >	getParameterDistributionForName (ParameterDistribution::WhichParameter which) const
virtual double	meanValue () const
void	resetToValue (double value)
virtual double	scaleFactor () const
virtual void	serialize (Streamer &s)=0
void	setDistribution (DistributionItem *d)
template<typename T >
T *	setDistributionType ()

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

Protected Attributes
SelectionProperty< DistributionItem * >	m_distribution

Constructor & Destructor Documentation

~BeamDistributionItem()

virtual BeamDistributionItem::~BeamDistributionItem ( )

virtualdefault

Member Function Documentation

createDistribution1D()

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

protectedvirtual

Definition at line 75 of file BeamDistributionItem.cpp.

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

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

Referenced by getParameterDistributionForName(), and meanValue().

Here is the call graph for this function:

distribution()

DistributionItem * BeamDistributionItem::distribution

(

)

const

Definition at line 60 of file BeamDistributionItem.cpp.

{
    return m_distribution.get();
}

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

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

Here is the call graph for this function:

distributionSelection()

SelectionDescriptor< DistributionItem * > BeamDistributionItem::distributionSelection

(

)

const

Definition at line 65 of file BeamDistributionItem.cpp.

{
    return m_distribution;
}

References m_distribution.

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

getParameterDistributionForName()

std::unique_ptr< ParameterDistribution > BeamDistributionItem::getParameterDistributionForName

(

ParameterDistribution::WhichParameter

which

)

const

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 createDistribution1D(), distribution(), and scaleFactor().

Here is the call graph for this function:

meanValue()

double BeamDistributionItem::meanValue ( ) const

virtual

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 createDistribution1D(), distribution(), and scaleFactor().

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

Here is the call graph for this function:

resetToValue()

void BeamDistributionItem::resetToValue

(

double

value

)

Definition at line 48 of file BeamDistributionItem.cpp.

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

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

Here is the call graph for this function:

scaleFactor()

double BeamDistributionItem::scaleFactor ( ) const

virtual

Reimplemented in SpecularBeamInclinationItem, BeamInclinationAngleItem, and BeamAzimuthalAngleItem.

Definition at line 55 of file BeamDistributionItem.cpp.

{
    return 1.0;
}

Referenced by createDistribution1D(), getParameterDistributionForName(), and meanValue().

serialize()

virtual void BeamDistributionItem::serialize ( Streamer &  s )

pure virtual

Implemented in SpecularBeamInclinationItem, BeamWavelengthItem, BeamInclinationAngleItem, and BeamAzimuthalAngleItem.

setDistribution()

void BeamDistributionItem::setDistribution

(

DistributionItem *

d

)

Definition at line 70 of file BeamDistributionItem.cpp.

{
    m_distribution.set(d);
}

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

Here is the call graph for this function:

setDistributionType()

template<typename T >

T * BeamDistributionItem::setDistributionType

Definition at line 52 of file BeamDistributionItem.h.

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

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

Here is the call graph for this function:

Member Data Documentation

m_distribution

SelectionProperty<DistributionItem*> BeamDistributionItem::m_distribution

protected

Definition at line 48 of file BeamDistributionItem.h.

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

---

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

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