ISpecularScan Class Reference

Description

Abstract base class for all types of specular scans.

Definition at line 34 of file ISpecularScan.h.

Inheritance diagram for ISpecularScan:

Collaboration diagram for ISpecularScan:

Public Member Functions
	~ISpecularScan () override
const PolFilter *	analyzer () const
ISpecularScan *	clone () const override=0
virtual const IAxis *	coordinateAxis () const =0
	Returns coordinate axis assigned to the data holder. More...
virtual CoordSystem1D *	createCoordSystem () const =0
virtual std::vector< double >	createIntensities (const std::vector< SpecularElement > &eles) const =0
	Returns intensity vector corresponding to convolution of given simulation elements. More...
virtual std::vector< double >	footprint (size_t i, size_t n_elements) const =0
	Returns footprint correction factor for a range of simulation elements of size n_elements and starting from element with index i. More...
virtual const IFootprintFactor *	footprintFactor () const =0
	Returns IFootprintFactor object pointer. More...
virtual std::vector< SpecularElement >	generateElements () const =0
	Generates simulation elements for specular simulations. More...
virtual size_t	numberOfElements () const =0
	Returns the number of simulation elements. More...
bool	polarized () const
PolMatrices	polMatrices () const
void	setAnalyzer (R3 direction, double efficiency, double total_transmission)
	Sets the polarization analyzer characteristics of the detector. More...
void	setPolarization (R3 bloch_vector)
	Sets the polarization density matrix according to the given Bloch vector. More...
virtual void	transferToCPP ()
	Used for Python overriding of clone (see swig/tweaks.py) More...
virtual double	wavelength () const =0

Protected Attributes
std::unique_ptr< R3 >	m_beamPolarization
	Bloch vector encoding the beam's polarization. More...
std::unique_ptr< PolFilter >	m_polAnalyzer

Constructor & Destructor Documentation

~ISpecularScan()

ISpecularScan::~ISpecularScan ( )

overridedefault

Member Function Documentation

analyzer()

const PolFilter* ISpecularScan::analyzer ( ) const

inline

Definition at line 45 of file ISpecularScan.h.

{ return m_polAnalyzer.get(); }

References m_polAnalyzer.

clone()

ISpecularScan* ISpecularScan::clone ( ) const

overridepure virtual

Implements ICloneable.

Implemented in QzScan, and AlphaScan.

coordinateAxis()

virtual const IAxis* ISpecularScan::coordinateAxis ( ) const

pure virtual

Returns coordinate axis assigned to the data holder.

Implemented in QzScan, and AlphaScan.

Referenced by SpecularSimulation::SpecularSimulation().

createCoordSystem()

virtual CoordSystem1D* ISpecularScan::createCoordSystem ( ) const

pure virtual

Implemented in QzScan, and AlphaScan.

createIntensities()

virtual std::vector<double> ISpecularScan::createIntensities ( const std::vector< SpecularElement > &  eles ) const

pure virtual

Returns intensity vector corresponding to convolution of given simulation elements.

Implemented in QzScan, and AlphaScan.

footprint()

virtual std::vector<double> ISpecularScan::footprint ( size_t  i, size_t  n_elements  ) const

pure virtual

Returns footprint correction factor for a range of simulation elements of size n_elements and starting from element with index i.

Implemented in AlphaScan, and QzScan.

footprintFactor()

virtual const IFootprintFactor* ISpecularScan::footprintFactor ( ) const

pure virtual

Returns IFootprintFactor object pointer.

Implemented in QzScan, and AlphaScan.

generateElements()

virtual std::vector<SpecularElement> ISpecularScan::generateElements ( ) const

pure virtual

Generates simulation elements for specular simulations.

Implemented in QzScan, and AlphaScan.

numberOfElements()

virtual size_t ISpecularScan::numberOfElements ( ) const

pure virtual

Returns the number of simulation elements.

Implemented in QzScan, and AlphaScan.

polarized()

bool ISpecularScan::polarized

(

)

const

Definition at line 31 of file ISpecularScan.cpp.

{
    return m_beamPolarization || m_polAnalyzer;
}

References m_beamPolarization, and m_polAnalyzer.

polMatrices()

PolMatrices ISpecularScan::polMatrices

(

)

const

Definition at line 36 of file ISpecularScan.cpp.

{
    PolMatrices result;
    if (m_beamPolarization)
        result.setPolarizerMatrix(SpinMatrix::FromBlochVector(*m_beamPolarization));
    if (m_polAnalyzer)
        result.setAnalyzerMatrix(m_polAnalyzer->matrix());
    return result;
}

References SpinMatrix::FromBlochVector(), m_beamPolarization, m_polAnalyzer, PolMatrices::setAnalyzerMatrix(), and PolMatrices::setPolarizerMatrix().

Referenced by AlphaScan::generateElements(), and QzScan::generateElements().

Here is the call graph for this function:

setAnalyzer()

void ISpecularScan::setAnalyzer	(	R3	direction,
		double	efficiency,
		double	total_transmission
	)

Sets the polarization analyzer characteristics of the detector.

Definition at line 26 of file ISpecularScan.cpp.

{
    m_polAnalyzer.reset(new PolFilter(direction, efficiency, total_transmission));
}

References m_polAnalyzer.

setPolarization()

void ISpecularScan::setPolarization

(

R3

bloch_vector

)

Sets the polarization density matrix according to the given Bloch vector.

Definition at line 21 of file ISpecularScan.cpp.

{
    m_beamPolarization.reset(new R3(bloch_vector));
}

References m_beamPolarization.

transferToCPP()

virtual void ICloneable::transferToCPP ( )

inlinevirtualinherited

Used for Python overriding of clone (see swig/tweaks.py)

Definition at line 32 of file ICloneable.h.

wavelength()

virtual double ISpecularScan::wavelength ( ) const

pure virtual

Implemented in QzScan, and AlphaScan.

Member Data Documentation

m_beamPolarization

std::unique_ptr<R3> ISpecularScan::m_beamPolarization

protected

Bloch vector encoding the beam's polarization.

Definition at line 77 of file ISpecularScan.h.

Referenced by AlphaScan::clone(), QzScan::clone(), polarized(), polMatrices(), and setPolarization().

m_polAnalyzer

std::unique_ptr<PolFilter> ISpecularScan::m_polAnalyzer

protected

Definition at line 78 of file ISpecularScan.h.

Referenced by analyzer(), AlphaScan::clone(), QzScan::clone(), polarized(), polMatrices(), and setAnalyzer().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Sim/Scan/ISpecularScan.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Sim/Scan/ISpecularScan.cpp