QzScan Class Reference

Description

Scan type with z-components of scattering vector as coordinate values. Wavelength and incident angles are not accessible separately.

Definition at line 28 of file QzScan.h.

Inheritance diagram for QzScan:

Collaboration diagram for QzScan:

Public Member Functions
	QzScan (const IAxis &qs_nm)
	QzScan (int nbins, double qz_min, double qz_max)
	Sets q-defined specular scan. Accepts either numpy array of q-values sorted in ascending order or an IAxis object with q-values. Alternatively an axis can be defined in-place, then the first passed parameter is the number of bins, second - minimum on-axis q-value, third - maximum on-axis q_value. More...
	QzScan (std::vector< double > qs_nm)
	Accepts qz-value vector (in inverse nm) More...
	~QzScan () override
const PolFilter *	analyzer () const
QzScan *	clone () const override
const IAxis *	coordinateAxis () const override
	Returns coordinate axis assigned to the data holder. More...
CoordSystem1D *	createCoordSystem () const override
std::vector< double >	createIntensities (const std::vector< SpecularElement > &eles) const override
	Returns intensity vector corresponding to convolution of given simulation elements. More...
std::vector< double >	footprint (size_t i, size_t n_elements) const override
	Returns footprint correction factor for a range of simulation elements of size n_elements and starting from element with index i. More...
const IFootprintFactor *	footprintFactor () const override
	Returns IFootprintFactor object pointer. More...
std::vector< SpecularElement >	generateElements () const override
	Generates simulation elements for specular simulations. More...
size_t	numberOfElements () const override
	Returns the number of simulation elements. More...
double	offset () const
bool	polarized () const
PolMatrices	polMatrices () const
const ScanResolution *	resolution () const
void	setAbsoluteQResolution (const IRangedDistribution &distr, const std::vector< double > &std_dev)
	Sets qz resolution values via IRangedDistribution and values of standard deviations. std_dev can be either single-valued or a numpy array. In the latter case the length of the array should coinside with the length of the qz-axis. More...
void	setAbsoluteQResolution (const IRangedDistribution &distr, double std_dev)
void	setAnalyzer (R3 direction, double efficiency, double total_transmission)
	Sets the polarization analyzer characteristics of the detector. More...
void	setOffset (double offset)
void	setPolarization (R3 bloch_vector)
	Sets the polarization density matrix according to the given Bloch vector. More...
void	setQResolution (const ScanResolution &resolution)
	Sets q resolution values via ScanResolution object. More...
void	setRelativeQResolution (const IRangedDistribution &distr, const std::vector< double > &rel_dev)
	Sets qz resolution values via IRangedDistribution and values of relative deviations (that is, rel_dev equals standard deviation divided by the mean value). rel_dev can be either single-valued or a numpy array. In the latter case the length of the array should coinside with the length of the qz-axis. More...
void	setRelativeQResolution (const IRangedDistribution &distr, double rel_dev)
virtual void	transferToCPP ()
	Used for Python overriding of clone (see swig/tweaks.py) More...
double	wavelength () const override

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

Private Member Functions
	QzScan (IAxis *qs_nm)
std::vector< std::vector< ParameterSample > >	applyQResolution () const
std::vector< double >	generateQzVector () const

Private Attributes
double	m_offset = 0.
const std::unique_ptr< IAxis >	m_qs
std::unique_ptr< ScanResolution >	m_resolution

Constructor & Destructor Documentation

QzScan() [1/4]

QzScan::QzScan

(

std::vector< double >

qs_nm

)

Accepts qz-value vector (in inverse nm)

Definition at line 39 of file QzScan.cpp.

    : QzScan(new PointwiseAxis("qs", std::move(qs_nm)))
{
}

Referenced by clone().

QzScan() [2/4]

QzScan::QzScan

(

const IAxis &

qs_nm

)

Definition at line 44 of file QzScan.cpp.

    : QzScan(qs_nm.clone())
{
}

QzScan() [3/4]

