BornAgain  1.19.79
Simulate and fit neutron and x-ray scattering at grazing incidence
SymmetricResolutionItem Class Referenceabstract

Description

Definition at line 70 of file DistributionItems.h.

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

Public Member Functions

 SymmetricResolutionItem (double mean, int decimals=3, const QString &meanLabel="Mean")
 
virtual std::unique_ptr< IDistribution1D > createDistribution (double scale=1.0) const =0
 
virtual std::unique_ptr< IRangedDistribution > createIRangedDistribution (double scale) const =0
 
virtual double deviation (double scale) const =0
 
virtual DoubleDescriptors distributionValues (bool withMean=true) const =0
 
 DOUBLE_PROPERTY (mean, Mean)
 
 DOUBLE_PROPERTY (sigmaFactor, SigmaFactor)
 
bool hasSigmaFactor () const
 
virtual void initDistribution (double)
 
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

◆ SymmetricResolutionItem()

SymmetricResolutionItem::SymmetricResolutionItem ( double  mean,
int  decimals = 3,
const QString &  meanLabel = "Mean" 
)

Definition at line 69 of file DistributionItems.cpp.

71 {
72  m_mean.init(meanLabel, "", mean, Unit::unitless, decimals, RealLimits::limitless(), "mean");
73  addToSerialization(&m_mean);
74 }
@ unitless
void addToSerialization(DoubleProperty *d)

References DistributionItem::addToSerialization(), and unitless.

Here is the call graph for this function:

Member Function Documentation

◆ addToSerialization()

◆ createDistribution()

virtual std::unique_ptr<IDistribution1D> DistributionItem::createDistribution ( double  scale = 1.0) const
pure virtualinherited

◆ createIRangedDistribution()

virtual std::unique_ptr<IRangedDistribution> SymmetricResolutionItem::createIRangedDistribution ( double  scale) const
pure virtual

◆ deviation()

virtual double SymmetricResolutionItem::deviation ( double  scale) const
pure virtual

◆ distributionValues()

virtual DoubleDescriptors DistributionItem::distributionValues ( bool  withMean = true) const
pure virtualinherited

◆ DOUBLE_PROPERTY() [1/2]

SymmetricResolutionItem::DOUBLE_PROPERTY ( mean  ,
Mean   
)

◆ DOUBLE_PROPERTY() [2/2]

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

virtual void DistributionItem::initDistribution ( double  )
inlinevirtualinherited

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

Definition at line 62 of file DistributionItems.cpp.

63 {
64  return m_limits;
65 }

References DistributionItem::m_limits.

Referenced by DistributionPlot::plot_multiple_values(), DistributionItem::setLimits(), and 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.

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 SymmetricResolutionItem::setLimits ( const RealLimits &  limits)
overridevirtual

Reimplemented from DistributionItem.

Definition at line 81 of file DistributionItems.cpp.

82 {
84  m_mean.setLimits(limits);
85 }
RealLimits limits() const
virtual void setLimits(const RealLimits &limits)

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

Here is the call graph for this function:

◆ setMeanDecimals()

void SymmetricResolutionItem::setMeanDecimals ( uint  d)

Definition at line 87 of file DistributionItems.cpp.

88 {
89  m_mean.setDecimals(d);
90 }

◆ setUnit()

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

Set the unit of the distributed value.

Implements DistributionItem.

Reimplemented in DistributionCosineItem, DistributionGaussianItem, and DistributionLorentzItem.

Definition at line 76 of file DistributionItems.cpp.

77 {
78  m_mean.setUnit(unit);
79 }

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

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