Profile2DVoigtItem Class Reference

Description

Definition at line 129 of file ProfileItems.h.

Inheritance diagram for Profile2DVoigtItem:

Collaboration diagram for Profile2DVoigtItem:

Public Member Functions
	Profile2DVoigtItem ()
std::unique_ptr< IProfile2D >	createProfile () const override
DoubleDescriptor	eta () const
DoubleDescriptor	gamma () const
DoubleDescriptor	omegaX () const
DoubleDescriptor	omegaY () const
void	serialize (Streamer &s) override
void	setEta (double eta)
void	setGamma (double gamma)
void	setOmegaX (double omega_x)
void	setOmegaY (double omega_y)
DoubleDescriptors	valueDescriptors () const override

Protected Attributes
DoubleProperty	m_gamma
DoubleProperty	m_omegaX
DoubleProperty	m_omegaY

Private Attributes
DoubleProperty	m_eta

Constructor & Destructor Documentation

Profile2DVoigtItem()

Profile2DVoigtItem::Profile2DVoigtItem

(

)

Definition at line 192 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< IProfile2D > Profile2DVoigtItem::createProfile ( ) const

overridevirtual

Implements Profile2DItem.

Definition at line 198 of file ProfileItems.cpp.

{
    return std::make_unique<Profile2DVoigt>(omegaX(), omegaY(), Units::deg2rad(gamma()), m_eta);
}

References Profile2DItem::gamma(), m_eta, Profile2DItem::omegaX(), and Profile2DItem::omegaY().

Here is the call graph for this function:

eta()

DoubleDescriptor Profile2DVoigtItem::eta

(

)

const

Definition at line 212 of file ProfileItems.cpp.

{
    return m_eta;
}

References m_eta.

Referenced by setEta(), and valueDescriptors().

gamma()

DoubleDescriptor Profile2DItem::gamma ( ) const

inherited

Definition at line 147 of file ProfileItems.cpp.

{
    return m_gamma;
}

References Profile2DItem::m_gamma.

Referenced by Profile2DCauchyItem::createProfile(), Profile2DGaussItem::createProfile(), Profile2DGateItem::createProfile(), Profile2DConeItem::createProfile(), createProfile(), Profile2DItem::setGamma(), Profile2DItem::valueDescriptors(), and valueDescriptors().

omegaX()

DoubleDescriptor Profile2DItem::omegaX ( ) const

inherited

Definition at line 127 of file ProfileItems.cpp.

{
    return m_omegaX;
}

References Profile2DItem::m_omegaX.

Referenced by Profile2DCauchyItem::createProfile(), Profile2DGaussItem::createProfile(), Profile2DGateItem::createProfile(), Profile2DConeItem::createProfile(), createProfile(), Profile2DItem::valueDescriptors(), and valueDescriptors().

omegaY()

DoubleDescriptor Profile2DItem::omegaY ( ) const

inherited

Definition at line 137 of file ProfileItems.cpp.

{
    return m_omegaY;
}

References Profile2DItem::m_omegaY.

Referenced by Profile2DCauchyItem::createProfile(), Profile2DGaussItem::createProfile(), Profile2DGateItem::createProfile(), Profile2DConeItem::createProfile(), createProfile(), Profile2DItem::valueDescriptors(), and valueDescriptors().

serialize()

void Profile2DVoigtItem::serialize ( Streamer &  s )

overridevirtual

Reimplemented from Profile2DItem.

Definition at line 203 of file ProfileItems.cpp.

{
    s.assertVersion(0);
    Serialize::rwProperty(s, m_omegaX);
    Serialize::rwProperty(s, m_omegaY);
    Serialize::rwProperty(s, m_gamma);
    Serialize::rwProperty(s, m_eta);
}

References Streamer::assertVersion(), m_eta, Profile2DItem::m_gamma, Profile2DItem::m_omegaX, Profile2DItem::m_omegaY, and Serialize::rwProperty().

Here is the call graph for this function:

setEta()

void Profile2DVoigtItem::setEta

(

double

eta

)

Definition at line 217 of file ProfileItems.cpp.

{
    m_eta.set(eta);
}

References eta(), m_eta, and DoubleProperty::set().

Here is the call graph for this function:

setGamma()

void Profile2DItem::setGamma ( double  gamma )

inherited

Definition at line 152 of file ProfileItems.cpp.

{
    m_gamma.set(gamma);
}

References Profile2DItem::gamma(), Profile2DItem::m_gamma, and DoubleProperty::set().

Here is the call graph for this function:

setOmegaX()

void Profile2DItem::setOmegaX ( double  omega_x )

inherited

Definition at line 132 of file ProfileItems.cpp.

{
    m_omegaX.set(omega_x);
}

References Profile2DItem::m_omegaX, and DoubleProperty::set().

Here is the call graph for this function:

setOmegaY()

void Profile2DItem::setOmegaY ( double  omega_y )

inherited

Definition at line 142 of file ProfileItems.cpp.

{
    m_omegaY.set(omega_y);
}

References Profile2DItem::m_omegaY, and DoubleProperty::set().

Here is the call graph for this function:

valueDescriptors()

DoubleDescriptors Profile2DVoigtItem::valueDescriptors ( ) const

overridevirtual

Reimplemented from Profile2DItem.

Definition at line 222 of file ProfileItems.cpp.

{
    return {omegaX(), omegaY(), eta(), gamma()};
}

References eta(), Profile2DItem::gamma(), Profile2DItem::omegaX(), and Profile2DItem::omegaY().

Here is the call graph for this function:

Member Data Documentation

m_eta

DoubleProperty Profile2DVoigtItem::m_eta

private

Definition at line 141 of file ProfileItems.h.

Referenced by Profile2DVoigtItem(), createProfile(), eta(), serialize(), and setEta().

m_gamma

DoubleProperty Profile2DItem::m_gamma

protectedinherited

Definition at line 106 of file ProfileItems.h.

Referenced by Profile2DItem::Profile2DItem(), Profile2DItem::gamma(), Profile2DItem::serialize(), serialize(), and Profile2DItem::setGamma().

m_omegaX

DoubleProperty Profile2DItem::m_omegaX

protectedinherited

Definition at line 104 of file ProfileItems.h.

Referenced by Profile2DItem::Profile2DItem(), Profile2DItem::omegaX(), Profile2DItem::serialize(), serialize(), and Profile2DItem::setOmegaX().

m_omegaY

DoubleProperty Profile2DItem::m_omegaY

protectedinherited

Definition at line 105 of file ProfileItems.h.

Referenced by Profile2DItem::Profile2DItem(), Profile2DItem::omegaY(), Profile2DItem::serialize(), serialize(), and Profile2DItem::setOmegaY().

---

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