QzScan::QzScan	(	int	nbins,
		double	qz_min,
		double	qz_max
	)

Sets q-defined specular scan. Accepts either numpy array of q-values sorted in ascending order or an IAxis object with q-values. Alternatively an axis can be defined in-place, then the first passed parameter is the number of bins, second - minimum on-axis q-value, third - maximum on-axis q_value.

Definition at line 49 of file QzScan.cpp.

    : QzScan(new FixedBinAxis("qs", nbins, qz_min, qz_max))
{
}

~QzScan()

QzScan::~QzScan ( )

overridedefault

QzScan() [4/4]

QzScan::QzScan ( IAxis *  qs_nm )

private

Definition at line 25 of file QzScan.cpp.

    : m_qs(std::move(qs_nm))
    , m_resolution(ScanResolution::scanEmptyResolution())
{
    std::vector<double> axis_values = m_qs->binCenters();
    if (!std::is_sorted(axis_values.begin(), axis_values.end()))
        throw std::runtime_error("Error in QzScan::checkInitialization: q-vector values shall "
                                 "be sorted in ascending order.");
 
    if (axis_values.front() < 0)
        throw std::runtime_error("Error in QzScan::checkInitialization: q-vector values are out "
                                 "of acceptable range.");
}

References m_qs.

Member Function Documentation

analyzer()

const PolFilter* ISpecularScan::analyzer ( ) const

inlineinherited

Definition at line 45 of file ISpecularScan.h.

{ return m_polAnalyzer.get(); }

References ISpecularScan::m_polAnalyzer.

applyQResolution()

std::vector< std::vector< ParameterSample > > QzScan::applyQResolution ( ) const

private

Definition at line 167 of file QzScan.cpp.

{
    return m_resolution->generateSamples(m_qs->binCenters());
}

References m_qs, and m_resolution.

Referenced by createIntensities(), and generateQzVector().

clone()

QzScan * QzScan::clone ( ) const

overridevirtual

Implements ISpecularScan.

Definition at line 56 of file QzScan.cpp.

{
    auto* result = new QzScan(*m_qs);
    result->setQResolution(*m_resolution);
    result->setOffset(m_offset);
    // TODO merge with same code in AlphaScan
    if (m_beamPolarization)
        result->m_beamPolarization.reset(new R3(*m_beamPolarization));
    if (m_polAnalyzer)
        result->m_polAnalyzer.reset(new PolFilter(*m_polAnalyzer));
    return result;
}

References QzScan(), ISpecularScan::m_beamPolarization, m_offset, ISpecularScan::m_polAnalyzer, m_qs, and m_resolution.

Referenced by createCoordSystem().

Here is the call graph for this function:

coordinateAxis()

const IAxis* QzScan::coordinateAxis ( ) const

inlineoverridevirtual

Returns coordinate axis assigned to the data holder.

Implements ISpecularScan.

Definition at line 51 of file QzScan.h.

{ return m_qs.get(); }

References m_qs.

Referenced by createCoordSystem().

createCoordSystem()

CoordSystem1D * QzScan::createCoordSystem ( ) const

overridevirtual

Implements ISpecularScan.

Definition at line 97 of file QzScan.cpp.

{
    return new WavenumberReflectometryCoordinates(coordinateAxis()->clone());
}

References clone(), and coordinateAxis().

Here is the call graph for this function:

createIntensities()

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

overridevirtual

Returns intensity vector corresponding to convolution of given simulation elements.

Implements ISpecularScan.

Definition at line 102 of file QzScan.cpp.

{
    const size_t axis_size = m_qs->size();
    std::vector<double> result(axis_size, 0.0);
 
    const auto samples = applyQResolution();
 
    size_t elem_pos = 0;
    for (size_t i = 0; i < axis_size; ++i) {
        double& current = result[i];
        for (size_t j = 0, size = samples[i].size(); j < size; ++j) {
            current += eles[elem_pos].intensity() * samples[i][j].weight;
            ++elem_pos;
        }
    }
    return result;
}

References applyQResolution(), and m_qs.

