SimulationElement Class Reference

Data stucture containing both input and output of a single detector cell. More...

Collaboration diagram for SimulationElement:

Public Member Functions
	SimulationElement ()=delete
	SimulationElement (const SimulationElement &other)
	SimulationElement (double wavelength, double alpha_i, double phi_i, std::unique_ptr< IPixel > pixel, const Eigen::Matrix2cd &beam_polarization, const Eigen::Matrix2cd &analyzer, bool isSpecular_)
	SimulationElement (SimulationElement &&other)
	~SimulationElement ()
void	addIntensity (double intensity)
double	getAlpha (double x, double y) const
double	getAlphaI () const
double	getAlphaMean () const
kvector_t	getKi () const
kvector_t	getMeanKf () const
double	getPhi (double x, double y) const
double	getPhiI () const
double	getPhiMean () const
kvector_t	getQ (double x, double y) const
	Returns scattering vector Q, with Kf determined from in-pixel coordinates x,y. More...
double	integrationFactor (double x, double y) const
double	intensity () const
bool	isSpecular () const
	Tells if simulation element corresponds to a specular peak. More...
kvector_t	meanQ () const
SimulationElement &	operator= (const SimulationElement &)=delete
SimulationElement	pointElement (double x, double y) const
	Returns copy of this SimulationElement with k_f given by in-pixel coordinate x,y. More...
const PolarizationHandler &	polarizationHandler () const
	Returns assigned PolarizationHandler. More...
void	setIntensity (double intensity)
double	solidAngle () const
double	wavelength () const

Private Member Functions
kvector_t	getKf (double x, double y) const
	Returns outgoing wavevector Kf for in-pixel coordinates x,y. More...

Private Attributes
const double	m_alpha_i
	incident grazing angle More...
double	m_intensity
	simulated intensity for detector cell More...
const bool	m_is_specular
const kvector_t	m_k_i
	cached value of k_i More...
const kvector_t	m_mean_kf
	cached value of mean_kf More...
const double	m_phi_i
	incident angle in xy plane More...
std::unique_ptr< IPixel >	m_pixel
const PolarizationHandler	m_polarization
const double	m_wavelength
	wavelength of beam More...

Detailed Description

Data stucture containing both input and output of a single detector cell.

Definition at line 32 of file SimulationElement.h.

Constructor & Destructor Documentation

SimulationElement() [1/4]

SimulationElement::SimulationElement ( )

delete

SimulationElement() [2/4]

SimulationElement::SimulationElement	(	double	wavelength,
		double	alpha_i,
		double	phi_i,
		std::unique_ptr< IPixel >	pixel,
		const Eigen::Matrix2cd &	beam_polarization,
		const Eigen::Matrix2cd &	analyzer,
		bool	isSpecular_
	)

Definition at line 19 of file SimulationElement.cpp.

    : m_polarization(beam_polarization, analyzer)
    , m_wavelength(wavelength)
    , m_alpha_i(alpha_i)
    , m_phi_i(phi_i)
    , m_k_i(vecOfLambdaAlphaPhi(m_wavelength, m_alpha_i, m_phi_i))
    , m_mean_kf(pixel->getK(0.5, 0.5, m_wavelength))
    , m_pixel(std::move(pixel))
    , m_is_specular(isSpecular_)
    , m_intensity(0.0)
{
}

SimulationElement() [3/4]

SimulationElement::SimulationElement

(

const SimulationElement &

other

)

Definition at line 35 of file SimulationElement.cpp.

    : m_polarization(other.m_polarization)
    , m_wavelength(other.m_wavelength)
    , m_alpha_i(other.m_alpha_i)
    , m_phi_i(other.m_phi_i)
    , m_k_i(other.m_k_i)
    , m_mean_kf(other.m_mean_kf)
    , m_pixel(std::move(other.m_pixel->clone()))
    , m_is_specular(other.m_is_specular)
    , m_intensity(other.m_intensity)
{
}

SimulationElement() [4/4]

SimulationElement::SimulationElement ( SimulationElement &&  other )

default

~SimulationElement()

SimulationElement::~SimulationElement ( )

default

Member Function Documentation

addIntensity()

void SimulationElement::addIntensity ( double  intensity )

inline

Definition at line 55 of file SimulationElement.h.

{ m_intensity += intensity; }

References intensity(), and m_intensity.

Referenced by ParticleLayoutComputation::compute(), and RoughMultiLayerComputation::compute().

Here is the call graph for this function:

getAlpha()

double SimulationElement::getAlpha	(	double	x,
		double	y
	)		const

Definition at line 92 of file SimulationElement.cpp.

{
    return M_PI_2 - getKf(x, y).theta();
}

References getKf(), M_PI_2, and BasicVector3D< T >::theta().

Referenced by getAlphaMean().

Here is the call graph for this function:

getAlphaI()

double SimulationElement::getAlphaI ( ) const

inline

Definition at line 50 of file SimulationElement.h.

{ return m_alpha_i; }

References m_alpha_i.

Referenced by GISASSpecularComputation::compute(), and ISimulation2D::normalize().

getAlphaMean()

double SimulationElement::getAlphaMean ( ) const

inline

Definition at line 52 of file SimulationElement.h.

{ return getAlpha(0.5, 0.5); }

References getAlpha().

Referenced by RoughMultiLayerComputation::compute().

Here is the call graph for this function:

getKf()

kvector_t SimulationElement::getKf ( double  x, double  y  ) const

private

Returns outgoing wavevector Kf for in-pixel coordinates x,y.

In-pixel coordinates take values from 0 to 1.

Definition at line 75 of file SimulationElement.cpp.

{
    return m_pixel->getK(x, y, m_wavelength);
}

References m_pixel, and m_wavelength.

Referenced by getAlpha(), and getPhi().

getKi()

kvector_t SimulationElement::getKi

(

)

const

Definition at line 63 of file SimulationElement.cpp.

{
    return m_k_i;
}

References m_k_i.

Referenced by FormFactorCoherentPart::evaluate(), FormFactorCoherentPart::evaluatePol(), getQ(), and meanQ().

getMeanKf()

kvector_t SimulationElement::getMeanKf

(

)

const

Definition at line 68 of file SimulationElement.cpp.

{
    return m_mean_kf;
}

References m_mean_kf.

Referenced by FormFactorCoherentPart::evaluate(), FormFactorCoherentPart::evaluatePol(), MatrixFresnelMap::getOutCoefficients(), ScalarFresnelMap::getOutCoefficients(), and meanQ().

getPhi()

double SimulationElement::getPhi	(	double	x,
		double	y
	)		const

Definition at line 97 of file SimulationElement.cpp.

{
    return getKf(x, y).phi();
}

References getKf(), and BasicVector3D< T >::phi().

Referenced by getPhiMean().

Here is the call graph for this function:

getPhiI()

double SimulationElement::getPhiI ( ) const

inline

Definition at line 51 of file SimulationElement.h.

{ return m_phi_i; }

References m_phi_i.

getPhiMean()

double SimulationElement::getPhiMean ( ) const

inline

Definition at line 53 of file SimulationElement.h.

{ return getPhi(0.5, 0.5); }

References getPhi().

Here is the call graph for this function:

getQ()

kvector_t SimulationElement::getQ	(	double	x,
		double	y
	)		const

Returns scattering vector Q, with Kf determined from in-pixel coordinates x,y.

In-pixel coordinates take values from 0 to 1.

Definition at line 87 of file SimulationElement.cpp.

{
    return getKi() - m_pixel->getK(x, y, m_wavelength);
}

References getKi(), m_pixel, and m_wavelength.

Here is the call graph for this function:

integrationFactor()

double SimulationElement::integrationFactor	(	double	x,
		double	y
	)		const

Definition at line 102 of file SimulationElement.cpp.

{
    return m_pixel->integrationFactor(x, y);
}

References m_pixel.

Referenced by IInterferenceFunctionStrategy::evaluate_for_fixed_angles().

intensity()

double SimulationElement::intensity ( ) const

inline

Definition at line 56 of file SimulationElement.h.

{ return m_intensity; }

References m_intensity.

Referenced by ISimulation2D::addBackgroundIntensity(), addIntensity(), ISimulation2D::normalize(), and setIntensity().

isSpecular()

bool SimulationElement::isSpecular ( ) const

inline

Tells if simulation element corresponds to a specular peak.

Definition at line 70 of file SimulationElement.h.

{ return m_is_specular; }

References m_is_specular.

Referenced by GISASSpecularComputation::compute().

meanQ()

kvector_t SimulationElement::meanQ

(

)

const

Definition at line 80 of file SimulationElement.cpp.

{
    return getKi() - getMeanKf();
}

References getKi(), and getMeanKf().

