BeamWavelengthItem Class Reference

Description

Definition at line 20 of file BeamWavelengthItem.h.

Inheritance diagram for BeamWavelengthItem:

Collaboration diagram for BeamWavelengthItem:

Public Member Functions
	BeamWavelengthItem ()
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
void	serialize (Streamer &s) override
void	setDistribution (DistributionItem *d)
template<typename T >
T *	setDistributionType ()
double	wavelength () const
	Returns wavelength. In the case of distribution applied, returns its mean. More...

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

Protected Attributes
SelectionProperty< DistributionItem * >	m_distribution

Constructor & Destructor Documentation

BeamWavelengthItem() [1/2]

BeamWavelengthItem::BeamWavelengthItem

(

)

Definition at line 43 of file BeamWavelengthItem.cpp.

    : BeamWavelengthItem(false)
{
}

BeamWavelengthItem() [2/2]

BeamWavelengthItem::BeamWavelengthItem ( bool  onlySymmetricDistributions )

protected

Definition at line 48 of file BeamWavelengthItem.cpp.

{
    m_distribution.initWithInitializer<DistributionItemCatalog>(
        "Distribution", "", "distribution",
        onlySymmetricDistributions ? DistributionItemCatalog::symmetricTypes()
                                   : DistributionItemCatalog::types(),
        initDistribution);
}

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

Here is the call graph for this function:

Member Function Documentation

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:

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 wavelength().

Here is the call graph for this function:

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 BeamDistributionItem::scaleFactor ( ) const

virtualinherited

Reimplemented in SpecularBeamInclinationItem, BeamInclinationAngleItem, and BeamAzimuthalAngleItem.

Definition at line 55 of file BeamDistributionItem.cpp.

{
    return 1.0;
}

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

serialize()

void BeamWavelengthItem::serialize ( Streamer &  s )

overridevirtual

Implements BeamDistributionItem.

Definition at line 57 of file BeamWavelengthItem.cpp.

{
    s.assertVersion(0);
    Serialize::rwSelected<DistributionItemCatalog>(s, m_distribution);
 
    if (s.xmlReader()) {
        m_distribution->setLimits(RealLimits::positive());
        m_distribution->setUnit(Unit::nanometer);
    }
}

References Streamer::assertVersion(), BeamDistributionItem::m_distribution, nanometer, 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:

wavelength()

double BeamWavelengthItem::wavelength

(

)

const

Returns wavelength. In the case of distribution applied, returns its mean.

Definition at line 68 of file BeamWavelengthItem.cpp.

{
    return BeamDistributionItem::meanValue();
}

References BeamDistributionItem::meanValue().

Referenced by SpecularBeamWavelengthItem::setToRange().

Here is the call graph for this function:

Member Data Documentation

m_distribution

SelectionProperty<DistributionItem*> BeamDistributionItem::m_distribution

protectedinherited

Definition at line 48 of file BeamDistributionItem.h.

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

---

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

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