DistributionLorentzItem Class Reference

Description

Definition at line 111 of file DistributionItems.h.

Inheritance diagram for DistributionLorentzItem:

Collaboration diagram for DistributionLorentzItem:

Public Member Functions
	DistributionLorentzItem ()
std::unique_ptr< IDistribution1D >	createDistribution (double scale=1.0) const override
std::unique_ptr< IRangedDistribution >	createIRangedDistribution (double scale) const override
double	deviation (double scale) const override
DoubleDescriptors	distributionValues (bool withMean=true) const override
	DOUBLE_PROPERTY (hwhm, Hwhm)
	DOUBLE_PROPERTY (mean, Mean)
	DOUBLE_PROPERTY (sigmaFactor, SigmaFactor)
bool	hasSigmaFactor () const
void	initDistribution (double value) override
template<typename T >
bool	is () const
RealLimits	limits () const
void	serialize (Streamer &s)
	Serialization of contents. More...
void	setLimits (const RealLimits &limits) override
void	setMeanDecimals (uint d)
void	setUnit (const variant< QString, Unit > &unit) override
	Set the unit of the distributed value. More...
	UINT_PROPERTY (numberOfSamples, NumberOfSamples)

Protected Member Functions
void	addToSerialization (DoubleProperty *d)
void	initSigmaFactor ()

Protected Attributes
RealLimits	m_limits

Private Attributes
QVector< DoubleProperty * >	m_serializationProperties

Constructor & Destructor Documentation

DistributionLorentzItem()

DistributionLorentzItem::DistributionLorentzItem

(

)

Definition at line 168 of file DistributionItems.cpp.

    : SymmetricResolutionItem(1.0)
{
    initSigmaFactor();
 
    m_hwhm.init("HWHM", "", 1.0, Unit::unitless, "hwhm");
    addToSerialization(&m_hwhm);
}

References DistributionItem::addToSerialization(), DistributionItem::initSigmaFactor(), and unitless.

Here is the call graph for this function:

Member Function Documentation

addToSerialization()

void DistributionItem::addToSerialization ( DoubleProperty *  d )

protectedinherited

Definition at line 40 of file DistributionItems.cpp.

{
    m_serializationProperties << d;
}

References DistributionItem::m_serializationProperties.

Referenced by DistributionCosineItem::DistributionCosineItem(), DistributionGateItem::DistributionGateItem(), DistributionGaussianItem::DistributionGaussianItem(), DistributionLogNormalItem::DistributionLogNormalItem(), DistributionLorentzItem(), DistributionTrapezoidItem::DistributionTrapezoidItem(), SymmetricResolutionItem::SymmetricResolutionItem(), and DistributionItem::initSigmaFactor().

createDistribution()

std::unique_ptr< IDistribution1D > DistributionLorentzItem::createDistribution ( double  scale = 1.0 ) const

overridevirtual

Implements DistributionItem.

Definition at line 183 of file DistributionItems.cpp.

{
    return std::make_unique<DistributionLorentz>(scale * m_mean, scale * m_hwhm);
}

createIRangedDistribution()

std::unique_ptr< IRangedDistribution > DistributionLorentzItem::createIRangedDistribution ( double  scale ) const

overridevirtual

Implements SymmetricResolutionItem.

Definition at line 189 of file DistributionItems.cpp.

{
    return std::make_unique<RangedDistributionLorentz>(numberOfSamples(), sigmaFactor(),
                                                       m_limits.scaledLimits(scale));
}

References DistributionItem::m_limits.

deviation()

double DistributionLorentzItem::deviation ( double  scale ) const

overridevirtual

Implements SymmetricResolutionItem.

Definition at line 195 of file DistributionItems.cpp.

{
    return m_hwhm * scale;
}

distributionValues()

DoubleDescriptors DistributionLorentzItem::distributionValues ( bool  withMean = true ) const

overridevirtual

Implements DistributionItem.

Definition at line 211 of file DistributionItems.cpp.

{
    return withMean ? DoubleDescriptors{mean(), hwhm(), sigmaFactor()}
                    : DoubleDescriptors{hwhm(), sigmaFactor()};
}

DOUBLE_PROPERTY() [1/3]

DistributionLorentzItem::DOUBLE_PROPERTY	(	hwhm	,
		Hwhm
	)

DOUBLE_PROPERTY() [2/3]

SymmetricResolutionItem::DOUBLE_PROPERTY ( mean  , Mean    )

inherited

DOUBLE_PROPERTY() [3/3]

DistributionItem::DOUBLE_PROPERTY ( sigmaFactor  , SigmaFactor    )

inherited