Referenced by RoughMultiLayerComputation::compute(), DecouplingApproximationStrategy::polarizedCalculation(), SSCApproximationStrategy::polarizedCalculation(), DecouplingApproximationStrategy::scalarCalculation(), and SSCApproximationStrategy::scalarCalculation().

Here is the call graph for this function:

operator=()

SimulationElement& SimulationElement::operator= ( const SimulationElement &  )

delete

pointElement()

SimulationElement SimulationElement::pointElement	(	double	x,
		double	y
	)		const

Returns copy of this SimulationElement with k_f given by in-pixel coordinate x,y.

Definition at line 52 of file SimulationElement.cpp.

{
    return {m_wavelength,
            m_alpha_i,
            m_phi_i,
            std::unique_ptr<IPixel>(m_pixel->createZeroSizePixel(x, y)), // TODO simplify
            m_polarization.getPolarization(),
            m_polarization.getAnalyzerOperator(),
            m_is_specular};
}

References PolarizationHandler::getAnalyzerOperator(), PolarizationHandler::getPolarization(), m_alpha_i, m_is_specular, m_phi_i, m_pixel, m_polarization, and m_wavelength.

Referenced by IInterferenceFunctionStrategy::evaluate_for_fixed_angles().

Here is the call graph for this function:

polarizationHandler()

const PolarizationHandler& SimulationElement::polarizationHandler ( ) const

inline

Returns assigned PolarizationHandler.

Definition at line 47 of file SimulationElement.h.

{ return m_polarization; }

References m_polarization.

Referenced by DecouplingApproximationStrategy::polarizedCalculation(), and SSCApproximationStrategy::polarizedCalculation().

setIntensity()

void SimulationElement::setIntensity ( double  intensity )

inline

Definition at line 54 of file SimulationElement.h.

{ m_intensity = intensity; }

References intensity(), and m_intensity.

Referenced by ISimulation2D::addBackgroundIntensity(), GISASSpecularComputation::compute(), and ISimulation2D::normalize().

Here is the call graph for this function:

solidAngle()

double SimulationElement::solidAngle

(

)

const

Definition at line 107 of file SimulationElement.cpp.

{
    return m_pixel->solidAngle();
}

References m_pixel.

Referenced by GISASSpecularComputation::compute(), IInterferenceFunctionStrategy::evaluate(), and ISimulation2D::normalize().

wavelength()

double SimulationElement::wavelength ( ) const

inline

Definition at line 49 of file SimulationElement.h.

{ return m_wavelength; }

References m_wavelength.

Referenced by RoughMultiLayerComputation::compute(), FormFactorCoherentPart::evaluate(), and FormFactorCoherentPart::evaluatePol().

Member Data Documentation

m_alpha_i

const double SimulationElement::m_alpha_i

private

incident grazing angle

Definition at line 77 of file SimulationElement.h.

Referenced by getAlphaI(), and pointElement().

m_intensity

double SimulationElement::m_intensity

private

simulated intensity for detector cell

Definition at line 83 of file SimulationElement.h.

Referenced by addIntensity(), intensity(), and setIntensity().

m_is_specular

const bool SimulationElement::m_is_specular

private

Definition at line 82 of file SimulationElement.h.

Referenced by isSpecular(), and pointElement().

m_k_i

const kvector_t SimulationElement::m_k_i

private

cached value of k_i

Definition at line 79 of file SimulationElement.h.

Referenced by getKi().

m_mean_kf

const kvector_t SimulationElement::m_mean_kf

private

cached value of mean_kf

Definition at line 80 of file SimulationElement.h.

Referenced by getMeanKf().

m_phi_i

const double SimulationElement::m_phi_i

private

incident angle in xy plane

Definition at line 78 of file SimulationElement.h.

Referenced by getPhiI(), and pointElement().

m_pixel

std::unique_ptr<IPixel> SimulationElement::m_pixel

mutableprivate

Definition at line 81 of file SimulationElement.h.

Referenced by getKf(), getQ(), integrationFactor(), pointElement(), and solidAngle().

m_polarization

const PolarizationHandler SimulationElement::m_polarization

private

Definition at line 75 of file SimulationElement.h.

Referenced by pointElement(), and polarizationHandler().

m_wavelength

const double SimulationElement::m_wavelength

private

wavelength of beam

Definition at line 76 of file SimulationElement.h.

Referenced by getKf(), getQ(), pointElement(), and wavelength().

---

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

• /home/www/ba/Base/Pixel/SimulationElement.h
• /home/www/ba/Base/Pixel/SimulationElement.cpp