PolMatrices Class Reference

Description

Convenience class for handling polarization density matrix and polarization analyzer operator.

Definition at line 29 of file PolMatrices.h.

Collaboration diagram for PolMatrices:

Public Member Functions
	PolMatrices ()
	PolMatrices (SpinMatrix polarization, SpinMatrix analyzer)
const SpinMatrix &	analyzerMatrix () const
	Gets the polarization analyzer operator (in spin basis along z-axis) More...
const SpinMatrix &	polarizerMatrix () const
	Gets the polarization density matrix (in spin basis along z-axis) More...
void	setAnalyzerMatrix (const SpinMatrix &analyzer)
	Sets the polarization analyzer operator (in spin basis along z-axis) More...
void	setPolarizerMatrix (const SpinMatrix &polarization)
	Sets the polarization density matrix (in spin basis along z-axis) More...

Private Attributes
SpinMatrix	m_analyzer_matrix
	polarization analyzer operator More...
SpinMatrix	m_polarizer_matrix
	polarization density matrix More...

Constructor & Destructor Documentation

PolMatrices() [1/2]

PolMatrices::PolMatrices

(

)

Definition at line 20 of file PolMatrices.cpp.

    : m_polarizer_matrix(SpinMatrix::One() / 2.0)
    , m_analyzer_matrix(SpinMatrix::One())
{
}

PolMatrices() [2/2]

PolMatrices::PolMatrices	(	SpinMatrix	polarization,
		SpinMatrix	analyzer
	)

Definition at line 26 of file PolMatrices.cpp.

    : m_polarizer_matrix(std::move(polarization))
    , m_analyzer_matrix(std::move(analyzer))
{
}

Member Function Documentation

analyzerMatrix()

const SpinMatrix& PolMatrices::analyzerMatrix ( ) const

inline

Gets the polarization analyzer operator (in spin basis along z-axis)

Definition at line 44 of file PolMatrices.h.

{ return m_analyzer_matrix; }

References m_analyzer_matrix.

Referenced by DiffuseElement::pointElement(), and SpecularComputation::runProtected().

polarizerMatrix()

const SpinMatrix& PolMatrices::polarizerMatrix ( ) const

inline

Gets the polarization density matrix (in spin basis along z-axis)

Definition at line 38 of file PolMatrices.h.

{ return m_polarizer_matrix; }

References m_polarizer_matrix.

Referenced by DiffuseElement::pointElement(), and SpecularComputation::runProtected().

setAnalyzerMatrix()

void PolMatrices::setAnalyzerMatrix ( const SpinMatrix &  analyzer )

inline

Sets the polarization analyzer operator (in spin basis along z-axis)

Definition at line 41 of file PolMatrices.h.

{ m_analyzer_matrix = analyzer; }

References m_analyzer_matrix.

Referenced by ISpecularScan::polMatrices().

setPolarizerMatrix()

void PolMatrices::setPolarizerMatrix ( const SpinMatrix &  polarization )

inline

Sets the polarization density matrix (in spin basis along z-axis)

Definition at line 35 of file PolMatrices.h.

{ m_polarizer_matrix = polarization; }

References m_polarizer_matrix.

Referenced by ISpecularScan::polMatrices().

Member Data Documentation

m_analyzer_matrix

SpinMatrix PolMatrices::m_analyzer_matrix

private

polarization analyzer operator

Definition at line 48 of file PolMatrices.h.

Referenced by analyzerMatrix(), and setAnalyzerMatrix().

m_polarizer_matrix

SpinMatrix PolMatrices::m_polarizer_matrix

private

polarization density matrix

Definition at line 47 of file PolMatrices.h.

Referenced by polarizerMatrix(), and setPolarizerMatrix().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Base/Element/PolMatrices.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Base/Element/PolMatrices.cpp