BornAgain  1.19.79
Simulate and fit neutron and x-ray scattering at grazing incidence
DistributionLogNormalItem Class Reference

Description

Definition at line 143 of file DistributionItems.h.

Inheritance diagram for DistributionLogNormalItem:
[legend]
Collaboration diagram for DistributionLogNormalItem:
[legend]

Public Member Functions

 DistributionLogNormalItem ()
 
std::unique_ptr< IDistribution1D > createDistribution (double scale=1.0) const override
 
DoubleDescriptors distributionValues (bool withMean=true) const override
 
 DOUBLE_PROPERTY (median, Median)
 
 DOUBLE_PROPERTY (scaleParameter, ScaleParameter)
 
 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...
 
virtual void setLimits (const RealLimits &limits)
 
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

◆ DistributionLogNormalItem()

DistributionLogNormalItem::DistributionLogNormalItem ( )

Definition at line 270 of file DistributionItems.cpp.

271 {
272  initSigmaFactor();
273 
274  m_median.init("Median", "", 1.0, Unit::unitless, "median");
275  m_scaleParameter.init("ScaleParameter", "", 1.0, Unit::unitless, 3,
276  RealLimits::lowerLimited(0.0), "scalePar");
277 
278  addToSerialization(&m_median);
279  addToSerialization(&m_scaleParameter);
280 }
@ unitless
void addToSerialization(DoubleProperty *d)

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

Here is the call graph for this function:

Member Function Documentation

◆ addToSerialization()

◆ createDistribution()

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

Implements DistributionItem.

Definition at line 287 of file DistributionItems.cpp.

288 {
289  return std::make_unique<DistributionLogNormal>(scale * median(), scaleParameter());
290 }

◆ distributionValues()

DoubleDescriptors DistributionLogNormalItem::distributionValues ( bool  withMean = true) const
overridevirtual

Implements DistributionItem.

Definition at line 302 of file DistributionItems.cpp.

303 {
304  return {median(), scaleParameter(), sigmaFactor()};
305 }

◆ DOUBLE_PROPERTY() [1/3]

DistributionLogNormalItem::DOUBLE_PROPERTY ( median  ,
Median   
)

◆ DOUBLE_PROPERTY() [2/3]

DistributionLogNormalItem::DOUBLE_PROPERTY ( scaleParameter  ,
ScaleParameter   
)

◆ DOUBLE_PROPERTY() [3/3]

DistributionItem::DOUBLE_PROPERTY ( sigmaFactor  ,
SigmaFactor   
)
inherited

◆ hasSigmaFactor()

bool DistributionItem::hasSigmaFactor ( ) const
inherited

Definition at line 45 of file DistributionItems.cpp.

46 {
47  return m_sigmaFactor.isInitialized();
48 }

Referenced by DistributionPlot::plot_multiple_values().

◆ initDistribution()

void DistributionLogNormalItem::initDistribution ( double  value)
overridevirtual

Reimplemented from DistributionItem.

Definition at line 292 of file DistributionItems.cpp.

293 {
294  double scale(0.1 * std::abs(value));
295  if (scale == 0.0)
296  scale = 0.1;
297 
298  setMedian(value);
299  setScaleParameter(scale);
300 }

◆ initSigmaFactor()

void DistributionItem::initSigmaFactor ( )
protectedinherited

Definition at line 34 of file DistributionItems.cpp.

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

References DistributionItem::addToSerialization(), and unitless.

Referenced by DistributionCosineItem::DistributionCosineItem(), DistributionGaussianItem::DistributionGaussianItem(), DistributionLogNormalItem(), and DistributionLorentzItem::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.

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

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

◆ limits()

RealLimits DistributionItem::limits ( ) const
inherited

◆ 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.

51 {
52  s.assertVersion(0);
53  Serialize::rwProperty(s, m_numberOfSamples);
54 
55  for (auto* p : m_serializationProperties)
56  Serialize::rwProperty(s, *p);
57 
58  // m_limits and a changed unit (with setUnit) will not be serialized here. They have to be set
59  // again by the owner of DistributionItem after reading it
60 }
void assertVersion(unsigned expectedVersion) const
As reader, throws DeserializationException unless the expected version is read. As writer,...
Definition: Streamer.cpp:26
void rwProperty(Streamer &s, DoubleProperty &d)

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

Here is the call graph for this function:

◆ setLimits()

void DistributionItem::setLimits ( const RealLimits &  limits)
virtualinherited

Reimplemented in SymmetricResolutionItem.

Definition at line 29 of file DistributionItems.cpp.

30 {
31  m_limits = limits;
32 }
RealLimits limits() const

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

Referenced by BeamAzimuthalAngleItem::initDistribution(), BeamInclinationAngleItem::initDistribution(), BeamAzimuthalAngleItem::serialize(), BeamInclinationAngleItem::serialize(), BeamWavelengthItem::serialize(), SpecularBeamInclinationItem::serialize(), and SymmetricResolutionItem::setLimits().

Here is the call graph for this function:

◆ setUnit()

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

Set the unit of the distributed value.

Implements DistributionItem.

Definition at line 282 of file DistributionItems.cpp.

283 {
284  m_median.setUnit(unit);
285 }

◆ UINT_PROPERTY()

DistributionItem::UINT_PROPERTY ( numberOfSamples  ,
NumberOfSamples   
)
inherited

Member Data Documentation

◆ m_limits

◆ m_serializationProperties

QVector<DoubleProperty*> DistributionItem::m_serializationProperties
privateinherited

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