Here is the call graph for this function:

footprint()

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

overridevirtual

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

Implements ISpecularScan.

Definition at line 83 of file QzScan.cpp.

{
    if (i + n_elements > numberOfElements())
        throw std::runtime_error("Error in QzScan::footprint: given index exceeds the "
                                 "number of simulation elements");
    return std::vector<double>(n_elements, 1.0);
}

References numberOfElements().

Here is the call graph for this function:

footprintFactor()

const IFootprintFactor* QzScan::footprintFactor ( ) const

inlineoverridevirtual

Returns IFootprintFactor object pointer.

Implements ISpecularScan.

Definition at line 54 of file QzScan.h.

{ return nullptr; }

generateElements()

std::vector< SpecularElement > QzScan::generateElements ( ) const

overridevirtual

Generates simulation elements for specular simulations.

Implements ISpecularScan.

Definition at line 70 of file QzScan.cpp.

{
    const std::vector<double> qz = generateQzVector();
 
    std::vector<SpecularElement> result;
    result.reserve(qz.size());
    for (size_t i = 0, size = qz.size(); i < size; ++i)
        result.emplace_back(
            SpecularElement::FromQzScan(-(qz[i] + m_offset) / 2.0, polMatrices(), qz[i] >= 0));
 
    return result;
}

References SpecularElement::FromQzScan(), generateQzVector(), m_offset, and ISpecularScan::polMatrices().

Here is the call graph for this function:

generateQzVector()

std::vector< double > QzScan::generateQzVector ( ) const

private

Definition at line 155 of file QzScan.cpp.

{
    const auto samples = applyQResolution();
 
    std::vector<double> result;
    result.reserve(numberOfElements());
    for (size_t i = 0, size_out = samples.size(); i < size_out; ++i)
        for (size_t j = 0, size_in = samples[i].size(); j < size_in; ++j)
            result.push_back(samples[i][j].value);
    return result;
}

References applyQResolution(), and numberOfElements().

Referenced by generateElements().

Here is the call graph for this function:

numberOfElements()

size_t QzScan::numberOfElements ( ) const

overridevirtual

Returns the number of simulation elements.

Implements ISpecularScan.

Definition at line 92 of file QzScan.cpp.

{
    return m_qs->size() * m_resolution->nSamples();
}

References m_qs, and m_resolution.

Referenced by footprint(), and generateQzVector().

offset()

double QzScan::offset ( ) const

inline

Definition at line 89 of file QzScan.h.

{ return m_offset; }

References m_offset.

Referenced by setOffset().

polarized()

bool ISpecularScan::polarized ( ) const

inherited

Definition at line 31 of file ISpecularScan.cpp.

{
    return m_beamPolarization || m_polAnalyzer;
}

References ISpecularScan::m_beamPolarization, and ISpecularScan::m_polAnalyzer.

polMatrices()

PolMatrices ISpecularScan::polMatrices ( ) const

inherited

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(), ISpecularScan::m_beamPolarization, ISpecularScan::m_polAnalyzer, PolMatrices::setAnalyzerMatrix(), and PolMatrices::setPolarizerMatrix().

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

Here is the call graph for this function:

resolution()

const ScanResolution* QzScan::resolution ( ) const

inline

Definition at line 42 of file QzScan.h.

{ return m_resolution.get(); }

References m_resolution.

Referenced by setAbsoluteQResolution(), setQResolution(), and setRelativeQResolution().

setAbsoluteQResolution() [1/2]

void QzScan::setAbsoluteQResolution	(	const IRangedDistribution &	distr,
		const std::vector< double > &	std_dev
	)

Sets qz resolution values via IRangedDistribution and values of standard deviations. std_dev can be either single-valued or a numpy array. In the latter case the length of the array should coinside with the length of the qz-axis.

Definition at line 147 of file QzScan.cpp.

{
    std::unique_ptr<ScanResolution> resolution(
        ScanResolution::scanAbsoluteResolution(distr, std_dev));
    setQResolution(*resolution);
}

