Profile1DVoigtItem Class Reference

Description

Definition at line 70 of file ProfileItems.h.

Inheritance diagram for Profile1DVoigtItem:

Collaboration diagram for Profile1DVoigtItem:

Public Member Functions
	Profile1DVoigtItem ()
std::unique_ptr< IProfile1D >	createProfile () const override
DoubleDescriptor	eta () const
DoubleDescriptor	omega () const
void	serialize (Streamer &s) override
DoubleDescriptors	valueDescriptors () const override

Protected Attributes
DoubleProperty	m_omega

Private Attributes
DoubleProperty	m_eta

Static Private Attributes
static constexpr auto	P_OMEGA {"Omega"}

Constructor & Destructor Documentation

Profile1DVoigtItem()

Profile1DVoigtItem::Profile1DVoigtItem

(

)

Definition at line 77 of file ProfileItems.cpp.

{
    m_eta.init("Eta", "Parameter [0,1] to balance between Cauchy (eta=0.0) and Gauss (eta=1.0)",
               0.5, Unit::unitless, 3, RealLimits::limited(0.0, 1.0), "eta");
}

References DoubleProperty::init(), m_eta, and unitless.

Here is the call graph for this function:

Member Function Documentation

createProfile()

std::unique_ptr< IProfile1D > Profile1DVoigtItem::createProfile ( ) const

overridevirtual

Implements Profile1DItem.

Definition at line 83 of file ProfileItems.cpp.

{
    return std::make_unique<Profile1DVoigt>(omega(), m_eta);
}

References m_eta, and Profile1DItem::omega().

Here is the call graph for this function:

eta()

DoubleDescriptor Profile1DVoigtItem::eta

(

)

const

Definition at line 95 of file ProfileItems.cpp.

{
    return m_eta;
}

References m_eta.

Referenced by valueDescriptors().

omega()

DoubleDescriptor Profile1DItem::omega ( ) const

inherited

Definition at line 30 of file ProfileItems.cpp.

{
    return m_omega;
}

References Profile1DItem::m_omega.

Referenced by Profile1DCauchyItem::createProfile(), Profile1DGaussItem::createProfile(), Profile1DGateItem::createProfile(), Profile1DTriangleItem::createProfile(), Profile1DCosineItem::createProfile(), createProfile(), and Profile1DItem::valueDescriptors().

serialize()

void Profile1DVoigtItem::serialize ( Streamer &  s )

overridevirtual

Reimplemented from Profile1DItem.

Definition at line 88 of file ProfileItems.cpp.

{
    s.assertVersion(0);
    Serialize::rwProperty(s, m_omega);
    Serialize::rwProperty(s, m_eta);
}

References Streamer::assertVersion(), m_eta, Profile1DItem::m_omega, and Serialize::rwProperty().

Here is the call graph for this function:

valueDescriptors()

DoubleDescriptors Profile1DVoigtItem::valueDescriptors ( ) const

overridevirtual

Reimplemented from Profile1DItem.

Definition at line 100 of file ProfileItems.cpp.

{
    return Profile1DItem::valueDescriptors() + DoubleDescriptors{eta()};
}

References eta(), and Profile1DItem::valueDescriptors().

Here is the call graph for this function:

Member Data Documentation

m_eta

DoubleProperty Profile1DVoigtItem::m_eta

private

Definition at line 80 of file ProfileItems.h.

Referenced by Profile1DVoigtItem(), createProfile(), eta(), and serialize().

m_omega

DoubleProperty Profile1DItem::m_omega

protectedinherited

Definition at line 42 of file ProfileItems.h.

Referenced by Profile1DItem::Profile1DItem(), Profile1DItem::omega(), Profile1DItem::serialize(), and serialize().

P_OMEGA

constexpr auto Profile1DItem::P_OMEGA {"Omega"}

staticconstexprprivateinherited

Definition at line 28 of file ProfileItems.h.

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/Sample/ProfileItems.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/Sample/ProfileItems.cpp