hasSigmaFactor()

bool DistributionItem::hasSigmaFactor ( ) const

inherited

Definition at line 45 of file DistributionItems.cpp.

{
    return m_sigmaFactor.isInitialized();
}

Referenced by DistributionPlot::plot_multiple_values().

initDistribution()

void DistributionLorentzItem::initDistribution ( double  value )

overridevirtual

Reimplemented from DistributionItem.

Definition at line 200 of file DistributionItems.cpp.

{
    double hw(0.1 * std::abs(value));
    if (hw == 0.0)
        hw = 0.1;
 
    setMean(value);
    setHwhm(hw);
    m_hwhm.setLimits(RealLimits::lowerLimited(0.0));
}

initSigmaFactor()

void DistributionItem::initSigmaFactor ( )

protectedinherited

Definition at line 34 of file DistributionItems.cpp.

{
    m_sigmaFactor.init("Sigma factor", "", 2.0, Unit::unitless, "sigmaFactor");
    addToSerialization(&m_sigmaFactor);
}

References DistributionItem::addToSerialization(), and unitless.

Referenced by DistributionCosineItem::DistributionCosineItem(), DistributionGaussianItem::DistributionGaussianItem(), DistributionLogNormalItem::DistributionLogNormalItem(), and DistributionLorentzItem().

Here is the call graph for this function:

is()

template<typename T >

bool DistributionItem::is ( ) const

inlineinherited

Definition at line 33 of file DistributionItems.h.

    {
        return dynamic_cast<const T*>(this) != nullptr;
    }

Referenced by DistributionPlot::plot_distributions(), DistributionPlot::plot_multiple_values(), and DistributionPlot::plot_single_value().

limits()

RealLimits DistributionItem::limits ( ) const

inherited

Definition at line 62 of file DistributionItems.cpp.

{
    return m_limits;
}

References DistributionItem::m_limits.

Referenced by DistributionPlot::plot_multiple_values(), DistributionItem::setLimits(), and SymmetricResolutionItem::setLimits().

serialize()

void DistributionItem::serialize ( Streamer &  s )

inherited

Serialization of contents.

Important: limits and a changed unit (with setUnit) will not be serialized here. They have to be set again by the owner of DistributionItem after reading it

Definition at line 50 of file DistributionItems.cpp.

{
    s.assertVersion(0);
    Serialize::rwProperty(s, m_numberOfSamples);
 
    for (auto* p : m_serializationProperties)
        Serialize::rwProperty(s, *p);
 
    // m_limits and a changed unit (with setUnit) will not be serialized here. They have to be set
    // again by the owner of DistributionItem after reading it
}

References Streamer::assertVersion(), DistributionItem::m_serializationProperties, and Serialize::rwProperty().

Here is the call graph for this function:

setLimits()

void SymmetricResolutionItem::setLimits ( const RealLimits &  limits )

overridevirtualinherited

Reimplemented from DistributionItem.

Definition at line 81 of file DistributionItems.cpp.

{
    DistributionItem::setLimits(limits);
    m_mean.setLimits(limits);
}

References DistributionItem::limits(), and DistributionItem::setLimits().

Here is the call graph for this function:

setMeanDecimals()

void SymmetricResolutionItem::setMeanDecimals ( uint  d )

inherited

Definition at line 87 of file DistributionItems.cpp.

{
    m_mean.setDecimals(d);
}

setUnit()

void DistributionLorentzItem::setUnit ( const variant< QString, Unit > &  unit )

overridevirtual

Set the unit of the distributed value.

Reimplemented from SymmetricResolutionItem.

Definition at line 177 of file DistributionItems.cpp.

{
    SymmetricResolutionItem::setUnit(unit);
    m_hwhm.setUnit(unit);
}

References SymmetricResolutionItem::setUnit().

Here is the call graph for this function:

UINT_PROPERTY()

DistributionItem::UINT_PROPERTY ( numberOfSamples  , NumberOfSamples    )

inherited

Member Data Documentation

m_limits

RealLimits DistributionItem::m_limits

protectedinherited

Definition at line 64 of file DistributionItems.h.

Referenced by createIRangedDistribution(), DistributionGaussianItem::createIRangedDistribution(), DistributionCosineItem::createIRangedDistribution(), DistributionItem::limits(), and DistributionItem::setLimits().

m_serializationProperties

QVector<DoubleProperty*> DistributionItem::m_serializationProperties

privateinherited

Definition at line 67 of file DistributionItems.h.

Referenced by DistributionItem::addToSerialization(), and DistributionItem::serialize().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/Descriptor/DistributionItems.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/Descriptor/DistributionItems.cpp