References resolution(), ScanResolution::scanAbsoluteResolution(), and setQResolution().

Here is the call graph for this function:

setAbsoluteQResolution() [2/2]

void QzScan::setAbsoluteQResolution	(	const IRangedDistribution &	distr,
		double	std_dev
	)

Definition at line 140 of file QzScan.cpp.

{
    std::unique_ptr<ScanResolution> resolution(
        ScanResolution::scanAbsoluteResolution(distr, std_dev));
    setQResolution(*resolution);
}

References resolution(), ScanResolution::scanAbsoluteResolution(), and setQResolution().

Here is the call graph for this function:

setAnalyzer()

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

inherited

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 ISpecularScan::m_polAnalyzer.

setOffset()

void QzScan::setOffset ( double  offset )

inline

Definition at line 88 of file QzScan.h.

{ m_offset = offset; }

References m_offset, and offset().

Here is the call graph for this function:

setPolarization()

void ISpecularScan::setPolarization ( R3  bloch_vector )

inherited

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 ISpecularScan::m_beamPolarization.

setQResolution()

void QzScan::setQResolution

(

const ScanResolution &

resolution

)

Sets q resolution values via ScanResolution object.

Definition at line 120 of file QzScan.cpp.

{
    m_resolution.reset(resolution.clone());
}

References ScanResolution::clone(), m_resolution, and resolution().

Referenced by setAbsoluteQResolution(), and setRelativeQResolution().

Here is the call graph for this function:

setRelativeQResolution() [1/2]

void QzScan::setRelativeQResolution	(	const IRangedDistribution &	distr,
		const std::vector< double > &	rel_dev
	)

Sets qz resolution values via IRangedDistribution and values of relative deviations (that is, rel_dev equals standard deviation divided by the mean value). rel_dev can be either single-valued or a numpy array. In the latter case the length of the array should coinside with the length of the qz-axis.

Definition at line 132 of file QzScan.cpp.

{
    std::unique_ptr<ScanResolution> resolution(
        ScanResolution::scanRelativeResolution(distr, rel_dev));
    setQResolution(*resolution);
}

References resolution(), ScanResolution::scanRelativeResolution(), and setQResolution().

Here is the call graph for this function:

setRelativeQResolution() [2/2]

void QzScan::setRelativeQResolution	(	const IRangedDistribution &	distr,
		double	rel_dev
	)

Definition at line 125 of file QzScan.cpp.

{
    std::unique_ptr<ScanResolution> resolution(
        ScanResolution::scanRelativeResolution(distr, rel_dev));
    setQResolution(*resolution);
}

References resolution(), ScanResolution::scanRelativeResolution(), and setQResolution().

Here is the call graph for this function:

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()

double QzScan::wavelength ( ) const

inlineoverridevirtual

Implements ISpecularScan.

Definition at line 44 of file QzScan.h.

{ return 1.0; } // TODO (ISSUE #303)

Member Data Documentation

m_beamPolarization

std::unique_ptr<R3> ISpecularScan::m_beamPolarization

protectedinherited

Bloch vector encoding the beam's polarization.

Definition at line 77 of file ISpecularScan.h.

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

m_offset

double QzScan::m_offset = 0.

private

Definition at line 100 of file QzScan.h.

Referenced by clone(), generateElements(), offset(), and setOffset().

m_polAnalyzer

std::unique_ptr<PolFilter> ISpecularScan::m_polAnalyzer

protectedinherited

Definition at line 78 of file ISpecularScan.h.

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

m_qs

const std::unique_ptr<IAxis> QzScan::m_qs

private

Definition at line 97 of file QzScan.h.

Referenced by QzScan(), applyQResolution(), clone(), coordinateAxis(), createIntensities(), and numberOfElements().

m_resolution

std::unique_ptr<ScanResolution> QzScan::m_resolution

private

Definition at line 98 of file QzScan.h.

Referenced by applyQResolution(), clone(), numberOfElements(), resolution(), and setQResolution().

---

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

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